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.
Jetty - Embedded Servlet Container Configuration
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-webapp-jetty</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-webapp-jetty:${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-jetty"
}
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-jetty"
}
Embedded Jetty Container
The following settings and properties are available from the CAS configuration catalog:
cas.server.jetty.sni-host-check=true
Server Name Indication is an extension of the Transport Layer Security (TLS) protocol, which allows a client to indicate which hostname it is attempting to connect to at the start of the handshaking process. This is particularly useful when a server hosts multiple domains with different SSL certificates on a single IP address. Setting this setting to
|
server.jetty.accesslog.append=false
Append to log.
|
server.jetty.accesslog.custom-format=
Custom log format, see org.eclipse.jetty.server.CustomRequestLog. If defined, overrides the "format" configuration key.
|
server.jetty.accesslog.date-format=
Deprecation status is |
server.jetty.accesslog.enabled=false
Enable access log.
|
server.jetty.accesslog.extended-format=
Deprecation status is |
server.jetty.accesslog.file-date-format=
Date format to place in log file name.
|
server.jetty.accesslog.filename=
Log filename. If not specified, logs redirect to "System.err".
|
server.jetty.accesslog.format=
Log format.
|
server.jetty.accesslog.ignore-paths=
Request paths that should not be logged.
|
server.jetty.accesslog.locale=
Deprecation status is |
server.jetty.accesslog.log-cookies=
Deprecation status is |
server.jetty.accesslog.log-latency=
Deprecation status is |
server.jetty.accesslog.log-server=
Deprecation status is |
server.jetty.accesslog.retention-period=31
Number of days before rotated log files are deleted.
|
server.jetty.accesslog.time-zone=
Deprecation status is |
server.jetty.connection-idle-timeout=
Time that the connection can be idle before it is closed.
|
server.jetty.max-connections=-1
Maximum number of connections that the server accepts and processes at any given time.
|
server.jetty.max-form-keys=1000
Maximum number of form keys.
|
server.jetty.max-http-form-post-size=200000B
Maximum size of the form content in any HTTP post request.
|
server.jetty.max-http-post-size=
Deprecation status is |
server.jetty.max-http-response-header-size=16KB
Maximum size of the HTTP response header.
|
server.jetty.threads.acceptors=-1
Number of acceptor threads to use. When the value is -1, the default, the number of acceptors is derived from the operating environment.
|
server.jetty.threads.idle-timeout=60000ms
Maximum thread idle time.
|
server.jetty.threads.max=200
Maximum number of threads.
|
server.jetty.threads.max-queue-capacity=
Maximum capacity of the thread pool's backing queue. A default is computed based on the threading configuration.
|
server.jetty.threads.min=8
Minimum number of threads. Doesn't have an effect if virtual threads are enabled.
|
server.jetty.threads.selectors=-1
Number of selector threads to use. When the value is -1, the default, the number of selectors is derived from the operating environment.
|
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.