oidcclient

Documentation

Overview

Package oidcclient provides a client of OpenID Connect.

Index

• Variables
• type AuthCodeURLInput
• type Config
• type ExchangeAuthCodeInput
• type Factory
  • func (f *Factory) New(ctx context.Context, config Config) (Interface, error)
• type FactoryInterface
• type GetTokenByAuthCodeInput
• type Interface
• type TokenSet

Variables

var Set = wire.NewSet(
	wire.Struct(new(Factory), "*"),
	wire.Bind(new(FactoryInterface), new(*Factory)),
)

Set provides an implementation and interface for OIDC.

Types

type AuthCodeURLInput

type AuthCodeURLInput struct {
	State               string
	Nonce               string
	CodeChallenge       string
	CodeChallengeMethod string
	RedirectURI         string
}

type Config

type Config struct {
	IssuerURL     string
	ClientID      string
	ClientSecret  string
	ExtraScopes   []string // optional
	CertPool      certpool.Interface
	SkipTLSVerify bool
}

Config represents a configuration of OpenID Connect client.

type ExchangeAuthCodeInput

type ExchangeAuthCodeInput struct {
	Code         string
	CodeVerifier string
	Nonce        string
	RedirectURI  string
}

type Factory

type Factory struct {
	Logger logger.Interface
}

func (*Factory) New

func (f *Factory) New(ctx context.Context, config Config) (Interface, error)

New returns an instance of adaptors.Interface with the given configuration.

type FactoryInterface

type FactoryInterface interface {
	New(ctx context.Context, config Config) (Interface, error)
}

type GetTokenByAuthCodeInput

type GetTokenByAuthCodeInput struct {
	BindAddress         []string
	Nonce               string
	CodeChallenge       string
	CodeChallengeMethod string
	CodeVerifier        string
}

type Interface

type Interface interface {
	GetAuthCodeURL(in AuthCodeURLInput) string
	ExchangeAuthCode(ctx context.Context, in ExchangeAuthCodeInput) (*TokenSet, error)
	GetTokenByAuthCode(ctx context.Context, in GetTokenByAuthCodeInput, localServerReadyChan chan<- string) (*TokenSet, error)
	GetTokenByROPC(ctx context.Context, username, password string) (*TokenSet, error)
	Refresh(ctx context.Context, refreshToken string) (*TokenSet, error)
}

type TokenSet

type TokenSet struct {
	IDToken        string
	RefreshToken   string
	IDTokenSubject string
	IDTokenExpiry  time.Time
	IDTokenClaims  map[string]string // string representation of claims for logging
}

TokenSet represents an output DTO of Interface.GetTokenByAuthCode, Interface.GetTokenByROPC and Interface.Refresh.