WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

JWKS - OpenID Connect Authentication

The JWKS (JSON Web Key Set) endpoint and functionality returns a JWKS containing public keys that enable clients to validate a JSON Web Token (JWT) issued by CAS as an OpenID Connect Provider.

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}


`cas.authn.oidc.jwks.core.jwks-cache-expiration=PT60M` Timeout that indicates how long should the JWKS file be kept in cache. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.support.oidc.jwks.OidcJsonWebKeystoreCoreProperties.`
`cas.authn.oidc.jwks.core.jwks-key-id=cas` The key identifier to set for the generated key in the keystore. `org.apereo.cas.configuration.model.support.oidc.jwks.OidcJsonWebKeystoreCoreProperties.`
`cas.authn.oidc.jwks.core.jwks-key-size=2048` The key size for the generated jwks. This is an algorithm-specific metric, such as modulus length, specified in number of bits. If the keystore type is `EC`, the key size defined here should switch to one of `256`, `384` or `521`. If using `EC`, then the size should match the number of bits required. `org.apereo.cas.configuration.model.support.oidc.jwks.OidcJsonWebKeystoreCoreProperties.`
`cas.authn.oidc.jwks.core.jwks-type=RSA` The type of the JWKS used to handle signing/encryption of authentication tokens. Accepted values are `RSA` or `EC`. `org.apereo.cas.configuration.model.support.oidc.jwks.OidcJsonWebKeystoreCoreProperties.`