Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

provider

package

Go to main page

Versions in this module

v2

v2.2.0

Jul 13, 2021

Changes in this version

+ type ConstantTimeoutAlgorithm struct

+ func NewConstantTimeoutAlgorithm(timeout time.Duration) *ConstantTimeoutAlgorithm

+ func (cta *ConstantTimeoutAlgorithm) Timeout(ctx context.Context, tok *Token) (time.Duration, bool)

+ type LogarithmicTimeoutAlgorithm struct

+ func NewLogarithmicTimeoutAlgorithm(expiryLeewayFactor float64, timeout, expiryDelta time.Duration) *LogarithmicTimeoutAlgorithm

+ func (lta *LogarithmicTimeoutAlgorithm) Timeout(ctx context.Context, tok *Token) (time.Duration, bool)

+ type TimeToExpiryPiecewiseTimeoutAlgorithm struct

+ func NewTimeToExpiryPiecewiseTimeoutAlgorithm(mappings []TimeToExpiryPiecewiseTimeoutMapping) *TimeToExpiryPiecewiseTimeoutAlgorithm

+ func (ttepta *TimeToExpiryPiecewiseTimeoutAlgorithm) Timeout(ctx context.Context, tok *Token) (time.Duration, bool)

+ type TimeToExpiryPiecewiseTimeoutMapping struct

+ Algorithm TimeoutAlgorithm

+ Test func(d time.Duration, ok bool) bool

+ type TimeoutAlgorithm interface

+ Timeout func(ctx context.Context, tok *Token) (time.Duration, bool)

+ func NewBoundedLogarithmicTimeoutAlgorithm(expiryLeewayFactor float64, timeout, expiryDelta time.Duration) TimeoutAlgorithm

+ type TimeoutProvider struct

+ func NewTimeoutProvider(delegate Provider, alg TimeoutAlgorithm) *TimeoutProvider

+ func (tp *TimeoutProvider) Private(clientID, clientSecret string) PrivateOperations

+ func (tp *TimeoutProvider) Public(clientID string) PublicOperations

+ func (tp *TimeoutProvider) Version() int

v2.1.1

Jun 26, 2021

v2.1.0

Jun 24, 2021

Changes in this version

+ type EndpointFactoryFunc func(opts map[string]string) Endpoint

+ func StaticEndpointFactory(endpoint Endpoint) EndpointFactoryFunc

type Provider

+ func GoogleFactory(ctx context.Context, vsn int, opts map[string]string) (Provider, error)

type Token

+ ProviderOptions map[string]string

+ ProviderVersion int

v2.0.0

Apr 9, 2021

Changes in this version

+ const VersionLatest

+ var ErrNoOptions = errors.New("options provided but none accepted")

+ var ErrNoProviderWithVersion = errors.New("version not supported")

+ var ErrNoSuchProvider = errors.New("no provider with the given name")

+ var ErrOIDCMissingIDToken = errors.New("oidc: missing ID token in response")

+ var ErrOIDCNonceMismatch = errors.New("oidc: nonce does not match")

+ var GlobalRegistry = NewRegistry()

+ type AuthCodeExchangeOption interface

+ ApplyToAuthCodeExchangeOptions func(target *AuthCodeExchangeOptions)

+ type AuthCodeExchangeOptions struct

+ AuthCodeOptions []oauth2.AuthCodeOption

+ ProviderOptions map[string]string

+ RedirectURL string

+ func (o *AuthCodeExchangeOptions) ApplyOptions(opts []AuthCodeExchangeOption)

+ type AuthCodeURLOption interface

+ ApplyToAuthCodeURLOptions func(target *AuthCodeURLOptions)

+ type AuthCodeURLOptions struct

+ AuthCodeOptions []oauth2.AuthCodeOption

+ ProviderOptions map[string]string

+ RedirectURL string

+ Scopes []string

+ func (o *AuthCodeURLOptions) ApplyOptions(opts []AuthCodeURLOption)

+ type ClientCredentialsOption interface

+ ApplyToClientCredentialsOptions func(target *ClientCredentialsOptions)

+ type ClientCredentialsOptions struct

+ EndpointParams url.Values

+ ProviderOptions map[string]string

+ Scopes []string

+ func (o *ClientCredentialsOptions) ApplyOptions(opts []ClientCredentialsOption)

+ type DeviceCodeAuthOption interface

+ ApplyToDeviceCodeAuthOptions func(target *DeviceCodeAuthOptions)

+ type DeviceCodeAuthOptions struct

+ ProviderOptions map[string]string

+ Scopes []string

+ func (o *DeviceCodeAuthOptions) ApplyOptions(opts []DeviceCodeAuthOption)

