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"
}

Configuration

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

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

  • cas.authn.radius.password-encoder.encoding-algorithm=
  • The encoding algorithm to use such as MD5. Relevant when the type used is DEFAULT or GLIBC_CRYPT.

    org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

  • 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.

    The following types may be used:

    • NONE: No password encoding (i.e. plain-text) takes place.
    • DEFAULT: Use the DefaultPasswordEncoder of CAS. For message-digest algorithms via character-encoding and encoding-algorithm.
    • BCRYPT: Use the BCryptPasswordEncoder based on the strength provided and an optional secret.
    • SCRYPT: Use the SCryptPasswordEncoder.
    • PBKDF2: Use the Pbkdf2PasswordEncoder based on the strength provided and an optional secret.
    • STANDARD: Use the StandardPasswordEncoder based on the secret provided.
    • SSHA: Use the LdapShaPasswordEncoder supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA</code> or {SSHA</code> prepended to the encoded hash.
    • GLIBC_CRYPT: Use the GlibcCryptPasswordEncoder based on the encoding-algorithm, strength provided and an optional secret.
    • org.example.MyEncoder: An implementation of PasswordEncoder 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.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 of inotify 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.

    org.apereo.cas.configuration.model.core.authentication.GroovyPrincipalTransformationProperties.

  • cas.authn.radius.client.inet-address=localhost
  • Server address to connect and establish a session.

    org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.

  • 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.

    The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. You should only include this field in your configuration if you need to modify the default value.

  • 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.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.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.authn.radius.password-encoder.strength=16
  • Strength or number of iterations to use for password hashing. Usually relevant when dealing with PasswordEncoderTypes#PBKDF2, PasswordEncoderTypes#BCRYPT or PasswordEncoderTypes#GLIBC_CRYPT. When used by PasswordEncoderTypes#ARGON2, it indicates the salt strength.

    org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

  • 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.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.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.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.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.authn.radius.client.accounting-port=1813
  • The accounting port.

    org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.

  • cas.authn.radius.client.authentication-port=1812
  • The authentication port.

    org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.

  • cas.authn.radius.client.socket-timeout=0
  • Socket connection timeout in milliseconds.

    org.apereo.cas.configuration.model.support.radius.RadiusClientProperties.

  • 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.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.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.authn.radius.name=
  • The name of the authentication handler.

    org.apereo.cas.configuration.model.support.radius.RadiusProperties.

  • cas.authn.radius.server.nas-identifier=
  • The NAS identifier.

    org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.

  • cas.authn.radius.server.nas-ip-address=
  • The NAS IP address.

    org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.

  • cas.authn.radius.server.nas-ipv6-address=
  • The NAS IPv6 address.

    org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.

  • cas.authn.radius.server.nas-port=-1
  • The NAS port.

    org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.

  • cas.authn.radius.server.nas-port-id=-1
  • The NAS port id.

    org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.

  • cas.authn.radius.server.nas-port-type=-1
  • The NAS port type.

    org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.

  • cas.authn.radius.server.nas-real-port=-1
  • The NAS real port.

    org.apereo.cas.configuration.model.support.radius.RadiusServerProperties.

  • 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.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.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.