@@ -17,6 +17,20 @@ Currently supported flows are:
1717
1818![ Main screen capture] ( docs/oidc.png )
1919
20+ ### Note on OpenID Federation (OIDF) support
21+
22+ OpenID Federation support is in "draft" phase, as is the
23+ [ specification] ( https://openid.net/specs/openid-federation-1_0 ) itself. This means that you can expect braking changes
24+ in future releases related to OIDF capabilities. You can enable / disable OIDF support at any time in module
25+ configuration.
26+
27+ Currently, the following OIDF features are supported:
28+ * automatic client registration using a Request Object (passing it by value)
29+ * endpoint for issuing configuration entity statement (statement about itself)
30+ * fetch endpoint for issuing statements about subordinates (registered clients)
31+
32+ OIDF support is implemented using the underlying [ SimpleSAMLphp OpenID library] ( https://github.com/simplesamlphp/openid ) .
33+
2034## Version compatibility
2135
2236Minor versions of SimpleSAMLphp noted below means that the module has been tested with that version of SimpleSAMLphp
@@ -150,6 +164,16 @@ Once you deploy the module, in the SimpleSAMLphp administration area go to `OIDC
150164Protocol / Federation Settings page to see the available discovery URLs. These URLs can then be used to set up a
151165` .well-known ` URLs (see below).
152166
167+ ### Key rollover
168+
169+ The module supports defining additional (new) private / public key pair to be published on relevant JWKS endpoint
170+ or contained in relevant JWKS property. In this way, you can "announce" new public key which can then be fetched
171+ by RPs in order to prepare for the switch of the keys (until the switch of keys, all artifacts continue to be
172+ signed with the "old" private key).
173+
174+ In this way, after RPs fetch new JWKS (JWKS with "old" and "new" key), you can do the switch of keys when you find
175+ appropriate.
176+
153177### Note when using Apache web server
154178
155179If you are using Apache web server, you might encounter situations in which Apache strips of Authorization header
@@ -168,20 +192,6 @@ SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
168192```
169193Choose the one which works for you. If you don't set it, you'll get a warnings about this situation in your logs.
170194
171- ### Note on OpenID Federation (OIDF) support
172-
173- OpenID Federation support is in "draft" phase, as is the
174- [ specification] ( https://openid.net/specs/openid-federation-1_0 ) itself. This means that you can expect braking changes
175- in future releases related to OIDF capabilities. You can enable / disable OIDF support at any time in module
176- configuration.
177-
178- Currently, the following OIDF features are supported:
179- * endpoint for issuing configuration entity statement (statement about itself)
180- * fetch endpoint for issuing statements about subordinates (registered clients)
181- * automatic client registration using a Request Object
182-
183- OIDF support is implemented using the underlying [ SimpleSAMLphp OpenID library] ( https://github.com/simplesamlphp/openid ) .
184-
185195## Additional considerations
186196### Private scopes
187197
0 commit comments