Skip to content

Commit

Permalink
Add documentation for supported certificate formats and usage.
Browse files Browse the repository at this point in the history
  • Loading branch information
george-mcintyre committed Dec 3, 2024
1 parent 8e21e0d commit 3720e03
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions documentation/securepva.rst
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,21 @@ can authenticate their peer using X.509 certificates. Key features of the TLS im
- Fallback to TCP when TLS is not configured or certificates are invalid
- Certificate status verification during connection establishment
Supported Certificate Formats, Encodings and File Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------+----------------------+-----------+-------------------------+------------------------------+-------------------------+
| File Type | Extension | Encoding | Includes Private Key? | Includes Certificate Chain? | Common Usage |
+===========+======================+===========+=========================+==============================+=========================+
|| PEM || ``.pem``, ``.crt``, || Base64 || Optional || Optional (concatenated) || Web servers, OpenSSL |
|| || ``.cer``, ``.key`` || || || || |
+-----------+----------------------+-----------+-------------------------+------------------------------+-------------------------+
|| PKCS#12 || ``.p12``, ``.pfx`` || Binary || Optional (password) || Yes || Distributing cert key |
+-----------+----------------------+-----------+-------------------------+------------------------------+-------------------------+
|| JKS || ``.jks`` || Binary || Optional || Yes || Java applications |
+-----------+----------------------+-----------+-------------------------+------------------------------+-------------------------+
To use any of these formats just use the appropriate file extension when specifying the certificate and key files.
TLS encapsulation of the PVAccess protocol
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 3720e03

Please sign in to comment.