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/
Updating the Changelog
All pull requests that introduce a user-facing change must include a changelog entry. We use the changie tool to manage these entries and automate the release process.
1. Installing Changie
You only need to do this once. If you don't have changie installed, choose one of the options below.
- Homebrew (macOS):
brew install changie - Go Install:
go install github.com/miniscruff/changie@latest - Other Methods: See the official changie installation guide for other options, including pre-compiled binaries.
2. Creating an Entry
Once your code changes are complete, create the changelog entry:
-
Run the command in your terminal:
changie new -
Follow the prompts. An interactive prompt will ask you to select the kind of change (e.g.,
BREAKING CHANGES,NOTES,FEATURES) and write a concise description of what you changed. -
Commit the new file. After you're done,
changiewill create a new YAML file in the.changie/unreleaseddirectory. Commit this file along with your other code changes before submitting your pull request.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CheckOut ¶ added in v0.9.0
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.
Source Files
Directories