Documentation of the Common Criteria Flag#1983
Closed
kitography wants to merge 40 commits intomainfrom
Closed
Conversation
* Add spiffe secrets engine docs * Apply suggestions from code review Co-authored-by: Victor Rodriguez <vrizo@hashicorp.com> * Renames * Update content/vault/v1.21.x/content/api-docs/secret/spiffe.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Add spiffe secrets engine docs * Apply suggestions from code review Co-authored-by: Victor Rodriguez <vrizo@hashicorp.com> * Renames * Update content/vault/v1.21.x/content/api-docs/secret/spiffe.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Move to 2.0 folder * Remove old versions of spiffe docs * Apply suggestions from code review Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Apply suggestion from @ncabatoff Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com> * Apply suggestions from code review Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com> --------- Co-authored-by: Victor Rodriguez <vrizo@hashicorp.com> Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
* Update Azure secrets docs: * update ttl * Update content/vault/v2.x (rc)/content/api-docs/secret/azure.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update content/vault/v2.x (rc)/content/api-docs/secret/azure.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update content/vault/v2.x (rc)/content/api-docs/secret/azure.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update content/vault/v2.x (rc)/content/api-docs/secret/azure.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update content/vault/v2.x (rc)/content/api-docs/secret/azure.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update content/vault/v2.x (rc)/content/api-docs/secret/azure.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update content/vault/v2.x (rc)/content/api-docs/secret/azure.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update content/vault/v2.x (rc)/content/api-docs/secret/azure.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> --------- Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
…claim_access_token` for Azure AD Auth (#1872) https://hashicorp.atlassian.net/browse/VAULT-42462 ### Description: Adds documentation for two new parameters that support fetching group memberships directly from the Microsoft Graph API when using the Azure (Entra ID) provider with the JWT/OIDC auth method. #### Changes [jwt.mdx]: Add the distributed_claim_access_token parameter to the JWT login endpoint. This access token is required when fetch_groups is enabled and allows Vault to authenticate to the Microsoft Graph API to retrieve group memberships. Document the fetch_groups provider config option under the "Optional azure-specific configuration" section. This boolean parameter lets Vault fetch groups through GET /me/memberOf instead of relying on the groups claim in the token, bypassing both the 200-group token limit and the per-application 1,000 group assignment limit in Microsoft Entra ID.
Please go to the `Preview` tab and select the appropriate template: * [Boundary](?expand=1&labels=Boundary&title=Boundary+Docs&template=boundary_pull_request_template.md) * [Consul](?expand=1&labels=Consul&title=Consul+Docs&template=consul_pull_request_template.md) * [HCP services](?expand=1&template=hcp_pull_request_template.md) * [Nomad](?expand=1&labels=Nomad,Runtime&title=Nomad+Docs&template=nomad_pull_request_template.md) ### Terraform * [HCP Terraform](?expand=1&labels=hcp,terraform&title=HCP+Terraform+Docs&template=hcp_terraform_pull_request_template.md) * [Terraform](?expand=1&labels=terraform&title=Terraform+Docs&template=terraform_pull_request_template.md) * [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)
* update documentation for introducing WIF for Secret Sync for Azure Destination * replace plugin references with secret sync references and add secret sync identity token issuer references to the instructions. * docs: revise headers to avoid possessive phrasing based on style feedback Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: update curl example to use VAULT_ADDR for endpoint * docs: reword key retrieval description to avoid pronoun 'this' Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: update service principal description to use meaningful anchor text and remove pronoun 'this' Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: rewrite client_secret description in active voice and clarify fallback authentication behavior Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: rewrite identity_token_key description in active voice and remove pronoun usage Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: update curl example to use VAULT_ADDR for endpoint * docs: rewrite managed identity description in active voice for clarity Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: clarify subject identifier requirement by combining statements for conciseness Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: revise WIF description to use active voice and clearer link text Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: clarify WIF explanation for readability while preserving original meaning Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: fix broken markdown link in azurekv.mdx * docs: updating secrets sync docs for GCP WIF support --------- Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> Co-authored-by: Murali <murali.parthasarathy@hashicorp.com> Co-authored-by: Yoko Hyakuna <yoko.hyakuna1@ibm.com>
* update documentation for introducing WIF for Secret Sync for Azure Destination * replace plugin references with secret sync references and add secret sync identity token issuer references to the instructions. * docs: revise headers to avoid possessive phrasing based on style feedback Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: update curl example to use VAULT_ADDR for endpoint * docs: reword key retrieval description to avoid pronoun 'this' Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: update service principal description to use meaningful anchor text and remove pronoun 'this' Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: rewrite client_secret description in active voice and clarify fallback authentication behavior Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: rewrite identity_token_key description in active voice and remove pronoun usage Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: update curl example to use VAULT_ADDR for endpoint * docs: rewrite managed identity description in active voice for clarity Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: clarify subject identifier requirement by combining statements for conciseness Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: revise WIF description to use active voice and clearer link text Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: clarify WIF explanation for readability while preserving original meaning Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: fix broken markdown link in azurekv.mdx * docs: updating secrets sync docs for GCP WIF support * docs: updating secrets sync docs for GCP WIF support --------- Co-authored-by: Arjun K S <Arjun.KS@ibm.com> Co-authored-by: Arjun K S <arjun.ks@hashicorp.com> Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
* Document the new DRBG parameter to sys/tools/random and transit's random * Update content/vault/v2.x (rc)/content/api-docs/secret/transit.mdx Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com> * Update content/vault/v2.x (rc)/content/api-docs/secret/transit.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * Update content/vault/v2.x (rc)/content/api-docs/system/tools.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * more detail around algo and auto --------- Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com> Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
* update documentation for introducing WIF for Secret Sync for Azure Destination * replace plugin references with secret sync references and add secret sync identity token issuer references to the instructions. * docs: revise headers to avoid possessive phrasing based on style feedback Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: update curl example to use VAULT_ADDR for endpoint * docs: reword key retrieval description to avoid pronoun 'this' Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: update service principal description to use meaningful anchor text and remove pronoun 'this' Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: rewrite client_secret description in active voice and clarify fallback authentication behavior Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: rewrite identity_token_key description in active voice and remove pronoun usage Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: update curl example to use VAULT_ADDR for endpoint * docs: rewrite managed identity description in active voice for clarity Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: clarify subject identifier requirement by combining statements for conciseness Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: revise WIF description to use active voice and clearer link text Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: clarify WIF explanation for readability while preserving original meaning Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> * docs: fix broken markdown link in azurekv.mdx * update documentation for introducing WIF for Secret Sync for AWS Destination * update documentation for introducing WIF for Secret Sync for AWS Destination * docs: updating secrets sync docs for GCP WIF support * update documentation for introducing WIF for Secret Sync for AWS Destination * Apply suggestions from code review Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> --------- Co-authored-by: Arjun K S <Arjun.KS@ibm.com> Co-authored-by: Arjun K S <arjun.ks@hashicorp.com> Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> Co-authored-by: Murali <murali.parthasarathy@hashicorp.com>
Change key usage values from `random` to `generate_random`. Update the sample output of GET /sys/managed-keys/:type/:name to include key usages.
Contributor
Vercel Previews Deployed
|
Contributor
Broken Link CheckerNo broken links found! 🎉 |
|
|
||
| # Common Criteria Flag | ||
|
|
||
| The feature flag is "common_criteria_mode", it's set to "true" (the string) in |
Contributor
There was a problem hiding this comment.
I thought to enable the feature common_criteria_mode was added within the slice of the feature_flags configuration field within vault.hcl?
feature_flags = ["common_criteria_mode"]
| | `POST` | `/pki/issuer/:issuer_ref/sign-intermediate/` | | ||
| | `POST` | `/pki/sign-verbatim(/:name)` | | ||
| | `POST` | `/pki/issuer/:issuer_ref/sign-verbatim(/:name)` | | ||
| | `POST` | `/pki/roles/:name` | |
Contributor
There was a problem hiding this comment.
nit: This API uses not_before_duration not not_before
schavis
requested changes
Mar 12, 2026
| @@ -0,0 +1,85 @@ | |||
| --- | |||
Contributor
There was a problem hiding this comment.
If you're adding new pages, please make sure to also update the nav file in the data folder
| @@ -0,0 +1,85 @@ | |||
| --- | |||
| layout: api | |||
| page_title: Common Criteria Feature Flag | |||
Contributor
There was a problem hiding this comment.
Suggested change
| page_title: Common Criteria Feature Flag | |
| page_title: Common criteria feature flag |
Style correction: use sentence case for titles and headings
| necessary but not sufficient to run Vault in a manner compliant with common | ||
| criteria. | ||
|
|
||
| # Common Criteria Flag |
Contributor
There was a problem hiding this comment.
I'm very confused about the purpose of this page.
Just to confirm, this is a configuration parameter and an activation flag?
If it's a configuration parameter, why are we documenting how to enable it and the limitations/effects of the configuration setting in the API docs?
Generally speaking, content related to enabling a configuration parameter (and the effect it has on your server) should be in the configuration section. The API docs should focus on the available API endpoints, what they do, and what the request/response objects look like.
From skimming the rest of the PR, it doesn't seem like this is in the right place.
Contributor
|
This PR appears abandoned. I'm going to close it if only for the overwhelming number of conflicts. Feel free to recreate the PR against main |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
16 participants
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.
This PR adds documentation for the feature flag common_criteria_mode which addresses some of the incompatibilities between the NIAP common criteria requirements and Vault APIs that need to be addressed ahead of getting NIAP certification.