Skip to content

Commit 9e597e1

Browse files
dino8890c00kiemon5ter
authored andcommitted
Improved documentation for signing/encryption keys.
1 parent 4384f36 commit 9e597e1

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/howto/config.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -296,8 +296,8 @@ Example::
296296
key_file: "key.pem"
297297

298298
*key_file* is the name of a PEM formatted file that contains the private key
299-
of the service. This is currently used both to encrypt/sign assertions and as
300-
the client key in an HTTPS session.
299+
of the service. This is currently used both to sign assertions and as
300+
the client key in an HTTPS (mutual TLS) session.
301301

302302
cert_file
303303
^^^^^^^^^
@@ -328,7 +328,14 @@ Example::
328328
encryption_keypairs
329329
^^^^^^^^^^^^^^^^^^^
330330

331-
Indicates which certificates will be used for encryption capabilities::
331+
A list of dictionaries, each containing paths to the private and public keys
332+
used for encryption. The *key_file* refers to the PEM-formatted file that
333+
contains the private key for the service, while the *cert_file* refers to the
334+
corresponding public key (certificate) from the service's key pair. Both files
335+
must be in PEM format, and the *cert_file* should contain only a single
336+
certificate.
337+
338+
Example::
332339

333340
# Encryption
334341
'encryption_keypairs': [

0 commit comments

Comments
 (0)