adal

Mar 15, 2023

Changes in this version

+ type JWTCallback func() (string, error)

type ServicePrincipalToken

+ func NewServicePrincipalTokenFromFederatedTokenCallback(oauthConfig OAuthConfig, clientID string, jwtCallback JWTCallback, ...) (*ServicePrincipalToken, error)

May 4, 2022

retracted

Changes in this version

+ type ServicePrincipalFederatedSecret struct

+ func (secret *ServicePrincipalFederatedSecret) SetAuthenticationValues(spt *ServicePrincipalToken, v *url.Values) error

+ func (secret ServicePrincipalFederatedSecret) MarshalJSON() ([]byte, error)

type ServicePrincipalToken

+ func NewServicePrincipalTokenFromFederatedToken(oauthConfig OAuthConfig, clientID string, jwt string, resource string, ...) (*ServicePrincipalToken, error)

Feb 4, 2021

retracted

Changes in this version

+ type ManagedIdentityOptions struct

+ ClientID string

+ IdentityResourceID string

type ServicePrincipalToken

+ func NewServicePrincipalTokenFromManagedIdentity(resource string, options *ManagedIdentityOptions, ...) (*ServicePrincipalToken, error)

Dec 4, 2020

retracted

Changes in this version

type MultiTenantServicePrincipalToken

+ func NewMultiTenantServicePrincipalTokenFromCertificate(multiTenantCfg MultiTenantOAuthConfig, clientID string, ...) (*MultiTenantServicePrincipalToken, error)

Aug 13, 2020

Changes in this version

+ var ErrMissingCertificate = errors.New("adal: certificate missing")

+ var ErrMissingPrivateKey = errors.New("adal: private key missing")

+ func DecodePfxCertificateData(pfxData []byte, password string) (*x509.Certificate, *rsa.PrivateKey, error)

+ func MSIAvailable(ctx context.Context, sender Sender) bool

Aug 7, 2020

Changes in this version

type ServicePrincipalToken

+ func NewServicePrincipalTokenFromMSIWithIdentityResourceID(msiEndpoint, resource string, identityResourceID string, ...) (*ServicePrincipalToken, error)

Dec 13, 2019

Changes in this version

type ServicePrincipalToken

+ func (spt *ServicePrincipalToken) SetCustomRefreshFunc(customRefreshFunc TokenRefresh)

+ type TokenRefresh func(ctx context.Context, resource string) (*Token, error)

Oct 14, 2019

Changes in this version

type DeviceCode

+ func InitiateDeviceAuthWithContext(ctx context.Context, sender Sender, oauthConfig OAuthConfig, ...) (*DeviceCode, error)

type Token

+ func CheckForUserCompletionWithContext(ctx context.Context, sender Sender, code *DeviceCode) (*Token, error)

+ func WaitForUserCompletionWithContext(ctx context.Context, sender Sender, code *DeviceCode) (*Token, error)

Oct 10, 2019

Changes in this version

+ func GetMSIAppServiceEndpoint() (string, error)

+ func GetMSIEndpoint() (string, error)

Aug 15, 2019

Changes in this version

type MultiTenantServicePrincipalToken

+ func (mt *MultiTenantServicePrincipalToken) RefreshExchangeWithContext(ctx context.Context, resource string) error

+ func (mt *MultiTenantServicePrincipalToken) RefreshWithContext(ctx context.Context) error

Jul 8, 2019

Changes in this version

+ type MultiTenantOAuthConfig interface

+ AuxiliaryTenants func() []*OAuthConfig

+ PrimaryTenant func() *OAuthConfig

+ func NewMultiTenantOAuthConfig(activeDirectoryEndpoint, primaryTenantID string, auxiliaryTenantIDs []string, ...) (MultiTenantOAuthConfig, error)

+ type MultiTenantServicePrincipalToken struct

+ AuxiliaryTokens []*ServicePrincipalToken

+ PrimaryToken *ServicePrincipalToken

+ func NewMultiTenantServicePrincipalToken(multiTenantCfg MultiTenantOAuthConfig, clientID string, secret string, ...) (*MultiTenantServicePrincipalToken, error)

+ func (mt *MultiTenantServicePrincipalToken) AuxiliaryOAuthTokens() []string

+ func (mt *MultiTenantServicePrincipalToken) EnsureFreshWithContext(ctx context.Context) error

+ func (mt *MultiTenantServicePrincipalToken) PrimaryOAuthToken() string

+ type MultitenantOAuthTokenProvider interface

+ AuxiliaryOAuthTokens func() []string

+ PrimaryOAuthToken func() string

+ type OAuthOptions struct

+ APIVersion string

Apr 19, 2019

Changes in this version

+ const OAuthGrantTypeAuthorizationCode

