forgerock / twilio-verify-auth-tree-nodes

An authentication node for ForgeRock's Identity Platform 6.0.0 and above which integrates the Twilio Verify service with AM

Twilio Verify Auth Nodes

An authentication node for ForgeRock's Identity Platform 7.0.0 and ForgeRock Identity Cloud which integrates the Twilio Verify service with AM.

Usage

To deploy these nodes, download the jar from the releases tab on github here. Next, copy the jar into the ../web-container/webapps/openam/WEB-INF/lib directory where AM is deployed. Restart the web container to pick up the new node. The node will then appear in the authentication trees components palette.

If you'd like to build the integration from source, the code in this repository has binary dependencies that live in the ForgeRock maven repository. Maven can be configured to authenticate to this repository by following the following ForgeRock Knowledge Base Article.

Twilio Verify Sender Auth Node Configuration

This node kicks off the Twilio Verify request via the configured channel to the users device. This node can also optionally request the identifier from the user to send the one-time password. By default, this node looks to the userIdentifier value in sharedState for the user identifier. Twilio can also be configured to use geopermissions in the Twilio console, and information on that can be found here.

• Account SID - The unique string to identify the Account found in the Twilio account dashboard.
• Authentication Token - The authentication token found in the Twilio account dashboard.
• Service SID - The unique string to identify the Service in the Twilio account dashboard.
• Channel - The delivery channel that the OTP should be sent through. If the Email channel is specified, the Twilio Verify Service must be integrated with Sendgrid to send emails. Instructions on how to do that can be found here. If the SMS, WHATSAPP or Call channel is specified, the user identifier must contain the country code and can optionally contain special characters. All special characters are removed before the request is sent to Twilio. Valid identifiers would be: [phone] or 1(555)323-1234. Invalid identifiers would be [phone] as the country code is not present.
• Request Identifier - Should the node request the identifier from the user or should it look to the userIdentifier value in shared state.
• Identifier Shared State - The shared state variable to search for the identifier in.

Twilio Verify Collector Decision Auth Node Configuration

This node collects the one-time password from the user and validates that password against the Twilio Verify service.

• Hide Code Text - If enabled, hides the code text from the end user similar to a password collector.
• Identifier Shared State - The shared state variable to search for the identifier in.

Twilio Verify Lookup Auth Node Configuration

This node will do a lookup and check if the provided phone number is valid mobile carrier.

• Account SID - The unique string to identify the Account found in the Twilio account dashboard.
• Authentication Token - The authentication token found in the Twilio account dashboard.
• Identifier Shared State - The shared state variable to search for the identifier in.

Twilio Verify Identifier Node Configuration

This node will pull an attribute from the user's profile and store it in the shared state. These attributes can be the telephone number or email.

• Identifier Attribute - The unique string to identify the Account found in the Twilio account dashboard.
• Identifier Shared State - The shared state variable to store the identifier in.

Example Flow 1

The example flow below validates the users username and password, asks the user for their phone number, and sends a one-time password via SMS to that phone number. This is not a recommended flow for production use, but could be altered to pull the users phoneNumber from their profile. To deploy this flow via the AM-treetool, run cat Treetool/Twilio.json | amtree.sh -i verify -h https://{{AM_Domain}} -u amadmin -p {{admin_password}}.

Example Flow 2

The example flow above validates the user's username and password, identifies the users, pulls the phone number from the users profile, and sends a one-time password via SMS to that phone number. The Identify Exister User Node is used to identify the user.

Example Flow 3

The example flow above validates the user's username and password, identifies the users, pulls the phone number from the users profile, verifies the phone number is a mobile carrier, and sends a one-time password via SMS to that phone number. The Identify Exister User Node is used to identify the user.

twilio-verify-auth-tree-nodes's Issues

VerifyAuthNode-1.3.8 not working with AM 7.5.0

VerifyAuthNode-1.3.8 not working with AM 7.5.0, its giving below error, could it possible to get compatible jar for AM 7.5.0 @BrunoLavitForgerock @TylerGelinas

java.lang.NoSuchMethodError: 'com.sun.identity.idm.AMIdentity org.forgerock.openam.core.CoreWrapper.getIdentity(java.lang.String, java.lang.String)'