oauth

Documentation

Overview

Package oauth implements the oauth integration provider.

Index

• func Builder(provider types.ProviderType, opts ...ProviderOption) providers.Builder
• type Provider
  • func New(spec config.ProviderSpec, options ...ProviderOption) (*Provider, error)
  • func (p *Provider) BeginAuth(_ context.Context, input types.AuthContext) (types.AuthSession, error)
  • func (p *Provider) Mint(ctx context.Context, subject types.CredentialSubject) (types.CredentialPayload, error)
• type ProviderOption
  • func WithClientDescriptors(descriptors []types.ClientDescriptor) ProviderOption
  • func WithOperations(descriptors []types.OperationDescriptor) ProviderOption
• type Session
  • func (s *Session) AuthURL() string
  • func (s *Session) Finish(ctx context.Context, code string) (types.CredentialPayload, error)
  • func (s *Session) ProviderType() types.ProviderType
  • func (s *Session) State() string

Functions

func Builder

func Builder(provider types.ProviderType, opts ...ProviderOption) providers.Builder

Builder returns a providers.Builder that constructs OAuth providers for the given provider type

Types

type Provider

type Provider struct {
	// BaseProvider holds shared provider metadata
	providers.BaseProvider
	// contains filtered or unexported fields
}

Provider implements the types.Provider interface using Zitadel's relying party helpers

func New

func New(spec config.ProviderSpec, options ...ProviderOption) (*Provider, error)

New constructs a Provider from the supplied spec

func (*Provider) BeginAuth

func (p *Provider) BeginAuth(_ context.Context, input types.AuthContext) (types.AuthSession, error)

BeginAuth starts an OAuth authorization flow

func (*Provider) Mint

func (p *Provider) Mint(ctx context.Context, subject types.CredentialSubject) (types.CredentialPayload, error)

Mint refreshes an access token using the stored credential payload

type ProviderOption

type ProviderOption func(*Provider)

ProviderOption customizes OAuth provider construction.

func WithClientDescriptors

func WithClientDescriptors(descriptors []types.ClientDescriptor) ProviderOption

WithClientDescriptors registers client descriptors for pooling.

func WithOperations

func WithOperations(descriptors []types.OperationDescriptor) ProviderOption

WithOperations configures provider-managed operations.

type Session

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

Session implements types.AuthSession for OAuth flows

func (*Session) AuthURL

func (s *Session) AuthURL() string

AuthURL returns the URL the client should redirect to

func (*Session) Finish

func (s *Session) Finish(ctx context.Context, code string) (types.CredentialPayload, error)

Finish exchanges the authorization code for a credential payload

func (*Session) ProviderType

func (s *Session) ProviderType() types.ProviderType

ProviderType returns the provider identifier

func (*Session) State

func (s *Session) State() string

State returns the authorization state value