identity

Documentation

Overview

Package identity provides support for making OpenID Connect (OIDC) and OAuth2 authenticated HTTP requests with third party identity providers.

Index

• type AtomicAuthenticator
  • func NewAtomicAuthenticator() *AtomicAuthenticator
  • func (a *AtomicAuthenticator) Load() Authenticator
  • func (a *AtomicAuthenticator) Store(value Authenticator)
• type Authenticator
  • func NewAuthenticator(o oauth.Options) (a Authenticator, err error)
• type Claims
  • func NewClaimsFromRaw(raw map[string]json.RawMessage) Claims
  • func (claims Claims) Claims(v interface{}) error
  • func (claims Claims) Flatten() FlattenedClaims
  • func (claims Claims) ToAnyMap() map[string]*anypb.Any
  • func (claims *Claims) UnmarshalJSON(data []byte) error
• type FlattenedClaims
  • func NewFlattenedClaimsFromPB(m map[string]*structpb.ListValue) FlattenedClaims
  • func (claims FlattenedClaims) ToPB() map[string]*structpb.ListValue
  • func (claims *FlattenedClaims) UnmarshalJSON(data []byte) error
• type MockProvider
  • func (mp MockProvider) Authenticate(context.Context, string, identity.State) (*oauth2.Token, error)
  • func (mp MockProvider) GetSignInURL(s string) (string, error)
  • func (mp MockProvider) LogOut() (*url.URL, error)
  • func (mp MockProvider) Name() string
  • func (mp MockProvider) Refresh(context.Context, *oauth2.Token, identity.State) (*oauth2.Token, error)
  • func (mp MockProvider) Revoke(ctx context.Context, s *oauth2.Token) error
  • func (mp MockProvider) UpdateUserInfo(ctx context.Context, t *oauth2.Token, v interface{}) error
• type SessionClaims
  • func (claims *SessionClaims) SetRawIDToken(rawIDToken string)

Types

type AtomicAuthenticator

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

An AtomicAuthenticator is a strongly-typed atomic.Value for storing an authenticator.

func NewAtomicAuthenticator

func NewAtomicAuthenticator() *AtomicAuthenticator

NewAtomicAuthenticator creates a new AtomicAuthenticator.

func (*AtomicAuthenticator) Load

func (a *AtomicAuthenticator) Load() Authenticator

Load loads the current authenticator.

func (*AtomicAuthenticator) Store

func (a *AtomicAuthenticator) Store(value Authenticator)

Store stores the authenticator.

type Authenticator

type Authenticator interface {
	Authenticate(context.Context, string, identity.State) (*oauth2.Token, error)
	Refresh(context.Context, *oauth2.Token, identity.State) (*oauth2.Token, error)
	Revoke(context.Context, *oauth2.Token) error
	GetSignInURL(state string) (string, error)
	Name() string
	LogOut() (*url.URL, error)
	UpdateUserInfo(ctx context.Context, t *oauth2.Token, v interface{}) error
}

Authenticator is an interface representing the ability to authenticate with an identity provider.

func NewAuthenticator

func NewAuthenticator(o oauth.Options) (a Authenticator, err error)

NewAuthenticator returns a new identity provider based on its name.

type Claims

type Claims map[string]interface{}

Claims are JWT claims.

func NewClaimsFromRaw

func NewClaimsFromRaw(raw map[string]json.RawMessage) Claims

NewClaimsFromRaw creates a new Claims map from a map of raw messages.

func (Claims) Claims

func (claims Claims) Claims(v interface{}) error

Claims takes the claims data and fills v.

func (Claims) Flatten

func (claims Claims) Flatten() FlattenedClaims

Flatten flattens the claims to a FlattenedClaims map. For example:

{ "a": { "b": { "c": 12345 } } } => { "a.b.c": [12345] }

func (Claims) ToAnyMap

func (claims Claims) ToAnyMap() map[string]*anypb.Any

ToAnyMap converts the claims into a map of string => any.

func (*Claims) UnmarshalJSON

func (claims *Claims) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals the raw json data into the claims object.

type FlattenedClaims

type FlattenedClaims map[string][]interface{}

FlattenedClaims are a set claims flattened into a single-level map.

func NewFlattenedClaimsFromPB

func NewFlattenedClaimsFromPB(m map[string]*structpb.ListValue) FlattenedClaims

NewFlattenedClaimsFromPB creates a new FlattenedClaims from the protobuf struct type.

func (FlattenedClaims) ToPB

func (claims FlattenedClaims) ToPB() map[string]*structpb.ListValue

ToPB converts the flattened claims into a protobuf type.

func (*FlattenedClaims) UnmarshalJSON

func (claims *FlattenedClaims) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals JSON into the flattened claims.

type MockProvider

type MockProvider struct {
	AuthenticateResponse oauth2.Token
	AuthenticateError    error
	RefreshResponse      oauth2.Token
	RefreshError         error
	RevokeError          error
	GetSignInURLResponse string
	LogOutResponse       url.URL
	LogOutError          error
	UpdateUserInfoError  error
}

MockProvider provides a mocked implementation of the providers interface.

func (MockProvider) Authenticate

func (mp MockProvider) Authenticate(context.Context, string, identity.State) (*oauth2.Token, error)

Authenticate is a mocked providers function.

func (MockProvider) GetSignInURL

func (mp MockProvider) GetSignInURL(s string) (string, error)

GetSignInURL is a mocked providers function.

func (MockProvider) LogOut

func (mp MockProvider) LogOut() (*url.URL, error)

LogOut is a mocked providers function.

func (MockProvider) Name

func (mp MockProvider) Name() string

Name returns the provider name.

func (MockProvider) Refresh

func (mp MockProvider) Refresh(context.Context, *oauth2.Token, identity.State) (*oauth2.Token, error)

Refresh is a mocked providers function.

func (MockProvider) Revoke

func (mp MockProvider) Revoke(ctx context.Context, s *oauth2.Token) error

Revoke is a mocked providers function.

func (MockProvider) UpdateUserInfo

func (mp MockProvider) UpdateUserInfo(ctx context.Context, t *oauth2.Token, v interface{}) error

UpdateUserInfo is a mocked providers function.

type SessionClaims

type SessionClaims struct {
	Claims
	RawIDToken string
}

SessionClaims are claims that are attached to a session so we can store the raw id token.

func (*SessionClaims) SetRawIDToken

func (claims *SessionClaims) SetRawIDToken(rawIDToken string)

SetRawIDToken sets the raw id token.