ldap

Documentation

Index

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

Types

type LDAPAuth

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

func NewLDAPAuth

func NewLDAPAuth(username string, password *Password, opts ...LoginOption) (*LDAPAuth, error)

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

Supported options: WithMountPath

func (*LDAPAuth) Login

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

type LoginOption

type LoginOption func(a *LDAPAuth) error

func WithMountPath

func WithMountPath(mountPath string) LoginOption

type Password

type Password struct {
	// Path on the file system where the LDAP password can be found.
	FromFile string
	// The name of the environment variable containing the LDAP password
	FromEnv string
	// The password as a plaintext string value.
	FromString string
}