RADIUS Authentication
RADIUS support is enabled by only including the following dependency in the overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-radius</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-radius:${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-radius"
}
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-radius"
}
Configuration
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.authn.radius.password-encoder.encoding-algorithm=
The encoding algorithm to use such as
CAS Property:
|
1 |
cas.authn.radius.password-encoder.encoding-algorithm=... |
1
cas:
authn:
radius:
password-encoder:
encoding-algorithm: "..."
1
java -Dcas.authn.radius.password-encoder.encoding-algorithm="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_ENCODING_ALGORITHM="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.encoding-algorithm="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.type=NONE
Define the password encoder type to use. Type may be specified as blank or NONE
to disable password encoding. It may also refer to a fully-qualified class name that implements the Spring Security's PasswordEncoder
interface if you wish you define your own encoder.
-
NONE
: No password encoding (i.e. plain-text) takes place. -
DEFAULT
: Use theDefaultPasswordEncoder
of CAS. For message-digest algorithms viacharacter-encoding
andencoding-algorithm
. -
BCRYPT
: Use theBCryptPasswordEncoder
based on the strength provided and an optional secret. -
SCRYPT
: Use theSCryptPasswordEncoder
. -
PBKDF2
: Use thePbkdf2PasswordEncoder
based on the strength provided and an optional secret. -
STANDARD
: Use theStandardPasswordEncoder
based on the secret provided. -
SSHA
: Use theLdapShaPasswordEncoder
supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA} or {SSHA} prepended to the encoded hash. -
GLIBC_CRYPT
: Use theGlibcCryptPasswordEncoder
based on theencoding-algorithm
, strength provided and an optional secret. -
org.example.MyEncoder
: An implementation ofPasswordEncoder
of your own choosing. -
file:///path/to/script.groovy
: Path to a Groovy script charged with handling password encoding operations.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.type
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.
.properties
files:
1
cas.authn.radius.password-encoder.type=NONE
1
cas:
authn:
radius:
password-encoder:
type: "NONE"
1
java -Dcas.authn.radius.password-encoder.type="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_TYPE="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.type="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.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
.
org.apereo.cas.configuration.model.core.authentication.GroovyPrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.groovy.location
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.
.properties
files:
1
cas.authn.radius.principal-transformation.groovy.location=...
1
cas:
authn:
radius:
principal-transformation:
groovy:
location: "..."
1
java -Dcas.authn.radius.principal-transformation.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.client.inet-address=localhost
Server address to connect and establish a session.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.radius.client.inet-address
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.
.properties
files:
1
cas.authn.radius.client.inet-address=localhost
1
cas:
authn:
radius:
client:
inet-address: "localhost"
1
java -Dcas.authn.radius.client.inet-address="localhost" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_CLIENT_INET_ADDRESS="localhost"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.client.inet-address="localhost"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.client.shared-secret=N0Sh@ar3d$ecReT
Secret/password to use for the initial bind.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.radius.client.shared-secret
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.
.properties
files:
1
cas.authn.radius.client.shared-secret=N0Sh@ar3d$ecReT
1
cas:
authn:
radius:
client:
shared-secret: "N0Sh@ar3d$ecReT"
1
java -Dcas.authn.radius.client.shared-secret="N0Sh@ar3d$ecReT" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_CLIENT_SHARED_SECRET="N0Sh@ar3d$ecReT"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.client.shared-secret="N0Sh@ar3d$ecReT"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is
CAS Property:
|
1 |
cas.authn.radius.password-encoder.character-encoding=UTF-8 |
1
cas:
authn:
radius:
password-encoder:
character-encoding: "UTF-8"
1
java -Dcas.authn.radius.password-encoder.character-encoding="UTF-8" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_CHARACTER_ENCODING="UTF-8"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.character-encoding="UTF-8"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.hash-length=16
When used by PasswordEncoderTypes#ARGON2
, it indicates the hash strength/length.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.hash-length
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.
.properties
files:
1
cas.authn.radius.password-encoder.hash-length=16
1
cas:
authn:
radius:
password-encoder:
hash-length: "16"
1
java -Dcas.authn.radius.password-encoder.hash-length="16" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_HASH_LENGTH="16"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.hash-length="16"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.iterations=310000
When used by PasswordEncoderTypes#PBKDF2
, it indicates the required number of iterations.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.iterations
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.
.properties
files:
1
cas.authn.radius.password-encoder.iterations=310000
1
cas:
authn:
radius:
password-encoder:
iterations: "310000"
1
java -Dcas.authn.radius.password-encoder.iterations="310000" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_ITERATIONS="310000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.iterations="310000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.secret=
Secret to use with PasswordEncoderTypes#STANDARD
, PasswordEncoderTypes#PBKDF2
, PasswordEncoderTypes#BCRYPT
, PasswordEncoderTypes#GLIBC_CRYPT
password encoders. Secret usually is an optional setting.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.secret
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.
.properties
files:
1
cas.authn.radius.password-encoder.secret=...
1
cas:
authn:
radius:
password-encoder:
secret: "..."
1
java -Dcas.authn.radius.password-encoder.secret="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_SECRET="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.secret="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.strength=16
Strength or number of iterations to use for password hashing. Usually relevant when dealing with PasswordEncoderTypes#BCRYPT
, PasswordEncoderTypes#PBKDF2
or PasswordEncoderTypes#GLIBC_CRYPT
. When used by PasswordEncoderTypes#ARGON2
or PasswordEncoderTypes#PBKDF2
, it indicates the salt strength.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.strength
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.
.properties
files:
1
cas.authn.radius.password-encoder.strength=16
1
cas:
authn:
radius:
password-encoder:
strength: "16"
1
java -Dcas.authn.radius.password-encoder.strength="16" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_STRENGTH="16"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.strength="16"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.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.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.blocking-pattern
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.
.properties
files:
1
cas.authn.radius.principal-transformation.blocking-pattern=...
1
cas:
authn:
radius:
principal-transformation:
blocking-pattern: "..."
1
java -Dcas.authn.radius.principal-transformation.blocking-pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_BLOCKING_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.blocking-pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
-
NONE
: No conversion. -
LOWERCASE
: Lowercase conversion. -
UPPERCASE
: Uppercase conversion.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.case-conversion
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.
.properties
files:
1
cas.authn.radius.principal-transformation.case-conversion=NONE
1
cas:
authn:
radius:
principal-transformation:
case-conversion: "NONE"
1
java -Dcas.authn.radius.principal-transformation.case-conversion="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_CASE_CONVERSION="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.case-conversion="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.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.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.pattern
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.
.properties
files:
1
cas.authn.radius.principal-transformation.pattern=...
1
cas:
authn:
radius:
principal-transformation:
pattern: "..."
1
java -Dcas.authn.radius.principal-transformation.pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.prefix
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.
.properties
files:
1
cas.authn.radius.principal-transformation.prefix=...
1
cas:
authn:
radius:
principal-transformation:
prefix: "..."
1
java -Dcas.authn.radius.principal-transformation.prefix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_PREFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.prefix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.suffix
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.
.properties
files:
1
cas.authn.radius.principal-transformation.suffix=...
1
cas:
authn:
radius:
principal-transformation:
suffix: "..."
1
java -Dcas.authn.radius.principal-transformation.suffix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_SUFFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.suffix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.client.accounting-port=1813
The accounting port.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.radius.client.accounting-port
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.
.properties
files:
1
cas.authn.radius.client.accounting-port=1813
1
cas:
authn:
radius:
client:
accounting-port: "1813"
1
java -Dcas.authn.radius.client.accounting-port="1813" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_CLIENT_ACCOUNTING_PORT="1813"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.client.accounting-port="1813"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.client.authentication-port=1812
The authentication port.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.radius.client.authentication-port
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.
.properties
files:
1
cas.authn.radius.client.authentication-port=1812
1
cas:
authn:
radius:
client:
authentication-port: "1812"
1
java -Dcas.authn.radius.client.authentication-port="1812" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_CLIENT_AUTHENTICATION_PORT="1812"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.client.authentication-port="1812"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.client.socket-timeout=0
Socket connection timeout in milliseconds.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.radius.client.socket-timeout
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.
.properties
files:
1
cas.authn.radius.client.socket-timeout=0
1
cas:
authn:
radius:
client:
socket-timeout: "0"
1
java -Dcas.authn.radius.client.socket-timeout="0" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_CLIENT_SOCKET_TIMEOUT="0"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.client.socket-timeout="0"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.client.transport-type=UDP
Transport type to use by this client to connect to the server. Available values are as follows:
-
UDP
: Default. UDP client transport type. -
RADSEC
: RadSec is a protocol which allows RADIUS servers to transfer data over TCP and TLS for increased security.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.radius.client.transport-type
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.
.properties
files:
1
cas.authn.radius.client.transport-type=UDP
1
cas:
authn:
radius:
client:
transport-type: "UDP"
1
java -Dcas.authn.radius.client.transport-type="UDP" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_CLIENT_TRANSPORT_TYPE="UDP"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.client.transport-type="UDP"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.failover-on-authentication-failure=false
Whether authentication errors should be skipped and fail over to the next server.
org.apereo.cas.configuration.model.support.radius.RadiusProperties.
CAS Property: cas.authn.radius.failover-on-authentication-failure
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.
.properties
files:
1
cas.authn.radius.failover-on-authentication-failure=...
1
cas:
authn:
radius:
failover-on-authentication-failure: "..."
1
java -Dcas.authn.radius.failover-on-authentication-failure="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_FAILOVER_ON_AUTHENTICATION_FAILURE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.failover-on-authentication-failure="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.failover-on-exception=false
Whether catastrophic errors should be skipped and fail over to the next server.
org.apereo.cas.configuration.model.support.radius.RadiusProperties.
CAS Property: cas.authn.radius.failover-on-exception
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.
.properties
files:
1
cas.authn.radius.failover-on-exception=...
1
cas:
authn:
radius:
failover-on-exception: "..."
1
java -Dcas.authn.radius.failover-on-exception="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_FAILOVER_ON_EXCEPTION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.failover-on-exception="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.name=
The name of the authentication handler.
org.apereo.cas.configuration.model.support.radius.RadiusProperties.
CAS Property: cas.authn.radius.name
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.
.properties
files:
1
cas.authn.radius.name=...
1
cas:
authn:
radius:
name: "..."
1
java -Dcas.authn.radius.name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.server.nas-identifier=
The NAS identifier.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.radius.server.nas-identifier
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.
.properties
files:
1
cas.authn.radius.server.nas-identifier=...
1
cas:
authn:
radius:
server:
nas-identifier: "..."
1
java -Dcas.authn.radius.server.nas-identifier="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_SERVER_NAS_IDENTIFIER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.server.nas-identifier="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.server.nas-ip-address=
The NAS IP address.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.radius.server.nas-ip-address
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.
.properties
files:
1
cas.authn.radius.server.nas-ip-address=...
1
cas:
authn:
radius:
server:
nas-ip-address: "..."
1
java -Dcas.authn.radius.server.nas-ip-address="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_SERVER_NAS_IP_ADDRESS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.server.nas-ip-address="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.server.nas-ipv6-address=
The NAS IPv6 address.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.radius.server.nas-ipv6-address
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.
.properties
files:
1
cas.authn.radius.server.nas-ipv6-address=...
1
cas:
authn:
radius:
server:
nas-ipv6-address: "..."
1
java -Dcas.authn.radius.server.nas-ipv6-address="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_SERVER_NAS_IPV6_ADDRESS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.server.nas-ipv6-address="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.server.nas-port=-1
The NAS port.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.radius.server.nas-port
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.
.properties
files:
1
cas.authn.radius.server.nas-port=-1
1
cas:
authn:
radius:
server:
nas-port: "-1"
1
java -Dcas.authn.radius.server.nas-port="-1" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_SERVER_NAS_PORT="-1"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.server.nas-port="-1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.server.nas-port-id=-1
The NAS port id.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.radius.server.nas-port-id
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.
.properties
files:
1
cas.authn.radius.server.nas-port-id=-1
1
cas:
authn:
radius:
server:
nas-port-id: "-1"
1
java -Dcas.authn.radius.server.nas-port-id="-1" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_SERVER_NAS_PORT_ID="-1"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.server.nas-port-id="-1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.server.nas-port-type=-1
The NAS port type.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.radius.server.nas-port-type
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.
.properties
files:
1
cas.authn.radius.server.nas-port-type=-1
1
cas:
authn:
radius:
server:
nas-port-type: "-1"
1
java -Dcas.authn.radius.server.nas-port-type="-1" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_SERVER_NAS_PORT_TYPE="-1"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.server.nas-port-type="-1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.server.nas-real-port=-1
The NAS real port.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.radius.server.nas-real-port
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.
.properties
files:
1
cas.authn.radius.server.nas-real-port=-1
1
cas:
authn:
radius:
server:
nas-real-port: "-1"
1
java -Dcas.authn.radius.server.nas-real-port="-1" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_SERVER_NAS_REAL_PORT="-1"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.server.nas-real-port="-1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.server.protocol=EAP_MSCHAPv2
Radius protocol to use when communicating with the server.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.radius.server.protocol
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.
.properties
files:
1
cas.authn.radius.server.protocol=EAP_MSCHAPv2
1
cas:
authn:
radius:
server:
protocol: "EAP_MSCHAPv2"
1
java -Dcas.authn.radius.server.protocol="EAP_MSCHAPv2" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_SERVER_PROTOCOL="EAP_MSCHAPv2"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.server.protocol="EAP_MSCHAPv2"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.server.retries=3
Number of re-try attempts when dealing with connection and authentication failures.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.radius.server.retries
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.
.properties
files:
1
cas.authn.radius.server.retries=3
1
cas:
authn:
radius:
server:
retries: "3"
1
java -Dcas.authn.radius.server.retries="3" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_SERVER_RETRIES="3"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.server.retries="3"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.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:
-
ACTIVE
: Active authentication handler, and is invoked by default automatically to verify credentials globally. -
STANDBY
: Authentication handler is in a semi-enabled state, waiting to be called only on-demand when explicitly asked for.
org.apereo.cas.configuration.model.support.radius.RadiusProperties.
CAS Property: cas.authn.radius.state
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.
.properties
files:
1
cas.authn.radius.state=...
1
cas:
authn:
radius:
state: "..."
1
java -Dcas.authn.radius.state="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_STATE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.state="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Please review this guide to configure your build.
cas.authn.radius.password-encoder.encoding-algorithm=
The encoding algorithm to use such as
CAS Property:
|
1 |
cas.authn.radius.password-encoder.encoding-algorithm=... |
1
cas:
authn:
radius:
password-encoder:
encoding-algorithm: "..."
1
java -Dcas.authn.radius.password-encoder.encoding-algorithm="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_ENCODING_ALGORITHM="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.encoding-algorithm="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.type=NONE
Define the password encoder type to use. Type may be specified as blank or NONE
to disable password encoding. It may also refer to a fully-qualified class name that implements the Spring Security's PasswordEncoder
interface if you wish you define your own encoder.
-
NONE
: No password encoding (i.e. plain-text) takes place. -
DEFAULT
: Use theDefaultPasswordEncoder
of CAS. For message-digest algorithms viacharacter-encoding
andencoding-algorithm
. -
BCRYPT
: Use theBCryptPasswordEncoder
based on the strength provided and an optional secret. -
SCRYPT
: Use theSCryptPasswordEncoder
. -
PBKDF2
: Use thePbkdf2PasswordEncoder
based on the strength provided and an optional secret. -
STANDARD
: Use theStandardPasswordEncoder
based on the secret provided. -
SSHA
: Use theLdapShaPasswordEncoder
supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA} or {SSHA} prepended to the encoded hash. -
GLIBC_CRYPT
: Use theGlibcCryptPasswordEncoder
based on theencoding-algorithm
, strength provided and an optional secret. -
org.example.MyEncoder
: An implementation ofPasswordEncoder
of your own choosing. -
file:///path/to/script.groovy
: Path to a Groovy script charged with handling password encoding operations.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.type
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.
.properties
files:
1
cas.authn.radius.password-encoder.type=NONE
1
cas:
authn:
radius:
password-encoder:
type: "NONE"
1
java -Dcas.authn.radius.password-encoder.type="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_TYPE="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.type="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is DEFAULT
.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.character-encoding
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.
.properties
files:
1
cas.authn.radius.password-encoder.character-encoding=UTF-8
1
cas:
authn:
radius:
password-encoder:
character-encoding: "UTF-8"
1
java -Dcas.authn.radius.password-encoder.character-encoding="UTF-8" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_CHARACTER_ENCODING="UTF-8"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.character-encoding="UTF-8"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.hash-length=16
When used by PasswordEncoderTypes#ARGON2
, it indicates the hash strength/length.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.hash-length
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.
.properties
files:
1
cas.authn.radius.password-encoder.hash-length=16
1
cas:
authn:
radius:
password-encoder:
hash-length: "16"
1
java -Dcas.authn.radius.password-encoder.hash-length="16" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_HASH_LENGTH="16"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.hash-length="16"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.iterations=310000
When used by PasswordEncoderTypes#PBKDF2
, it indicates the required number of iterations.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.iterations
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.
.properties
files:
1
cas.authn.radius.password-encoder.iterations=310000
1
cas:
authn:
radius:
password-encoder:
iterations: "310000"
1
java -Dcas.authn.radius.password-encoder.iterations="310000" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_ITERATIONS="310000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.iterations="310000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.secret=
Secret to use with PasswordEncoderTypes#STANDARD
, PasswordEncoderTypes#PBKDF2
, PasswordEncoderTypes#BCRYPT
, PasswordEncoderTypes#GLIBC_CRYPT
password encoders. Secret usually is an optional setting.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.secret
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.
.properties
files:
1
cas.authn.radius.password-encoder.secret=...
1
cas:
authn:
radius:
password-encoder:
secret: "..."
1
java -Dcas.authn.radius.password-encoder.secret="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_SECRET="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.secret="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.password-encoder.strength=16
Strength or number of iterations to use for password hashing. Usually relevant when dealing with PasswordEncoderTypes#BCRYPT
, PasswordEncoderTypes#PBKDF2
or PasswordEncoderTypes#GLIBC_CRYPT
. When used by PasswordEncoderTypes#ARGON2
or PasswordEncoderTypes#PBKDF2
, it indicates the salt strength.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.radius.password-encoder.strength
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.
.properties
files:
1
cas.authn.radius.password-encoder.strength=16
1
cas:
authn:
radius:
password-encoder:
strength: "16"
1
java -Dcas.authn.radius.password-encoder.strength="16" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PASSWORD_ENCODER_STRENGTH="16"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.password-encoder.strength="16"
cas.war
with an embedded server container and can be found in the build/libs
directory.
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.
cas.authn.radius.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 Property:
|
1 |
cas.authn.radius.principal-transformation.groovy.location=... |
1
cas:
authn:
radius:
principal-transformation:
groovy:
location: "..."
1
java -Dcas.authn.radius.principal-transformation.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.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.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.blocking-pattern
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.
.properties
files:
1
cas.authn.radius.principal-transformation.blocking-pattern=...
1
cas:
authn:
radius:
principal-transformation:
blocking-pattern: "..."
1
java -Dcas.authn.radius.principal-transformation.blocking-pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_BLOCKING_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.blocking-pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
-
NONE
: No conversion. -
LOWERCASE
: Lowercase conversion. -
UPPERCASE
: Uppercase conversion.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.case-conversion
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.
.properties
files:
1
cas.authn.radius.principal-transformation.case-conversion=NONE
1
cas:
authn:
radius:
principal-transformation:
case-conversion: "NONE"
1
java -Dcas.authn.radius.principal-transformation.case-conversion="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_CASE_CONVERSION="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.case-conversion="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.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.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.pattern
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.
.properties
files:
1
cas.authn.radius.principal-transformation.pattern=...
1
cas:
authn:
radius:
principal-transformation:
pattern: "..."
1
java -Dcas.authn.radius.principal-transformation.pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.prefix
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.
.properties
files:
1
cas.authn.radius.principal-transformation.prefix=...
1
cas:
authn:
radius:
principal-transformation:
prefix: "..."
1
java -Dcas.authn.radius.principal-transformation.prefix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_PREFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.prefix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.radius.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.radius.principal-transformation.suffix
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.
.properties
files:
1
cas.authn.radius.principal-transformation.suffix=...
1
cas:
authn:
radius:
principal-transformation:
suffix: "..."
1
java -Dcas.authn.radius.principal-transformation.suffix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_RADIUS_PRINCIPAL_TRANSFORMATION_SUFFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.radius.principal-transformation.suffix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
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")
}
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.
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.
RSA RADIUS MFA
RSA RADIUS OTP support for MFA is enabled by only including the following dependency in the overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-radius-mfa</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-radius-mfa:${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-radius-mfa"
}
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-radius-mfa"
}
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.authn.mfa.radius.bypass.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 Property:
|
1 |
cas.authn.mfa.radius.bypass.groovy.location=... |
1
cas:
authn:
mfa:
radius:
bypass:
groovy:
location: "..."
1
java -Dcas.authn.mfa.radius.bypass.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.rest.url=
The endpoint URL to contact and retrieve attributes.
org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.rest.url
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.rest.url=...
1
cas:
authn:
mfa:
radius:
bypass:
rest:
url: "..."
1
java -Dcas.authn.mfa.radius.bypass.rest.url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_REST_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.rest.url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.client.inet-address=localhost
Server address to connect and establish a session.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.mfa.radius.client.inet-address
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.
.properties
files:
1
cas.authn.mfa.radius.client.inet-address=localhost
1
cas:
authn:
mfa:
radius:
client:
inet-address: "localhost"
1
java -Dcas.authn.mfa.radius.client.inet-address="localhost" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_CLIENT_INET_ADDRESS="localhost"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.client.inet-address="localhost"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.client.shared-secret=N0Sh@ar3d$ecReT
Secret/password to use for the initial bind.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.mfa.radius.client.shared-secret
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.
.properties
files:
1
cas.authn.mfa.radius.client.shared-secret=N0Sh@ar3d$ecReT
1
cas:
authn:
mfa:
radius:
client:
shared-secret: "N0Sh@ar3d$ecReT"
1
java -Dcas.authn.mfa.radius.client.shared-secret="N0Sh@ar3d$ecReT" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_CLIENT_SHARED_SECRET="N0Sh@ar3d$ecReT"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.client.shared-secret="N0Sh@ar3d$ecReT"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.authentication-attribute-name=
Skip multifactor authentication based on designated authentication attribute names.
CAS Property:
|
1 |
cas.authn.mfa.radius.bypass.authentication-attribute-name=... |
1
cas:
authn:
mfa:
radius:
bypass:
authentication-attribute-name: "..."
1
java -Dcas.authn.mfa.radius.bypass.authentication-attribute-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_AUTHENTICATION_ATTRIBUTE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.authentication-attribute-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.authentication-attribute-value=
Optionally, skip multifactor authentication based on designated authentication attribute values. Multiple values may be separated by a comma.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.authentication-attribute-value
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.authentication-attribute-value=...
1
cas:
authn:
mfa:
radius:
bypass:
authentication-attribute-value: "..."
1
java -Dcas.authn.mfa.radius.bypass.authentication-attribute-value="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_AUTHENTICATION_ATTRIBUTE_VALUE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.authentication-attribute-value="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.authentication-handler-name=
Skip multifactor authentication depending on form of primary authentication execution. Specifically, skip multifactor if the a particular authentication handler noted by its name successfully is able to authenticate credentials in the primary factor. Multiple values may be separated by a comma.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.authentication-handler-name
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.authentication-handler-name=...
1
cas:
authn:
mfa:
radius:
bypass:
authentication-handler-name: "..."
1
java -Dcas.authn.mfa.radius.bypass.authentication-handler-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_AUTHENTICATION_HANDLER_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.authentication-handler-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.authentication-method-name=
Skip multifactor authentication depending on method/form of primary authentication execution. Specifically, skip multifactor if the authentication method attribute collected as part of authentication metadata matches a certain value. Multiple values may be separated by a comma.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.authentication-method-name
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.authentication-method-name=...
1
cas:
authn:
mfa:
radius:
bypass:
authentication-method-name: "..."
1
java -Dcas.authn.mfa.radius.bypass.authentication-method-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_AUTHENTICATION_METHOD_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.authentication-method-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.credential-class-type=
Skip multifactor authentication depending on form of primary credentials. Value must equal the fully qualified class name of the credential type.
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.credential-class-type
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.credential-class-type=...
1
cas:
authn:
mfa:
radius:
bypass:
credential-class-type: "..."
1
java -Dcas.authn.mfa.radius.bypass.credential-class-type="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_CREDENTIAL_CLASS_TYPE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.credential-class-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.http-request-headers=
Skip multifactor authentication if the http request contains the defined header names. Header names may be comma-separated and can be regular expressions; values are ignored.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.http-request-headers
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.http-request-headers=...
1
cas:
authn:
mfa:
radius:
bypass:
http-request-headers: "..."
1
java -Dcas.authn.mfa.radius.bypass.http-request-headers="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_HTTP_REQUEST_HEADERS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.http-request-headers="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.http-request-remote-address=
Skip multifactor authentication if the http request's remote address or host matches the value defined here. The value may be specified as a regular expression.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.http-request-remote-address
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.http-request-remote-address=...
1
cas:
authn:
mfa:
radius:
bypass:
http-request-remote-address: "..."
1
java -Dcas.authn.mfa.radius.bypass.http-request-remote-address="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_HTTP_REQUEST_REMOTE_ADDRESS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.http-request-remote-address="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.principal-attribute-name=
Skip multifactor authentication based on designated principal attribute names.
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.principal-attribute-name
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.principal-attribute-name=...
1
cas:
authn:
mfa:
radius:
bypass:
principal-attribute-name: "..."
1
java -Dcas.authn.mfa.radius.bypass.principal-attribute-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_PRINCIPAL_ATTRIBUTE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.principal-attribute-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.principal-attribute-value=
Optionally, skip multifactor authentication based on designated principal attribute values.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.principal-attribute-value
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.principal-attribute-value=...
1
cas:
authn:
mfa:
radius:
bypass:
principal-attribute-value: "..."
1
java -Dcas.authn.mfa.radius.bypass.principal-attribute-value="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_PRINCIPAL_ATTRIBUTE_VALUE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.principal-attribute-value="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.rest.basic-auth-password=
If REST endpoint is protected via basic authentication, specify the password for authentication.
org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.rest.basic-auth-password
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.rest.basic-auth-password=...
1
cas:
authn:
mfa:
radius:
bypass:
rest:
basic-auth-password: "..."
1
java -Dcas.authn.mfa.radius.bypass.rest.basic-auth-password="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_REST_BASIC_AUTH_PASSWORD="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.rest.basic-auth-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.rest.basic-auth-username=
If REST endpoint is protected via basic authentication, specify the username for authentication.
org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.rest.basic-auth-username
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.rest.basic-auth-username=...
1
cas:
authn:
mfa:
radius:
bypass:
rest:
basic-auth-username: "..."
1
java -Dcas.authn.mfa.radius.bypass.rest.basic-auth-username="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_REST_BASIC_AUTH_USERNAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.rest.basic-auth-username="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.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.
org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.rest.headers
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.rest.headers=...
1
cas:
authn:
mfa:
radius:
bypass:
rest:
headers: "..."
1
java -Dcas.authn.mfa.radius.bypass.rest.headers="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_REST_HEADERS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.rest.headers="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.rest.method=GET
HTTP method to use when contacting the rest endpoint. Examples include GET, POST
, etc.
org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.rest.method
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.rest.method=GET
1
cas:
authn:
mfa:
radius:
bypass:
rest:
method: "GET"
1
java -Dcas.authn.mfa.radius.bypass.rest.method="GET" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_REST_METHOD="GET"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.rest.method="GET"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.client.accounting-port=1813
The accounting port.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.mfa.radius.client.accounting-port
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.
.properties
files:
1
cas.authn.mfa.radius.client.accounting-port=1813
1
cas:
authn:
mfa:
radius:
client:
accounting-port: "1813"
1
java -Dcas.authn.mfa.radius.client.accounting-port="1813" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_CLIENT_ACCOUNTING_PORT="1813"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.client.accounting-port="1813"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.client.authentication-port=1812
The authentication port.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.mfa.radius.client.authentication-port
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.
.properties
files:
1
cas.authn.mfa.radius.client.authentication-port=1812
1
cas:
authn:
mfa:
radius:
client:
authentication-port: "1812"
1
java -Dcas.authn.mfa.radius.client.authentication-port="1812" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_CLIENT_AUTHENTICATION_PORT="1812"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.client.authentication-port="1812"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.client.socket-timeout=0
Socket connection timeout in milliseconds.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.mfa.radius.client.socket-timeout
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.
.properties
files:
1
cas.authn.mfa.radius.client.socket-timeout=0
1
cas:
authn:
mfa:
radius:
client:
socket-timeout: "0"
1
java -Dcas.authn.mfa.radius.client.socket-timeout="0" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_CLIENT_SOCKET_TIMEOUT="0"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.client.socket-timeout="0"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.client.transport-type=UDP
Transport type to use by this client to connect to the server. Available values are as follows:
-
UDP
: Default. UDP client transport type. -
RADSEC
: RadSec is a protocol which allows RADIUS servers to transfer data over TCP and TLS for increased security.
org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.
CAS Property: cas.authn.mfa.radius.client.transport-type
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.
.properties
files:
1
cas.authn.mfa.radius.client.transport-type=UDP
1
cas:
authn:
mfa:
radius:
client:
transport-type: "UDP"
1
java -Dcas.authn.mfa.radius.client.transport-type="UDP" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_CLIENT_TRANSPORT_TYPE="UDP"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.client.transport-type="UDP"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.server.nas-identifier=
The NAS identifier.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.mfa.radius.server.nas-identifier
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.
.properties
files:
1
cas.authn.mfa.radius.server.nas-identifier=...
1
cas:
authn:
mfa:
radius:
server:
nas-identifier: "..."
1
java -Dcas.authn.mfa.radius.server.nas-identifier="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_SERVER_NAS_IDENTIFIER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.server.nas-identifier="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.server.nas-ip-address=
The NAS IP address.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.mfa.radius.server.nas-ip-address
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.
.properties
files:
1
cas.authn.mfa.radius.server.nas-ip-address=...
1
cas:
authn:
mfa:
radius:
server:
nas-ip-address: "..."
1
java -Dcas.authn.mfa.radius.server.nas-ip-address="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_SERVER_NAS_IP_ADDRESS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.server.nas-ip-address="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.server.nas-ipv6-address=
The NAS IPv6 address.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.mfa.radius.server.nas-ipv6-address
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.
.properties
files:
1
cas.authn.mfa.radius.server.nas-ipv6-address=...
1
cas:
authn:
mfa:
radius:
server:
nas-ipv6-address: "..."
1
java -Dcas.authn.mfa.radius.server.nas-ipv6-address="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_SERVER_NAS_IPV6_ADDRESS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.server.nas-ipv6-address="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.server.nas-port=-1
The NAS port.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.mfa.radius.server.nas-port
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.
.properties
files:
1
cas.authn.mfa.radius.server.nas-port=-1
1
cas:
authn:
mfa:
radius:
server:
nas-port: "-1"
1
java -Dcas.authn.mfa.radius.server.nas-port="-1" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_SERVER_NAS_PORT="-1"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.server.nas-port="-1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.server.nas-port-id=-1
The NAS port id.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.mfa.radius.server.nas-port-id
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.
.properties
files:
1
cas.authn.mfa.radius.server.nas-port-id=-1
1
cas:
authn:
mfa:
radius:
server:
nas-port-id: "-1"
1
java -Dcas.authn.mfa.radius.server.nas-port-id="-1" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_SERVER_NAS_PORT_ID="-1"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.server.nas-port-id="-1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.server.nas-port-type=-1
The NAS port type.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.mfa.radius.server.nas-port-type
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.
.properties
files:
1
cas.authn.mfa.radius.server.nas-port-type=-1
1
cas:
authn:
mfa:
radius:
server:
nas-port-type: "-1"
1
java -Dcas.authn.mfa.radius.server.nas-port-type="-1" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_SERVER_NAS_PORT_TYPE="-1"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.server.nas-port-type="-1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.server.nas-real-port=-1
The NAS real port.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.mfa.radius.server.nas-real-port
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.
.properties
files:
1
cas.authn.mfa.radius.server.nas-real-port=-1
1
cas:
authn:
mfa:
radius:
server:
nas-real-port: "-1"
1
java -Dcas.authn.mfa.radius.server.nas-real-port="-1" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_SERVER_NAS_REAL_PORT="-1"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.server.nas-real-port="-1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.server.protocol=EAP_MSCHAPv2
Radius protocol to use when communicating with the server.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.mfa.radius.server.protocol
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.
.properties
files:
1
cas.authn.mfa.radius.server.protocol=EAP_MSCHAPv2
1
cas:
authn:
mfa:
radius:
server:
protocol: "EAP_MSCHAPv2"
1
java -Dcas.authn.mfa.radius.server.protocol="EAP_MSCHAPv2" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_SERVER_PROTOCOL="EAP_MSCHAPv2"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.server.protocol="EAP_MSCHAPv2"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.server.retries=3
Number of re-try attempts when dealing with connection and authentication failures.
org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.
CAS Property: cas.authn.mfa.radius.server.retries
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.
.properties
files:
1
cas.authn.mfa.radius.server.retries=3
1
cas:
authn:
mfa:
radius:
server:
retries: "3"
1
java -Dcas.authn.mfa.radius.server.retries="3" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_SERVER_RETRIES="3"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.server.retries="3"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.allowed-authentication-attempts=-1
Total number of allowed authentication attempts with the radius mfa server before the authentication event is considered cancelled. A negative/zero value indicates that no limit is enforced.
org.apereo.cas.configuration.model.support.mfa.RadiusMultifactorAuthenticationProperties.
CAS Property: cas.authn.mfa.radius.allowed-authentication-attempts
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.
.properties
files:
1
cas.authn.mfa.radius.allowed-authentication-attempts=-1
1
cas:
authn:
mfa:
radius:
allowed-authentication-attempts: "-1"
1
java -Dcas.authn.mfa.radius.allowed-authentication-attempts="-1" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_ALLOWED_AUTHENTICATION_ATTEMPTS="-1"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.allowed-authentication-attempts="-1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.failover-on-authentication-failure=false
In the event that radius authentication fails, fail over to the next server in the list.
org.apereo.cas.configuration.model.support.mfa.RadiusMultifactorAuthenticationProperties.
CAS Property: cas.authn.mfa.radius.failover-on-authentication-failure
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.
.properties
files:
1
cas.authn.mfa.radius.failover-on-authentication-failure=...
1
cas:
authn:
mfa:
radius:
failover-on-authentication-failure: "..."
1
java -Dcas.authn.mfa.radius.failover-on-authentication-failure="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_FAILOVER_ON_AUTHENTICATION_FAILURE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.failover-on-authentication-failure="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.failover-on-exception=false
In the event that radius authentication fails due to a catastrophic event, fail over to the next server in the list.
org.apereo.cas.configuration.model.support.mfa.RadiusMultifactorAuthenticationProperties.
CAS Property: cas.authn.mfa.radius.failover-on-exception
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.
.properties
files:
1
cas.authn.mfa.radius.failover-on-exception=...
1
cas:
authn:
mfa:
radius:
failover-on-exception: "..."
1
java -Dcas.authn.mfa.radius.failover-on-exception="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_FAILOVER_ON_EXCEPTION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.failover-on-exception="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.failure-mode=CLOSED
The failure mode policy for this MFA provider. The authentication policy by default supports fail-closed mode, which means that if you attempt to exercise a particular provider available to CAS and the provider cannot be reached, authentication will be stopped and an error will be displayed. You can of course change this behavior so that authentication proceeds without exercising the provider functionality, if that provider cannot respond. Each defined multifactor authentication provider can set its own failure mode policy. Failure modes set at this location will override the global failure mode, but defer to any failure mode set by the registered service. Available values are as follows:
-
OPEN
: Disallow MFA, proceed with authentication but don't communicate MFA to the RP. -
CLOSED
: Disallow MFA, block with authentication. -
PHANTOM
: Disallow MFA, proceed with authentication and communicate MFA to the RP. -
NONE
: Do not check for failure at all. -
UNDEFINED
: The default one indicating that no failure mode is set at all.
org.apereo.cas.configuration.model.support.mfa.RadiusMultifactorAuthenticationProperties.
CAS Property: cas.authn.mfa.radius.failure-mode
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.
.properties
files:
1
cas.authn.mfa.radius.failure-mode=CLOSED
1
cas:
authn:
mfa:
radius:
failure-mode: "CLOSED"
1
java -Dcas.authn.mfa.radius.failure-mode="CLOSED" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_FAILURE_MODE="CLOSED"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.failure-mode="CLOSED"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.id=
The identifier for the multifactor provider. In most cases, this need not be configured explicitly, unless multiple instances of the same provider type are configured in CAS.
org.apereo.cas.configuration.model.support.mfa.RadiusMultifactorAuthenticationProperties.
CAS Property: cas.authn.mfa.radius.id
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.
.properties
files:
1
cas.authn.mfa.radius.id=...
1
cas:
authn:
mfa:
radius:
id: "..."
1
java -Dcas.authn.mfa.radius.id="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_ID="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.id="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.name=
The name of the authentication handler used to verify credentials in MFA. Remember that if you have more than one authentication handler of the same type, the names must be defined uniquely for each authentication scheme. Failing to do so may force CAS to not register authentication handlers with a duplicate name.
org.apereo.cas.configuration.model.support.mfa.RadiusMultifactorAuthenticationProperties.
CAS Property: cas.authn.mfa.radius.name
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.
.properties
files:
1
cas.authn.mfa.radius.name=...
1
cas:
authn:
mfa:
radius:
name: "..."
1
java -Dcas.authn.mfa.radius.name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.order=
The order of the authentication handler in the chain.
org.apereo.cas.configuration.model.support.mfa.RadiusMultifactorAuthenticationProperties.
CAS Property: cas.authn.mfa.radius.order
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.
.properties
files:
1
cas.authn.mfa.radius.order=...
1
cas:
authn:
mfa:
radius:
order: "..."
1
java -Dcas.authn.mfa.radius.order="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_ORDER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.order="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.rank=0
At times, CAS needs to determine the correct provider when step-up authentication is required. Consider for a moment that CAS already has established an SSO session with/without a provider and has reached a level of authentication. Another incoming request attempts to exercise that SSO session with a different and often competing authentication requirement that may differ from the authentication level CAS has already established. Concretely, examples may be:
- CAS has achieved an SSO session, but a separate request now requires step-up authentication with DuoSecurity.
- CAS has achieved an SSO session with an authentication level satisfied by DuoSecurity, but a separate request now requires step-up authentication with YubiKey.
org.apereo.cas.configuration.model.support.mfa.RadiusMultifactorAuthenticationProperties.
CAS Property: cas.authn.mfa.radius.rank
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.
.properties
files:
1
cas.authn.mfa.radius.rank=0
1
cas:
authn:
mfa:
radius:
rank: "0"
1
java -Dcas.authn.mfa.radius.rank="0" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_RANK="0"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.rank="0"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.trusted-device-enabled=false
Indicates whether this provider should support trusted devices.
org.apereo.cas.configuration.model.support.mfa.RadiusMultifactorAuthenticationProperties.
CAS Property: cas.authn.mfa.radius.trusted-device-enabled
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.
.properties
files:
1
cas.authn.mfa.radius.trusted-device-enabled=...
1
cas:
authn:
mfa:
radius:
trusted-device-enabled: "..."
1
java -Dcas.authn.mfa.radius.trusted-device-enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_TRUSTED_DEVICE_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.trusted-device-enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Please review this guide to configure your build.
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.
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.
Bypass
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.authn.mfa.radius.bypass.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 Property:
|
1 |
cas.authn.mfa.radius.bypass.groovy.location=... |
1
cas:
authn:
mfa:
radius:
bypass:
groovy:
location: "..."
1
java -Dcas.authn.mfa.radius.bypass.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.rest.url=
The endpoint URL to contact and retrieve attributes.
org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.rest.url
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.rest.url=...
1
cas:
authn:
mfa:
radius:
bypass:
rest:
url: "..."
1
java -Dcas.authn.mfa.radius.bypass.rest.url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_REST_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.rest.url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.authentication-attribute-name=
Skip multifactor authentication based on designated authentication attribute names.
CAS Property:
|
1 |
cas.authn.mfa.radius.bypass.authentication-attribute-name=... |
1
cas:
authn:
mfa:
radius:
bypass:
authentication-attribute-name: "..."
1
java -Dcas.authn.mfa.radius.bypass.authentication-attribute-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_AUTHENTICATION_ATTRIBUTE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.authentication-attribute-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.authentication-attribute-value=
Optionally, skip multifactor authentication based on designated authentication attribute values. Multiple values may be separated by a comma.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.authentication-attribute-value
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.authentication-attribute-value=...
1
cas:
authn:
mfa:
radius:
bypass:
authentication-attribute-value: "..."
1
java -Dcas.authn.mfa.radius.bypass.authentication-attribute-value="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_AUTHENTICATION_ATTRIBUTE_VALUE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.authentication-attribute-value="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.authentication-handler-name=
Skip multifactor authentication depending on form of primary authentication execution. Specifically, skip multifactor if the a particular authentication handler noted by its name successfully is able to authenticate credentials in the primary factor. Multiple values may be separated by a comma.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.authentication-handler-name
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.authentication-handler-name=...
1
cas:
authn:
mfa:
radius:
bypass:
authentication-handler-name: "..."
1
java -Dcas.authn.mfa.radius.bypass.authentication-handler-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_AUTHENTICATION_HANDLER_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.authentication-handler-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.authentication-method-name=
Skip multifactor authentication depending on method/form of primary authentication execution. Specifically, skip multifactor if the authentication method attribute collected as part of authentication metadata matches a certain value. Multiple values may be separated by a comma.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.authentication-method-name
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.authentication-method-name=...
1
cas:
authn:
mfa:
radius:
bypass:
authentication-method-name: "..."
1
java -Dcas.authn.mfa.radius.bypass.authentication-method-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_AUTHENTICATION_METHOD_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.authentication-method-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.credential-class-type=
Skip multifactor authentication depending on form of primary credentials. Value must equal the fully qualified class name of the credential type.
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.credential-class-type
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.credential-class-type=...
1
cas:
authn:
mfa:
radius:
bypass:
credential-class-type: "..."
1
java -Dcas.authn.mfa.radius.bypass.credential-class-type="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_CREDENTIAL_CLASS_TYPE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.credential-class-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.http-request-headers=
Skip multifactor authentication if the http request contains the defined header names. Header names may be comma-separated and can be regular expressions; values are ignored.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.http-request-headers
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.http-request-headers=...
1
cas:
authn:
mfa:
radius:
bypass:
http-request-headers: "..."
1
java -Dcas.authn.mfa.radius.bypass.http-request-headers="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_HTTP_REQUEST_HEADERS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.http-request-headers="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.http-request-remote-address=
Skip multifactor authentication if the http request's remote address or host matches the value defined here. The value may be specified as a regular expression.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.http-request-remote-address
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.http-request-remote-address=...
1
cas:
authn:
mfa:
radius:
bypass:
http-request-remote-address: "..."
1
java -Dcas.authn.mfa.radius.bypass.http-request-remote-address="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_HTTP_REQUEST_REMOTE_ADDRESS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.http-request-remote-address="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.principal-attribute-name=
Skip multifactor authentication based on designated principal attribute names.
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.principal-attribute-name
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.principal-attribute-name=...
1
cas:
authn:
mfa:
radius:
bypass:
principal-attribute-name: "..."
1
java -Dcas.authn.mfa.radius.bypass.principal-attribute-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_PRINCIPAL_ATTRIBUTE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.principal-attribute-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.principal-attribute-value=
Optionally, skip multifactor authentication based on designated principal attribute values.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.principal-attribute-value
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.principal-attribute-value=...
1
cas:
authn:
mfa:
radius:
bypass:
principal-attribute-value: "..."
1
java -Dcas.authn.mfa.radius.bypass.principal-attribute-value="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_PRINCIPAL_ATTRIBUTE_VALUE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.principal-attribute-value="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.rest.basic-auth-password=
If REST endpoint is protected via basic authentication, specify the password for authentication.
org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.rest.basic-auth-password
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.rest.basic-auth-password=...
1
cas:
authn:
mfa:
radius:
bypass:
rest:
basic-auth-password: "..."
1
java -Dcas.authn.mfa.radius.bypass.rest.basic-auth-password="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_REST_BASIC_AUTH_PASSWORD="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.rest.basic-auth-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.rest.basic-auth-username=
If REST endpoint is protected via basic authentication, specify the username for authentication.
org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.rest.basic-auth-username
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.rest.basic-auth-username=...
1
cas:
authn:
mfa:
radius:
bypass:
rest:
basic-auth-username: "..."
1
java -Dcas.authn.mfa.radius.bypass.rest.basic-auth-username="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_REST_BASIC_AUTH_USERNAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.rest.basic-auth-username="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.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.
org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.rest.headers
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.rest.headers=...
1
cas:
authn:
mfa:
radius:
bypass:
rest:
headers: "..."
1
java -Dcas.authn.mfa.radius.bypass.rest.headers="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_REST_HEADERS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.rest.headers="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.mfa.radius.bypass.rest.method=GET
HTTP method to use when contacting the rest endpoint. Examples include GET, POST
, etc.
org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.
CAS Property: cas.authn.mfa.radius.bypass.rest.method
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.
.properties
files:
1
cas.authn.mfa.radius.bypass.rest.method=GET
1
cas:
authn:
mfa:
radius:
bypass:
rest:
method: "GET"
1
java -Dcas.authn.mfa.radius.bypass.rest.method="GET" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_MFA_RADIUS_BYPASS_REST_METHOD="GET"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.mfa.radius.bypass.rest.method="GET"
cas.war
with an embedded server container and can be found in the build/libs
directory.
Please review this guide to configure your build.
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.
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.