oauth2

Documentation

Index

• type AccessToken
  • func (t AccessToken) String() string
• type Config
  • func (c *Config) Validate() error
• type PlgdProvider
  • func NewPlgdProvider(ctx context.Context, config Config, logger log.Logger) (*PlgdProvider, error)
  • func (p *PlgdProvider) Close()
  • func (p *PlgdProvider) Exchange(ctx context.Context, authorizationCode string) (*Token, error)
  • func (p *PlgdProvider) Refresh(ctx context.Context, refreshToken string) (*Token, error)
• type Token
  • func (o Token) IsValidAccessToken() bool
  • func (o Token) Refresh(ctx context.Context, cfg oauth2.Config) (Token, bool, error)

Types

type AccessToken

type AccessToken string

func (AccessToken) String

func (t AccessToken) String() string

type Config

type Config struct {
	Authority    string `yaml:"authority" json:"authority"`
	oauth.Config `yaml:",inline"`
	HTTP         client.Config `yaml:"http" json:"http"`
}

Config general configuration

func (*Config) Validate

func (c *Config) Validate() error

type PlgdProvider

type PlgdProvider struct {
	Config     Config
	OAuth2     *oauth2.Config
	HTTPClient *client.Client
	OpenID     openid.Config
}

PlgdProvider configuration with new http client

func NewPlgdProvider

func NewPlgdProvider(ctx context.Context, config Config, logger log.Logger) (*PlgdProvider, error)

NewPlgdProvider creates OAuth client

func (*PlgdProvider) Close

func (p *PlgdProvider) Close()

func (*PlgdProvider) Exchange

func (p *PlgdProvider) Exchange(ctx context.Context, authorizationCode string) (*Token, error)

Exchange Auth Code for Access Token via OAuth

func (*PlgdProvider) Refresh

func (p *PlgdProvider) Refresh(ctx context.Context, refreshToken string) (*Token, error)

Refresh gets new Access Token via OAuth.

type Token

type Token struct {
	AccessToken  AccessToken
	RefreshToken string
	Expiry       time.Time
}

Token provides access tokens and their attributes.

func (Token) IsValidAccessToken

func (o Token) IsValidAccessToken() bool

func (Token) Refresh

func (o Token) Refresh(ctx context.Context, cfg oauth2.Config) (Token, bool, error)