auth

package
v1.14.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 4, 2024 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// MethodAWSIAM authenticates to vault via AWS IAM Auth
	MethodAWSIAM = "aws-iam"

	// MethodAWSEC2 authenticates to vault via AWS EC2 Auth
	MethodAWSEC2 = "aws-ec2"

	// AWSAuthErrorMessage is the default error message for AWS IAM Authentication
	AWSAuthErrorMessage = "Error authenticating to vault via AWS IAM authentication"

	// AWSAuthHeaderKey is the header key used during AWS IAM authentication
	AWSAuthHeaderKey = "X-Vault-AWS-IAM-Server-ID"

	// NonceMaxBytes is the maximum number of bytes that will be read from the nonce file
	NonceMaxBytes = 1024
)
View Source
const (
	// MethodGCPGCE is the GCP GCE authentication method
	MethodGCPGCE = "gcp-gce"

	// MethodGCPIAM is the GCP IAM authentication method
	MethodGCPIAM = "gcp-iam"
)
View Source
const (
	// MethodAgent assumes the vault_addr is an agent handling authentication
	MethodAgent = "agent"
)
View Source
const (
	// MethodAppRole authenticates to vault via the AppRole backend
	MethodAppRole = "approle"
)
View Source
const (
	// MethodCert authenticates to vault via client cert
	MethodCert = "cert"
)
View Source
const MethodToken = "token"

MethodToken authenticates to vault via token

Variables

This section is empty.

Functions

func CheckAuthentication

func CheckAuthentication(client *api.Client) error

CheckAuthentication verifies that the connection to vault is setup correctly by retrieving information about the configured token

Types

type AWSEC2Authenticater

type AWSEC2Authenticater struct{}

func (*AWSEC2Authenticater) Authenticate

func (a *AWSEC2Authenticater) Authenticate(options cli.Options, client *api.Client) error

Authenticate to vault via the AWS authentication method

type AWSIAMAuthenticater

type AWSIAMAuthenticater struct{}

func (*AWSIAMAuthenticater) Authenticate

func (a *AWSIAMAuthenticater) Authenticate(options cli.Options, client *api.Client) error

Authenticate to vault via AWS IAM authentication

type AgentAuthenticater added in v1.13.0

type AgentAuthenticater struct{}

func (*AgentAuthenticater) Authenticate added in v1.13.0

func (a *AgentAuthenticater) Authenticate(options cli.Options, client *api.Client) error

Authenticate does nothing, assumes agent is handling authentication

type AppRoleAuthenticater

type AppRoleAuthenticater struct{}

func (*AppRoleAuthenticater) Authenticate

func (a *AppRoleAuthenticater) Authenticate(options cli.Options, client *api.Client) error

AppRole authenticates to vault via the AppRole backend

type Authenticater

type Authenticater interface {
	Authenticate(options cli.Options, client *api.Client) error
}

type CertAuthenticater

type CertAuthenticater struct{}

func (*CertAuthenticater) Authenticate

func (c *CertAuthenticater) Authenticate(options cli.Options, client *api.Client) error

Authenticate to vault via the cert auth backend

type GCPGCEAuthenticater added in v1.13.0

type GCPGCEAuthenticater struct{}

GCPGCEAuthenticater authenticates into GCP using GCE metadata auth

func (*GCPGCEAuthenticater) Authenticate added in v1.13.0

func (a *GCPGCEAuthenticater) Authenticate(options cli.Options, client *api.Client) error

Authenticate authenticates using GCE metadata auth

type GCPIAMAuthenticater added in v1.13.0

type GCPIAMAuthenticater struct{}

GCPIAMAuthenticater authenticates into GCP using IAM auth

func (*GCPIAMAuthenticater) Authenticate added in v1.13.0

func (a *GCPIAMAuthenticater) Authenticate(options cli.Options, client *api.Client) error

Authenticate authenticates using IAM auth

type TokenAuthenticater

type TokenAuthenticater struct{}

func (*TokenAuthenticater) Authenticate

func (t *TokenAuthenticater) Authenticate(options cli.Options, client *api.Client) error

Authenticate to vault via token

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL