https://github.com/nickpack/keycloak-sms-authenticator-sns

SMS 2 Factor Authentication for Keycloak via AWS SNS
https://github.com/nickpack/keycloak-sms-authenticator-sns

authentication aws keycloak sns two-factor-authentication

Last synced: about 1 month ago
JSON representation

SMS 2 Factor Authentication for Keycloak via AWS SNS

• Host: GitHub
• URL: https://github.com/nickpack/keycloak-sms-authenticator-sns
• Owner: nickpack
• License: epl-2.0
• Archived: true
• Fork: true (gwallet/keycloak-sms-authenticator)
• Created: 2017-08-09T09:06:55.000Z (almost 7 years ago)
• Default Branch: develop
• Last Pushed: 2018-11-15T12:13:09.000Z (over 5 years ago)
• Last Synced: 2024-04-15T03:18:16.050Z (3 months ago)
• Topics: authentication, aws, keycloak, sns, two-factor-authentication
• Language: Java
• Homepage:
• Size: 91.8 KB
• Stars: 71
• Watchers: 7
• Forks: 37
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-keycloak - SMS 2 Factor Authentication for Keycloak via AWS SNS

README

        
# keycloak-sms-authenticator-sns

To install the SMS Authenticator one has to:

* Add the jar to the Keycloak server:

  * `$ cp target/keycloak-sms-authenticator-sns-*.jar _KEYCLOAK_HOME_/providers/`

* Add three templates to the Keycloak server:

  * `$ cp templates/sms-validation.ftl _KEYCLOAK_HOME_/themes/base/login/`

  * `$ cp templates/sms-validation-error.ftl _KEYCLOAK_HOME_/themes/base/login/`

  * `$ cp templates/sms-validation-mobile-number.ftl _KEYCLOAK_HOME_/themes/base/login/`

Configure your REALM to use the SMS Authentication.

First create a new REALM (or select a previously created REALM).

Under Authentication > Flows:

* Copy 'Browse' flow to 'Browser with SMS' flow

* Click on 'Actions > Add execution on the 'Browser with SMS Forms' line and add the 'SMS Authentication'

* Set 'SMS Authentication' to 'REQUIRED' or 'ALTERNATIVE'

* To configure the SMS Authenticator, click on Actions  Config and fill in the attributes.

Under Authentication > Bindings:

* Select 'Browser with SMS' as the 'Browser Flow' for the REALM.

Under Authentication > Required Actions:

* Click on Register and select 'SMS Authentication' to add the Required Action to the REALM.

* Make sure that for the 'SMS Authentication' both the 'Enabled' and 'Default Action' check boxes are checked.

* Click on Register and select 'Mobile Number' to add the Required Action to the REALM.

* Make sure that for the 'Mobile Number' both the 'Enabled' and 'Default Action' check boxes are checked.

Malys contributions (for [Lyra Network](https://www.lyra-network.com/))

* Internationalization support

* Vault, Java properties, environment variables parameters support

* Lyrasms gateway support

* Add mobilephone number verification

* Add input mobile phone number on authenticator

* Refactoring

* Template cleaning

* Documentation