Skip to content

Commit 69620ae

Browse files
committed
docs: clarify usage of OIDCPublicKeyFiles/OIDCPrivateKeyFiles
Signed-off-by: Hans Zandbelt <[email protected]>
1 parent 8a1dc8a commit 69620ae

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

auth_openidc.conf

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -224,22 +224,23 @@
224224
# NB: this can be overridden on a per-OP basis in the .conf file using the key: auth_request_method
225225
#OIDCProviderAuthRequestMethod [ GET | POST | PAR ]
226226

227-
# The fully qualified names of the files that contain the PEM-formatted RSA/EC Public key or a X.509 certificates
228-
# that contain the RSA/EC public keys to be used for JWT (OP state/id_token) encryption by the OP.
229-
# One of these keys must correspond to the private keys defined in OIDCPrivateKeyFiles.
230-
# When not defined no encryption will be requested.
231-
# You can also prefix <filename> with a JWK key identifier to manually override the automatically
227+
# The fully qualified names of the files that contain a PEM-formatted RSA/EC Public key or a X.509 certificates
228+
# that contain the RSA/EC public keys to be used for (optional) signing and/or encryption e.g. private_key_jwt
229+
# authentication to the OPs token/introspection endpoint, id_token encryption by the OP, signed authentication
230+
# requests, signed JWT userinfo claims propagation, dPOP etc.
231+
# The value(s) defined must correspond to the private keys defined in OIDCPrivateKeyFiles.
232+
# One can prefix <filename> with a JWK key ("kid") identifier to manually override the automatically
232233
# generated "kid" that will be used for this key in the JWKs derived from this certificate and
233234
# published at OIDCClientJwksUri.
234-
# Specify the prefix "sig:" or "enc:" to indicate a key is specifically to be used for signing or encryption.
235-
# NB: this can be overridden on a per-OP basis in the .conf file using the key "keys" whose value is a JWK set/array (use=sign)
235+
# Specify the prefix "sig:" or "enc:" to indicate a key is specifically to be used for respectively signing or encryption only.
236+
# NB: this can be overridden on a per-OP basis in the .conf file using the key "keys" whose value is a JWK set/array (use=sign or enc)
237+
# When not defined no signing and/or no encryption will be possible.
236238
#OIDCPublicKeyFiles (["sig:"|"enc:"][<kid>#]<filename>)+
237239

238240
# The fully qualified names of the files that contain the PEM-formatted RSA/EC private
239-
# keys that can be used to decrypt content sent to us by the OP.
240-
# These keys must correspond to the public keys defined in OIDCPublicKeyFiles.
241-
# When not defined no decryption will be possible.
242-
# NB: this can be overridden on a per-OP basis in the .conf file using the key "keys" whose value is a JWK set/array (use=enc)
241+
# keys corresponding to the public keys defined in OIDCPublicKeyFiles.
242+
# When not defined no signing and/or no encryption will be possible.
243+
# NB: this can be overridden on a per-OP basis in the .conf file using the key "keys" whose value is a JWK set/array (use=sign or enc)
243244
#OIDCPrivateKeyFiles (["sig:"|"enc:"][<kid>#]<filename>)+
244245

245246
########################################################################################
@@ -1052,6 +1053,7 @@
10521053
# url (string) : use this url instead of redirect_uri for request_uri
10531054
# request_object_type (string) : parameter used for sending authorization request object
10541055
# "request_uri" (default) or "request"
1056+
# OIDCPrivateKeyFiles and OIDCPublicKeyFiles must have been set before this directive is applied.
10551057
# NB: this can be overridden on a per-OP basis in the .conf file using the key: request_object
10561058
#OIDCRequestObject <stringified-and-double-quote-escaped-JSON-object>
10571059

0 commit comments

Comments
 (0)