userpass

Documentation

Index

• type LoginOption
  • func WithMountPath(mountPath string) LoginOption
• type Password
• type UserpassAuth
  • func NewUserpassAuth(username string, password *Password, opts ...LoginOption) (*UserpassAuth, error)
  • func (a *UserpassAuth) Login(ctx context.Context, client *api.Client) (*api.Secret, error)

Types

type LoginOption

type LoginOption func(a *UserpassAuth) error

func WithMountPath

func WithMountPath(mountPath string) LoginOption

type Password

type Password struct {
	// Path on the file system where the password corresponding to this
	// application's Vault role can be found.
	FromFile string
	// The name of the environment variable containing the password
	// that corresponds to this application's Vault role.
	FromEnv string
	// The password as a plaintext string value.
	FromString string
}

type UserpassAuth

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

func NewUserpassAuth

func NewUserpassAuth(username string, password *Password, opts ...LoginOption) (*UserpassAuth, error)

NewUserpassAuth initializes a new Userpass auth method interface to be passed as a parameter to the client.Auth().Login method.

Supported options: WithMountPath

func (*UserpassAuth) Login

func (a *UserpassAuth) Login(ctx context.Context, client *api.Client) (*api.Secret, error)