Undertow - Embedded Servlet Container Configuration

1
2
3
4
5
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-webapp-undertow</artifactId>
    <version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-webapp-undertow:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-webapp-undertow"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
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?

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

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

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

    How can I configure this property?

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

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

    How can I configure this property?

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

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

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

    How can I configure this property?

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

    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?

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

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

    How can I configure this property?

    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?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Be Selective

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

    YAGNI

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

    Naming Convention

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

    :information_source: Note

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

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

    Validation

    Configuration properties are automatically validated on CAS startup to report issues with configuration binding, 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.