Skip to content

Commit 9ec3d78

Browse files
author
Keyfactor
committed
Update generated README
1 parent 98e2819 commit 9ec3d78

File tree

1 file changed

+45
-13
lines changed

1 file changed

+45
-13
lines changed

README.md

Lines changed: 45 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# keyfactor-vault-secrets-engine
23

34
A Vault plugin that allows Vault to use Keyfactor Command as a CA and issue certificates.
@@ -10,18 +11,17 @@ This API client allows for programmatic management of Keyfactor resources.
1011

1112
## Support for keyfactor-vault-secrets-engine
1213

13-
keyfactor-vault-secrets-engine is open source and community supported, meaning that there is no support guaranteed from
14-
Keyfactor Support for these tools.
14+
keyfactor-vault-secrets-engine is open source and community supported, meaning that there is no support guaranteed from Keyfactor Support for these tools.
1515

16-
###### To report a problem or suggest a new feature, use the **[Issues](../../issues)
17-
** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)
18-
** tab.
16+
###### To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
1917

2018
---
2119

2220

2321
---
2422

23+
24+
2525
# Hashicorp Vault Secrets Engine
2626

2727
Keyfactor enables DevOps teams to get seamless access to trusted internal and public certificates via native Vault API
@@ -154,11 +154,11 @@ document.
154154
- An adequate number of unseal keys to meet the minimum criteria to unseal the Hashicorp Vault
155155
- A Hashicorp Vault login token
156156

157-
## Installation - Keyfactor Command
157+
## Installation - Keyfactor
158158

159-
### Create the Keyfactor Command service account or oAuth client
159+
### Create the Active Directory service account or oAuth client
160160

161-
For the purposes of this document, we will not go into the details of how to create a service account user since this
161+
For the purposes of this document, we will not go into the details of how to create an Active Directory user since this
162162
process can vary widely, however, here are a couple of things to consider:
163163

164164
- Ensure that the user does not have an expiring password, or if it does, ensure that the password resets are managed
@@ -450,17 +450,48 @@ The values that will need to be set are the following:
450450

451451
- url
452452
- The url pointing to the keyfactor platform with no trailing slashes **(example: "https://kftrain.keyfactor.lab")**
453-
- username
454-
- The username of the account used for authenticating to the platform including the domain **(example: "
455-
KEYFACTOR\VaultUser")**
456-
- password
457-
- The password corresponding to the user account for authenticating to the platform.
458453
- ca
459454
- The certificate authority used when issuing certificates via the plugin **(example:
460455
kftrain.keyfactor.lab\\\\keyfactor-KFTRAIN-CA)**
461456
- template
462457
- The certificate template name to use when issuing certificates. It should be issuable by the CA
463458

459+
#### Basic Authentication Configuration
460+
461+
If you are using basic authentication to Keyfactor Command, you will also need to set the following values:
462+
463+
- username
464+
- The username of the account used for authenticating to the platform including the domain **(example: "
465+
KEYFACTOR\VaultUser")**
466+
- password
467+
- The password corresponding to the user account for authenticating to the platform.
468+
469+
#### oAuth2 Configuration
470+
471+
##### Client Credentials Grant
472+
473+
If you are using the client credentials grant to authenticate to Keyfactor Command, you will also need to set the
474+
following values:
475+
476+
- client_id
477+
- The client ID of the oAuth2 client used for authenticating to the platform
478+
- client_secret
479+
- The client secret corresponding to the oAuth2 client for authenticating to the platform
480+
- token_url
481+
- The URL to the oAuth2 token endpoint for the platform
482+
- scopes
483+
- The scopes of the oAuth2 client
484+
- audience
485+
- The audience of the oAuth2 client
486+
487+
##### Access Token
488+
489+
If you are using a static access token to authenticate to Keyfactor Command, you will also need to set the following
490+
value:
491+
492+
- access_token
493+
- The access token used for authenticating to the platform
494+
464495
Once you've set the configuration properties, run the command:
465496
`vault read <instance name>/config`
466497
in order to view the configuration settings (see example below).
@@ -635,3 +666,4 @@ instance of the plugin is named "keyfactor".
635666

636667
`vault read keyfactor/ca_chain`
637668

669+

0 commit comments

Comments
 (0)