Apache Tomcat - Embedded Servlet Container AJP

Open an AJP connector on the embedded Apache Tomcat, for deployments where a web server such as Apache httpd forwards requests to CAS over AJP. AJP is off by default.

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

cas.server.tomcat.ajp.enabledEnable AJP support in CAS for the embedded Apache Tomcat container.

false

Required

Enable AJP support in CAS for the embedded Apache Tomcat container.

Type: Boolean
Default: false
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.allow-traceA boolean value which can be used to enable or disable the TRACE HTTP method.

false

A boolean value which can be used to enable or disable the TRACE HTTP method. If not specified, this attribute is set to false.

Type: Boolean
Default: false
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.async-timeoutThe default timeout for asynchronous requests in milliseconds.

PT5S

Duration

The default timeout for asynchronous requests in milliseconds. If not specified, this attribute is set to 10000 (10 seconds).

Type: String
Default: PT5S
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.attributesAdditional attributes to be set on the AJP connector in form of key-value pairs.

no default

Additional attributes to be set on the AJP connector in form of key-value pairs. Examples include:

tomcatAuthentication: If set to true, the authentication will be done in Tomcat. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Tomcat. Note that this principal will have no roles associated with it. The default value is true.
maxThreads: The maximum number of request processing threads to be created by this Connector, which therefore determines the maximum number of simultaneous requests that can be handled. If not specified, this attribute is set to 200. If an executor is associated with this connector, this attribute is ignored as the connector will execute tasks using the executor rather than an internal thread pool.
keepAliveTimeout: The number of milliseconds this Connector will wait for another AJP request before closing the connection. The default value is to use the value that has been set for the connectionTimeout attribute.
maxCookieCount: The maximum number of cookies that are permitted for a request. A value of less than zero means no limit. If not specified, a default value of 200 will be used.
bufferSize: The size of the output buffer to use. If less than or equal to zero, then output buffering is disabled. The default value is -1 (i.e. buffering disabled)
clientCertProvider: When client certificate information is presented in a form other than instances of java.security.cert.X509Certificate it needs to be converted before it can be used and this property controls which JSSE provider is used to perform the conversion. For example it is used with the AJP connectors, the HTTP APR connector and with the org.apache.catalina.valves.SSLValve.If not specified, the default provider will be used.
connectionTimeout: The number of milliseconds this Connector will wait, after accepting a connection, for the request URI line to be presented. The default value is infinite (i.e. no timeout).
address: For servers with more than one IP address, this attribute specifies which address will be used for listening on the specified port. By default, this port will be used on all IP addresses associated with the server. A value of 127.0.0.1 indicates that the Connector will only listen on the loopback interface.

See the Apache Tomcat documentation for a full list.

Type: Map<String,String>
Default: none
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.enable-lookupsSet to true if you want calls to request.getRemoteHost() to perform DNS lookups in order to return the actual host name of the remote client.

false

Set to true if you want calls to request.getRemoteHost() to perform DNS lookups in order to return the actual host name of the remote client. Set to false to skip the DNS lookup and return the IP address in String form instead (thereby improving performance). By default, DNS lookups are disabled.

Type: Boolean
Default: false
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.max-post-sizeThe maximum size in bytes of the POST which will be handled by the container FORM URL parameter parsing.

20971520

The maximum size in bytes of the POST which will be handled by the container FORM URL parameter parsing. The feature can be disabled by setting this attribute to a value less than or equal to 0. If not specified, this attribute is set to 2097152 (2 megabytes).

Type: Integer
Default: 20971520
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.portThe TCP port number on which this Connector will create a server socket and await incoming connections.

8009

The TCP port number on which this Connector will create a server socket and await incoming connections. Your operating system will allow only one server application to listen to a particular port number on a particular IP address. If the special value of 0 (zero) is used, then Tomcat will select a free port at random to use for this connector. This is typically only useful in embedded and testing applications.

Type: Integer
Default: 8009
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.protocolSets the protocol to handle incoming traffic.

AJP/1.3

Sets the protocol to handle incoming traffic.

Type: String
Default: AJP/1.3
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.proxy-portIf this Connector is being used in a proxy configuration, configure this attribute to specify the server port to be returned for calls to request.getServerPort().

-1

If this Connector is being used in a proxy configuration, configure this attribute to specify the server port to be returned for calls to request.getServerPort().

Type: Integer
Default: -1
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.redirect-portIf this Connector is supporting non-SSL requests, and a request is received for which a matching security-constraint requires SSL transport, Catalina will automatically redirect the request to the port number specifie...

-1

If this Connector is supporting non-SSL requests, and a request is received for which a matching security-constraint requires SSL transport, Catalina will automatically redirect the request to the port number specified here.

Type: Integer
Default: -1
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.schemeSet this attribute to the name of the protocol you wish to have returned by calls to request.getScheme() .

http

Set this attribute to the name of the protocol you wish to have returned by calls to request.getScheme(). For example, you would set this attribute to https for an SSL Connector.

Type: String
Default: http
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.secretSet the secret that must be included with every request.

no default

Set the secret that must be included with every request.

Type: String
Default: none
Defined by: CasEmbeddedApacheTomcatAjpProperties

cas.server.tomcat.ajp.secureSet this attribute to true if you wish to have calls to request.isSecure() to return true for requests received by this Connector (you would want this on an SSL Connector).

false

Set this attribute to true if you wish to have calls to request.isSecure() to return true for requests received by this Connector (you would want this on an SSL Connector). The default value is false.

Type: Boolean
Default: false
Defined by: CasEmbeddedApacheTomcatAjpProperties

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

Notes on configuration

Configuration Metadata

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

Be Selective

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

YAGNI

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

Naming Convention

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

Note

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

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

Validation

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

Indexed Settings

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