|
| 1 | +package oidc |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "errors" |
| 6 | + "fmt" |
| 7 | + |
| 8 | + "github.com/databricks/databricks-sdk-go/httpclient" |
| 9 | + "github.com/databricks/databricks-sdk-go/logger" |
| 10 | +) |
| 11 | + |
| 12 | +// NewAzureDevOpsIDTokenSource returns a new IDTokenSource that retrieves an IDToken |
| 13 | +// from the Azure DevOps environment. This IDTokenSource is only valid when |
| 14 | +// running in Azure DevOps Pipelines with OIDC enabled. |
| 15 | +func NewAzureDevOpsIDTokenSource(client *httpclient.ApiClient, azureDevOpsAccessToken, azureDevOpsTeamFoundationCollectionUri, azureDevOpsPlanId, azureDevOpsJobId, azureDevOpsTeamProjectId, azureDevOpsHostType string) IDTokenSource { |
| 16 | + return &azureDevOpsIDTokenSource{ |
| 17 | + azureDevOpsAccessToken: azureDevOpsAccessToken, |
| 18 | + azureDevOpsTeamFoundationCollectionUri: azureDevOpsTeamFoundationCollectionUri, |
| 19 | + refreshClient: client, |
| 20 | + azureDevOpsPlanId: azureDevOpsPlanId, |
| 21 | + azureDevOpsJobId: azureDevOpsJobId, |
| 22 | + azureDevOpsTeamProjectId: azureDevOpsTeamProjectId, |
| 23 | + azureDevOpsHostType: azureDevOpsHostType, |
| 24 | + } |
| 25 | +} |
| 26 | + |
| 27 | +// azureDevOpsIDTokenSource retrieves JWT Tokens from Azure DevOps Pipelines. |
| 28 | +type azureDevOpsIDTokenSource struct { |
| 29 | + azureDevOpsAccessToken string |
| 30 | + azureDevOpsTeamFoundationCollectionUri string |
| 31 | + refreshClient *httpclient.ApiClient |
| 32 | + azureDevOpsPlanId string |
| 33 | + azureDevOpsJobId string |
| 34 | + azureDevOpsTeamProjectId string |
| 35 | + azureDevOpsHostType string |
| 36 | +} |
| 37 | + |
| 38 | +// IDToken returns a JWT Token for the specified audience. For Azure DevOps OIDC, |
| 39 | +// the audience parameter is ignored as Azure DevOps tokens always use "api://AzureADTokenExchange". |
| 40 | +// It will return an error if not running in Azure DevOps Pipelines. |
| 41 | +func (a *azureDevOpsIDTokenSource) IDToken(ctx context.Context, audience string) (*IDToken, error) { |
| 42 | + if a.azureDevOpsAccessToken == "" { |
| 43 | + logger.Debugf(ctx, "Missing AZUREDEVOPS_ACCESSTOKEN, likely not calling from Azure DevOps Pipeline") |
| 44 | + return nil, errors.New("missing AZUREDEVOPS_ACCESSTOKEN") |
| 45 | + } |
| 46 | + if a.azureDevOpsTeamFoundationCollectionUri == "" { |
| 47 | + logger.Debugf(ctx, "Missing AZUREDEVOPS_TEAMFOUNDATIONCOLLECTIONURI, likely not calling from Azure DevOps Pipeline") |
| 48 | + return nil, errors.New("missing AZUREDEVOPS_TEAMFOUNDATIONCOLLECTIONURI") |
| 49 | + } |
| 50 | + if a.azureDevOpsPlanId == "" { |
| 51 | + logger.Debugf(ctx, "Missing AZUREDEVOPS_PLANID, likely not calling from Azure DevOps Pipeline") |
| 52 | + return nil, errors.New("missing AZUREDEVOPS_PLANID") |
| 53 | + } |
| 54 | + if a.azureDevOpsJobId == "" { |
| 55 | + logger.Debugf(ctx, "Missing AZUREDEVOPS_JOBID, likely not calling from Azure DevOps Pipeline") |
| 56 | + return nil, errors.New("missing AZUREDEVOPS_JOBID") |
| 57 | + } |
| 58 | + if a.azureDevOpsTeamProjectId == "" { |
| 59 | + logger.Debugf(ctx, "Missing AZUREDEVOPS_TEAMPROJECTID, likely not calling from Azure DevOps Pipeline") |
| 60 | + return nil, errors.New("missing AZUREDEVOPS_TEAMPROJECTID") |
| 61 | + } |
| 62 | + if a.azureDevOpsHostType == "" { |
| 63 | + logger.Debugf(ctx, "Missing AZUREDEVOPS_HOSTTYPE, likely not calling from Azure DevOps Pipeline") |
| 64 | + return nil, errors.New("missing AZUREDEVOPS_HOSTTYPE") |
| 65 | + } |
| 66 | + |
| 67 | + // Azure DevOps OIDC endpoint format |
| 68 | + // Reference: https://learn.microsoft.com/en-us/rest/api/azure/devops/distributedtask/oidctoken/create?view=azure-devops-rest-7.1 |
| 69 | + // Use azureDevOpsHostType to determine the hub name dynamically (e.g., "build", "release", etc.) |
| 70 | + requestUrl := fmt.Sprintf("%s/%s/_apis/distributedtask/hubs/%s/plans/%s/jobs/%s/oidctoken?api-version=7.2-preview.1", |
| 71 | + a.azureDevOpsTeamFoundationCollectionUri, |
| 72 | + a.azureDevOpsTeamProjectId, |
| 73 | + a.azureDevOpsHostType, |
| 74 | + a.azureDevOpsPlanId, |
| 75 | + a.azureDevOpsJobId) |
| 76 | + |
| 77 | + // Azure DevOps returns {"oidcToken":"***"} format, not {"value":"***"} |
| 78 | + var azureResp struct { |
| 79 | + OidcToken string `json:"oidcToken"` |
| 80 | + } |
| 81 | + |
| 82 | + err := a.refreshClient.Do(ctx, "POST", requestUrl, |
| 83 | + httpclient.WithRequestHeader("Authorization", fmt.Sprintf("Bearer %s", a.azureDevOpsAccessToken)), |
| 84 | + httpclient.WithResponseUnmarshal(&azureResp), |
| 85 | + ) |
| 86 | + if err != nil { |
| 87 | + return nil, fmt.Errorf("failed to request ID token from Azure DevOps: %w", err) |
| 88 | + } |
| 89 | + |
| 90 | + if azureResp.OidcToken == "" { |
| 91 | + return nil, fmt.Errorf("empty OIDC token received from Azure DevOps") |
| 92 | + } |
| 93 | + |
| 94 | + return &IDToken{Value: azureResp.OidcToken}, nil |
| 95 | +} |
0 commit comments