APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

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

Twilio Multifactor Authentication

Multifactor authentication via Twilio allows CAS to use the Twilio verification service and APIs to send passcodes to end-users via SMS, WhatsApp or voice calls, etc and verify the attempt subsequently by asking the user to provide the code back.

The recipient is determined as a principal attribute configured in CAS settings. Multiple verification channels are supported.

Configuration

Support is enabled by including the following module in the overlay:

Show in CAS Initializr Generate CAS Server WAR Overlay 


1
2
3
4
5



<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-twilio-mfa</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-support-twilio-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-twilio-mfa"
}





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
        The following platform references are included automatically and are listed for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-twilio-mfa"
}

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

cas.authn.mfa.twilio.bypass.groovy.locationThe location of the resource.
no default
Required

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, especially if the script is 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.

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.

Type
Resource
Default
none
Defined by
GroovyMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.urlThe endpoint URL to contact and retrieve attributes.
no default
RequiredSpEL

The endpoint URL to contact and retrieve attributes.

Type
String
Default
none
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
Supports
Spring Expression Language
cas.authn.mfa.twilio.core.account-idTwilio account identifier used for authentication.
no default
RequiredSpEL

Twilio account identifier used for authentication.

Type
String
Default
none
Defined by
CasTwilioMultifactorAuthenticationCoreProperties
Supports
Spring Expression Language
cas.authn.mfa.twilio.core.recipient-attribute-nameThe attribute name that contains the contact info (phone, etc) to send the verification attempt.
phoneNumber
Required

The attribute name that contains the contact info (phone, etc) to send the verification attempt.

Type
String
Default
phoneNumber
Defined by
CasTwilioMultifactorAuthenticationCoreProperties
cas.authn.mfa.twilio.core.service-sidThe identifier of the verification service typically in the ^VA[0-9a-fA-F]{32 $} format.
no default
RequiredSpEL

The identifier of the verification service typically in the ^VA[0-9a-fA-F]{32$} format. A Verification Service is the set of common configurations used to create and check verifications. You can create a service with the API or in the Console.

Type
String
Default
none
Defined by
CasTwilioMultifactorAuthenticationCoreProperties
Supports
Spring Expression Language
cas.authn.mfa.twilio.core.tokenTwilio secret token used for authentication.
no default
RequiredSpEL

Twilio secret token used for authentication.

Type
String
Default
none
Defined by
CasTwilioMultifactorAuthenticationCoreProperties
Supports
Spring Expression Language
cas.authn.mfa.twilio.bucket4j.bandwidthDescribe the available bandwidth and the overall limitations.
no default

Describe the available bandwidth and the overall limitations. Multiple bandwidths allow for different policies per unit of measure. (i.e. allows 1000 tokens per 1 minute, but not often then 50 tokens per 1 second).

Type
List<Bucket4jBandwidthLimitProperties>
Default
none
Defined by
CasTwilioMultifactorAuthenticationBucket4jProperties
cas.authn.mfa.twilio.bucket4j.bandwidth[0].capacityNumber of tokens/requests that can be used within the time window.
120

Number of tokens/requests that can be used within the time window.

Type
long
Default
120
Defined by
Bucket4jBandwidthLimitProperties
cas.authn.mfa.twilio.bucket4j.bandwidth[0].durationTime window in which capacity can be allowed.
PT60S
Duration

Time window in which capacity can be allowed.

Type
String
Default
PT60S
Defined by
Bucket4jBandwidthLimitProperties
cas.authn.mfa.twilio.bucket4j.bandwidth[0].initial-tokensBy default initial size of bucket equals to capacity.
no default

By default initial size of bucket equals to capacity. But sometimes, you may want to have lesser initial size, for example for case of cold start in order to prevent denial of service.

Type
long
Default
none
Defined by
Bucket4jBandwidthLimitProperties
cas.authn.mfa.twilio.bucket4j.bandwidth[0].refill-countThe number of tokens that should be used to refill the bucket given the specified refill duration.
10

The number of tokens that should be used to refill the bucket given the specified refill duration.

Type
long
Default
10
Defined by
Bucket4jBandwidthLimitProperties
cas.authn.mfa.twilio.bucket4j.bandwidth[0].refill-durationDuration to use to refill the bucket.
PT30S
Duration

Duration to use to refill the bucket.

Type
String
Default
PT30S
Defined by
Bucket4jBandwidthLimitProperties
cas.authn.mfa.twilio.bucket4j.bandwidth[0].refill-strategyDescribes how the bucket should be refilled.
GREEDY
Describes how the bucket should be refilled. Specifies the speed of tokens regeneration. Available values are as follows:
  • GREEDY: This type of refill regenerates tokens in a greedy manner; it tries to add the tokens to bucket as soon as possible. For example refill "10 tokens per 1 second" adds 1 token per each 100 millisecond; in other words refill will not wait 1 second to regenerate 10 tokens.
  • INTERVALLY: This type of refill regenerates tokens in intervally manner. "Intervally" in opposite to "greedy" will wait until whole period would be elapsed before regenerating tokens.
