Amazon SNS SMS Messaging
Send SMS messages from CAS through Amazon Simple Notification Service.
To learn more, visit this site.
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-sms-aws-sns</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-sms-aws-sns:${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-sms-aws-sns"
}
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-sms-aws-sns"
}
The following settings and properties are available from the CAS configuration catalog:
cas.sms-provider.sns.credential-access-keyUse access-key provided by AWS to authenticate.
Use access-key provided by AWS to authenticate.
cas.sms-provider.sns.credential-secret-keyUse secret key provided by AWS to authenticate.
Use secret key provided by AWS to authenticate.
cas.sms-provider.sns.endpointAWS custom endpoint.
AWS custom endpoint.
cas.sms-provider.sns.regionAWS region used.
AWS region used.
cas.sms-provider.sns.client-execution-timeoutClient execution timeout.
10000Client execution timeout.
cas.sms-provider.sns.connection-timeoutConnection timeout.
5000Connection timeout.
cas.sms-provider.sns.local-addressLocal address.
Local address.
cas.sms-provider.sns.max-connectionsMaximum connections setting.
10Maximum connections setting.
cas.sms-provider.sns.max-priceThe maximum amount in USD that you are willing to spend to send the SMS message.
The maximum amount in USD that you are willing to spend to send the SMS message.
Amazon SNS will not send the message if it determines that doing so would incur a cost that exceeds the maximum price. This attribute has no effect if your month-to-date SMS costs have already exceeded the limit set for the MonthlySpendLimit attribute, which you set by using the SetSMSAttributes request. If you are sending the message to an Amazon SNS topic, the maximum price applies to each message delivery to each phone number that is subscribed to the topic.
cas.sms-provider.sns.profile-nameProfile name to use.
Profile name to use.
cas.sms-provider.sns.profile-pathProfile path.
Profile path.
cas.sms-provider.sns.proxy-hostOptionally specifies the proxy host to connect through.
Optionally specifies the proxy host to connect through.
cas.sms-provider.sns.proxy-passwordOptionally specifies the proxy password to connect through.
Optionally specifies the proxy password to connect through.
cas.sms-provider.sns.proxy-usernameOptionally specifies the proxy username to connect through.
Optionally specifies the proxy username to connect through.
cas.sms-provider.sns.retry-modeOutline the requested retry mode.
STANDARDOutline the requested retry mode. Accepted values are STANDARD, LEGACY.
cas.sms-provider.sns.sender-idA custom ID that contains up to 11 alphanumeric characters, including at least one letter and no spaces.
A custom ID that contains up to 11 alphanumeric characters, including at least one letter and no spaces.
The sender ID is displayed as the message sender on the receiving device. For example, you can use your business brand to make the message source easier to recognize. Support for sender IDs varies by country and/or region. For example, messages delivered to U.S. phone numbers will not display the sender ID. If you do not specify a sender ID, the message will display a long code as the sender ID in supported countries and regions. For countries or regions that require an alphabetic sender ID, the message displays NOTICE as the sender ID.
cas.sms-provider.sns.sms-typeThe type of message that you are sending.
Transactional- Promotional - Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
- Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
cas.sms-provider.sns.socket-timeoutSocket timeout.
5000Socket timeout.
cas.sms-provider.sns.use-reaperFlag that indicates whether to use reaper.
falseFlag that indicates whether to use reaper.
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.