用于电话和短信的 Keycloak 提供程序
sms voice phone one key login
With this provider you can enforce authentication policies based on a verification token sent to users' mobile phones. Currently, there are implementations for:
More services can be added with ease due to the modularity of the code. In fact, nothing would stop you from implementing a sender of TTS calls or WhatsApp messages.
This is what you can do for now:
redirect_uri paramsCondition - phone provided #46number-regx rename to number-regex, and match regex at after canonicalize phone numberCookie Max Age and add cli param otp-expiresConfigure OTP over SMS or setting Create OTP Credential in user registration ), Regardless of the user's phone numberhour-maximum rename to target-hour-maximumsource-hour-maximumMigration:
canonicalize-phone-numbers is "" or compatible is true , because in old user data phone number is not canonicalize.number-regx to number-regex and change regex match after canonicalize phone numberThis was initially developed using Quarkus Keycloak as baseline. Wildfily keycloak is not supported anymore and I did not test user storage beyond Kerberos or LDAP. I may try to help you but I cannot guarantee.
docker-compose up , docker-compose is required!If you want to build the project, simply run examples/docker-build.sh after cloning the repository.
keycloak-phone-provide
main
keycloak-phone-provide.resources
theme
keycloak-sms-provider-dummy
test message will print to console.
For sms service provider, choose one of:keycloak-sms-provider-aws-snskeycloak-sms-provider-totalvoicekeycloak-sms-provider-twiliokeycloak-sms-provider-cloopenkeycloak-sms-provider-yunxinkeycloak-sms-provider-aliyunkeycloak-sms-provider-tencent
Local
target\providers to keycloak home directoryCli params
…You will need to change the realm login theme to phone.
You can create a customized theme base on phone.
parent=phoneTwo user attributes are going to be used by this provider: phoneNumberVerified (bool) and phoneNumber (str). Multiple
users can have the same phoneNumber, but only one of them will have phoneNumberVerified = true at the end of a
verification process. This accommodates the use case of pre-paid numbers that get recycled if inactive for too much time.
Under Authentication > Flows:
Copy the Registration flow to Registration with phone flow through the menu button on the right of the registration flow
Replace Registration User Creation with Registration Phone User Creation
(Optional) Click on settings for Registration Phone User Creation to configure it
(Optional) To enable phone verification, click on Registration with phone registration Form >Add Phone validation if you want to verify phone.
(Optional) Read query parameter add to user attribute:
Click on Registration with phone registration Form > Actions > Add execution on the Query Parameter Reader line
Click on Registration with phone registration Form > Actions > configure add accept param name in to
(Optional) Hidden password field:
Delete or disable Password Validation.
(Optional) if not any user profile:
Delete or disable Profile Validation
Set all added items as Required.
On the Authentication page, bind Registration with phone to Registration flow and select it to be Required.
Under Realm Settings > Themes
Set Login Theme to phone
Tip:
If Realm parameter Email as username is true, then config Phone number as username and hide email is invalid!
If parameter duplicate-phone is true then Phone number as username is invalid!
Registration URL:
http:///realms//protocol/openid-connect/registrations?client_id=&response_type=code&scope=openid%20email&redirect_uri=Under Authentication > Flows:
Browser flow to Browser with phone flowUsername Password Form with Phone Username Password FormPhone Username Password Form to configure.Under Realm Settings > Themes
Set Login Theme as phone
Set Bind Browser with phone to Browser flow
On the Authentication page, bind Browser with phone to Browser flow
Phone OTP uses OTP Credential's phone number,Different from the user's phone number, Credential's phone number come from required actions Configure OTP over SMS, Unless the Create OTP Credential is enabled on user registration flow.
On Authentication page, copy the browser flow and replace OTP with OTP Over SMS . Don't forget to bind this flow copy as the de facto browser flow.
Finally, Enable the required actions Configure OTP over SMS in the Required Actions tab.
Under Authentication > Flows:
Direct Grant flow to Direct grant with phone flowAdd step on the Provide Phone Number lineAdd step on the Provide Verification Code lineProvide Phone Number and Provide Verification Code to REQUIREDUnder Clients > $YOUR_CLIENT > Advanced > Authentication Flow Overrides
Bind Direct Grant Flow to Direct grant with phone
Either Phone/Otp or Username/Password :
Under Authentication > Flows:
Direct Grant flow to Direct grant everybody with phone flowActions > Add step on the Authentication Everybody By Phone line and move to firstAuthentication Everybody By Phone to REQUIREDUnder Clients > $YOUR_CLIENT > Advanced > Authentication Flow Overrides
Set Direct Grant Flow to Direct grant everybody with phone
About the API endpoints:
You'll get 2 extra endpoints that are useful to do the verification from a custom application.
GET /realms/{realmName}/sms/verification-code?phoneNumber=+5534990001234 (To request a number verification. No auth required.)POST /realms/{realmName}/sms/verification-code?phoneNumber=+5534990001234&code=123456 (To verify the process. User must be authenticated.)You'll get 2 extra endpoints that are useful to do the access token from a custom application.
GET /realms/{realmName}/sms/authentication-code?phoneNumber=+5534990001234 (To request a number verification. No auth required.)POST /realms/{realmName}/protocol/openid-connect/token
Content-Type: application/x-www-form-urlencoded
grant_type=password&phone_number=$PHONE_NUMBER&code=$VERIFICATION_CODE&client_id=$CLIENT_ID&client_secret=$CLIENT_SECRECTAnd then use Verification Code authentication flow with the code to obtain an access code.
Under Authentication > Flows:
Reset credentials flow to Reset credentials with phone flowAdd step on the Rest Credential With Phone lineAdd step on the Send Rest Email If Not Phone lineSend Rest Email If Not Phone to ConditionalRest Credential With Phone and Reset Password to REQUIREDSet Bind Reset credentials with phone to Reset credentials flow
Condition - phone provided
Update Phone Number update user's phone number on next login.Configure OTP over SMS update OTP Credential's phone number on next login.Phone one key login Testing , coming soon!
Some code written is based on existing ones in these two projects: keycloak-sms-provider and keycloak-phone-authenticator. Certainly I would have many problems coding all those providers blindly. Thank you!
暂无开放 Issues,或尚未同步最近议题。