kirinse/keycloak-aws-ses-email-provider

Drop-in Email Provider SPI replacement for Keycloak to send emails via AWS Simple Email Service (SES). Demo purposes only

Keycloak Email Provider for AWS SES (Simple Email Service)

This is a drop-in Email Provider SPI replacement implementation for Keycloak SSO server. It's for demo purposes only and can be used as base for your own implementation.

The codebase is provided as-is and might not be free of errors. So, you're on your own when using it. Generally, this project is work in progress.

Dependencies

The implementation uses the AWS Java API Version 2. This dependency will be packaged with the help of the Maven Shade Plugin into the target JAR archive.

To save space and build a smaller fat-jar, all the async resources have been excluded from the AWS SDK. The email provider just uses the synchronous client.

All other dependencies are used from Keycloaks underlying Wildfly server (see jboss-deployment-structure.xml).

Installation

Build the project with mvn package and copy the generated .jar file (the shaded one, not the original one!) into the standalone/deployments/ folder of your Keycloak installation. It will be deployed automatically (hot deployment works the same).

Configuration

To configure the email provider SPI, include a snippet like this in your standalone(-ha).xml file:

<subsystem xmlns="urn:jboss:domain:keycloak-server:1.1">
  ...
  <spi name="emailSender">
    <default-provider>aws-ses</default-provider>
    <provider name="aws-ses" enabled="true">
      <!-- Optional, if you want (or need) to set another region for SES as the environment default region: -->
      <properties>
        <property name="region" value="eu-west-1"/>
      </properties>
    </provider>
  </spi>
  ...
</subsystem>

Alternatively, you can use this jboss-cli script snippet to configure your Keycloak server:

if (outcome == success) of /subsystem=keycloak-server/spi=emailSender:read-resource
  /subsystem=keycloak-server/spi=emailSender/:remove()
end-if
/subsystem=keycloak-server/spi=emailSender/:add(default-provider=aws-ses)
/subsystem=keycloak-server/spi=emailSender/provider=aws-ses/:add(enabled=true)
# Optional, if you want (or need) to set another region for SES as the environment default region:
# /subsystem=keycloak-server/spi=emailSender/provider=aws-ses/:write-attribute(name=properties,value={"region" => "eu-west-1"})

As the Email Provider SPI is not selectable/configurable on a per-realm base, you can't set the AWS SES provider for one realm and leave the default SMTP provider in another. If you use/configure this SPI to be used in Keyclaok, it's system-wide!

Additionally, Keycloak does not provide a possibility to configure an Email Provider SPI through the admin console with custom values. The way described above is the only way.

However, with this SPI implementation, you can use the values for from, fromDisplayName, replyTo and replyToDisplayName from the defaut SMTP configuration page in your sent emails:

Will result in:

AWS Configuration

This SPI makes use of the DefaultAWSCredentialsProviderChain and the DefaultAWSRegionProviderChain. So, it's on you how you configure your Keycloak environment in a way that is able to authenticate itself against AWS.

For specifying a different region for SES usage, see configuration above.

Your used profile needs the privilege to send emails with at least ses:SendEmail.