authn

Documentation

Overview

Package authn is used to identify requesters

Index

• type Client
  • func (c *Client) Authenticate(tokens *Tokens, now time.Time) (bool, error)
  • func (c *Client) AuthorizeURL(state string) string
  • func (c *Client) ExchangeCode(code string) (*Tokens, error)
  • func (c *Client) Refresh(tokens *Tokens) error
  • func (c *Client) SyncPublicKeys(now time.Time)
  • func (c *Client) ValidateToken(token string, now time.Time) error
• type Tokens

Types

type Client

type Client struct {
	AuthURL     string
	TokenURL    string
	JWKSURL     string
	ID          string
	Secret      string
	CallbackURL string

	// Set to true if you store the tokens in your database for connections to OTHER services.
	// This will skip fetching the public keys from the JWKSURL, speeding up the authentication process.
	// Do NOT set to true if the tokens are provided by the client in order to access YOUR service.
	SkipSignatureValidation bool
	// contains filtered or unexported fields
}

func (*Client) Authenticate

func (c *Client) Authenticate(tokens *Tokens, now time.Time) (bool, error)

Authenticate refreshes the user's access token if its invalid/expired and returns true if it was refreshed.

func (*Client) AuthorizeURL

func (c *Client) AuthorizeURL(state string) string

func (*Client) ExchangeCode

func (c *Client) ExchangeCode(code string) (*Tokens, error)

ExchangeCode exchanges an authorization code for access and refresh tokens

func (*Client) Refresh

func (c *Client) Refresh(tokens *Tokens) error

func (*Client) SyncPublicKeys

func (c *Client) SyncPublicKeys(now time.Time)

SyncPublicKeys syncs the keys if one/more is missing.

func (*Client) ValidateToken

func (c *Client) ValidateToken(token string, now time.Time) error

ValidateToken validates the token and returns an error if it is invalid.

type Tokens

type Tokens struct {
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token"`
}