auth

Documentation

Index

• Constants
• Variables
• type AuthenticationProvider
  • func NewAuthenticationProvider(ctx context.Context, options Options) (AuthenticationProvider, error)
  • func NewOIDCProvider(ctx context.Context, jsonParam string) (AuthenticationProvider, error)
• type GrpcAuthenticationDelegator
  • func NewGrpcAuthenticationDelegator(provider AuthenticationProvider) (*GrpcAuthenticationDelegator, error)
  • func (delegator *GrpcAuthenticationDelegator) GetStreamInterceptor() grpc.StreamServerInterceptor
  • func (delegator *GrpcAuthenticationDelegator) GetUnaryInterceptor() grpc.UnaryServerInterceptor
• type OIDCOptions
  • func (op *OIDCOptions) Validate() error
• type OIDCProvider
  • func (*OIDCProvider) AcceptParamType() string
  • func (p *OIDCProvider) Authenticate(ctx context.Context, param any) (string, error)
• type Options
  • func (op *Options) IsEnabled() bool
• type ProviderWithVerifier

Constants

const (
	ProviderOIDC = "oidc"

	ProviderParamTypeToken = "token"
)

const (
	MetadataAuthorizationKey = "authorization"
	TokenPrefix              = "Bearer "
)

const (
	DefaultUserNameCalm         = "sub"
	AllowedAudienceDefaultValue = ""
)

Variables

var (
	ErrUnsupportedProvider              = errors.New("unsupported authentication provider")
	ErrUnMatchedAuthenticationParamType = errors.New("unmatched authentication parameter type")
	ErrEmptyToken                       = errors.New("empty token")
	ErrMalformedToken                   = errors.New("malformed token")
)

var (
	ErrEmptyIssueURL         = errors.New("empty issue URL")
	ErrEmptyAllowedAudiences = errors.New("empty allowed audiences")
	ErrUnknownIssuer         = errors.New("unknown issuer")
	ErrUserNameNotFound      = errors.New("username not found")
	ErrForbiddenAudience     = errors.New("forbidden audience")
)

var Disabled = Options{}

var (
	ErrMetadataFetchFailed = errors.New("metadata fetch failed")
)

Types

type AuthenticationProvider

type AuthenticationProvider interface {
	AcceptParamType() string
	Authenticate(ctx context.Context, param any) (string, error)
}

todo: add metrics

func NewAuthenticationProvider

func NewAuthenticationProvider(ctx context.Context, options Options) (AuthenticationProvider, error)

func NewOIDCProvider

func NewOIDCProvider(ctx context.Context, jsonParam string) (AuthenticationProvider, error)

type GrpcAuthenticationDelegator

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

func NewGrpcAuthenticationDelegator

func NewGrpcAuthenticationDelegator(provider AuthenticationProvider) (*GrpcAuthenticationDelegator, error)

func (*GrpcAuthenticationDelegator) GetStreamInterceptor

func (delegator *GrpcAuthenticationDelegator) GetStreamInterceptor() grpc.StreamServerInterceptor

func (*GrpcAuthenticationDelegator) GetUnaryInterceptor

func (delegator *GrpcAuthenticationDelegator) GetUnaryInterceptor() grpc.UnaryServerInterceptor

type OIDCOptions

type OIDCOptions struct {
	AllowedIssueURLs string `json:"allowedIssueURLs,omitempty"`
	AllowedAudiences string `json:"allowedAudiences,omitempty"`
	UserNameClaim    string `json:"userNameClaim,omitempty"`
}

func (*OIDCOptions) Validate

func (op *OIDCOptions) Validate() error

type OIDCProvider

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

func (*OIDCProvider) AcceptParamType

func (*OIDCProvider) AcceptParamType() string

func (*OIDCProvider) Authenticate

func (p *OIDCProvider) Authenticate(ctx context.Context, param any) (string, error)

type Options

type Options struct {
	ProviderName   string
	ProviderParams string
}

func (*Options) IsEnabled

func (op *Options) IsEnabled() bool

type ProviderWithVerifier

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