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.
Delegated Authentication - Identity Provider Registration
An identity provider is a server which can authenticate users (like Google, Yahoo…) instead of a CAS server. If you want to delegate the CAS authentication to Twitter for example, you have to add an OAuth client for the Twitter provider, which will be done automatically for you once provider settings are taught to CAS.
Notice that for each provider, the CAS server is considered as a client and therefore should be declared as an client at the external identity provider. After the declaration, a key and a secret may be given by the provider which has to be defined in the CAS configuration as well.
Actuator Endpoints
The following endpoints are provided by CAS:
Default
Identity providers for delegated authentication can be registered with CAS using settings.
| Provider | Reference |
|---|---|
| Apple | See this guide. |
| Azure AD | See this guide. |
| CAS | See this guide. |
| Custom | See this guide. |
| DropBox | See this guide. |
| See this guide. | |
| FourSquare | See this guide. |
| Generic OpenID Connect | See this guide. |
| GitHub | See this guide. |
| See this guide. | |
| Google OpenID Connect | See this guide. |
| HiOrgServer | See this guide. |
| Keycloak | See this guide. |
| See this guide. | |
| OAuth20 | See this guide. |
| PayPal | See this guide. |
| SAML2 | See this guide. |
| See this guide. | |
| WindowsLive | See this guide. |
| Wordpress | See this guide. |
| Yahoo | See this guide. |
JDBC
Identity providers for delegated authentication can be provided to CAS using a SQL database. To active this feature, you need to start by including the following module in the overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-jpa-util</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-jpa-util:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-jpa-util"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-jpa-util"
}
The following settings and properties are available from the CAS configuration catalog:
cas.authn.pac4j.jdbc.driver-class=org.hsqldb.jdbcDriver
The JDBC driver used to connect to the database.
|
cas.authn.pac4j.jdbc.password=
The database connection password.
|
cas.authn.pac4j.jdbc.url=jdbc:hsqldb:mem:cas-hsql-database
The database connection URL. This setting supports the Spring Expression Language.
|
cas.authn.pac4j.jdbc.user=sa
The database user. The database user must have sufficient permissions to be able to handle schema changes and updates, when needed.
|
cas.authn.pac4j.jdbc.pool.keep-alive-time=0
This property controls the keepalive interval for a connection in the pool. An in-use connection will never be tested by the keepalive thread, only when it is idle will it be tested. Default is zero, which disables this feature. This settings supports the
|
cas.authn.pac4j.jdbc.pool.max-size=18
Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.
|
cas.authn.pac4j.jdbc.pool.max-wait=PT2S
Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. This settings supports the
|
cas.authn.pac4j.jdbc.pool.maximum-lifetime=PT10M
This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed. This settings supports the
|
cas.authn.pac4j.jdbc.pool.min-size=6
Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.
|
cas.authn.pac4j.jdbc.pool.name=
Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration.
|
cas.authn.pac4j.jdbc.pool.suspension=false
Whether or not pool suspension is allowed. There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it.
|
cas.authn.pac4j.jdbc.pool.timeout-millis=1000
The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
|
cas.authn.pac4j.jdbc.autocommit=false
The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction.
|
cas.authn.pac4j.jdbc.batch-size=100
A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
|
cas.authn.pac4j.jdbc.connection-timeout=PT30S
Indicates the maximum number of milliseconds that the service can wait to obtain a connection. This settings supports the
|
cas.authn.pac4j.jdbc.data-source-name=
Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is.
|
cas.authn.pac4j.jdbc.ddl-auto=update
Hibernate feature to automatically validate and exports DDL to the schema. By default, creates and drops the schema automatically when a session is starts and ends. Setting the value to
create-drop will result in the loss of all data as soon as CAS is started. For transient data like tickets this is probably not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe for data, is confirmed to result in invalid database state. validate or none settings are likely the only safe options for production use. For more info, see this.
|
cas.authn.pac4j.jdbc.default-catalog=
Qualifies unqualified table names with the given catalog in generated SQL.
|
cas.authn.pac4j.jdbc.default-schema=
Qualify unqualified table names with the given schema/tablespace in generated SQL.
|
cas.authn.pac4j.jdbc.dialect=org.hibernate.dialect.HSQLDialect
The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.
|
cas.authn.pac4j.jdbc.fail-fast-timeout=1
Set the pool initialization failure timeout.
connectionTimeout or validationTimeout; they will be honored before this timeout is applied. The default value is one millisecond.
|
cas.authn.pac4j.jdbc.fetch-size=100
Used to specify number of rows to be fetched in a select query.
|
cas.authn.pac4j.jdbc.generate-statistics=false
Allow hibernate to generate query statistics.
|
cas.authn.pac4j.jdbc.health-query=
The SQL query to be executed to test the validity of connections. This is for "legacy" databases that do not support the JDBC4
|
cas.authn.pac4j.jdbc.idle-timeout=PT10M
Controls the maximum amount of time that a connection is allowed to sit idle in the pool. This settings supports the
|
cas.authn.pac4j.jdbc.isolate-internal-queries=false
This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction. Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if#autocommit is disabled.
|
cas.authn.pac4j.jdbc.isolation-level-name=ISOLATION_READ_COMMITTED
Defines the isolation level for transactions. @see org.springframework.transaction.TransactionDefinition
|
cas.authn.pac4j.jdbc.leak-threshold=PT6S
Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak. This settings supports the
|
cas.authn.pac4j.jdbc.physical-naming-strategy-class-name=org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy
Fully-qualified name of the class that can control the physical naming strategy of hibernate.
|
cas.authn.pac4j.jdbc.propagation-behavior-name=PROPAGATION_REQUIRED
Defines the propagation behavior for transactions. @see org.springframework.transaction.TransactionDefinition
|
cas.authn.pac4j.jdbc.properties=
Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.
|
cas.authn.pac4j.jdbc.read-only=false
Configures the Connections to be added to the pool as read-only Connections.
|
Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.
cas.jdbc.case-insensitive=false
When choosing physical table names, determine whether names should be considered case-insensitive. How can I configure this property?
|
cas.jdbc.gen-ddl=true
Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables. How can I configure this property?
|
cas.jdbc.physical-table-names=
Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default. How can I configure this property?
|
cas.jdbc.show-sql=false
|
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
Note
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Feature Activation
To activate this feature, the following feature toggle(s) must be turned on:
1
CasFeatureModule.DelegatedAuthentication.jdbc.enabled=true
To learn more about configuration feature toggles, please see this page.
The identity provider configuration is expected to be found in the following database table:
1
2
3
4
5
6
7
CREATE TABLE JdbcIdentityProviderEntity (
id INTEGER IDENTITY PRIMARY KEY,
type VARCHAR(250),
index INTEGER,
name VARCHAR(250),
value VARCHAR(250)
);
For example, the following SQL script indicates the required configuration for an external CAS identity provider:
1
2
3
4
INSERT INTO JdbcIdentityProviderEntity (type, index, name, value)
VALUES ('cas', 0, 'login-url', 'https://cas.example.org');
INSERT INTO JdbcIdentityProviderEntity (type, index, name, value)
VALUES ('cas', 0, 'protocol', 'CAS30');
You’ll note that the value in the name column is appended to the configuration prefix cas.authn.pac4j. The
following types are supported: cas ,oidc, saml, oauth.
REST
Identity providers for delegated authentication can be provided to CAS using an external REST endpoint.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.pac4j.rest.url=
The endpoint URL to contact and retrieve attributes.
|
cas.authn.pac4j.rest.basic-auth-password=
If REST endpoint is protected via basic authentication, specify the password for authentication.
|
cas.authn.pac4j.rest.basic-auth-username=
If REST endpoint is protected via basic authentication, specify the username for authentication.
|
cas.authn.pac4j.rest.headers=
Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value.
|
cas.authn.pac4j.rest.method=GET
HTTP method to use when contacting the rest endpoint. Examples include
|
cas.authn.pac4j.rest.type=pac4j
Specify the format of the payload that would be produced by the REST API. Accepted values are:
|
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
Note
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
The expected payload type, that is controlled via CAS settings, can be understood and consumed in the following ways.
-
This allows the CAS server to reach to a remote REST endpoint whose responsibility is to produce the following payload in the response body:
1 2 3 4 5 6 7 8 9 10
{ "callbackUrl": "https://sso.example.org/cas/login", "properties": { "github.id": "...", "github.secret": "...", "cas.loginUrl.1": "...", "cas.protocol.1": "..." } }
The syntax and collection of available
propertiesin the above payload is controlled by the Pac4j library. The response that is returned must be accompanied by a200status code. -
This allows the CAS server to reach to a remote REST endpoint whose responsibility is to produce the following payload in the response body:
1 2 3 4 5 6 7 8
{ "cas.authn.pac4j.github.client-name": "...", "cas.authn.pac4j.github.id": "...", "cas.authn.pac4j.github.secret": "...", "cas.authn.pac4j.cas[0].login-url": "...", "cas.authn.pac4j.cas[0].protocol": "..." }
The payload is expected to contain CAS specific properties that would be used to construct external identity providers. The response that is returned must be accompanied by a
200status code.
Caching
Note that once identity provider registration data is fetched, the results are cached by CAS using a configurable expiration policy and the endpoint is only contacted by CAS if the cache content is empty or has been invalidated. This cache is owned by each CAS server node, in case there is more than one in the same cluster and operations that interact with the cache must be able to apply task to the cache for all CAS server nodes.