Account (Self-Service) Registration - Communication
Account creation requests are expected to be verified using a dedicated activation link that can be shared with the user using mail or text messages. The activation link is expected to remain valid for a configurable period of time.
To learn more about available options, please see this guide or this guide, or this guide.
The following settings and properties are available from the CAS configuration catalog:
cas.account-registration.mail.attribute-namePrincipal attribute names that indicates the destination email address for this message.
Principal attribute names that indicates the destination email address for this message. The attributes must already be resolved and available to the CAS principal. When multiple attributes are specified, each attribute is then examined against the available CAS principal to locate the email address value, which may result in multiple emails being sent.
cas.account-registration.mail.fromEmail from address.
Email from address.
cas.account-registration.mail.subjectEmail subject line.
Email subject line.
The subject can either be defined verbatim, or it may point to a message key in the language bundle using the syntax #{subject-language-key}. This key should point to a valid message defined in the appropriate language bundle that is then picked up via the active locale. In case where the language code cannot resolve the real subject, a default subject value would be used.
cas.account-registration.sms.attribute-namePrincipal attribute names that indicates the destination phone number for this SMS message.
Principal attribute names that indicates the destination phone number for this SMS message. The attribute must already be resolved and available to the CAS principal.
cas.account-registration.sms.fromThe from address for the message.
The from address for the message.
cas.account-registration.sms.textThe body of the SMS message.
The body of the SMS message.
cas.account-registration.mail.bccEmail BCC address, if any.
Email BCC address, if any.
cas.account-registration.mail.ccEmail CC address, if any.
Email CC address, if any.
cas.account-registration.mail.htmlIndicate whether the message body should be evaluated as HTML text.
falseIndicate whether the message body should be evaluated as HTML text. The application of this setting depends on the email provider implementation and may not be fully supported everywhere. This is typically relevant for the default org.springframework.mail.javamail.JavaMailSender.
cas.account-registration.mail.prioritySet the priority ( X-Priority header) of the message.
1Set the priority (X-Priority header) of the message. Values: 1 (Highest), 2 (High), 3 (Normal), 4 (Low), 5 (Lowest). The application of this setting depends on the email provider implementation and may not be fully supported everywhere. This is typically relevant for the default org.springframework.mail.javamail.JavaMailSender.
cas.account-registration.mail.reply-toEmail Reply-To address, if any.
Email Reply-To address, if any.
cas.account-registration.mail.textEmail message body.
Email message body. Could be plain text or a reference to an external file that would serve as a template.
If specified as a path to an external file with an extension .gtemplate, then the email message body would be processed using the Groovy template engine. The template engine uses JSP style <% %> script and <%= %> expression syntax or GString style expressions. The variable out is bound to the writer that the template is being written to.
If using plain text, the contents are processed for string substitution candidates using named variables. For example, you may refer to an expected url variable in the email text via ${url}, or use ${token} to locate the token variable. In certain cases, additional parameters are passed to the email body processor that might include authentication and/or principal attributes, the available locale, client http information, etc.
cas.account-registration.mail.validate-addressesSet whether to validate all addresses which get passed to this helper.
falseSet whether to validate all addresses which get passed to this helper. The application of this setting depends on the email provider implementation and may not be fully supported everywhere. This is typically relevant for the default org.springframework.mail.javamail.JavaMailSender.
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.
Email servers
The following settings may also need to be defined to describe the mail server settings:
spring.mail.default-encodingDefault MimeMessage encoding.
UTF-8Default MimeMessage encoding.
spring.mail.hostSMTP server host.
SMTP server host. For instance, 'smtp.example.com'.
spring.mail.jndi-nameSession JNDI name.
Session JNDI name. When set, takes precedence over other Session settings.
spring.mail.passwordLogin password of the SMTP server.
Login password of the SMTP server.
spring.mail.portSMTP server port.
SMTP server port.
spring.mail.propertiesAdditional JavaMail Session properties.
Additional JavaMail Session properties.
spring.mail.protocolProtocol used by the SMTP server.
smtpProtocol used by the SMTP server.
spring.mail.ssl.bundleSSL bundle name.
SSL bundle name. If set, 'mail.(protocol).ssl.socketFactory' property is set to an SSLSocketFactory obtained from the corresponding SSL bundle.
Note that the STARTTLS command can use the corresponding SSLSocketFactory, even if the 'mail.(protocol).ssl.enable' property is not set.
spring.mail.ssl.enabledWhether to enable SSL support.
falseWhether to enable SSL support. If enabled, 'mail.(protocol).ssl.enable' property is set to 'true'.
spring.mail.ssl.verify-hostnameWhether to enable hostname verification.
trueWhether to enable hostname verification.
spring.mail.test-connectionWhether to test that the mail server is available on startup.
falseWhether to test that the mail server is available on startup.
spring.mail.usernameLogin user of the SMTP server.
Login user of the SMTP server.
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.