-
Notifications
You must be signed in to change notification settings - Fork 502
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
AAD authentication using access token (#755)
* Connect to a DB by directly supplying auth token * Rename to AuthToken to AccessToken to match AAD terminology Co-authored-by: Rudra Pratap Singh Nirvan <[email protected]>
- Loading branch information
1 parent
cc3f8a4
commit ed0f620
Showing
5 changed files
with
454 additions
and
362 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,192 +1,203 @@ | ||
| package azuread | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/Azure/azure-sdk-for-go/sdk/azcore" | ||
| "github.com/Azure/azure-sdk-for-go/sdk/azcore/policy" | ||
| "github.com/Azure/azure-sdk-for-go/sdk/azidentity" | ||
| mssql "github.com/denisenkom/go-mssqldb" | ||
| "github.com/denisenkom/go-mssqldb/msdsn" | ||
| ) | ||
|
|
||
| const ( | ||
| ActiveDirectoryDefault = "ActiveDirectoryDefault" | ||
| ActiveDirectoryIntegrated = "ActiveDirectoryIntegrated" | ||
| ActiveDirectoryPassword = "ActiveDirectoryPassword" | ||
| ActiveDirectoryInteractive = "ActiveDirectoryInteractive" | ||
| // ActiveDirectoryMSI is a synonym for ActiveDirectoryManagedIdentity | ||
| ActiveDirectoryMSI = "ActiveDirectoryMSI" | ||
| ActiveDirectoryManagedIdentity = "ActiveDirectoryManagedIdentity" | ||
| // ActiveDirectoryApplication is a synonym for ActiveDirectoryServicePrincipal | ||
| ActiveDirectoryApplication = "ActiveDirectoryApplication" | ||
| ActiveDirectoryServicePrincipal = "ActiveDirectoryServicePrincipal" | ||
| scopeDefaultSuffix = "/.default" | ||
| ) | ||
|
|
||
| type azureFedAuthConfig struct { | ||
| adalWorkflow byte | ||
| mssqlConfig msdsn.Config | ||
| // The detected federated authentication library | ||
| fedAuthLibrary int | ||
| fedAuthWorkflow string | ||
| // Service principal logins | ||
| clientID string | ||
| tenantID string | ||
| clientSecret string | ||
| certificatePath string | ||
|
|
||
| // AD password/managed identity/interactive | ||
| user string | ||
| password string | ||
| applicationClientID string | ||
| } | ||
|
|
||
| // parse returns a config based on an msdsn-style connection string | ||
| func parse(dsn string) (*azureFedAuthConfig, error) { | ||
| mssqlConfig, params, err := msdsn.Parse(dsn) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| config := &azureFedAuthConfig{ | ||
| fedAuthLibrary: mssql.FedAuthLibraryReserved, | ||
| mssqlConfig: mssqlConfig, | ||
| } | ||
|
|
||
| err = config.validateParameters(params) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return config, nil | ||
| } | ||
|
|
||
| func (p *azureFedAuthConfig) validateParameters(params map[string]string) error { | ||
|
|
||
| fedAuthWorkflow, _ := params["fedauth"] | ||
| if fedAuthWorkflow == "" { | ||
| return nil | ||
| } | ||
|
|
||
| p.fedAuthLibrary = mssql.FedAuthLibraryADAL | ||
|
|
||
| p.applicationClientID, _ = params["applicationclientid"] | ||
|
|
||
| switch { | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryPassword): | ||
| if p.applicationClientID == "" { | ||
| return errors.New("applicationclientid parameter is required for " + ActiveDirectoryPassword) | ||
| } | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowPassword | ||
| p.user, _ = params["user id"] | ||
| p.password, _ = params["password"] | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryIntegrated): | ||
| // Active Directory Integrated authentication is not fully supported: | ||
| // you can only use this by also implementing an a token provider | ||
| // and supplying it via ActiveDirectoryTokenProvider in the Connection. | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowIntegrated | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryManagedIdentity) || strings.EqualFold(fedAuthWorkflow, ActiveDirectoryMSI): | ||
| // When using MSI, to request a specific client ID or user-assigned identity, | ||
| // provide the ID in the "user id" parameter | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowMSI | ||
| p.clientID, _ = splitTenantAndClientID(params["user id"]) | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryApplication) || strings.EqualFold(fedAuthWorkflow, ActiveDirectoryServicePrincipal): | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowPassword | ||
| // Split the clientID@tenantID format | ||
| // If no tenant is provided we'll use the one from the server | ||
| p.clientID, p.tenantID = splitTenantAndClientID(params["user id"]) | ||
| if p.clientID == "" { | ||
| return errors.New("Must provide 'client id[@tenant id]' as username parameter when using ActiveDirectoryApplication authentication") | ||
| } | ||
|
|
||
| p.clientSecret, _ = params["password"] | ||
|
|
||
| p.certificatePath, _ = params["clientcertpath"] | ||
|
|
||
| if p.certificatePath == "" && p.clientSecret == "" { | ||
| return errors.New("Must provide 'password' parameter when using ActiveDirectoryApplication authentication without cert/key credentials") | ||
| } | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryDefault): | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowPassword | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryInteractive): | ||
| if p.applicationClientID == "" { | ||
| return errors.New("applicationclientid parameter is required for " + ActiveDirectoryInteractive) | ||
| } | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowPassword | ||
| // user is an optional login hint | ||
| p.user, _ = params["user id"] | ||
| // we don't really have a password but we need to use some value. | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowPassword | ||
|
|
||
| default: | ||
| return fmt.Errorf("Invalid federated authentication type '%s': expected one of %+v", | ||
| fedAuthWorkflow, | ||
| []string{ActiveDirectoryApplication, ActiveDirectoryServicePrincipal, ActiveDirectoryDefault, ActiveDirectoryIntegrated, ActiveDirectoryInteractive, ActiveDirectoryManagedIdentity, ActiveDirectoryMSI, ActiveDirectoryPassword}) | ||
| } | ||
| p.fedAuthWorkflow = fedAuthWorkflow | ||
| return nil | ||
| } | ||
|
|
||
| func splitTenantAndClientID(user string) (string, string) { | ||
| // Split the user name into client id and tenant id at the @ symbol | ||
| at := strings.IndexRune(user, '@') | ||
| if at < 1 || at >= (len(user)-1) { | ||
| return user, "" | ||
| } | ||
|
|
||
| return user[0:at], user[at+1:] | ||
| } | ||
|
|
||
| func splitAuthorityAndTenant(authorityUrl string) (string, string) { | ||
| separatorIndex := strings.LastIndex(authorityUrl, "/") | ||
| tenant := authorityUrl[separatorIndex+1:] | ||
| authority := authorityUrl[:separatorIndex] | ||
| return authority, tenant | ||
| } | ||
|
|
||
| func (p *azureFedAuthConfig) provideActiveDirectoryToken(ctx context.Context, serverSPN, stsURL string) (string, error) { | ||
| var cred azcore.TokenCredential | ||
| var err error | ||
| authority, tenant := splitAuthorityAndTenant(stsURL) | ||
| // client secret connection strings may override the server tenant | ||
| if p.tenantID != "" { | ||
| tenant = p.tenantID | ||
| } | ||
| scope := stsURL | ||
| if !strings.HasSuffix(serverSPN, scopeDefaultSuffix) { | ||
| scope = strings.TrimRight(serverSPN, "/") + scopeDefaultSuffix | ||
| } | ||
|
|
||
| switch p.fedAuthWorkflow { | ||
| case ActiveDirectoryServicePrincipal, ActiveDirectoryApplication: | ||
| switch { | ||
| case p.certificatePath != "": | ||
| cred, err = azidentity.NewClientCertificateCredential(tenant, p.clientID, p.certificatePath, &azidentity.ClientCertificateCredentialOptions{Password: p.clientSecret}) | ||
| default: | ||
| cred, err = azidentity.NewClientSecretCredential(tenant, p.clientID, p.clientSecret, nil) | ||
| } | ||
| case ActiveDirectoryPassword: | ||
| cred, err = azidentity.NewUsernamePasswordCredential(tenant, p.applicationClientID, p.user, p.password, nil) | ||
| case ActiveDirectoryMSI, ActiveDirectoryManagedIdentity: | ||
| cred, err = azidentity.NewManagedIdentityCredential(p.clientID, nil) | ||
| case ActiveDirectoryInteractive: | ||
| cred, err = azidentity.NewInteractiveBrowserCredential(&azidentity.InteractiveBrowserCredentialOptions{AuthorityHost: authority, ClientID: p.applicationClientID}) | ||
|
|
||
| default: | ||
| // Integrated just uses Default until azidentity adds Windows-specific authentication | ||
| cred, err = azidentity.NewDefaultAzureCredential(nil) | ||
| } | ||
|
|
||
| if err != nil { | ||
| return "", err | ||
| } | ||
| opts := policy.TokenRequestOptions{Scopes: []string{scope}} | ||
| tk, err := cred.GetToken(ctx, opts) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| return tk.Token, err | ||
| } | ||
| package azuread | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/Azure/azure-sdk-for-go/sdk/azcore" | ||
| "github.com/Azure/azure-sdk-for-go/sdk/azcore/policy" | ||
| "github.com/Azure/azure-sdk-for-go/sdk/azidentity" | ||
|
|
||
| mssql "github.com/denisenkom/go-mssqldb" | ||
| "github.com/denisenkom/go-mssqldb/msdsn" | ||
| ) | ||
|
|
||
| const ( | ||
| ActiveDirectoryDefault = "ActiveDirectoryDefault" | ||
| ActiveDirectoryIntegrated = "ActiveDirectoryIntegrated" | ||
| ActiveDirectoryPassword = "ActiveDirectoryPassword" | ||
| ActiveDirectoryInteractive = "ActiveDirectoryInteractive" | ||
| // ActiveDirectoryMSI is a synonym for ActiveDirectoryManagedIdentity | ||
| ActiveDirectoryMSI = "ActiveDirectoryMSI" | ||
| ActiveDirectoryManagedIdentity = "ActiveDirectoryManagedIdentity" | ||
| // ActiveDirectoryApplication is a synonym for ActiveDirectoryServicePrincipal | ||
| ActiveDirectoryApplication = "ActiveDirectoryApplication" | ||
| ActiveDirectoryServicePrincipal = "ActiveDirectoryServicePrincipal" | ||
| ActiveDirectoryServicePrincipalAccessToken = "ActiveDirectoryServicePrincipalAccessToken" | ||
| scopeDefaultSuffix = "/.default" | ||
| ) | ||
|
|
||
| type azureFedAuthConfig struct { | ||
| adalWorkflow byte | ||
| mssqlConfig msdsn.Config | ||
| // The detected federated authentication library | ||
| fedAuthLibrary int | ||
| fedAuthWorkflow string | ||
| // Service principal logins | ||
| clientID string | ||
| tenantID string | ||
| clientSecret string | ||
| certificatePath string | ||
|
|
||
| // AD password/managed identity/interactive | ||
| user string | ||
| password string | ||
| applicationClientID string | ||
| } | ||
|
|
||
| // parse returns a config based on an msdsn-style connection string | ||
| func parse(dsn string) (*azureFedAuthConfig, error) { | ||
| mssqlConfig, params, err := msdsn.Parse(dsn) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| config := &azureFedAuthConfig{ | ||
| fedAuthLibrary: mssql.FedAuthLibraryReserved, | ||
| mssqlConfig: mssqlConfig, | ||
| } | ||
|
|
||
| err = config.validateParameters(params) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return config, nil | ||
| } | ||
|
|
||
| func (p *azureFedAuthConfig) validateParameters(params map[string]string) error { | ||
|
|
||
| fedAuthWorkflow, _ := params["fedauth"] | ||
| if fedAuthWorkflow == "" { | ||
| return nil | ||
| } | ||
|
|
||
| p.fedAuthLibrary = mssql.FedAuthLibraryADAL | ||
|
|
||
| p.applicationClientID, _ = params["applicationclientid"] | ||
|
|
||
| switch { | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryPassword): | ||
| if p.applicationClientID == "" { | ||
| return errors.New("applicationclientid parameter is required for " + ActiveDirectoryPassword) | ||
| } | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowPassword | ||
| p.user, _ = params["user id"] | ||
| p.password, _ = params["password"] | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryIntegrated): | ||
| // Active Directory Integrated authentication is not fully supported: | ||
| // you can only use this by also implementing an a token provider | ||
| // and supplying it via ActiveDirectoryTokenProvider in the Connection. | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowIntegrated | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryManagedIdentity) || strings.EqualFold(fedAuthWorkflow, ActiveDirectoryMSI): | ||
| // When using MSI, to request a specific client ID or user-assigned identity, | ||
| // provide the ID in the "user id" parameter | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowMSI | ||
| p.clientID, _ = splitTenantAndClientID(params["user id"]) | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryApplication) || strings.EqualFold(fedAuthWorkflow, ActiveDirectoryServicePrincipal): | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowPassword | ||
| // Split the clientID@tenantID format | ||
| // If no tenant is provided we'll use the one from the server | ||
| p.clientID, p.tenantID = splitTenantAndClientID(params["user id"]) | ||
| if p.clientID == "" { | ||
| return errors.New("Must provide 'client id[@tenant id]' as username parameter when using ActiveDirectoryApplication authentication") | ||
| } | ||
|
|
||
| p.clientSecret, _ = params["password"] | ||
|
|
||
| p.certificatePath, _ = params["clientcertpath"] | ||
|
|
||
| if p.certificatePath == "" && p.clientSecret == "" { | ||
| return errors.New("Must provide 'password' parameter when using ActiveDirectoryApplication authentication without cert/key credentials") | ||
| } | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryDefault): | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowPassword | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryInteractive): | ||
| if p.applicationClientID == "" { | ||
| return errors.New("applicationclientid parameter is required for " + ActiveDirectoryInteractive) | ||
| } | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowPassword | ||
| // user is an optional login hint | ||
| p.user, _ = params["user id"] | ||
| // we don't really have a password but we need to use some value. | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowPassword | ||
| case strings.EqualFold(fedAuthWorkflow, ActiveDirectoryServicePrincipalAccessToken): | ||
| p.fedAuthLibrary = mssql.FedAuthLibrarySecurityToken | ||
| p.adalWorkflow = mssql.FedAuthADALWorkflowNone | ||
| p.password, _ = params["password"] | ||
|
|
||
| if p.password == "" { | ||
| return errors.New("Must provide 'password' parameter when using ActiveDirectoryApplicationAuthToken authentication") | ||
| } | ||
| default: | ||
| return fmt.Errorf("Invalid federated authentication type '%s': expected one of %+v", | ||
| fedAuthWorkflow, | ||
| []string{ActiveDirectoryApplication, ActiveDirectoryServicePrincipal, ActiveDirectoryDefault, ActiveDirectoryIntegrated, ActiveDirectoryInteractive, ActiveDirectoryManagedIdentity, ActiveDirectoryMSI, ActiveDirectoryPassword}) | ||
| } | ||
| p.fedAuthWorkflow = fedAuthWorkflow | ||
| return nil | ||
| } | ||
|
|
||
| func splitTenantAndClientID(user string) (string, string) { | ||
| // Split the user name into client id and tenant id at the @ symbol | ||
| at := strings.IndexRune(user, '@') | ||
| if at < 1 || at >= (len(user)-1) { | ||
| return user, "" | ||
| } | ||
|
|
||
| return user[0:at], user[at+1:] | ||
| } | ||
|
|
||
| func splitAuthorityAndTenant(authorityUrl string) (string, string) { | ||
| separatorIndex := strings.LastIndex(authorityUrl, "/") | ||
| tenant := authorityUrl[separatorIndex+1:] | ||
| authority := authorityUrl[:separatorIndex] | ||
| return authority, tenant | ||
| } | ||
|
|
||
| func (p *azureFedAuthConfig) provideActiveDirectoryToken(ctx context.Context, serverSPN, stsURL string) (string, error) { | ||
| var cred azcore.TokenCredential | ||
| var err error | ||
| authority, tenant := splitAuthorityAndTenant(stsURL) | ||
| // client secret connection strings may override the server tenant | ||
| if p.tenantID != "" { | ||
| tenant = p.tenantID | ||
| } | ||
| scope := stsURL | ||
| if !strings.HasSuffix(serverSPN, scopeDefaultSuffix) { | ||
| scope = strings.TrimRight(serverSPN, "/") + scopeDefaultSuffix | ||
| } | ||
|
|
||
| switch p.fedAuthWorkflow { | ||
| case ActiveDirectoryServicePrincipal, ActiveDirectoryApplication: | ||
| switch { | ||
| case p.certificatePath != "": | ||
| cred, err = azidentity.NewClientCertificateCredential(tenant, p.clientID, p.certificatePath, &azidentity.ClientCertificateCredentialOptions{Password: p.clientSecret}) | ||
| default: | ||
| cred, err = azidentity.NewClientSecretCredential(tenant, p.clientID, p.clientSecret, nil) | ||
| } | ||
| case ActiveDirectoryServicePrincipalAccessToken: | ||
| return p.password, nil | ||
| case ActiveDirectoryPassword: | ||
| cred, err = azidentity.NewUsernamePasswordCredential(tenant, p.applicationClientID, p.user, p.password, nil) | ||
| case ActiveDirectoryMSI, ActiveDirectoryManagedIdentity: | ||
| cred, err = azidentity.NewManagedIdentityCredential(p.clientID, nil) | ||
| case ActiveDirectoryInteractive: | ||
| cred, err = azidentity.NewInteractiveBrowserCredential(&azidentity.InteractiveBrowserCredentialOptions{AuthorityHost: authority, ClientID: p.applicationClientID}) | ||
|
|
||
| default: | ||
| // Integrated just uses Default until azidentity adds Windows-specific authentication | ||
| cred, err = azidentity.NewDefaultAzureCredential(nil) | ||
| } | ||
|
|
||
| if err != nil { | ||
| return "", err | ||
| } | ||
| opts := policy.TokenRequestOptions{Scopes: []string{scope}} | ||
| tk, err := cred.GetToken(ctx, opts) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| return tk.Token, err | ||
| } |
Oops, something went wrong.