APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Apache Syncope Attribute Resolution

Support is enabled by including the following dependency in the WAR overlay:

Show in CAS Initializr Generate CAS Server 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 are included automatically and are listed 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 configuration describes how to fetch and retrieve attributes from Apache Syncope.

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

cas.authn.attribute-repository.syncope.basic-auth-passwordSpecify the password for REST authentication.
no default
Required

Specify the password for REST authentication.

Type
String
Default
none
Defined by
SyncopePrincipalAttributesProperties
cas.authn.attribute-repository.syncope.basic-auth-usernameSpecify the username for REST authentication.
no default
Required

Specify the username for REST authentication.

Type
String
Default
none
Defined by
SyncopePrincipalAttributesProperties
cas.authn.attribute-repository.syncope.domainSyncope domain used for authentication, etc.
Master
Required

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.

Type
String
Default
Master
Defined by
SyncopePrincipalAttributesProperties
cas.authn.attribute-repository.syncope.search-filterUser FIQL filter to use for searching.
username=={user}
Required

User FIQL filter to use for searching. Syntax is username=={user} or username=={0}.

Type
String
Default
username=={user}
Defined by
SyncopePrincipalAttributesProperties
cas.authn.attribute-repository.syncope.urlSyncope instance URL primary used for REST.
no default
RequiredSpEL

Syncope instance URL primary used for REST.

Type
String
Default
none
Defined by
SyncopePrincipalAttributesProperties
Supports
Spring Expression Language
cas.authn.attribute-repository.syncope.attribute-mappingsMap of attributes that optionally may be used to control the names of the collected attributes from Syncope.
no default

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 lastLoginDate->lastDate will process the Syncope attribute lastLoginDate and will internally rename that to lastDate. If no mapping is specified, CAS defaults will be used instead.

Type
Map<String,String>
Default
none
Defined by
SyncopePrincipalAttributesProperties
cas.authn.attribute-repository.syncope.headersHeaders, defined as a Map, to include in the request when making the REST call.
no default

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.

Type
Map<String,String>
Default
none
Defined by
SyncopePrincipalAttributesProperties
cas.authn.attribute-repository.syncope.idA value can be assigned to this field to uniquely identify this resolver.
no default

A value can be assigned to this field to uniquely identify this resolver.

Type
String
Default
none
Defined by
SyncopePrincipalAttributesProperties
cas.authn.attribute-repository.syncope.include-user-groupsIndicates whether user groups should be included in the attribute resolution.
false

Indicates whether user groups should be included in the attribute resolution. This results in a separate API call to Apache Syncope to fetch user groups after the user attributes have been resolved.

Type
Boolean
Default
false
Defined by
SyncopePrincipalAttributesProperties
cas.authn.attribute-repository.syncope.orderThe order of this attribute repository in the chain of repositories.
0

The order of this attribute repository in the chain of repositories. Can be used to explicitly position this source in chain and affects merging strategies.

Type
Integer
Default
0
Defined by
SyncopePrincipalAttributesProperties
cas.authn.attribute-repository.syncope.stateWhether attribute resolution based on this source is enabled.
active
Whether attribute resolution based on this source is enabled. Available values are as follows:
  • ACTIVE: Active and enabled repository, and is invoked by default automatically.
  • DISABLED: Attribute repository is disabled and will not be used to resolve people and attributes.
  • STANDBY: Repository is in a semi-enabled state, waiting to be called only on-demand when explicitly asked for and will not be registered into the resolution plan.
Type
AttributeRepositoryStates
Default
active
Defined by
SyncopePrincipalAttributesProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

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.

:information_source: 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, especially 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.

Multitenancy

Configuration settings for Syncope attribute resolution can be specified in a multitenant environment. Please review this guide for more information.