Skip to content

Improved documentation for signing/encryption keys. #986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improved documentation for signing/encryption keys. #986

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/howto/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,8 @@ Example::
key_file: "key.pem"

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

cert_file
^^^^^^^^^
Expand Down Expand Up @@ -324,7 +324,14 @@ Example::
encryption_keypairs
^^^^^^^^^^^^^^^^^^^

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

Example::

# Encryption
'encryption_keypairs': [
Expand Down