https://github.com/gwallet/keycloak-sms-authenticator

https://github.com/gwallet/keycloak-sms-authenticator

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/gwallet/keycloak-sms-authenticator
• Owner: gwallet
• License: epl-2.0
• Created: 2017-02-27T09:51:10.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-13T01:54:55.000Z (almost 2 years ago)
• Last Synced: 2024-05-28T12:51:59.519Z (6 months ago)
• Language: Java
• Size: 40 KB
• Stars: 193
• Watchers: 10
• Forks: 168
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# keycloak-sms-authenticator

To install the SMS Authenticator one has to:

* Add the jar to the Keycloak server:

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

* Add two 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/`

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 Authernticator, 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 boes are checked.