/agama-sms

Agama Project that utilizes sending an SMS OTP to verify control of a mobile device

Primary LanguageJavaApache License 2.0Apache-2.0

Agama SMS

Contributors Forks Stargazers Issues Apache License

This Agama Project uses OTP SMS to helps enhance security, reduce the risk of unauthorized access and fraud, and ensure compliance with regulatory requirements in various online services and transactions. For more information you can also see:

Requirements

  • Agama Dependency: No dependency
  • Third Party Accounts: A Twilio Account with access to the settings.

Supported IDPs

IDP Description
Jans Auth Server https://docs.jans.io/v1.1.0/admin/planning/

Flows

Qualified Name Description
org.gluu.agama.sms.main This is the main flow, it control the first factor of the authentication and trigger the second factor.
org.gluu.agama.sms.otp This flow collect OTP code from user and perform validation. When validation is done the result is send back to the main flow.
org.gluu.agama.sms.register This flow is use to register user's phone number if the phone number is not setup.

Configuration

Flow Property Value Description
org.gluu.agama.sms.main ACCOUNT_SID Your twilio ACCOUNT_SID (available in your twilio account settings page)
org.gluu.agama.sms.main AUTH_TOKEN Your twilio AUTH_TOKEN (available in your twilio account settings page)
org.gluu.agama.sms.main FROM_NUMBER Your twilio FROM_NUMBER (available in your twilio account settings page)

Sample JSON:

```
    {
        "org.gluu.agama.sms.otp": {},
        "org.gluu.agama.sms.register": {},
        "org.gluu.agama.sms.main": {
          "ACCOUNT_SID": "PUT_YOUR_TWILIO_ACCOUNT_SID_HERE",
          "AUTH_TOKEN": "PUT_YOUR_TWILIO_AUTH_TOKEN_HERE",
          "FROM_NUMBER": "PUT_YOUR_TWILIO_FROM_NUMBER_HERE"
        }
    }
 ```

Demo

Contributors

Thomas
Mougang Gasmyr

License

This project is licensed under the Apache 2.0