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.
Apache Syncope Authentication
CAS support handling the authentication event via Apache Syncope. This
is done by using the rest/users/self REST API that is exposed by a running Syncope instance.
As part of a successful authentication attempt, the properties of the provided user object
are transformed into CAS attributes that can then be released to applications, etc.
Configuration
Support is enabled by including the following dependency in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-syncope-authentication</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-syncope-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-syncope-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-syncope-authentication"
}
The following settings and properties are available from the CAS configuration catalog:
cas.authn.syncope.password-encoder.encoding-algorithm=
The encoding algorithm to use such as
|
cas.authn.syncope.password-encoder.type=NONE
Define the password encoder type to use. Type may be specified as blank or
|
cas.authn.syncope.principal-transformation.groovy.location=
The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256. You can check the current value via cat /proc/sys/fs/inotify/max_user_instances. In situations and scenarios where CAS is able to automatically watch the underlying resource for changes and detect updates and modifications dynamically, you may be able to specify the following setting as either an environment variable or system property with a value of false to disable the resource watcher: org.apereo.cas.util.io.PathWatcherService.
|
cas.authn.syncope.domain=Master
Syncope domain used for authentication, etc. Multiple domains can be separated via comma. Each domain entry results in a separate authentication attempt and transaction by CAS.
|
cas.authn.syncope.provisioning.basic-auth-password=
Specify the password for REST authentication.
|
cas.authn.syncope.provisioning.basic-auth-username=
Specify the username for REST authentication.
|
cas.authn.syncope.provisioning.domain=Master
Syncope domain used for authentication, etc. Multiple domains can be separated via comma. Each domain entry results in a separate authentication attempt and transaction by CAS.
|
cas.authn.syncope.provisioning.realm=/
Syncope realm used for principal provisioning. Realms define a hierarchical security domain tree, primarily meant for containing users. The root realm contains everything, and other realms can be seen as containers that split up the total number of entities into smaller pools.
|
cas.authn.syncope.provisioning.search-filter=username=={user}
User FIQL filter to use for searching. Syntax is
|
cas.authn.syncope.provisioning.url=
Syncope instance URL primary used for REST. This setting supports the Spring Expression Language.
|
cas.authn.syncope.url=
Syncope instance URL primary used for REST. This setting supports the Spring Expression Language.
|
cas.authn.syncope.password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is
|
cas.authn.syncope.password-encoder.hash-length=16
When used by
|
cas.authn.syncope.password-encoder.iterations=310000
When used by
|
cas.authn.syncope.password-encoder.secret=
Secret to use with
|
cas.authn.syncope.password-encoder.strength=16
Strength or number of iterations to use for password hashing. Usually relevant when dealing with
|
cas.authn.syncope.principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail. This setting supports the Spring Expression Language.
|
cas.authn.syncope.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
|
cas.authn.syncope.principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username. This setting supports the Spring Expression Language.
|
cas.authn.syncope.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication. This setting supports the Spring Expression Language.
|
cas.authn.syncope.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication. This setting supports the Spring Expression Language.
|
cas.authn.syncope.attribute-mappings=
Map of attributes that optionally may be used to control the names of the collected attributes from Syncope. If an attribute is provided by Syncope, it can be listed here as the key of the map with a value that should be the name of that attribute as collected and recorded by CAS. For example, the convention
|
cas.authn.syncope.credential-criteria=
A number of authentication handlers are allowed to determine whether they can operate on the provided credential and as such lend themselves to be tried and tested during the authentication handler selection phase. The credential criteria may be one of the following options:
This settings supports regular expression patterns. [?].
|
cas.authn.syncope.name=
Name of the authentication handler.
|
cas.authn.syncope.order=
The order of this authentication handler in the chain.
|
cas.authn.syncope.provisioning.attribute-mappings=
Map of attributes that optionally may be used to control the names of the collected attributes from Syncope. If an attribute is provided by Syncope, it can be listed here as the key of the map with a value that should be the name of that attribute as collected and recorded by CAS. For example, the convention
|
cas.authn.syncope.provisioning.enabled=false
Whether or not provisioning should be enabled with Syncope.
|
cas.authn.syncope.provisioning.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.syncope.state=
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.syncope.password-encoder.encoding-algorithm=
The encoding algorithm to use such as
|
cas.authn.syncope.password-encoder.type=NONE
Define the password encoder type to use. Type may be specified as blank or
|
cas.authn.syncope.password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is
|
cas.authn.syncope.password-encoder.hash-length=16
When used by
|
cas.authn.syncope.password-encoder.iterations=310000
When used by
|
cas.authn.syncope.password-encoder.secret=
Secret to use with
|
cas.authn.syncope.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 ...
cas.authn.syncope.principal-transformation.groovy.location=
The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256. You can check the current value via cat /proc/sys/fs/inotify/max_user_instances. In situations and scenarios where CAS is able to automatically watch the underlying resource for changes and detect updates and modifications dynamically, you may be able to specify the following setting as either an environment variable or system property with a value of false to disable the resource watcher: org.apereo.cas.util.io.PathWatcherService.
|
cas.authn.syncope.principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail. This setting supports the Spring Expression Language.
|
cas.authn.syncope.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
|
cas.authn.syncope.principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username. This setting supports the Spring Expression Language.
|
cas.authn.syncope.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication. This setting supports the Spring Expression Language.
|
cas.authn.syncope.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication. This setting supports the Spring Expression Language.
|
Authentication handlers that generally deal with username-password credentials can be configured to transform the user id prior to executing the authentication sequence. Each authentication strategy in CAS provides settings to properly transform the principal. Refer to the relevant settings for the authentication strategy at hand to learn more.
Authentication handlers as part of principal transformation may also be provided a path to a Groovy script to transform the provided username. The outline of the script may take on the following form:
1
2
3
4
String run(final Object... args) {
def (providedUsername,logger) = args
return providedUsername.concat("SomethingElse")
}
Certain authentication handlers are allowed to determine whether they can operate on the provided credential and as such lend themselves to be tried and tested during the authentication handler selection phase. The credential criteria may be one of the following options:
- A regular expression pattern that is tested against the credential identifier.
- A fully qualified class name of your own design that looks similar to the below example:
1
2
3
4
5
6
7
8
9
import java.util.function.Predicate;
import org.apereo.cas.authentication.Credential;
public class PredicateExample implements Predicate<Credential> {
@Override
public boolean test(final Credential credential) {
// Examine the credential and return true/false
}
}
- Path to an external Groovy script that looks similar to the below example:
1
2
3
4
5
6
7
8
9
import org.apereo.cas.authentication.Credential
import java.util.function.Predicate
class PredicateExample implements Predicate<Credential> {
@Override
boolean test(final Credential credential) {
// test and return result
}
}
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.
Attributes
As part of a successful authentication attempt, the following attributes provided by Apache Syncope are collected by CAS:
| Attribute Name |
|---|
syncopeUserRoles |
syncopeUserSecurityQuestion |
syncopeUserStatus |
syncopeUserKey |
syncopeUserRealm |
syncopeUserCreator |
syncopeUserCreationDate |
syncopeUserChangePwdDate |
syncopeUserLastLoginDate |
syncopeUserDynRoles |
syncopeUserDynRealms |
syncopeUserMemberships |
syncopeUserDynMemberships |
syncopeUserDynRelationships |
syncopeUserAttrs |
Note that attributes are only collected if they contain a value.