-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Add docs for password policies #8974
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
905dba3
Add docs for password policies
pcman312 c053087
Wordsmithing; Updated performance graph to svg
pcman312 a9449d0
Moved rules below performance; Wordsmithing
pcman312 4c5b616
Merge branch 'master' into docs/password-policies
pcman312 66c9843
Fix grammar & typos; improve performance graph
pcman312 79fd5dc
Merge branch 'master' into docs/password-policies
pcman312 462e31d
Improved performance section; wordsmithing
pcman312 3e7dcc4
Improved performance graph; Wordsmithing
pcman312 1a90820
Improved probability graph
pcman312 fb5ee59
Fix typos, grammar; wordsmithing
pcman312 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| --- | ||
| layout: api | ||
| page_title: /sys/policies/password - HTTP API | ||
| sidebar_title: <code>/sys/policies/password</code> | ||
| description: >- | ||
| The `/sys/policies/password` endpoints are used to manage password generation policies in Vault. | ||
| --- | ||
|
|
||
| # `/sys/policies/password/` | ||
|
|
||
| The `/sys/policies/password/` endpoints are used to manage password generation policies in Vault. | ||
| Not all secret engines utilize password policies, so check the documentation for the engine you | ||
| are using for compatibility. | ||
|
|
||
| ~> Password policies are only available in Vault version 1.5+. | ||
|
|
||
| See [Password Policies](/docs/concepts/password-policies) for details of how password policies work | ||
| as well as the syntax of the policies themselves. | ||
|
|
||
| ## Create/Update Password Policy | ||
|
|
||
| This endpoint adds a new or updates an existing password policy. Once a policy is updated, | ||
| it takes effect immediately to all associated secret engines. | ||
|
|
||
| Prior to Vault saving the password policy, it will attempt to generate a number of passwords | ||
| from the policy. This helps prevent creating password policies that are impossible to satisfy | ||
| as well as prevent password policies that are overly restrictive which prevents both a poor | ||
| security posture for the policy as well as preventing performance problems due to slow | ||
| generation times. | ||
|
|
||
| | Method | Path | | ||
| | :----- | :----------------------------- | | ||
| | `PUT` | `/sys/policies/password/:name` | | ||
|
|
||
| ### Parameters | ||
|
|
||
| - `name` `(string: <required>)` – Specifies the name of the password policy to create. | ||
| This is specified as part of the request URL. | ||
|
|
||
| - `policy` `(string: <required>)` - Specifies the password policy document. This can be | ||
| base64-encoded to avoid string escaping. See [Password Policy Syntax](#password-policy-syntax) | ||
| for details on password policy definitions. | ||
|
|
||
| ### Sample Payload | ||
|
|
||
| ```json | ||
| { | ||
| "policy": "length = 20\nrule \"charset\" { ..." | ||
| } | ||
| ``` | ||
|
|
||
| ### Sample Request | ||
| **cURL:** | ||
| ```shell | ||
| $ cat payload.json | ||
| { | ||
| "policy": "length = 20\nrule \"charset\" {\n charset = \"abcde\"\n}\n" | ||
| } | ||
|
|
||
| $ curl \ | ||
| --header "X-Vault-Token: ..." \ | ||
| --request PUT \ | ||
| --data @payload.json \ | ||
| http://127.0.0.1:8200/v1/sys/policies/password/my-policy | ||
| ``` | ||
|
|
||
| **Vault CLI:** | ||
| ```shell | ||
| $ cat my-policy.hcl | ||
| length = 20 | ||
| rule "charset" { | ||
| charset = "abcde" | ||
| } | ||
|
|
||
| $ vault write sys/policies/password/my-policy policy=@my-policy.hcl | ||
| ``` | ||
|
|
||
| ## Read Password Policy | ||
|
|
||
| This endpoint retrieves information about the named password policy. | ||
|
|
||
| | Method | Path | | ||
| | :----- | :----------------------------- | | ||
| | `GET` | `/sys/policies/password/:name` | | ||
|
|
||
| ### Parameters | ||
|
|
||
| - `name` `(string: <required>)` – Specifies the name of the password policy to retrieve. | ||
| This is specified as part of the request URL. | ||
|
|
||
| ### Sample Request | ||
|
|
||
| ```shell | ||
| $ curl \ | ||
| --header "X-Vault-Token: ..." \ | ||
| http://127.0.0.1:8200/v1/sys/policies/password/my-policy | ||
| ``` | ||
|
|
||
| ### Sample Response | ||
| ```json | ||
| { | ||
| "policy": "length = 20\nrule \"charset\" { ..." | ||
| } | ||
| ``` | ||
|
|
||
| ## Delete Password Policy | ||
|
|
||
| This endpoint deletes the password policy with the given name. This does not check if any | ||
| secret engines are using it prior to deletion, so you should ensure that any engines that | ||
| are utilizing this password policy are changed to a different policy (or to that engines' | ||
| default behavior). | ||
|
|
||
| | Method | Path | | ||
| | :----- | :----------------------------- | | ||
| | `DELETE` | `/sys/policies/password/:name` | | ||
|
|
||
| ### Parameters | ||
|
|
||
| - `name` `(string: <required>)` – Specifies the name of the password policy to delete. | ||
| This is specified as part of the request URL. | ||
|
|
||
| ### Sample Request | ||
|
|
||
| ```shell | ||
| $ curl \ | ||
| --header "X-Vault-Token: ..." \ | ||
| --request DELETE | ||
| http://127.0.0.1:8200/v1/sys/policies/password/my-policy | ||
| ``` | ||
|
|
||
| ## Generate Password from Password Policy | ||
|
|
||
| This endpoint generates a password from the specified existing password policy. | ||
|
|
||
| | Method | Path | | ||
| | :----- | :----------------------------- | | ||
| | `GET` | `/sys/policies/password/:name/generate` | | ||
|
|
||
| ### Parameters | ||
|
|
||
| - `name` `(string: <required>)` – Specifies the name of the password policy to generate | ||
| a password from. This is specified as part of the request URL. | ||
|
|
||
| ### Sample Request | ||
|
|
||
| ```shell | ||
| $ curl \ | ||
| --header "X-Vault-Token: ..." \ | ||
| http://127.0.0.1:8200/v1/sys/policies/password/my-policy/generate | ||
| ``` | ||
|
|
||
| ### Sample Response | ||
| ```json | ||
| { | ||
| "password": "..." | ||
| } | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.