+ const OAuthGrantTypeClientCredentials

+ const OAuthGrantTypeDeviceCode

+ const OAuthGrantTypeRefreshToken

+ const OAuthGrantTypeUserPass

+ var ErrDeviceAccessDenied = fmt.Errorf("%s Error while retrieving OAuth token: Access Denied", logPrefix)

+ var ErrDeviceAuthorizationPending = fmt.Errorf("%s Error while retrieving OAuth token: Authorization Pending", logPrefix)

+ var ErrDeviceCodeEmpty = fmt.Errorf("%s Error while retrieving device code: Device Code Empty", logPrefix)

+ var ErrDeviceCodeExpired = fmt.Errorf("%s Error while retrieving OAuth token: Code Expired", logPrefix)

+ var ErrDeviceGeneric = fmt.Errorf("%s Error while retrieving OAuth token: Unknown Error", logPrefix)

+ var ErrDeviceSlowDown = fmt.Errorf("%s Error while retrieving OAuth token: Slow Down", logPrefix)

+ var ErrOAuthTokenEmpty = fmt.Errorf("%s Error while retrieving OAuth token: Token Empty", logPrefix)

+ func AddToUserAgent(extension string) error

+ func GetMSIVMEndpoint() (string, error)

+ func SaveToken(path string, mode os.FileMode, token Token) error

+ func UserAgent() string

+ type DeviceCode struct

+ ClientID string

+ DeviceCode *string

+ ExpiresIn *int64

+ Interval *int64

+ Message *string

+ OAuthConfig OAuthConfig

+ Resource string

+ UserCode *string

+ VerificationURL *string

+ func InitiateDeviceAuth(sender Sender, oauthConfig OAuthConfig, clientID, resource string) (*DeviceCode, error)

+ type OAuthConfig struct

+ AuthorityEndpoint url.URL

+ AuthorizeEndpoint url.URL

+ DeviceCodeEndpoint url.URL

+ TokenEndpoint url.URL

+ func NewOAuthConfig(activeDirectoryEndpoint, tenantID string) (*OAuthConfig, error)

+ func NewOAuthConfigWithAPIVersion(activeDirectoryEndpoint, tenantID string, apiVersion *string) (*OAuthConfig, error)

+ func (oac OAuthConfig) IsZero() bool

+ type OAuthTokenProvider interface

+ OAuthToken func() string

+ type Refresher interface

+ EnsureFresh func() error

+ Refresh func() error

+ RefreshExchange func(resource string) error

+ type RefresherWithContext interface

+ EnsureFreshWithContext func(ctx context.Context) error

+ RefreshExchangeWithContext func(ctx context.Context, resource string) error

+ RefreshWithContext func(ctx context.Context) error

+ type SendDecorator func(Sender) Sender

+ type Sender interface

+ Do func(*http.Request) (*http.Response, error)

+ func CreateSender(decorators ...SendDecorator) Sender

+ func DecorateSender(s Sender, decorators ...SendDecorator) Sender

+ type SenderFunc func(*http.Request) (*http.Response, error)

+ func (sf SenderFunc) Do(r *http.Request) (*http.Response, error)

+ type ServicePrincipalAuthorizationCodeSecret struct

+ AuthorizationCode string

+ ClientSecret string

+ RedirectURI string

+ func (secret *ServicePrincipalAuthorizationCodeSecret) SetAuthenticationValues(spt *ServicePrincipalToken, v *url.Values) error

+ func (secret ServicePrincipalAuthorizationCodeSecret) MarshalJSON() ([]byte, error)

+ type ServicePrincipalCertificateSecret struct

+ Certificate *x509.Certificate

+ PrivateKey *rsa.PrivateKey

+ func (secret *ServicePrincipalCertificateSecret) SetAuthenticationValues(spt *ServicePrincipalToken, v *url.Values) error

+ func (secret *ServicePrincipalCertificateSecret) SignJwt(spt *ServicePrincipalToken) (string, error)

+ func (secret ServicePrincipalCertificateSecret) MarshalJSON() ([]byte, error)

+ type ServicePrincipalMSISecret struct

+ func (msiSecret *ServicePrincipalMSISecret) SetAuthenticationValues(spt *ServicePrincipalToken, v *url.Values) error

+ func (msiSecret ServicePrincipalMSISecret) MarshalJSON() ([]byte, error)

+ type ServicePrincipalNoSecret struct

+ func (noSecret *ServicePrincipalNoSecret) SetAuthenticationValues(spt *ServicePrincipalToken, v *url.Values) error

+ func (noSecret ServicePrincipalNoSecret) MarshalJSON() ([]byte, error)

+ type ServicePrincipalSecret interface

