oauth2

Documentation

Index

• type AccessToken
  • func (t AccessToken) String() string
• type AuthCodePlgdProvider
  • func NewAuthCodePlgdProvider(config Config, httpClient *client.Client) *AuthCodePlgdProvider
  • func (p *AuthCodePlgdProvider) Close()
  • func (p *AuthCodePlgdProvider) Exchange(ctx context.Context, authorizationCode string) (*Token, error)
  • func (p *AuthCodePlgdProvider) HTTP() *http.Client
  • func (p *AuthCodePlgdProvider) Refresh(ctx context.Context, refreshToken string) (*Token, error)
• type ClientCredentialsPlgdProvider
  • func NewClientCredentialsPlgdProvider(config Config, httpClient *client.Client, jwksURL string, ...) *ClientCredentialsPlgdProvider
  • func (p *ClientCredentialsPlgdProvider) Close()
  • func (p *ClientCredentialsPlgdProvider) Exchange(ctx context.Context, authorizationCode string) (*Token, error)
  • func (p *ClientCredentialsPlgdProvider) HTTP() *http.Client
  • func (p *ClientCredentialsPlgdProvider) Refresh(ctx context.Context, refreshToken string) (*Token, error)
• type Config
  • func (c *Config) Validate() error
• type PlgdProvider
  • func NewPlgdProvider(ctx context.Context, config Config, fileWatcher *fsnotify.Watcher, ...) (*PlgdProvider, 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 AuthCodePlgdProvider

type AuthCodePlgdProvider struct {
	Config     Config
	HTTPClient *client.Client
}

PlgdProvider configuration with new http client

func NewAuthCodePlgdProvider

func NewAuthCodePlgdProvider(config Config, httpClient *client.Client) *AuthCodePlgdProvider

NewPlgdProvider creates OAuth client

func (*AuthCodePlgdProvider) Close

func (p *AuthCodePlgdProvider) Close()

func (*AuthCodePlgdProvider) Exchange

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

Exchange Auth Code for Access Token via OAuth

func (*AuthCodePlgdProvider) HTTP

func (p *AuthCodePlgdProvider) HTTP() *http.Client

func (*AuthCodePlgdProvider) Refresh

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

Refresh gets new Access Token via OAuth.

type ClientCredentialsPlgdProvider

type ClientCredentialsPlgdProvider struct {
	Config     Config
	HTTPClient *client.Client
	// contains filtered or unexported fields
}

PlgdProvider configuration with new http client

func NewClientCredentialsPlgdProvider

func NewClientCredentialsPlgdProvider(config Config, httpClient *client.Client, jwksURL string, ownerClaim, deviceIDClaim string) *ClientCredentialsPlgdProvider

NewPlgdProvider creates OAuth client

func (*ClientCredentialsPlgdProvider) Close

func (p *ClientCredentialsPlgdProvider) Close()

func (*ClientCredentialsPlgdProvider) Exchange

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

Exchange Auth Code for Access Token via OAuth

func (*ClientCredentialsPlgdProvider) HTTP

func (p *ClientCredentialsPlgdProvider) HTTP() *http.Client

func (*ClientCredentialsPlgdProvider) Refresh

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

Refresh gets new Access Token via OAuth.

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

	OpenID openid.Config
	// contains filtered or unexported fields
}

PlgdProvider configuration with new http client

func NewPlgdProvider

func NewPlgdProvider(ctx context.Context, config Config, fileWatcher *fsnotify.Watcher, logger log.Logger, tracerProvider trace.TracerProvider, ownerClaim, deviceIDClaim string) (*PlgdProvider, error)

NewPlgdProvider creates OAuth client

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)