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.
REST Authentication
Be CarefulThis documentation describes how to delegate and submit authentication requests to a remote REST endpoint. It has nothing to do with the native CAS REST API, whose configuration and caveats are documented here.
REST authentication is enabled by including the following dependencies in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-rest-authentication</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-rest-authentication:${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-rest-authentication"
}
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-rest-authentication"
}
This allows the CAS server to reach to a remote REST endpoint via a POST for verification of credentials.
Credentials are passed via an Authorization header whose value is Basic XYZ where XYZ is a
Base64 encoded version of the credentials.
The response that is returned must be accompanied by a 200
status code where the body should contain id and attributes fields, the latter being optional,
which represent the authenticated principal for CAS:
1
2
3
4
5
6
7
8
9
10
{
"@class": "org.apereo.cas.authentication.principal.SimplePrincipal",
"id": "casuser",
"attributes": {
"@class": "java.util.LinkedHashMap",
"names": [
"java.util.List", ["cas", "user"]
]
}
}
Expected responses from the REST endpoint are mapped to CAS as such:
| Code | Result |
|---|---|
200 |
Successful authentication. |
403 |
Produces a AccountDisabledException
|
404 |
Produces a AccountNotFoundException
|
423 |
Produces a AccountLockedException
|
412 |
Produces a AccountExpiredException
|
428 |
Produces a AccountPasswordMustChangeException
|
| Other | Produces a FailedLoginException
|
Authentication Warnings
The remote REST endpoint can send warnings back to the CAS server using custom headers. If the authentication is successful, these warnings will be shown to the user directly after the login.
| Header | Description |
|---|---|
X-CAS-Warning |
For each X-CAS-Warning header present in the response, a corresponding message will be shown to the user. The header value can either be the key for a localized message or the message itself. |
X-CAS-PasswordExpirationDat |
If this header is present in the response and contains a RFC1123 date a special message will be shown to warn the user about the expiring password. If a password management provider is configured, the user will be able to directly change the password. |
Configuration
The following settings and properties are available from the CAS configuration catalog:
cas.authn.rest[0].password-encoder.encoding-algorithm=
The encoding algorithm to use such as
|
cas.authn.rest[0].password-encoder.type=NONE
Define the password encoder type to use.
Type may be specified as blank or
|
cas.authn.rest[0].uri=
Endpoint URI to use for verification of credentials.
|
cas.authn.rest[0].password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'.
Relevant when the type used is
|
cas.authn.rest[0].password-encoder.hash-length=16
When used by
|
cas.authn.rest[0].password-encoder.iterations=310000
When used by
|
cas.authn.rest[0].password-encoder.secret=
Secret to use with
|
cas.authn.rest[0].password-encoder.strength=16
Strength or number of iterations to use for password hashing.
Usually relevant when dealing with
|
cas.authn.rest[0].method=POST
HTTP method to use when contacting the REST API for authentication.
|
cas.authn.rest[0].name=
Name of the authentication handler.
|
cas.authn.rest[0].order=
Order of the authentication handler in the chain.
|
cas.authn.rest[0].state=ACTIVE
Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated. Available values are as follows:
|
cas.authn.rest[0].password-encoder.encoding-algorithm=
The encoding algorithm to use such as
|
cas.authn.rest[0].password-encoder.type=NONE
Define the password encoder type to use.
Type may be specified as blank or
|
cas.authn.rest[0].password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'.
Relevant when the type used is
|
cas.authn.rest[0].password-encoder.hash-length=16
When used by
|
cas.authn.rest[0].password-encoder.iterations=310000
When used by
|
cas.authn.rest[0].password-encoder.secret=
Secret to use with
|
cas.authn.rest[0].password-encoder.strength=16
Strength or number of iterations to use for password hashing.
Usually relevant when dealing with
|
If you need to design your own password encoding scheme where the type is specified as a fully qualified Java class name, the structure of the class would be similar to the following:
1
2
3
4
5
6
7
8
9
10
11
package org.example.cas;
import org.springframework.security.crypto.codec.*;
import org.springframework.security.crypto.password.*;
public class MyEncoder extends AbstractPasswordEncoder {
@Override
protected byte[] encode(CharSequence rawPassword, byte[] salt) {
return ...
}
}
If you need to design your own password encoding scheme where the type is specified as a path to a Groovy script, the structure of the script would be similar to the following:
1
2
3
4
5
6
7
8
9
10
11
12
import java.util.*
byte[] run(final Object... args) {
def (rawPassword,generatedSalt,logger,applicationContext) = args
logger.debug("Encoding password...")
return ...
}
Boolean matches(final Object... args) {
def (rawPassword,encodedPassword,logger,applicationContext) = args
logger.debug("Does match or not ?");
return ...
To prepare CAS to support and integrate with Apache Groovy, please review this guide.
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.