Documentation of the Common Criteria Flag#1983
Conversation
Vercel Previews Deployed
|
Broken Link CheckerNo broken links found! 🎉 |
|
|
||
| # Common Criteria Flag | ||
|
|
||
| The feature flag is "common_criteria_mode", it's set to "true" (the string) in |
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` | |
There was a problem hiding this comment.
nit: This API uses not_before_duration not not_before
| @@ -0,0 +1,85 @@ | |||
| --- | |||
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 | |||
There was a problem hiding this comment.
| 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 |
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/affects 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.
3 participants
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.