https://github.com/mesutpiskin/keycloak-2fa-email-authenticator

🔒 Keycloak Authentication Provider implementation to get a two factor authentication with a OTP/code/token send via Email (through SMTP)
https://github.com/mesutpiskin/keycloak-2fa-email-authenticator

email-otp keycloak keycloak-spi two-factor-authentication

Last synced: about 1 month ago
JSON representation

🔒 Keycloak Authentication Provider implementation to get a two factor authentication with a OTP/code/token send via Email (through SMTP)

• Host: GitHub
• URL: https://github.com/mesutpiskin/keycloak-2fa-email-authenticator
• Owner: mesutpiskin
• License: apache-2.0
• Created: 2022-10-20T17:22:17.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-13T07:18:38.000Z (about 2 months ago)
• Last Synced: 2024-05-13T08:33:08.963Z (about 2 months ago)
• Topics: email-otp, keycloak, keycloak-spi, two-factor-authentication
• Language: Java
• Homepage: https://medium.com/@mesutpiskin/two-factor-authentication-via-email-in-keycloak-custom-auth-spi-935bbb3952a8
• Size: 190 KB
• Stars: 109
• Watchers: 6
• Forks: 66
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-keycloak - 2FA with Code sent via Email

README

        
# 🔒 Keycloak 2FA Email Authenticator

Keycloak Authentication Provider implementation to get a two factor authentication with an OTP (One-time-password) send via Email (through SMTP).

When logging in with this provider, you can send a verification code (OTP) to the user's e-mail address.

Tested with Keycloak version 22.0.1. If you are using a different Keycloak version, don't forget to change the version in pom.xml file.

The [Server Development part of the Keycloak reference documentation](https://www.keycloak.org/docs/latest/server_development/index.html) contains additional resources and examples for developing custom Keycloak extensions.

# Development

If you are using Eclipse, you need to install the Lombok plugin, otherwise Eclipse cannot resolve `log` which is declared at runtim through @JBossLog annotation.

Find further information at https://projectlombok.org/setup/eclipse

# 🚀 Deployment

## Artifact

You can download the necessary artifacts for Keycloak 2FA Email Authenticator from the [release on GitHub.](https://github.com/mesutpiskin/keycloak-2fa-email-authenticator/releases/tag/v0.4) Please choose the appropriate version based on your Keycloak installation.

## Providers

`mvn package` will create a jar file.

copy `keycloak-2fa-email-authenticator.jar` to `keycloak/providers/` directory.

If you are Dockerized keycloak then copy to `/opt/jboss/keycloak/standalone/deployments/` directory.

## Theme Resources

- **html/code-email.ftl** is a html email template. Copy to `themes/base/email/html/`

- copy **text/code-email.ftl**  to `themes/base/email/text/`

- append **messages/*.properties** to `themes/base/email/messages/messages_en.properties`

## Build

Don't forget to start kc.sh with build parameter to make KeyCloak recognize the new povider:

> bin/kc.sh build

# Configuration

## Email Configuration

Don't forget to configure your realm's SMTP settings, otherwise no email will be send:

1. Login as admin on your KeyCloak installation.

2. Switch to your realm

3. Click `Realm settings` from the menu on the left.

4. Click on the `Email`-tab and enter your smpt data.

## Authentication Flow

Create new browser login authentication flow and add Email OTP flow after Username Password Form.