Skip to content

Commit 3c9c9c9

Browse files
committed
chore(docs): Reformat docs, fix grammar and spelling mistakes, and a lot of opinionated format changes.
1 parent 98ea684 commit 3c9c9c9

File tree

8 files changed

+1467
-1265
lines changed

8 files changed

+1467
-1265
lines changed

README.md

Lines changed: 1279 additions & 1074 deletions
Large diffs are not rendered by default.

docsource/content.md

Lines changed: 163 additions & 176 deletions
Large diffs are not rendered by default.

docsource/rfder.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Overview
22

3-
The RFDER store type can be used to manage DER encoded files.
3+
The `RFDER` store type can be used to manage DER encoded files.
44

5-
Use cases supported:
5+
### Supported use cases
66
1. Single certificate stores with private key in an external file.
77
2. Single certificate stores with no private key.

docsource/rfjks.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
## Overview
22

3-
The RFJKS store type can be used to manage java keystores of types JKS or PKCS12. If creating a new java keystore and adding a certificate all via Keyfactor Command, the created java keystore will be of type PKCS12, as java keystores of type JKS have been deprecated as of JDK 9.
3+
The `RFJKS` store type can be used to manage java keystores of types `JKS` or `PKCS12`. If creating a new java keystore
4+
and adding a certificate all via Keyfactor Command, the created java keystore will be of type `PKCS12`, as java keystores
5+
of type `JKS` have been deprecated as of `JDK 9`.
46

5-
Use cases supported:
7+
### Supported use cases
68
1. One-to-many trust entries - A trust entry is defined as a single certificate without a private key in a certificate store. Each trust entry is identified with a custom alias.
79
2. One-to-many key entries - One-to-many certificates with private keys and optionally the full certificate chain. Each certificate is identified with a custom alias.
810
3. A mix of trust and key entries.

docsource/rfkdb.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
## Overview
22

3-
The RFKDB store type can be used to manage IBM Key Database Files (KDB) files. The IBM utility, GSKCAPICMD, is used to read and write certificates from and to the target store and is therefore required to be installed on the server where each KDB certificate store being managed resides, and its location MUST be in the system $Path.
3+
The `RFKDB` store type can be used to manage IBM Key Database Files (`KDB`) files. The IBM utility, `GSKCAPICMD`, is used
4+
to read and write certificates from and to the target store and is therefore required to be installed on the server where
5+
each `KDB` certificate store being managed resides, and its location MUST be in the system `$Path`.
46

5-
Use cases supported:
7+
### Supported use cases
68
1. One-to-many trust entries - A trust entry is defined as a single certificate without a private key in a certificate store. Each trust entry is identified with a custom alias.
79
2. One-to-many key entries - One-to-many certificates with private keys and optionally the full certificate chain. Each certificate is identified with a custom alias.
810
3. A mix of trust and key entries.

docsource/rfora.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
## Overview
22

3-
The RFORA store type can be used to manage Pkcs12 Oracle Wallets. Please note that while this should work for Pkcs12 Oracle Wallets installed on both Windows and Linux servers, this has only been tested on wallets installed on Windows. Please note, when entering the Store Path for an Oracle Wallet in Keyfactor Command, make sure to INCLUDE the eWallet.p12 file name that by convention is the name of the Pkcs12 wallet file that gets created.
3+
The `RFORA` store type can be used to manage `PKCS12` Oracle Wallets.
44

5-
Use cases supported:
5+
> NOTE: This should work for `PKCS12` Oracle Wallets installed on both Windows and Linux servers, this has only been tested on wallets installed on Windows.
6+
> NOTE: When entering the Store Path for an Oracle Wallet in Keyfactor Command, make sure to INCLUDE the `eWallet.p12` file name that by convention is the name of the `PKCS12` wallet file that gets created.
7+
8+
### Supported use cases
69
1. One-to-many trust entries - A trust entry is defined as a single certificate without a private key in a certificate store. Each trust entry is identified with a custom alias.
710
2. One-to-many key entries - One-to-many certificates with private keys and optionally the full certificate chain. Each certificate is identified with a custom alias.
811
3. A mix of trust and key entries.

docsource/rfpem.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
## Overview
22

3-
The RFPEM store type can be used to manage PEM encoded files.
3+
The `RFPEM` store type can be used to manage `PEM` encoded files.
44

5-
Use cases supported:
5+
### Supported use cases
66
1. Trust stores - A file with one-to-many certificates (no private keys, no certificate chains).
77
2. Single certificate stores with private key in the file.
88
3. Single certificate stores with certificate chain and private key in the file.
99
4. Single certificate stores with private key in an external file.
1010
5. Single certificate stores with certificate chain in the file and private key in an external file
1111

12-
NOTE: PEM stores may only have one private key (internal or external) associated with the store, as only one certificate/chain/private key combination can be stored in a PEM store supported by RFPEM. Private keys will be stored in encrypted or unencrypted PKCS#8 format (BEGIN [ENCRYPTED] PRIVATE KEY) based on the Store Password set on the Keyfactor Command Certificate Store unless managing a PEM store that currently contains a private key in PKCS#1 format (BEGIN RSA PRIVATE KEY or BEGIN EC PRIVATE KEY). Store password MUST be set to "No Password" if managing a store with a PKCS#1 private key, as encrypted PKCS#1 keys are not supported with this integration.
12+
### Additional Considerations and Limitations
13+
- `PEM` stores may only have one private key (internal or external) associated with the store, as only one certificate/chain/private key combination can be stored in a PEM store supported by `RFPEM`.
14+
- Private keys will be stored in encrypted or unencrypted `PKCS#8` format (`BEGIN [ENCRYPTED] PRIVATE KEY`) based on the Store Password set on the Keyfactor Command Certificate Store unless managing a `PEM` store that currently contains a private key in `PKCS#1` format (`BEGIN RSA PRIVATE KEY` or `BEGIN EC PRIVATE KEY`).
15+
- Store password *MUST* be set to `No Password` if managing a store with a `PKCS#1` private key, as encrypted `PKCS#1` keys are not supported with this integration.

docsource/rfpkcs12.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## Overview
22

3-
The RFPkcs12 store type can be used to manage any PKCS#12 compliant file format INCLUDING java keystores of type PKCS12.
3+
The RFPkcs12 store type can be used to manage any `PKCS#12` compliant file format INCLUDING java keystores of type `PKCS12`.
44

5-
Use cases supported:
6-
1. One-to-many trust entries - A trust entry is defined as a single certificate without a private key in a certificate store. Each trust entry MUST BE identified with a custom friendly name/alias.
5+
Supported use cases :
6+
1. One-to-many trust entries - A trust entry is defined as a single certificate without a private key in a certificate store. Each trust entry MUST BE identified with a custom friendly name/alias.
77
2. One-to-many key entries - One-to-many certificates with private keys and optionally the full certificate chain. Each certificate MUST BE identified with a custom friendly name/alias.
88
3. A mix of trust and key entries. Each entry MUST BE identified with a custom friendly name/alias.
99
4. Single certificate stores with a blank/missing friendly name/alias. Any management add job will replace the current certificate entry and will keep the friendly name/alias blank. The Keyfactor Command certificate store will show the current certificate thumbprint as the entry's alias.
1010

11-
Use cases not supported:
11+
Unsupported use cases:
1212
1. Multiple key and/or trust entries with a mix of existing and non existing friendly names/aliases.
1313
2. Multiple key and/or trust entries with blank friendly names/aliases

0 commit comments

Comments
 (0)