WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

Undertow - Embedded Servlet Container Configuration

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

implementation "org.apereo.cas:cas-server-webapp-undertow:${project.'cas.version'}"

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

dependencies {
    implementation "org.apereo.cas:cas-server-webapp-undertow"
}

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)
        
        Including this module in the CAS WAR overlay is optional and unnecessary. This module is automatically included
        and bundled with the CAS server distribution and there are alternative options baked in to allow one to replace
        this module with another. The entry below is listed for reference only.
    */
    implementation "org.apereo.cas:cas-server-webapp-undertow"
}

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

_{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. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

_{The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.}

server.undertow.accesslog.dir=

Undertow access log directory.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.

_{How can I configure this property?}

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

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:

server.undertow.accesslog.dir=...

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:

server: 
  undertow: 
    accesslog: 
      dir: "..."

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 -Dserver.undertow.accesslog.dir="..." -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 SERVER_UNDERTOW_ACCESSLOG_DIR="..."

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 --server.undertow.accesslog.dir="..."

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.

server.undertow.accesslog.enabled=false

Whether to enable the access log.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.

_{How can I configure this property?}

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

Note

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

server.undertow.accesslog.enabled=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    accesslog: 
      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 -Dserver.undertow.accesslog.enabled="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_ACCESSLOG_ENABLED="..."

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 --server.undertow.accesslog.enabled="..."

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.

server.undertow.accesslog.pattern=common

Format pattern for access logs.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.

_{How can I configure this property?}

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

Note

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

server.undertow.accesslog.pattern=common

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    accesslog: 
      pattern: "common"

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 -Dserver.undertow.accesslog.pattern="common" -jar build/libs/cas.war

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

export SERVER_UNDERTOW_ACCESSLOG_PATTERN="common"

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 --server.undertow.accesslog.pattern="common"

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.

server.undertow.accesslog.prefix=access_log.

Log file name prefix.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.

_{How can I configure this property?}

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

Note

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

server.undertow.accesslog.prefix=access_log.

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    accesslog: 
      prefix: "access_log."

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 -Dserver.undertow.accesslog.prefix="access_log." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_ACCESSLOG_PREFIX="access_log."

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 --server.undertow.accesslog.prefix="access_log."

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.

server.undertow.accesslog.rotate=true

Whether to enable access log rotation.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.

_{How can I configure this property?}

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

Note

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

server.undertow.accesslog.rotate=true

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    accesslog: 
      rotate: "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 -Dserver.undertow.accesslog.rotate="true" -jar build/libs/cas.war

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

export SERVER_UNDERTOW_ACCESSLOG_ROTATE="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 --server.undertow.accesslog.rotate="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.

server.undertow.accesslog.suffix=log

Log file name suffix.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.

_{How can I configure this property?}

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

Note

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

server.undertow.accesslog.suffix=log

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    accesslog: 
      suffix: "log"

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 -Dserver.undertow.accesslog.suffix="log" -jar build/libs/cas.war

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

export SERVER_UNDERTOW_ACCESSLOG_SUFFIX="log"

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 --server.undertow.accesslog.suffix="log"

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.

server.undertow.allow-encoded-slash=false

Whether the server should decode percent encoded slash characters. Enabling encoded slashes can have security implications due to different servers interpreting the slash differently. Only enable this if you have a legacy application that requires it. Has no effect when server.undertow.decode-slash is set.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.allow-encoded-slash=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    allow-encoded-slash: "..."

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 -Dserver.undertow.allow-encoded-slash="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_ALLOW_ENCODED_SLASH="..."

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 --server.undertow.allow-encoded-slash="..."

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.

Deprecation status is WARNINGwith a replacement setting: server.undertow.decode-slash.

server.undertow.always-set-keep-alive=true

Whether the 'Connection: keep-alive' header should be added to all responses, even if not required by the HTTP specification.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.always-set-keep-alive=true

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    always-set-keep-alive: "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 -Dserver.undertow.always-set-keep-alive="true" -jar build/libs/cas.war

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

export SERVER_UNDERTOW_ALWAYS_SET_KEEP_ALIVE="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 --server.undertow.always-set-keep-alive="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.

server.undertow.buffer-size=

Size of each buffer. The default is derived from the maximum amount of memory that is available to the JVM.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.buffer-size=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    buffer-size: "..."

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 -Dserver.undertow.buffer-size="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_BUFFER_SIZE="..."

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 --server.undertow.buffer-size="..."

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.

server.undertow.buffers-per-region=

Number of buffer per region.

_{How can I configure this property?}

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

Note

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

server.undertow.buffers-per-region=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    buffers-per-region: "..."

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 -Dserver.undertow.buffers-per-region="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_BUFFERS_PER_REGION="..."

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 --server.undertow.buffers-per-region="..."

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.

Deprecation status is ERRORwithout a replacement setting.

server.undertow.decode-slash=

Whether encoded slash characters (%2F) should be decoded. Decoding can cause security problems if a front-end proxy does not perform the same decoding. Only enable this if you have a legacy application that requires it. When set, server.undertow.allow-encoded-slash has no effect.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.decode-slash=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    decode-slash: "..."

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 -Dserver.undertow.decode-slash="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_DECODE_SLASH="..."

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 --server.undertow.decode-slash="..."

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.

server.undertow.decode-url=true

Whether the URL should be decoded. When disabled, percent-encoded characters in the URL will be left as-is.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.decode-url=true

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    decode-url: "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 -Dserver.undertow.decode-url="true" -jar build/libs/cas.war

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

export SERVER_UNDERTOW_DECODE_URL="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 --server.undertow.decode-url="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.

server.undertow.direct-buffers=

Whether to allocate buffers outside the Java heap. The default is derived from the maximum amount of memory that is available to the JVM.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.direct-buffers=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    direct-buffers: "..."

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 -Dserver.undertow.direct-buffers="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_DIRECT_BUFFERS="..."

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 --server.undertow.direct-buffers="..."

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.

server.undertow.eager-filter-init=true

Whether servlet filters should be initialized on startup.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.eager-filter-init=true

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    eager-filter-init: "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 -Dserver.undertow.eager-filter-init="true" -jar build/libs/cas.war

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

export SERVER_UNDERTOW_EAGER_FILTER_INIT="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 --server.undertow.eager-filter-init="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.

server.undertow.max-cookies=200

Maximum number of cookies that are allowed. This limit exists to prevent hash collision based DOS attacks.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.max-cookies=200

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    max-cookies: "200"

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 -Dserver.undertow.max-cookies="200" -jar build/libs/cas.war

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

export SERVER_UNDERTOW_MAX_COOKIES="200"

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 --server.undertow.max-cookies="200"

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.

server.undertow.max-headers=

Maximum number of headers that are allowed. This limit exists to prevent hash collision based DOS attacks.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.max-headers=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    max-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 -Dserver.undertow.max-headers="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_MAX_HEADERS="..."

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 --server.undertow.max-headers="..."

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.

server.undertow.max-http-post-size=-1B

Maximum size of the HTTP post content. When the value is -1, the default, the size is unlimited.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.max-http-post-size=-1B

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    max-http-post-size: "-1B"

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 -Dserver.undertow.max-http-post-size="-1B" -jar build/libs/cas.war

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

export SERVER_UNDERTOW_MAX_HTTP_POST_SIZE="-1B"

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 --server.undertow.max-http-post-size="-1B"

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.

server.undertow.max-parameters=

Maximum number of query or path parameters that are allowed. This limit exists to prevent hash collision based DOS attacks.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.max-parameters=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    max-parameters: "..."

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 -Dserver.undertow.max-parameters="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_MAX_PARAMETERS="..."

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 --server.undertow.max-parameters="..."

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.

server.undertow.no-request-timeout=

Amount of time a connection can sit idle without processing a request, before it is closed by the server.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.no-request-timeout=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    no-request-timeout: "..."

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 -Dserver.undertow.no-request-timeout="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_NO_REQUEST_TIMEOUT="..."

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 --server.undertow.no-request-timeout="..."

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.

server.undertow.options.server=

Server options as defined in io.undertow.UndertowOptions.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Options.

_{How can I configure this property?}

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

Note

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

server.undertow.options.server=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    options: 
      server: "..."

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 -Dserver.undertow.options.server="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_OPTIONS_SERVER="..."

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 --server.undertow.options.server="..."

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.

server.undertow.options.socket=

Socket options as defined in org.xnio.Options.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Options.

_{How can I configure this property?}

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

Note

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

server.undertow.options.socket=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    options: 
      socket: "..."

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 -Dserver.undertow.options.socket="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_OPTIONS_SOCKET="..."

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 --server.undertow.options.socket="..."

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.

server.undertow.preserve-path-on-forward=false

Whether to preserve the path of a request when it is forwarded.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.preserve-path-on-forward=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    preserve-path-on-forward: "..."

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 -Dserver.undertow.preserve-path-on-forward="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_PRESERVE_PATH_ON_FORWARD="..."

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 --server.undertow.preserve-path-on-forward="..."

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.

server.undertow.threads.io=

Number of I/O threads to create for the worker. The default is derived from the number of available processors.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Threads.

_{How can I configure this property?}

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

Note

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

server.undertow.threads.io=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    threads: 
      io: "..."

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 -Dserver.undertow.threads.io="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_THREADS_IO="..."

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 --server.undertow.threads.io="..."

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.

server.undertow.threads.worker=

Number of worker threads. The default is 8 times the number of I/O threads.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Threads.

_{How can I configure this property?}

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

Note

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

server.undertow.threads.worker=...

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    threads: 
      worker: "..."

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 -Dserver.undertow.threads.worker="..." -jar build/libs/cas.war

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

export SERVER_UNDERTOW_THREADS_WORKER="..."

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 --server.undertow.threads.worker="..."

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.

server.undertow.url-charset=UTF-8

Charset used to decode URLs.

org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.

_{How can I configure this property?}

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

Note

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

server.undertow.url-charset=UTF-8

CAS properties can be specified using the YAML syntax:

server: 
  undertow: 
    url-charset: "UTF-8"

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 -Dserver.undertow.url-charset="UTF-8" -jar build/libs/cas.war

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

export SERVER_UNDERTOW_URL_CHARSET="UTF-8"

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 --server.undertow.url-charset="UTF-8"

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.

# Undertow access log directory.
# server.undertow.accesslog.dir=

# Whether to enable the access log.
# server.undertow.accesslog.enabled=false

# Format pattern for access logs.
# server.undertow.accesslog.pattern=common

# Log file name prefix.
# server.undertow.accesslog.prefix=access_log.

# Whether to enable access log rotation.
# server.undertow.accesslog.rotate=true

# Log file name suffix.
# server.undertow.accesslog.suffix=log

# Whether the server should decode percent encoded slash characters.
# server.undertow.allow-encoded-slash=false

# Whether the 'Connection: keep-alive' header should be added to all responses, even if not required by the HTTP specification.
# server.undertow.always-set-keep-alive=true

# Size of each buffer.
# server.undertow.buffer-size=

# Number of buffer per region.
# server.undertow.buffers-per-region=

# Whether encoded slash characters (%2F) should be decoded.
# server.undertow.decode-slash=

# Whether the URL should be decoded.
# server.undertow.decode-url=true

# Whether to allocate buffers outside the Java heap.
# server.undertow.direct-buffers=

# Whether servlet filters should be initialized on startup.
# server.undertow.eager-filter-init=true

# Maximum number of cookies that are allowed.
# server.undertow.max-cookies=200

# Maximum number of headers that are allowed.
# server.undertow.max-headers=

# Maximum size of the HTTP post content.
# server.undertow.max-http-post-size=-1B

# Maximum number of query or path parameters that are allowed.
# server.undertow.max-parameters=

# Amount of time a connection can sit idle without processing a request, before it is closed by the server.
# server.undertow.no-request-timeout=

# Server options as defined in io.undertow.UndertowOptions.
# server.undertow.options.server=

# Socket options as defined in org.xnio.Options.
# server.undertow.options.socket=

# Whether to preserve the path of a request when it is forwarded.
# server.undertow.preserve-path-on-forward=false

# Number of I/O threads to create for the worker.
# server.undertow.threads.io=

# Number of worker threads.
# server.undertow.threads.worker=

# Charset used to decode URLs.
# server.undertow.url-charset=UTF-8

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.

Note

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

Validation

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

Indexed Settings

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