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.
Configuration Security - Spring Cloud
Securing CAS settings and decrypting them is entirely handled by the Spring Cloud project as described in this guide.
The Spring Cloud configuration server exposes /encrypt
and /decrypt
endpoints to support encrypting and decrypting values.
Both endpoints accept a POST
payload; you can use /encrypt
to secure and
encrypt settings and place them inside your CAS configuration.
CAS will auto-decrypt at the appropriate moment.
The following settings and properties are available from the CAS configuration catalog:
encrypt.key-store.alias=
Alias for a key in the store.
|
encrypt.key-store.location=
Location of the key store file, e.g. classpath:/keystore.jks.
|
encrypt.key-store.password=
Password that locks the keystore.
|
encrypt.key-store.secret=
Secret protecting the key (defaults to the same as the password).
|
encrypt.key-store.type=jks
The KeyStore type. Defaults to jks.
|
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.
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.
To use the encryption and decryption features you need the full-strength "Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files" installed in your JVM version (if it’s not there by default).
To encrypt a given setting, use:
1
curl -u casuser:Mellon https://config.server.endpoint/encrypt -d sensitiveValue
Then, copy the encrypted setting into your CAS configuration using the method specified below.
Be careful with curl
.
You may have to use --data-urlencode
or set an explicit Content-Type: text/plain
to account for special characters such as +
.
If you wish to manually encrypt and decrypt settings to ensure the functionality is sane, use:
1
2
3
4
5
export ENCRYPTED=`curl -u casuser:Mellon https://config.server.endpoint/encrypt \
-d sensitiveValue | python -c 'import sys,urllib;print urllib.quote(sys.stdin.read().strip())'`
echo $ENCRYPTED
curl -u casuser:Mellon https://config.server.endpoint/decrypt \
-d $ENCRYPTED | python -c 'import sys,urllib;print urllib.quote(sys.stdin.read().strip())'
Properties that are prefixed with {cipher}
are automatically decrypted by the Spring Cloud configuration server at runtime, such as:
1
2
3
cas
something
sensitive: '{cipher}FKSAJDFGYOS8F7GLHAKERGFHLSAJ'
Or:
1
2
# Note that there are no quotes around the value!
cas.something.sensitive={cipher}FKSAJDFGYOS8F7GLHAKERGFHLSAJ
Troubleshooting
To enable additional logging, modify the logging configuration file to add the following:
1
2
3
4
<Logger name="org.springframework.cloud" level="debug" additivity="false">
<AppenderRef ref="casConsole"/>
<AppenderRef ref="casFile"/>
</Logger>