oidc

Documentation

Index

• func StreamServerInterceptor(t Authenticator) grpc.StreamServerInterceptor
• func UnaryServerInterceptor(t Authenticator) grpc.UnaryServerInterceptor
• type Authenticator
• type Authn
  • func NewOidcAuthn(ctx context.Context, conf config.Oidc) (*Authn, error)
  • func (oidc *Authn) Authenticate(requestContext context.Context) error
• type Config
• type SlogAdapter
  • func (a SlogAdapter) Debug(msg string, keysAndValues ...interface{})
  • func (a SlogAdapter) Error(msg string, keysAndValues ...interface{})
  • func (a SlogAdapter) Info(msg string, keysAndValues ...interface{})
  • func (a SlogAdapter) Warn(msg string, keysAndValues ...interface{})

Functions

func StreamServerInterceptor

func StreamServerInterceptor(t Authenticator) grpc.StreamServerInterceptor

StreamServerInterceptor returns a gRPC stream server interceptor that wraps the incoming stream with an authenticator.

func UnaryServerInterceptor

func UnaryServerInterceptor(t Authenticator) grpc.UnaryServerInterceptor

UnaryServerInterceptor returns a gRPC unary server interceptor that performs authentication using the provided Authenticator.

Types

type Authenticator

type Authenticator interface {
	Authenticate(ctx context.Context) error
}

Authenticator - Interface for oidc authenticator

type Authn

type Authn struct {
	// URL of the issuer. This is typically the base URL of the identity provider.
	IssuerURL string
	// Audience for which the token is intended. It must match the audience in the JWT.
	Audience string
	// URL of the JSON Web Key Set (JWKS). This URL hosts public keys used to verify JWT signatures.
	JwksURI string
	// contains filtered or unexported fields
}

func NewOidcAuthn

func NewOidcAuthn(ctx context.Context, conf config.Oidc) (*Authn, error)

NewOidcAuthn initializes a new instance of the Authn struct with OpenID Connect (OIDC) configuration. It takes in a context for managing cancellation and a configuration object. It returns a pointer to an Authn instance or an error.

func (*Authn) Authenticate

func (oidc *Authn) Authenticate(requestContext context.Context) error

Authenticate validates the JWT token found in the authorization header of the incoming request. It uses the OIDC configuration to validate the token against the issuer's public keys.

type Config

type Config struct {
	// Issuer is the OIDC provider's unique identifier URL.
	Issuer string `json:"issuer"`
	// JWKsURI is the URL to the JSON Web Key Set (JWKS) provided by the OIDC issuer.
	JWKsURI string `json:"jwks_uri"`
}

Config holds OpenID Connect (OIDC) configuration details.

type SlogAdapter

type SlogAdapter struct {
	Logger *slog.Logger
}

SlogAdapter adapts the slog.Logger to be compatible with retryablehttp.LeveledLogger.

func (SlogAdapter) Debug

func (a SlogAdapter) Debug(msg string, keysAndValues ...interface{})

Debug logs messages at debug level.

func (SlogAdapter) Error

func (a SlogAdapter) Error(msg string, keysAndValues ...interface{})

Error logs messages at error level.

func (SlogAdapter) Info

func (a SlogAdapter) Info(msg string, keysAndValues ...interface{})

Info logs messages at info level.

func (SlogAdapter) Warn

func (a SlogAdapter) Warn(msg string, keysAndValues ...interface{})

Warn logs messages at warn level.