Type
Bucket4jBandwidthLimitProperties.BandwidthRefillStrategies
Default
GREEDY
Defined by
Bucket4jBandwidthLimitProperties
cas.authn.mfa.twilio.bucket4j.blockingWhether the request should block until capacity becomes available.
true

Whether the request should block until capacity becomes available. When enabled, a request that finds the bucket empty parks its thread until the refill adds a token. On a request-serving path that turns a burst into thread-pool exhaustion, so throttling rejects the request immediately by default and only waits when this is explicitly turned on.

Type
Boolean
Default
true
Defined by
CasTwilioMultifactorAuthenticationBucket4jProperties
cas.authn.mfa.twilio.bucket4j.enabledDecide whether bucket4j functionality should be enabled.
true

Decide whether bucket4j functionality should be enabled.

Type
Boolean
Default
true
Defined by
CasTwilioMultifactorAuthenticationBucket4jProperties
cas.authn.mfa.twilio.bypass.authentication-attribute-nameSkip multifactor authentication based on designated authentication attribute names.
no default

Skip multifactor authentication based on designated authentication attribute names.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.authentication-attribute-valueOptionally, skip multifactor authentication based on designated authentication attribute values.
no default
Regex

Optionally, skip multifactor authentication based on designated authentication attribute values. Multiple values may be separated by a comma.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.authentication-handler-nameSkip multifactor authentication depending on form of primary authentication execution.
no default
Regex

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.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.authentication-method-nameSkip multifactor authentication depending on method/form of primary authentication execution.
no default
Regex

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.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.credential-class-typeSkip multifactor authentication depending on form of primary credentials.
no default

Skip multifactor authentication depending on form of primary credentials. Value must equal the fully qualified class name of the credential type.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.http-request-headersSkip multifactor authentication if the http request contains the defined header names.
no default
Regex

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.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.http-request-remote-addressSkip multifactor authentication if the http request's remote address or host matches the value defined here.
no default
Regex

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.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.principal-attribute-nameSkip multifactor authentication based on designated principal attribute names.
no default

Skip multifactor authentication based on designated principal attribute names.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.principal-attribute-valueOptionally, skip multifactor authentication based on designated principal attribute values.
no default
Regex

Optionally, skip multifactor authentication based on designated principal attribute values.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.basic-auth-passwordIf REST endpoint is protected via basic authentication, specify the password for authentication.
no default

If REST endpoint is protected via basic authentication, specify the password for authentication.

Type
String
Default
none
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.basic-auth-usernameIf REST endpoint is protected via basic authentication, specify the username for authentication.
no default

If REST endpoint is protected via basic authentication, specify the username for authentication.

Type
String
Default
none
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.headersHeaders, defined as a Map, to include in the request when making the REST call.
no default

Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value.

Type
Map<String,String>
Default
none
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.maximum-retry-attemptsWhen attempting to reach the endpoint, this setting controls the number of retry attempts that CAS should execute Setting this value to a zero or negative value will disable the retry policy.
3

When attempting to reach the endpoint, this setting controls the number of retry attempts that CAS should execute Setting this value to a zero or negative value will disable the retry policy.

Type
Integer
Default
3
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.methodHTTP method to use when contacting the rest endpoint.
GET

HTTP method to use when contacting the rest endpoint. Examples include GET, POST, etc.

Type
String
Default
GET
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.core.verification-channelsThe list of channels to use for verification.
no default

The list of channels to use for verification. Supported valued are: sms, call, email, whatsapp, sna. Default is sms.

Type
List<String>
Default
none
Defined by
CasTwilioMultifactorAuthenticationCoreProperties
cas.authn.mfa.twilio.failure-modeThe failure mode policy for this MFA provider.
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.
Type
BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes
Default
CLOSED
Defined by
CasTwilioMultifactorAuthenticationProperties
cas.authn.mfa.twilio.idThe identifier for the multifactor provider.
no default

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.

Type
String
Default
none
Defined by
CasTwilioMultifactorAuthenticationProperties
cas.authn.mfa.twilio.nameThe name of the authentication handler used to verify credentials in MFA.
no default

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.

Type
String
Default
none
Defined by
CasTwilioMultifactorAuthenticationProperties
cas.authn.mfa.twilio.orderThe order of the authentication handler in the chain.
no default

The order of the authentication handler in the chain.

