Skip to content

Document password policy entropy source #992

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.

Sign up for GitHub

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

Closed
Parent: [PUBLISH] vault/1.21.x
wants to merge 2 commits into from
Closed

Document password policy entropy source #992

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
051bff5
Document password policy entropy source
sgmiller Sep 24, 2025
fbebd27
clarify difference between empty string and platform, accept other su…
sgmiller Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions content/vault/v1.21.x (rc)/content/api-docs/system/policies-password.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ generation times.
base64-encoded to avoid string escaping. See [Password Policy Syntax](/vault/docs/concepts/password-policies#password-policy-syntax)
for details on password policy definitions.

- `entropy_source` `(string: "")` - Specifies the source of entropy
(randomness) used to generate the passwords. The default ("") and
"platform" source randomness from the platform RNG. "seal" (enterprise
only) sources entropy from the entropy augmentation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `entropy_source` `(string: "")` - Specifies the source of entropy
(randomness) used to generate the passwords. The default ("") and
"platform" source randomness from the platform RNG. "seal" (enterprise
only) sources entropy from the entropy augmentation.
- `entropy_source` `(string: "platform")` - Specifies the source of entropy
(randomness) used to generate the passwords. Must be one of:
- `platform` - source randomness from the platform RNG.
- `seal` - source entropy from the entropy augmentation. <EnterpriseAlert inline="true" />

It sounds like the default is platform?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default is unset, because existing policies won't have a value for it. We could change the readout code to produce platform, but it'd produce Terraform diffs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the formatting and ent fixes though

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Phrased it as "" means "default source"


### Sample payload

```json
Expand Down
Loading