client

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(cfg openidconfig.Config, jwksProvider JwksProvider) *Client
  • func (c *Client) AuthCodeGrant(ctx context.Context, code string, opts []oauth2.AuthCodeOption) (*oauth2.Token, error)
  • func (c *Client) Login(r *http.Request) (*Login, error)
  • func (c *Client) LoginCallback(r *http.Request, cookie *openid.LoginCookie) (*LoginCallback, error)
  • func (c *Client) Logout(r *http.Request) (*Logout, error)
  • func (c *Client) LogoutCallback(r *http.Request, cookie *openid.LogoutCookie, validator urlpkg.Validator) *LogoutCallback
  • func (c *Client) LogoutFrontchannel(r *http.Request) *LogoutFrontchannel
  • func (c *Client) MakeAssertion(expiration time.Duration) (string, error)
  • func (c *Client) RefreshGrant(ctx context.Context, refreshToken string) (*openid.TokenResponse, error)
• type JwksProvider
• type Login
  • func NewLogin(c *Client, r *http.Request) (*Login, error)
  • func (l *Login) SetCookie(w http.ResponseWriter, opts cookie.Options, crypter crypto.Crypter, ...) error
• type LoginCallback
  • func NewLoginCallback(c *Client, r *http.Request, cookie *openid.LoginCookie) (*LoginCallback, error)
  • func (in *LoginCallback) IdentityProviderError() error
  • func (in *LoginCallback) RedeemTokens(ctx context.Context) (*openid.Tokens, error)
  • func (in *LoginCallback) StateMismatchError() error
• type Logout
  • func NewLogout(c *Client, r *http.Request) (*Logout, error)
  • func (in *Logout) SetCookie(w http.ResponseWriter, opts cookie.Options, crypter crypto.Crypter, ...) error
  • func (in *Logout) SingleLogoutURL(idToken string) string
• type LogoutCallback
  • func NewLogoutCallback(c *Client, r *http.Request, cookie *openid.LogoutCookie, ...) *LogoutCallback
  • func (in *LogoutCallback) PostLogoutRedirectURI() string
• type LogoutFrontchannel
  • func NewLogoutFrontchannel(r *http.Request) *LogoutFrontchannel
  • func (l *LogoutFrontchannel) MissingSidParameter() bool
  • func (l *LogoutFrontchannel) Sid() string

Constants

const (
	LocaleURLParameter        = "locale"
	SecurityLevelURLParameter = "level"
	PromptURLParameter        = "prompt"
	MaxAgeURLParameter        = "max_age"
)

const (
	DefaultClientAssertionLifetime = 30 * time.Second
)

Variables

var (
	ErrOpenIDClient = errors.New("client error")
	ErrOpenIDServer = errors.New("server error")
)

var (
	ErrInvalidSecurityLevel  = errors.New("InvalidSecurityLevel")
	ErrInvalidLocale         = errors.New("InvalidLocale")
	ErrInvalidPrompt         = errors.New("InvalidPrompt")
	ErrInvalidLoginParameter = errors.New("InvalidLoginParameter")

	// LoginParameterMapping maps incoming login parameters to OpenID Connect parameters
	LoginParameterMapping = map[string]string{
		LocaleURLParameter:        "ui_locales",
		SecurityLevelURLParameter: "acr_values",
	}

	PromptAllowedValues = []string{"login", "select_account"}
)

Types

type Client

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

func NewClient

func NewClient(cfg openidconfig.Config, jwksProvider JwksProvider) *Client

func (*Client) AuthCodeGrant

func (c *Client) AuthCodeGrant(ctx context.Context, code string, opts []oauth2.AuthCodeOption) (*oauth2.Token, error)

func (*Client) Login

func (c *Client) Login(r *http.Request) (*Login, error)

func (*Client) LoginCallback

func (c *Client) LoginCallback(r *http.Request, cookie *openid.LoginCookie) (*LoginCallback, error)

func (*Client) Logout

func (c *Client) Logout(r *http.Request) (*Logout, error)

func (*Client) LogoutCallback

func (c *Client) LogoutCallback(r *http.Request, cookie *openid.LogoutCookie, validator urlpkg.Validator) *LogoutCallback

func (*Client) LogoutFrontchannel

func (c *Client) LogoutFrontchannel(r *http.Request) *LogoutFrontchannel

func (*Client) MakeAssertion

func (c *Client) MakeAssertion(expiration time.Duration) (string, error)

func (*Client) RefreshGrant

func (c *Client) RefreshGrant(ctx context.Context, refreshToken string) (*openid.TokenResponse, error)

type JwksProvider

type JwksProvider interface {
	GetPublicJwkSet(ctx context.Context) (*jwk.Set, error)
	RefreshPublicJwkSet(ctx context.Context) (*jwk.Set, error)
}

type Login

type Login struct {
	AuthCodeURL string
	Acr         string
	Locale      string
	Prompt      string
	*openid.LoginCookie
}

func NewLogin

func NewLogin(c *Client, r *http.Request) (*Login, error)

func (*Login) SetCookie

func (l *Login) SetCookie(w http.ResponseWriter, opts cookie.Options, crypter crypto.Crypter, canonicalRedirect string) error

type LoginCallback

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

func NewLoginCallback

func NewLoginCallback(c *Client, r *http.Request, cookie *openid.LoginCookie) (*LoginCallback, error)

func (*LoginCallback) IdentityProviderError

func (in *LoginCallback) IdentityProviderError() error

func (*LoginCallback) RedeemTokens

func (in *LoginCallback) RedeemTokens(ctx context.Context) (*openid.Tokens, error)

func (*LoginCallback) StateMismatchError

func (in *LoginCallback) StateMismatchError() error

type Logout

type Logout struct {
	*Client
	Cookie *openid.LogoutCookie
	// contains filtered or unexported fields
}

func NewLogout

func NewLogout(c *Client, r *http.Request) (*Logout, error)

func (*Logout) SetCookie

func (in *Logout) SetCookie(w http.ResponseWriter, opts cookie.Options, crypter crypto.Crypter, canonicalRedirect string) error

func (*Logout) SingleLogoutURL

func (in *Logout) SingleLogoutURL(idToken string) string

type LogoutCallback

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

func NewLogoutCallback

func NewLogoutCallback(c *Client, r *http.Request, cookie *openid.LogoutCookie, validator urlpkg.Validator) *LogoutCallback

func (*LogoutCallback) PostLogoutRedirectURI

func (in *LogoutCallback) PostLogoutRedirectURI() string

type LogoutFrontchannel

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

func NewLogoutFrontchannel

func NewLogoutFrontchannel(r *http.Request) *LogoutFrontchannel

func (*LogoutFrontchannel) MissingSidParameter

func (l *LogoutFrontchannel) MissingSidParameter() bool

func (*LogoutFrontchannel) Sid

func (l *LogoutFrontchannel) Sid() string

Sid is the session identifier which SHOULD be included as a parameter in the front-channel logout request.