ldap

package module

v0.12.0 Latest Latest Go to latest Published: Mar 24, 2026 License: MPL-2.0 Imports: 6 Imported by: 9

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hashicorp/vault

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 (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
}