msentraid

Documentation

Overview

Package msentraid is the Microsoft Entra ID specific extension.

Index

• type Provider
  • func New() Provider
  • func (p Provider) AdditionalScopes() []string
  • func (p Provider) AuthOptions() []oauth2.AuthCodeOption
  • func (p Provider) CheckTokenScopes(token *oauth2.Token) error
  • func (p Provider) CurrentAuthenticationModesOffered(sessionMode string, supportedAuthModes map[string]string, tokenExists bool, ...) ([]string, error)
  • func (p Provider) GetExtraFields(token *oauth2.Token) map[string]interface{}
  • func (p Provider) GetUserInfo(ctx context.Context, accessToken *oauth2.Token, idToken *oidc.IDToken) (info.User, error)
  • func (p Provider) VerifyUsername(requestedUsername, authenticatedUsername string) error

Types

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider is the Microsoft Entra ID provider implementation.

func New

func New() Provider

New returns a new MSEntraID provider.

func (Provider) AdditionalScopes

func (p Provider) AdditionalScopes() []string

AdditionalScopes returns the generic scopes required by the EntraID provider.

func (Provider) AuthOptions

func (p Provider) AuthOptions() []oauth2.AuthCodeOption

AuthOptions returns the generic auth options required by the EntraID provider.

func (Provider) CheckTokenScopes

func (p Provider) CheckTokenScopes(token *oauth2.Token) error

CheckTokenScopes checks if the token has the required scopes.

func (Provider) CurrentAuthenticationModesOffered

func (p Provider) CurrentAuthenticationModesOffered(
	sessionMode string,
	supportedAuthModes map[string]string,
	tokenExists bool,
	providerReachable bool,
	endpoints map[string]struct{},
	currentAuthStep int,
) ([]string, error)

CurrentAuthenticationModesOffered returns the generic authentication modes supported by the provider.

Token validity is not considered, only the presence of a token.

func (Provider) GetExtraFields

func (p Provider) GetExtraFields(token *oauth2.Token) map[string]interface{}

GetExtraFields returns the extra fields of the token which should be stored persistently.

func (Provider) GetUserInfo

func (p Provider) GetUserInfo(ctx context.Context, accessToken *oauth2.Token, idToken *oidc.IDToken) (info.User, error)

GetUserInfo is a no-op when no specific provider is in use.

func (Provider) VerifyUsername

func (p Provider) VerifyUsername(requestedUsername, authenticatedUsername string) error

VerifyUsername checks if the authenticated username matches the requested username and that both are valid.