authn

Documentation

Index

• Variables
• func ContextWithAuthClaims(parent context.Context, claims *AuthClaims) context.Context
• type AuthClaims
  • func AuthClaimsFromContext(ctx context.Context) (*AuthClaims, bool)
• type Authenticator
• type NoopAuthenticator
  • func (n NoopAuthenticator) Authenticate(requestContext context.Context) (*AuthClaims, error)
  • func (n NoopAuthenticator) Close()
• type OIDCAuthenticator
• type OidcConfig

Variables

var (
	ErrUnauthenticated    = status.Error(codes.Code(openfgav1.AuthErrorCode_unauthenticated), "unauthenticated")
	ErrMissingBearerToken = status.Error(codes.Code(openfgav1.AuthErrorCode_bearer_token_missing), "missing bearer token")
)

Functions

func ContextWithAuthClaims

func ContextWithAuthClaims(parent context.Context, claims *AuthClaims) context.Context

ContextWithAuthClaims injects the provided AuthClaims into the parent context.

Types

type AuthClaims

type AuthClaims struct {
	Subject string
	Scopes  map[string]bool
}

AuthClaims contains claims that are included in OIDC standard claims. https://openid.net/specs/openid-connect-core-1_0.html#IDToken

func AuthClaimsFromContext

func AuthClaimsFromContext(ctx context.Context) (*AuthClaims, bool)

AuthClaimsFromContext extracts the AuthClaims from the provided ctx (if any).

type Authenticator

type Authenticator interface {
	// Authenticate returns a nil error and the AuthClaims info (if available) if the subject is authenticated or a
	// non-nil error with an appropriate error cause otherwise.
	Authenticate(requestContext context.Context) (*AuthClaims, error)

	// Close Cleans up the authenticator.
	Close()
}

type NoopAuthenticator

type NoopAuthenticator struct{}

func (NoopAuthenticator) Authenticate

func (n NoopAuthenticator) Authenticate(requestContext context.Context) (*AuthClaims, error)

func (NoopAuthenticator) Close

func (n NoopAuthenticator) Close()

type OIDCAuthenticator

type OIDCAuthenticator interface {
	GetConfiguration() (*OidcConfig, error)
	GetKeys() (*keyfunc.JWKS, error)
}

type OidcConfig

type OidcConfig struct {
	Issuer  string `json:"issuer"`
	JWKsURI string `json:"jwks_uri"`
}

OidcConfig contains authorization server metadata. See https://datatracker.ietf.org/doc/html/rfc8414#section-2