APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Cloudwatch Logging

Log data can be automatically routed to AWS CloudWatch. Support is enabled by including the following module in the overlay:

Show in CAS Initializr Generate CAS Server WAR Overlay 


1
2
3
4
5



<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-aws-cloudwatch</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-support-aws-cloudwatch:${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-support-aws-cloudwatch"
}





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
        The following platform references are included automatically and are listed 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-aws-cloudwatch"
}

With the above module, you may then declare a specific appender to communicate with AWS CloudWatch:



1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18



<CloudWatchAppender name="cloudWatch"
                    awsLogGroupName="LogGroupName"
                    awsLogStreamName="LogStreamName"
                    awsLogRegionName="us-west-1"
                    credentialAccessKey="..."
                    credentialSecretKey="..."
                    awsLogStreamFlushPeriodInSeconds="5"
                    createIfNeeded="true"
                    createLogGroupIfNeeded="false"
                    createLogStreamIfNeeded="false">
    <PatternLayout>
        <Pattern>%5p | %d{ISO8601}{UTC} | %t | %C | %M:%L | %m %ex %n</Pattern>
    </PatternLayout>
</CloudWatchAppender>
...
<Logger name="org.apereo" additivity="true" level="debug">
    <appender-ref ref="cloudWatch" />
</Logger>

AWS credentials are fetched from the following sources automatically, where relevant and made possible via CAS configuration:

  1. EC2 instance metadata linked to the IAM role.
  2. External properties file that contains accessKey and secretKey as property keys.
  3. AWS profile path and profile name.
  4. System properties that include aws.accessKeyId, aws.secretKey and aws.sessionToken
  5. Environment variables that include AWS_ACCESS_KEY_ID, AWS_SECRET_KEY and AWS_SESSION_TOKEN.
  6. Properties file on the classpath as awscredentials.properties that contains accessKey and secretKey as property keys.
  7. Static credentials for access key and secret provided directly by the configuration at hand (logging, etc).

createIfNeeded, createLogGroupIfNeeded, and createLogStreamIfNeeded are optional; createIfNeeded will default to true while createLogGroupIfNeeded and createLogStreamIfNeeded default to false. Any true value will take precedence (i.e., set all to false to not create anything).

Actuator Endpoints

The following endpoints are provided by CAS:

cloudWatchLogs
CAS endpoint1 operationNot exposed by default
1

Turn the endpoint on and expose it over the web. One entry covers every operation. By default only info, health and status are exposed.



1
2



management.endpoint.cloudWatchLogs.access=UNRESTRICTED
management.endpoints.web.exposure.include=cloudWatchLogs

Endpoints may be mapped to other paths. For example, to serve health at healthcheck:



1



management.endpoints.web.path-mapping.health=healthcheck

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

cas.logging.cloudwatch.credential-access-keyUse access-key provided by AWS to authenticate.
no default
RequiredSpEL

Use access-key provided by AWS to authenticate.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
Supports
Spring Expression Language
cas.logging.cloudwatch.credential-secret-keyUse secret key provided by AWS to authenticate.
no default
RequiredSpEL

Use secret key provided by AWS to authenticate.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
Supports
Spring Expression Language
cas.logging.cloudwatch.endpointAWS custom endpoint.
no default
Required

AWS custom endpoint.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.log-group-nameA log group is a container that organizes and stores log streams that share the same retention, monitoring, and access control settings.
no default
Required

A log group is a container that organizes and stores log streams that share the same retention, monitoring, and access control settings. Each log group can have a unique name, and you can think of it as a logical grouping of logs that relate to a specific application, service, or environment.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.log-stream-nameA log stream is a sequence of log events that share the same source.
no default
Required

A log stream is a sequence of log events that share the same source. Each log stream belongs to a log group, and you can have multiple log streams within a single log group. Log streams are typically used to separate log data from different sources within the same application or service.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.regionAWS region used.
no default
Required

AWS region used.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.client-execution-timeoutClient execution timeout.
10000
Duration

Client execution timeout.

Type
String
Default
10000
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.connection-timeoutConnection timeout.
5000
Duration

Connection timeout.

Type
String
Default
5000
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.local-addressLocal address.
no default

Local address.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.max-connectionsMaximum connections setting.
10

Maximum connections setting.

Type
Integer
Default
10
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.profile-nameProfile name to use.
no default

Profile name to use.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.profile-pathProfile path.
no default

Profile path.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.proxy-hostOptionally specifies the proxy host to connect through.
no default

Optionally specifies the proxy host to connect through.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.proxy-passwordOptionally specifies the proxy password to connect through.
no default

Optionally specifies the proxy password to connect through.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.proxy-usernameOptionally specifies the proxy username to connect through.
no default

Optionally specifies the proxy username to connect through.

Type
String
Default
none
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.retry-modeOutline the requested retry mode.
STANDARD

Outline the requested retry mode. Accepted values are STANDARD, LEGACY.

Type
String
Default
STANDARD
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.socket-timeoutSocket timeout.
5000
Duration

Socket timeout.

Type
String
Default
5000
Defined by
AmazonCloudWatchLogsProperties
cas.logging.cloudwatch.use-reaperFlag that indicates whether to use reaper.
false

Flag that indicates whether to use reaper.

Type
Boolean
Default
false
Defined by
AmazonCloudWatchLogsProperties

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.

: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, 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.