+ SetAuthenticationValues func(spt *ServicePrincipalToken, values *url.Values) error

+ type ServicePrincipalToken struct

+ MaxMSIRefreshAttempts int

+ func NewServicePrincipalToken(oauthConfig OAuthConfig, clientID string, secret string, resource string, ...) (*ServicePrincipalToken, error)

+ func NewServicePrincipalTokenFromAuthorizationCode(oauthConfig OAuthConfig, clientID string, clientSecret string, ...) (*ServicePrincipalToken, error)

+ func NewServicePrincipalTokenFromCertificate(oauthConfig OAuthConfig, clientID string, certificate *x509.Certificate, ...) (*ServicePrincipalToken, error)

+ func NewServicePrincipalTokenFromMSI(msiEndpoint, resource string, callbacks ...TokenRefreshCallback) (*ServicePrincipalToken, error)

+ func NewServicePrincipalTokenFromMSIWithUserAssignedID(msiEndpoint, resource string, userAssignedID string, ...) (*ServicePrincipalToken, error)

+ func NewServicePrincipalTokenFromManualToken(oauthConfig OAuthConfig, clientID string, resource string, token Token, ...) (*ServicePrincipalToken, error)

+ func NewServicePrincipalTokenFromManualTokenSecret(oauthConfig OAuthConfig, clientID string, resource string, token Token, ...) (*ServicePrincipalToken, error)

+ func NewServicePrincipalTokenFromUsernamePassword(oauthConfig OAuthConfig, clientID string, username string, password string, ...) (*ServicePrincipalToken, error)

+ func NewServicePrincipalTokenWithSecret(oauthConfig OAuthConfig, id string, resource string, ...) (*ServicePrincipalToken, error)

+ func (spt *ServicePrincipalToken) EnsureFresh() error

+ func (spt *ServicePrincipalToken) EnsureFreshWithContext(ctx context.Context) error

+ func (spt *ServicePrincipalToken) InvokeRefreshCallbacks(token Token) error

+ func (spt *ServicePrincipalToken) OAuthToken() string

+ func (spt *ServicePrincipalToken) Refresh() error

+ func (spt *ServicePrincipalToken) RefreshExchange(resource string) error

+ func (spt *ServicePrincipalToken) RefreshExchangeWithContext(ctx context.Context, resource string) error

+ func (spt *ServicePrincipalToken) RefreshWithContext(ctx context.Context) error

+ func (spt *ServicePrincipalToken) SetAutoRefresh(autoRefresh bool)

+ func (spt *ServicePrincipalToken) SetRefreshCallbacks(callbacks []TokenRefreshCallback)

+ func (spt *ServicePrincipalToken) SetRefreshWithin(d time.Duration)

+ func (spt *ServicePrincipalToken) SetSender(s Sender)

+ func (spt *ServicePrincipalToken) Token() Token

+ func (spt *ServicePrincipalToken) UnmarshalJSON(data []byte) error

+ func (spt ServicePrincipalToken) MarshalJSON() ([]byte, error)

+ func (spt ServicePrincipalToken) MarshalTokenJSON() ([]byte, error)

+ type ServicePrincipalTokenSecret struct

+ ClientSecret string

+ func (tokenSecret *ServicePrincipalTokenSecret) SetAuthenticationValues(spt *ServicePrincipalToken, v *url.Values) error

+ func (tokenSecret ServicePrincipalTokenSecret) MarshalJSON() ([]byte, error)

+ type ServicePrincipalUsernamePasswordSecret struct

+ Password string

+ Username string

+ func (secret *ServicePrincipalUsernamePasswordSecret) SetAuthenticationValues(spt *ServicePrincipalToken, v *url.Values) error

+ func (secret ServicePrincipalUsernamePasswordSecret) MarshalJSON() ([]byte, error)

+ type Token struct

+ AccessToken string

+ ExpiresIn json.Number

+ ExpiresOn json.Number

+ NotBefore json.Number

+ RefreshToken string

+ Resource string

+ Type string

+ func CheckForUserCompletion(sender Sender, code *DeviceCode) (*Token, error)

+ func LoadToken(path string) (*Token, error)

+ func WaitForUserCompletion(sender Sender, code *DeviceCode) (*Token, error)

+ func (t *Token) OAuthToken() string

+ func (t Token) Expires() time.Time

+ func (t Token) IsExpired() bool

+ func (t Token) IsZero() bool

+ func (t Token) WillExpireIn(d time.Duration) bool

+ type TokenError struct

+ Error *string

+ ErrorCodes []int

+ ErrorDescription *string

+ Timestamp *string

+ TraceID *string

+ type TokenRefreshCallback func(Token) error

+ type TokenRefreshError interface

+ Response func() *http.Response