+ type DeviceCodeExchangeOption interface

+ ApplyToDeviceCodeExchangeOptions func(target *DeviceCodeExchangeOptions)

+ type DeviceCodeExchangeOptions struct

+ ProviderOptions map[string]string

+ func (o *DeviceCodeExchangeOptions) ApplyOptions(opts []DeviceCodeExchangeOption)

+ type Endpoint struct

+ DeviceURL string

+ type FactoryFunc func(ctx context.Context, vsn int, opts map[string]string) (Provider, error)

+ func BasicFactory(endpoint Endpoint) FactoryFunc

+ type OptionError struct

+ Cause error

+ Message string

+ Option string

+ func (oe *OptionError) Error() string

+ func (oe *OptionError) Unwrap() error

+ type PrivateOperations interface

+ AuthCodeExchange func(ctx context.Context, code string, opts ...AuthCodeExchangeOption) (*Token, error)

+ ClientCredentials func(ctx context.Context, opts ...ClientCredentialsOption) (*Token, error)

+ type Provider interface

+ Private func(clientID, clientSecret string) PrivateOperations

+ Public func(clientID string) PublicOperations

+ Version func() int

+ func AzureADFactory(ctx context.Context, vsn int, opts map[string]string) (Provider, error)

+ func CustomFactory(ctx context.Context, vsn int, opts map[string]string) (Provider, error)

+ func OIDCFactory(ctx context.Context, vsn int, opts map[string]string) (Provider, error)

+ type PublicOperations interface

+ AuthCodeURL func(state string, opts ...AuthCodeURLOption) (string, bool)

+ DeviceCodeAuth func(ctx context.Context, opts ...DeviceCodeAuthOption) (*devicecode.Auth, bool, error)

+ DeviceCodeExchange func(ctx context.Context, deviceCode string, opts ...DeviceCodeExchangeOption) (*Token, error)

+ RefreshToken func(ctx context.Context, t *Token, opts ...RefreshTokenOption) (*Token, error)

+ type RefreshTokenOption interface

+ ApplyToRefreshTokenOptions func(target *RefreshTokenOptions)

+ type RefreshTokenOptions struct

+ ProviderOptions map[string]string

+ func (o *RefreshTokenOptions) ApplyOptions(opts []RefreshTokenOption)

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) MustRegister(name string, factory FactoryFunc)

+ func (r *Registry) New(ctx context.Context, name string, opts map[string]string) (Provider, error)

+ func (r *Registry) NewAt(ctx context.Context, name string, vsn int, opts map[string]string) (Provider, error)

+ func (r *Registry) Register(name string, factory FactoryFunc) error

+ type Token struct

+ ExtraData map[string]interface{}

+ type WithProviderOptions map[string]string

+ func (wpo WithProviderOptions) ApplyToAuthCodeExchangeOptions(target *AuthCodeExchangeOptions)

+ func (wpo WithProviderOptions) ApplyToAuthCodeURLOptions(target *AuthCodeURLOptions)

+ func (wpo WithProviderOptions) ApplyToClientCredentialsOptions(target *ClientCredentialsOptions)

+ func (wpo WithProviderOptions) ApplyToDeviceCodeAuthOptions(target *DeviceCodeAuthOptions)

+ func (wpo WithProviderOptions) ApplyToDeviceCodeExchangeOptions(target *DeviceCodeExchangeOptions)

+ func (wpo WithProviderOptions) ApplyToRefreshTokenOptions(target *RefreshTokenOptions)

+ type WithRedirectURL string

+ func (wru WithRedirectURL) ApplyToAuthCodeExchangeOptions(target *AuthCodeExchangeOptions)

+ func (wru WithRedirectURL) ApplyToAuthCodeURLOptions(target *AuthCodeURLOptions)

+ type WithScopes []string

+ func (ws WithScopes) ApplyToAuthCodeURLOptions(target *AuthCodeURLOptions)

+ func (ws WithScopes) ApplyToClientCredentialsOptions(target *ClientCredentialsOptions)

+ func (ws WithScopes) ApplyToDeviceCodeAuthOptions(target *DeviceCodeAuthOptions)

+ type WithURLParams map[string]string

+ func (wup WithURLParams) ApplyToAuthCodeExchangeOptions(target *AuthCodeExchangeOptions)

+ func (wup WithURLParams) ApplyToAuthCodeURLOptions(target *AuthCodeURLOptions)

+ func (wup WithURLParams) ApplyToClientCredentialsOptions(target *ClientCredentialsOptions)

Other modules containing this package

github.com/puppetlabs/vault-plugin-secrets-oauthapp

github.com/puppetlabs/vault-plugin-secrets-oauthapp/v3