oidc

Documentation

Overview

oidc implements the authenticator.Token interface using the OpenID Connect protocol.

Index

• type OIDCAuthenticator
  • func New(issuerURL, clientID, caFile, usernameClaim string) (*OIDCAuthenticator, error)
  • func (a *OIDCAuthenticator) AuthenticateToken(value string) (user.Info, bool, error)
  • func (a *OIDCAuthenticator) Close()

Types

type OIDCAuthenticator

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

func New

func New(issuerURL, clientID, caFile, usernameClaim string) (*OIDCAuthenticator, error)

New creates a new OpenID Connect client with the given issuerURL and clientID. NOTE(yifan): For now we assume the server provides the "jwks_uri" so we don't need to manager the key sets by ourselves.

func (*OIDCAuthenticator) AuthenticateToken

func (a *OIDCAuthenticator) AuthenticateToken(value string) (user.Info, bool, error)

AuthenticateToken decodes and verifies a JWT using the OIDC client, if the verification succeeds, then it will extract the user info from the JWT claims.

func (*OIDCAuthenticator) Close

func (a *OIDCAuthenticator) Close()

Close closes the OIDC authenticator, this will close the provider sync goroutine.