CouchDb Surrogate Authentication

CouchDb support for surrogate authentication is enabled by including the following dependencies in the WAR overlay:

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

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

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

dependencies {
    implementation "org.apereo.cas:cas-server-support-surrogate-authentication-couchdb"
}

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-surrogate-authentication-couchdb"
}

Surrogate accounts may also be retrieved from an CouchDb instance. By default, this takes the form of surrogate/principal key/value pairs. Users authorized as surrogates may be listed multiple times to authorize them to access multiple accounts.

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.surrogate.couch-db.db-name=

Database name.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.db-name=...

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: 
    surrogate: 
      couch-db: 
        db-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.surrogate.couch-db.db-name="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched.

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

export CAS_AUTHN_SURROGATE_COUCH_DB_DB_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.db-name="..."

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

cas.authn.surrogate.couch-db.password=

Password for connection.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.password=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        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.surrogate.couch-db.password="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_PASSWORD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.password="..."

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

cas.authn.surrogate.couch-db.url=http://localhost:5984

Connection url.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.url=http://localhost:5984

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        url: "http://localhost:5984"

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.surrogate.couch-db.url="http://localhost:5984" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_URL="http://localhost:5984"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.url="http://localhost:5984"

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

cas.authn.surrogate.couch-db.username=

Username for connection.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.username=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        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.surrogate.couch-db.username="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_USERNAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.username="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.caching=false

Use a local cache to reduce fetches..

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.caching=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        caching: "..."

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.surrogate.couch-db.caching="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_CACHING="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.caching="..."

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

cas.authn.surrogate.couch-db.cleanup-idle-connections=true

Remove idle connections from pool.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.cleanup-idle-connections=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        cleanup-idle-connections: "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.surrogate.couch-db.cleanup-idle-connections="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_CLEANUP_IDLE_CONNECTIONS="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.cleanup-idle-connections="true"

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

cas.authn.surrogate.couch-db.connection-timeout=1000

TCP connection timeout.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.connection-timeout=1000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        connection-timeout: "1000"

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.surrogate.couch-db.connection-timeout="1000" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_CONNECTION_TIMEOUT="1000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.connection-timeout="1000"

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

cas.authn.surrogate.couch-db.create-if-not-exists=true

Create the database if it doesn't exist.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.create-if-not-exists=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        create-if-not-exists: "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.surrogate.couch-db.create-if-not-exists="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_CREATE_IF_NOT_EXISTS="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.create-if-not-exists="true"

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

cas.authn.surrogate.couch-db.enable-ssl=false

Use TLS. Only needed if not specified by URL.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.enable-ssl=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        enable-ssl: "..."

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.surrogate.couch-db.enable-ssl="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_ENABLE_SSL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.enable-ssl="..."

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

cas.authn.surrogate.couch-db.max-cache-entries=1000

Max entries in local cache.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.max-cache-entries=1000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        max-cache-entries: "1000"

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.surrogate.couch-db.max-cache-entries="1000" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_MAX_CACHE_ENTRIES="1000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.max-cache-entries="1000"

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

cas.authn.surrogate.couch-db.max-connections=20

Maximum connections to CouchDB.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.max-connections=20

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        max-connections: "20"

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.surrogate.couch-db.max-connections="20" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_MAX_CONNECTIONS="20"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.max-connections="20"

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

cas.authn.surrogate.couch-db.max-object-size-bytes=8192

Largest allowable serialized object.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.max-object-size-bytes=8192

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        max-object-size-bytes: "8192"

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.surrogate.couch-db.max-object-size-bytes="8192" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_MAX_OBJECT_SIZE_BYTES="8192"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.max-object-size-bytes="8192"

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

cas.authn.surrogate.couch-db.profile-based=false

Use user profiles instead of surrogate/principal pairs. If +true+, a list of of principals the user is an authorized surrogate of is stored in the user profile in CouchDb. Most useful with CouchDb authentication or AUP.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.profile-based=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        profile-based: "..."

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.surrogate.couch-db.profile-based="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_PROFILE_BASED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.profile-based="..."

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

