oidc

Documentation

Index

• type Client
  • func New(config *Config) (*Client, error)
  • func (c *Client) CheckRefresh(tok *oauth2.Token) (*oauth2.Token, error)
  • func (c *Client) CreateOIDCRequest(state, scopeString string) string
  • func (c *Client) GetIDTokenClaims(reqContext context.Context, code string) ([]byte, error)
  • func (c *Client) HandleOIDCCallback(reqContext context.Context, code string) (*oauth2.Token, *oidc.IDToken, error)
• type Config

Types

type Client

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

Client for oidc

func New

func New(config *Config) (*Client, error)

New returns client instance

func (*Client) CheckRefresh

func (c *Client) CheckRefresh(tok *oauth2.Token) (*oauth2.Token, error)

CheckRefresh refreshes the given token if necessary, returning the original token if not.

func (*Client) CreateOIDCRequest

func (c *Client) CreateOIDCRequest(state, scopeString string) string

CreateOIDCRequest create oidc request

func (*Client) GetIDTokenClaims

func (c *Client) GetIDTokenClaims(reqContext context.Context, code string) ([]byte, error)

GetIDTokenClaims handle oidc callback and get claims from ID token

func (*Client) HandleOIDCCallback

func (c *Client) HandleOIDCCallback(reqContext context.Context, code string) (*oauth2.Token, *oidc.IDToken, error)

HandleOIDCCallback handle oidc callback and returns access token and optional refresh and ID tokens

type Config

type Config struct {
	TLSConfig              *tls.Config
	OIDCProviderURL        string
	OIDCClientID           string
	OIDCClientSecret       string
	OIDCClientSecretExpiry int
	OIDCCallbackURL        string
	// Scopes scopes that oidc.Client is allowed to request.
	Scopes []string
}

Config defines configuration for oidc client