shared

Documentation

Index

• Constants
• Variables
• type AccessTokenIDPResponse
• type AuthResultIDPResponse
• type IdentityProvider
• type IdentityProviderResponse
  • func NewIDPResponse(responseType string, result interface{}) (IdentityProviderResponse, error)
• type IdentityProviderResponseParser
• type RawTokenIDPResponse

Constants

const (
	// ResponseTypeAuthResult is the type of the auth result.
	ResponseTypeAuthResult = "AuthResult"
	// ResponseTypeAccessToken is the type of the access token.
	ResponseTypeAccessToken = "AccessToken"
	// ResponseTypeRawToken is the type of the response when you have a raw string.
	ResponseTypeRawToken = "RawToken"
)

Variables

var ErrAccessTokenNotFound = internal.ErrAccessTokenNotFound

var ErrAuthResultNotFound = internal.ErrAuthResultNotFound

var ErrInvalidIDPResponse = internal.ErrInvalidIDPResponse

var ErrRawTokenNotFound = internal.ErrRawTokenNotFound

Types

type AccessTokenIDPResponse

type AccessTokenIDPResponse interface {
	IdentityProviderResponse
	// AccessToken returns the Azure SDK AccessToken.
	// Returns ErrAccessTokenNotFound if the access token is not set.
	AccessToken() (azcore.AccessToken, error)
}

AccessTokenIDPResponse is an interface that defines the method for getting the access token. Returns ErrAccessTokenNotFound if the access token is not set.

type AuthResultIDPResponse

type AuthResultIDPResponse interface {
	IdentityProviderResponse
	// AuthResult returns the Microsoft Authentication Library AuthResult.
	// Returns ErrAuthResultNotFound if the auth result is not set.
	AuthResult() (public.AuthResult, error)
}

AuthResultIDPResponse is an interface that defines the method for getting the auth result. Returns ErrAuthResultNotFound if the auth result is not set.

type IdentityProvider

type IdentityProvider interface {
	// RequestToken requests a token from the identity provider.
	// The context is passed to the request to allow for cancellation and timeouts.
	// It returns the token, the expiration time, and an error if any.
	RequestToken(ctx context.Context) (IdentityProviderResponse, error)
}

IdentityProvider is an interface that defines the methods for an identity provider. It is used to request a token for authentication. The identity provider is responsible for providing the raw authentication token.

type IdentityProviderResponse

type IdentityProviderResponse interface {
	// Type returns the type of identity provider response
	Type() string
	// RawToken returns the raw token string.
	// Returns ErrRawTokenNotFound if the raw token is not set.
	RawToken() (string, error)
}

IdentityProviderResponse is an interface that defines the type method for the identity provider response. It is used to identify the type of response returned by the identity provider. The type can be either AuthResult, AccessToken, or RawToken. You can use this interface to check the type of the response and handle it accordingly. Available response types are: - ResponseTypeAuthResult: For Microsoft Authentication Library AuthResult - ResponseTypeAccessToken: For Azure SDK AccessToken - ResponseTypeRawToken: For raw token strings

func NewIDPResponse

func NewIDPResponse(responseType string, result interface{}) (IdentityProviderResponse, error)

NewIDPResponse creates a new auth result based on the type provided. It returns an IdentityProviderResponse interface. Type can be either AuthResult, AccessToken, or RawToken. Second argument is the result of the type provided in the first argument.

type IdentityProviderResponseParser

type IdentityProviderResponseParser interface {
	ParseResponse(response IdentityProviderResponse) (*token.Token, error)
}

IdentityProviderResponseParser is an interface that defines the methods for parsing the identity provider response. It is used to parse the response from the identity provider and extract the token. If not provided, the default implementation will be used.

type RawTokenIDPResponse

type RawTokenIDPResponse interface {
	IdentityProviderResponse
}