openldap

README

Vault Plugin: OpenLDAP Secrets Backend

This is a standalone backend plugin for use with Hashicorp Vault. This plugin provides OpenLDAP functionality to Vault.

Please note: We take Vault's security and our users' trust very seriously. If you believe you have found a security issue in Vault, please responsibly disclose by contacting us at security@hashicorp.com.

Quick Links

• Vault Website: https://developer.hashicorp.com/vault/docs
• OpenLDAP Docs: https://developer.hashicorp.com/vault/docs/secrets/ldap
• Main Project Github: https://www.github.com/hashicorp/vault

Getting Started

This is a Vault plugin and is meant to work with Vault. This guide assumes you have already installed Vault and have a basic understanding of how Vault works.

Otherwise, first read this guide on how to get started with Vault.

To learn specifically about how plugins work, see documentation on Vault plugins.

Usage

Please see documentation for the plugin on the Vault website.

This plugin is currently built into Vault and by default is accessed at openldap. To enable this in a running Vault server:

$ vault secrets enable openldap
Success! Enabled the openldap secrets engine at: openldap/

Documentation

Index

• func Backend(client ldapClient) *backend
• func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)
• type CheckOut
• type Client
  • func NewClient(logger hclog.Logger) *Client
  • func (c *Client) Execute(conf *client.Config, entries []*ldif.Entry, continueOnError bool) (err error)
  • func (c *Client) UpdateDNPassword(conf *client.Config, dn string, newPassword string) error
  • func (c *Client) UpdateUserPassword(conf *client.Config, username string, newPassword string) error

Functions

func Backend

func Backend(client ldapClient) *backend

func Factory

func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)

Types

type CheckOut

type CheckOut struct {
	IsAvailable         bool   `json:"is_available"`
	BorrowerEntityID    string `json:"borrower_entity_id"`
	BorrowerClientToken string `json:"borrower_client_token"`
}

CheckOut provides information for a service account that is currently checked out.

type Client

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

func NewClient

func NewClient(logger hclog.Logger) *Client

func (*Client) Execute

func (c *Client) Execute(conf *client.Config, entries []*ldif.Entry, continueOnError bool) (err error)

func (*Client) UpdateDNPassword

func (c *Client) UpdateDNPassword(conf *client.Config, dn string, newPassword string) error

UpdateDNPassword updates the password for the object with the given DN.

func (*Client) UpdateUserPassword

func (c *Client) UpdateUserPassword(conf *client.Config, username string, newPassword string) error

UpdateUserPassword updates the password for the object with the given username.