Type
Integer
Default
none
Defined by
CasTwilioMultifactorAuthenticationProperties
cas.authn.mfa.twilio.rankAt times, CAS needs to determine the correct provider when step-up authentication is required.
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.
In certain scenarios, CAS will attempt to rank authentication levels and compare them with each other. If CAS already has achieved a level that is higher than what the incoming request requires, no step-up authentication will be performed. If the opposite is true, CAS will route the authentication flow to the required authentication level and upon success, will adjust the SSO session with the new higher authentication level now satisfied. Ranking of authentication methods is done per provider via specific properties for each. Note that the higher the rank value is, the higher on the security scale it remains. A provider that ranks higher with a larger weight value trumps and override others with a lower value.
Type
Integer
Default
0
Defined by
CasTwilioMultifactorAuthenticationProperties
cas.authn.mfa.twilio.trusted-device-enabledIndicates whether this provider should support trusted devices.
false

Indicates whether this provider should support trusted devices.

Type
Boolean
Default
false
Defined by
CasTwilioMultifactorAuthenticationProperties

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

Groovy scripting

CAS takes advantage of Apache Groovy in forms of either embedded or external scripts that allow one to, by default, dynamically build constructs, attributes, access strategies and a lot more. To activate the functionality described here, you may need to prepare CAS to support and integrate with Apache Groovy.

Please review this guide to configure your build.

Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

Bypass

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

cas.authn.mfa.twilio.bypass.groovy.locationThe location of the resource.
no default
Required

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, especially if the script is 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.

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.

Type
Resource
Default
none
Defined by
GroovyMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.urlThe endpoint URL to contact and retrieve attributes.
no default
RequiredSpEL

The endpoint URL to contact and retrieve attributes.

Type
String
Default
none
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
Supports
Spring Expression Language
cas.authn.mfa.twilio.bypass.authentication-attribute-nameSkip multifactor authentication based on designated authentication attribute names.
no default

Skip multifactor authentication based on designated authentication attribute names.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.authentication-attribute-valueOptionally, skip multifactor authentication based on designated authentication attribute values.
no default
Regex

Optionally, skip multifactor authentication based on designated authentication attribute values. Multiple values may be separated by a comma.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.authentication-handler-nameSkip multifactor authentication depending on form of primary authentication execution.
no default
Regex

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.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.authentication-method-nameSkip multifactor authentication depending on method/form of primary authentication execution.
no default
Regex

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.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.credential-class-typeSkip multifactor authentication depending on form of primary credentials.
no default

Skip multifactor authentication depending on form of primary credentials. Value must equal the fully qualified class name of the credential type.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.http-request-headersSkip multifactor authentication if the http request contains the defined header names.
no default
Regex

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.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.http-request-remote-addressSkip multifactor authentication if the http request's remote address or host matches the value defined here.
no default
Regex

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.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.principal-attribute-nameSkip multifactor authentication based on designated principal attribute names.
no default

Skip multifactor authentication based on designated principal attribute names.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.principal-attribute-valueOptionally, skip multifactor authentication based on designated principal attribute values.
no default
Regex

Optionally, skip multifactor authentication based on designated principal attribute values.

Type
String
Default
none
Defined by
MultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.basic-auth-passwordIf REST endpoint is protected via basic authentication, specify the password for authentication.
no default

If REST endpoint is protected via basic authentication, specify the password for authentication.

Type
String
Default
none
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.basic-auth-usernameIf REST endpoint is protected via basic authentication, specify the username for authentication.
no default

If REST endpoint is protected via basic authentication, specify the username for authentication.

Type
String
Default
none
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.headersHeaders, defined as a Map, to include in the request when making the REST call.
no default

Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value.

Type
Map<String,String>
Default
none
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.maximum-retry-attemptsWhen attempting to reach the endpoint, this setting controls the number of retry attempts that CAS should execute Setting this value to a zero or negative value will disable the retry policy.
3

When attempting to reach the endpoint, this setting controls the number of retry attempts that CAS should execute Setting this value to a zero or negative value will disable the retry policy.

Type
Integer
Default
3
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties
cas.authn.mfa.twilio.bypass.rest.methodHTTP method to use when contacting the rest endpoint.
GET

HTTP method to use when contacting the rest endpoint. Examples include GET, POST, etc.

Type
String
Default
GET
Defined by
RestfulMultifactorAuthenticationProviderBypassProperties

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

Groovy scripting

CAS takes advantage of Apache Groovy in forms of either embedded or external scripts that allow one to, by default, dynamically build constructs, attributes, access strategies and a lot more. To activate the functionality described here, you may need to prepare CAS to support and integrate with Apache Groovy.

Please review this guide to configure your build.

Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.