cas.authn.surrogate.couch-db.proxy-host=

Proxy host.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.proxy-host=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        proxy-host: "..."

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.surrogate.couch-db.proxy-host="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_PROXY_HOST="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.proxy-host="..."

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

cas.authn.surrogate.couch-db.proxy-port=-1

proxy port.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.proxy-port=-1

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        proxy-port: "-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.surrogate.couch-db.proxy-port="-1" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_PROXY_PORT="-1"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.proxy-port="-1"

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

cas.authn.surrogate.couch-db.relaxed-ssl-settings=false

Relax TLS settings–like certificate verification.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.relaxed-ssl-settings=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        relaxed-ssl-settings: "..."

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.surrogate.couch-db.relaxed-ssl-settings="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_RELAXED_SSL_SETTINGS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.relaxed-ssl-settings="..."

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

cas.authn.surrogate.couch-db.retries=5

Retries for update conflicts.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.retries=5

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        retries: "5"

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.surrogate.couch-db.retries="5" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_RETRIES="5"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.retries="5"

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

cas.authn.surrogate.couch-db.socket-timeout=10000

Socket idle timeout.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.socket-timeout=10000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        socket-timeout: "10000"

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.surrogate.couch-db.socket-timeout="10000" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_SOCKET_TIMEOUT="10000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.socket-timeout="10000"

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

cas.authn.surrogate.couch-db.surrogate-principals-attribute=surrogateFor

Attribute with list of principals the user may surrogate when user surrogates are stored in user profiles.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.surrogate-principals-attribute=surrogateFor

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        surrogate-principals-attribute: "surrogateFor"

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.surrogate.couch-db.surrogate-principals-attribute="surrogateFor" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_SURROGATE_PRINCIPALS_ATTRIBUTE="surrogateFor"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.surrogate-principals-attribute="surrogateFor"

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

cas.authn.surrogate.couch-db.use-expect-continue=true

Expect HTTP 100 Continue during connection.

org.apereo.cas.configuration.model.support.surrogate.SurrogateCouchDbAuthenticationProperties.

_{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.surrogate.couch-db.use-expect-continue=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      couch-db: 
        use-expect-continue: "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.surrogate.couch-db.use-expect-continue="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_COUCH_DB_USE_EXPECT_CONTINUE="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.surrogate.couch-db.use-expect-continue="true"

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

# Use a local cache to reduce fetches..
# cas.authn.surrogate.couch-db.caching=false

# Remove idle connections from pool.
# cas.authn.surrogate.couch-db.cleanup-idle-connections=true

# TCP connection timeout.
# cas.authn.surrogate.couch-db.connection-timeout=1000

# Create the database if it doesn't exist.
# cas.authn.surrogate.couch-db.create-if-not-exists=true

# Use TLS.
# cas.authn.surrogate.couch-db.enable-ssl=false

# Max entries in local cache.
# cas.authn.surrogate.couch-db.max-cache-entries=1000

# Maximum connections to CouchDB.
# cas.authn.surrogate.couch-db.max-connections=20

# Largest allowable serialized object.
# cas.authn.surrogate.couch-db.max-object-size-bytes=8192

# Use user profiles instead of surrogate/principal pairs.
# cas.authn.surrogate.couch-db.profile-based=false

# Proxy host.
# cas.authn.surrogate.couch-db.proxy-host=

# proxy port.
# cas.authn.surrogate.couch-db.proxy-port=-1

# Relax TLS settings–like certificate verification.
# cas.authn.surrogate.couch-db.relaxed-ssl-settings=false

# Retries for update conflicts.
# cas.authn.surrogate.couch-db.retries=5

# Socket idle timeout.
# cas.authn.surrogate.couch-db.socket-timeout=10000

# Attribute with list of principals the user may surrogate when user surrogates are stored in user profiles.
# cas.authn.surrogate.couch-db.surrogate-principals-attribute=surrogateFor

# Expect HTTP 100 Continue during connection.
# cas.authn.surrogate.couch-db.use-expect-continue=true

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.

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

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. 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.