Skip to content

Commit 080f274

Browse files
Updated README for clarity on role functionality
1 parent 0fb49c3 commit 080f274

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,22 @@ Keyfactor Command can provide the control and visibility needed for a Vault envi
6666

6767
!["high-level-architecture"](images/arch-diagram.png)
6868

69+
> [!IMPORTANT]
70+
> The Keyfactor Vault Secrets Engine is designed to be a drop in replacement for the native
71+
> Vault CA, and implements most of the functionality provided by the PKI secrets engine
72+
> to enable enterprise grade certificate management for certificates requested via
73+
> Vault. There are some important security differences when using the Keyfactor plugin,
74+
> namely in how certificate issuance polices are enforced. The plugin only supports domain
75+
> and subdomain restrictive role polices and defers to the Command infrastructure for it's
76+
> issuance security model based on certificate templates. The only role parameters utilized
77+
> by this secrets engine are "AllowedDomains" and "AllowSubDomains". Other parameters
78+
> utilized by the Vault native PKI secrets engine, such as "TTL", "KeyType", "AllowIPSANs",
79+
> etc. For reference, the full list of fields supported by the Vault PKI secrets engine can
80+
> be found [here](https://developer.hashicorp.com/vault/api-docs/secret/pki#list-roles).
81+
> When architecting a solution, consideration should be given to the
82+
> native Vault policies, the roles implemented by the secrets engine plugin, and the template
83+
> rules available in Command.
84+
6985
## Compatibility
7086

7187
This Vault Plugin has been tested against Hashicorp Vault version 1.10+ and the Keyfactor Platform 9.6+. We provide several pre-built binary files that correspond to various operating systems and processor architectures. If not building the plugin from source code, select the os/architecture combination that corresponds to your environment.

0 commit comments

Comments
 (0)