Authy Authentication

CAS provides support for Authy’s TOTP API. This is done via Authy’s REST API that does all the heavy lifting.

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

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

implementation "org.apereo.cas:cas-server-support-authy:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-authy"
}

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

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.mfa.authy.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 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.support.mfa.GroovyMultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

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

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.groovy.location=...

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          groovy: 
            location: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.groovy.location="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war 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.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_GROOVY_LOCATION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.groovy.location="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.bypass.rest.url=

The endpoint URL to contact and retrieve attributes.

org.apereo.cas.configuration.model.support.mfa.RestfulMultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.rest.url=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          rest: 
            url: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.rest.url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_REST_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.rest.url="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.api-key=

Authy API key.

org.apereo.cas.configuration.model.support.mfa.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.api-key=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        api-key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.api-key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_API_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.api-key="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.api-url=

Authy API url.

org.apereo.cas.configuration.model.support.mfa.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.api-url=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        api-url: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.api-url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_API_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.api-url="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.mail-attribute=mail

Principal attribute used to look up an email address for credential verification. The attribute value is then used to look up the user record in Authy, or create the user.

org.apereo.cas.configuration.model.support.mfa.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.mail-attribute=mail

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        mail-attribute: "mail"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.mail-attribute="mail" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_MAIL_ATTRIBUTE="mail"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.mail-attribute="mail"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.phone-attribute=phone

Principal attribute used to look up a phone number for credential verification. The attribute value is then used to look up the user record in Authy, or create the user.

org.apereo.cas.configuration.model.support.mfa.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.phone-attribute=phone

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        phone-attribute: "phone"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.phone-attribute="phone" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_PHONE_ATTRIBUTE="phone"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.phone-attribute="phone"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

_{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.mfa.authy.bypass.authentication-attribute-name=

Skip multifactor authentication based on designated authentication attribute names.

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.authentication-attribute-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          authentication-attribute-name: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.authentication-attribute-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_AUTHENTICATION_ATTRIBUTE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.authentication-attribute-name="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.bypass.authentication-attribute-value=

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

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.authentication-attribute-value=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          authentication-attribute-value: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.authentication-attribute-value="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_AUTHENTICATION_ATTRIBUTE_VALUE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.authentication-attribute-value="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.authentication-handler-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          authentication-handler-name: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.authentication-handler-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_AUTHENTICATION_HANDLER_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.authentication-handler-name="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.authentication-method-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          authentication-method-name: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.authentication-method-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_AUTHENTICATION_METHOD_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.authentication-method-name="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.credential-class-type=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          credential-class-type: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.credential-class-type="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_CREDENTIAL_CLASS_TYPE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.credential-class-type="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.http-request-headers=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          http-request-headers: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.http-request-headers="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_HTTP_REQUEST_HEADERS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.http-request-headers="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.http-request-remote-address=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          http-request-remote-address: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.http-request-remote-address="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_HTTP_REQUEST_REMOTE_ADDRESS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.http-request-remote-address="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.bypass.principal-attribute-name=

Skip multifactor authentication based on designated principal attribute names.

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.principal-attribute-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          principal-attribute-name: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.principal-attribute-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_PRINCIPAL_ATTRIBUTE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.principal-attribute-name="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.bypass.principal-attribute-value=

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

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.principal-attribute-value=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          principal-attribute-value: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.principal-attribute-value="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_PRINCIPAL_ATTRIBUTE_VALUE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.principal-attribute-value="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.rest.basic-auth-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          rest: 
            basic-auth-password: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.rest.basic-auth-password="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_REST_BASIC_AUTH_PASSWORD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.rest.basic-auth-password="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.rest.basic-auth-username=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          rest: 
            basic-auth-username: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.rest.basic-auth-username="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_REST_BASIC_AUTH_USERNAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.rest.basic-auth-username="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.rest.headers=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "..."          rest: 
            headers: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.rest.headers="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_REST_HEADERS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.rest.headers="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.bypass.rest.method=GET

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        bypass: "GET"          rest: 
            method: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.bypass.rest.method="GET" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_BYPASS_REST_METHOD="GET"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.bypass.rest.method="GET"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.country-code=1

Phone number country code used to look up and/or create the Authy user account.

org.apereo.cas.configuration.model.support.mfa.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.country-code=1

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        country-code: "1"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.country-code="1" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_COUNTRY_CODE="1"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.country-code="1"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.failure-mode=CLOSED

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        failure-mode: "CLOSED"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.failure-mode="CLOSED" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_FAILURE_MODE="CLOSED"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.failure-mode="CLOSED"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.force-verification=true

Flag authentication requests to authy to force verification of credentials.

org.apereo.cas.configuration.model.support.mfa.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.force-verification=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        force-verification: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.force-verification="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_FORCE_VERIFICATION="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.force-verification="true"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.id=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        id: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.id="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_ID="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.id="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.name="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.order=

The order of the authentication handler in the chain.

org.apereo.cas.configuration.model.support.mfa.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.order=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        order: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.order="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_ORDER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.order="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.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.

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.

org.apereo.cas.configuration.model.support.mfa.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.rank=0

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        rank: "0"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.rank="0" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_RANK="0"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.rank="0"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.authn.mfa.authy.trusted-device-enabled=false

Indicates whether this provider should support trusted devices.

org.apereo.cas.configuration.model.support.mfa.AuthyMultifactorAuthenticationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.mfa.authy.trusted-device-enabled=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    mfa: 
      authy: 
        trusted-device-enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.mfa.authy.trusted-device-enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_MFA_AUTHY_TRUSTED_DEVICE_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.mfa.authy.trusted-device-enabled="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.