credentials

Documentation

Overview

Package credentials provides credential retrieval and management

Index

• type BasicAuthCredentials
  • func (c *BasicAuthCredentials) CredentialOfType(t Type) (cred interface{}, ok bool)
• type OAuthClientCredentials
  • func (c *OAuthClientCredentials) CredentialOfType(t Type) (cred interface{}, ok bool)
• type Provider
• type Providers
  • func FromEnvironment() Providers
  • func (p Providers) CredentialOfType(t Type) (cred interface{}, ok bool)
• type Type

Types

type BasicAuthCredentials

type BasicAuthCredentials struct {
	Username string
	Password string
}

BasicAuthCredentials provides credentials for basic auth.

func (*BasicAuthCredentials) CredentialOfType

func (c *BasicAuthCredentials) CredentialOfType(t Type) (cred interface{}, ok bool)

type OAuthClientCredentials

type OAuthClientCredentials struct {
	ClientID     string
	ClientSecret string
	RefreshToken string
}

OAuthClientCredentials provides credentials for the OAuth 2.0 client credentials flow.

func (*OAuthClientCredentials) CredentialOfType

func (c *OAuthClientCredentials) CredentialOfType(t Type) (cred interface{}, ok bool)

type Provider

type Provider interface {
	CredentialOfType(t Type) (cred interface{}, ok bool)
}

Provider defines the interface for a credential provider.

type Providers

type Providers []Provider

Providers allows []Provider to implement the Provider interface.

func FromEnvironment

func FromEnvironment() Providers

FromEnvironment loads credentials from the environment.

# Basic Auth
WD_BASIC_AUTH_USERNAME
WD_BASIC_AUTH_PASSWORD

# OAuth Client Credentials
WD_CLIENT_CREDENTIALS_CLIENT_ID
WD_CLIENT_CREDENTIALS_CLIENT_SECRET
WD_CLIENT_CREDENTIALS_REFRESH_TOKEN

func (Providers) CredentialOfType

func (p Providers) CredentialOfType(t Type) (cred interface{}, ok bool)

type Type

type Type string

Type represents a type of supported credentials.

const (
	// CredentialTypeBasicAuth represents basic auth credentials.
	TypeBasicAuth Type = "basic_auth"

	// CredentialTypeOAuthClientCredentials represents OAuth 2.0 client credentials.
	TypeOAuthClientCredentials Type = "client_credentials"
)