Configuring Email OTP

This section provides the instructions to configure multi-factor authentication (MFA) using Email One Time Password (Email OTP) in WSO2 Identity Server (WSO2 IS). The Email OTP enables a one-time password (OTP) to be used at the second step of MFA.

Follow the instructions in the sections below to configure MFA using Email OTP:

Before you begin!

To ensure you get the full understanding of configuring Email OTP with WSO2 IS, the sample travelocity application is used in this use case. Therefore, make sure to download the samples before you begin.
The samples run on the Apache Tomcat server and are written based on Servlet 3.0. Therefore, download Tomcat 7.x from here.
Install Apache Maven to build the samples. For more infomation, see Installation Prerequisites.

Configure the email OTP provider

You can use WSO2 Identity Server as the email OTP provider or you can configure Gmail or SendGrid as the email OTP provider using Gmail or SendGrid APIs. Follow the instructions in one of these sections to set up the email OTP provider.

Configure WSO2 IS as the email OTP provider

Follow the steps below to configure WSO2 IS to send emails once the Email OTP is enabled.

Alternatively, you can configure Gmail as the email OTP provider by following the instructions given in this section.

Shut down the server if it is running.

Open the <IS_HOME>/repository/conf/axis2/axis2.xml file, uncomment the transportSender name = "mailto" configurations, and update the following properties:

`mail.smtp.from`	Provide the email address of the SMTP account.
`mail.smtp.user`	Provide the username of the SMTP account.
`mail.smtp.password`	Provide the password of the SMTP account.

<transportSender  name="mailto"
class="org.apache.axis2.transport.mail.MailTransportSender">
    <parameter  name="mail.smtp.from">{SENDER'S_EMAIL_ID}</parameter>
	<parameter  name="mail.smtp.user">{USERNAME}</parameter>
	<parameter  name="mail.smtp.password">{PASSWORD}</parameter>
	<parameter  name="mail.smtp.host">smtp.gmail.com</parameter>
    <parameter  name="mail.smtp.port">587</parameter>
    <parameter  name="mail.smtp.starttls.enable">true</parameter>
    <parameter  name="mail.smtp.auth">true</parameter>
</transportSender>

If you are using Gmail account you have to on "Allow less secure apps" in your account.

Comment out the <module ref="addressing"/> property to avoid syntax errors.
```

```

Add the following email template to the <IS_HOME>/repository/conf/email/email-admin-config.xml.

<configuration type="EmailOTP" display="idleAccountReminder" locale="en_US" emailContentType="text/html">
   <targetEpr></targetEpr>
   <subject>WSO2 IS Email OTP</subject>
   <body>
      Hi,
      Please use this one time password {{OTPCode}} to sign in to your application.
   </body>
   <footer>
      Best Regards,
      WSO2 Identity Server Team
      http://www.wso2.com
   </footer>
   <redirectPath></redirectPath>
</configuration>

Configure the following properties in the <PRODUCT_HOME>/repository/conf/identity/identity-mgt.properties file to true.
```
Authentication.Policy.Enable=true
Authentication.Policy.Check.OneTime.Password=true
```

Add the following configuration to the application-authentication.xml file in the <IS_HOME>/repository/conf/identity directory.

<AuthenticatorConfig name="EmailOTP" enabled="true"> 
	<Parameter name="EMAILOTPAuthenticationEndpointURL">https://localhost:9443/emailotpauthenticationendpoint/emailotp.jsp</Parameter>
	<Parameter name="EmailOTPAuthenticationEndpointErrorPage">https://localhost:9443/emailotpauthenticationendpoint/emailotpError.jsp</Parameter>
	<Parameter name="EmailAddressRequestPage">https://localhost:9443/emailotpauthenticationendpoint/emailAddress.jsp</Parameter>
	<Parameter name="usecase">association</Parameter> 
	<Parameter name="useEventHandlerBasedEmailSender">true</Parameter>
	<Parameter name="secondaryUserstore">primary</Parameter>
	<Parameter name="EMAILOTPMandatory">false</Parameter> 
	<Parameter name="sendOTPToFederatedEmailAttribute">false</Parameter> 
	<Parameter name="federatedEmailAttributeKey">email</Parameter> 
	<Parameter name="EmailOTPEnableByUserClaim">true</Parameter> 
	<Parameter name="useEventHandlerBasedEmailSender">true</Parameter>
	<Parameter name="CaptureAndUpdateEmailAddress">true</Parameter> 
	<Parameter name="showEmailAddressInUI">true</Parameter> 
</AuthenticatorConfig>

To view the parameter definitions, click here

Parameter Description Sample Values

usecase

This parameter defines how the email ID will be retrieved. The default value is local.

Click here to view the value definitions

Value	Definition
local	This is the default value and is based on the federated username. You must set the federated username in the local userstore . The federated username must be the same as the local username.
association	The federated username must be associated with the local account in advance in the end user dashboard. The local username is retrieved from the association. To associate the user, log into the end user dashboard and go to Associated Account by clicking View details .
subjectUri	When configuring the federated authenticator, select the attribute in the subject identifier under the service provider section in UI, this is used as the username of the `EmailOTP` authenticator.
userAttribute	The name of the federatedauthenticator'suserattribute. That is the local username that is contained in a federated user's attribute. When using this, add the following parameter under the `<AuthenticatorConfig name="EmailOTP" enabled="true">` section in the `<IS_HOME>/repository/conf/identity/application-authentication.xml` file and put the value, e.g., email and screen_name, id. <Parameter name="userAttribute">email</Parameter> If you use OpenID Connect supported authenticators such as LinkedIn and Foursquare or in the case of multiple social login options as the first step and EmailOTP assecondstep, you need to add similar configuration for the specific authenticator in the `<IS_HOME>/repository/conf/identity/application-authentication.xml` file under the <`AuthenticatorConfigs`> section. Examples: Fourquare <AuthenticatorConfig name="Foursquare" enabled="true"> <Parameter name="EmailOTP-userAttribute">http://wso2.org/foursquare/claims/email</Parameter> <Parameter name="federatedEmailAttributeKey">http://wso2.org/foursquare/claims/email</Parameter> </AuthenticatorConfig> LinkedIn <AuthenticatorConfig name="LinkedIn" enabled="true"> <Parameter name="EmailOTP-userAttribute">http://wso2.org/linkedin/claims/emailAddress</Parameter> <Parameter name="federatedEmailAttributeKey">http://wso2.org/linkedin/claims/emailAddress</Parameter> </AuthenticatorConfig> Facebook <AuthenticatorConfig name="FacebookAuthenticator" enabled="true"> <Parameter name="EmailOTP-userAttribute">email</Parameter> <Parameter name="federatedEmailAttributeKey">email</Parameter> </AuthenticatorConfig> Likewise, you can add the Authenticator Config for Amazon, Google, Twitter, and Instagram with the relevant values.

local
association
userAttribute
subjectUri

secondaryUserstore

You can define multiple user stores per tenant as comma separated values.

Example:

<Parameter name="secondaryUserstore">jdbc, abc, xyz</Parameter>

The user store configurations are maintained per tenant:

If you use a super tenant, set all the parameter values into the <IS_HOME>/repository/conf/identity/application-authentication.xml file under the AuthenticatorConfigs section.

If you use a tenant,
- Upload the same XML file (application-authentication.xml) into a specific registry location (/_system/governance/EmailOTP).
- Create the collection named EmailOTP, add the resource and upload the application-authentication. xml file into the registry.
- While doing the authentication,thesysetmfirstcheckswhetherthereisanXML file uploaded to the registry. If that is so, it reads it from the registry but does not take the local file. If there is no file in the registry, then it only takes the property values from the local file.
- You can use the registry or local file to get the property values.

EMAILOTPMandatory

Thisparmeterdefineswhtherthe EmailOTP is enforced as the second step of the 2FA/MFA or not.

- If the user is not found in the active directory where the parameter is set to true, the OTP is directly sent to the email address defined in the claims set.
- If the user is not found in the active directory where the parameter is set to false , the authentication flow terminates at the first step of the 2FA/MFA.

true
false

sendOTPToFederatedEmailAttribute

When the EMAILOTPMandatory and this parameter are set to true and the user is not found in the active directory, the OTPissetn to the mail defined in the federated authenticator claim.

When the EMAILOTPMandatory is set to false, an error page gets displayed.

When the EMAILOTPMandatory is set to false and the user is not found in the active directory, the authentication mechanism terminates at the first step of the 2FA/MFA. This parameter is not required in such a scenario.

true
false

federatedEmailAttributeKey

This parameter identifies the email attribute of the federated authenticator, e.g. Foursquare. Set this parameter if the sendOTPToFederatedEmailAttribute is set to true. Example:

http://wso2.org/foursquare/claims/email

EmailOTPEnableByUserClaim

This parameter enables the user to overidethefunctionalitydefinedattheEMAILOTPMandatory parameter.

- If this parameter and the EMAILOTPMandatory parameters are set to true, the user can either enable or disable the EmailOTP functionality.
- If this parameter is set to false where the EMAILOTPMandatory parameter is set to true, the user gets redirected to an error page.
- If this parameter and the EMAILOTPMandatory parameters are set to false, the authentication flow terminates at the first step of the 2FA/MFA.
- If the user is not available in the active directory

true
false

CaptureAndUpdateEmailAddress

This parameter enables the user to update the email address that is used to send the OTP, at the first login where the email address is not previously set.

true
false

EmailAddressRequestPage

This parameter enables to display a page that requests for an email address where

- The user has not registered an email address.
- Sending OTP is defined as the second step of 2FA/MFA.
- The CaptureAndUpdateEmailAddress parameter is set to true.

Example: https://localhost:9443/emailotpauthenticationendpoint/emailAddress.jsp

showEmailAddressInUI

This parameter enables to display the email address to which the OTP is sent to on the UI.

true
false

Start WSO2 IS.

Configure Gmail as the email OTP provider

You can send the One Time Password (OTP) using Gmail APIs or using SendGrid. Follow the steps given below to configure Gmail APIs as the mechanism to send the OTP.

Alternatively, you can configure WSO2 Identity Server as the email OTP provider by following the instructions given in this section.

Create a Google account at https://gmail.com.
Got to https://console.developers.google.com and click ENABLE APIS AND SERVICES.
Search for Gmail API and click on it.
Click Enable to enable the Gmail APIs.
Why is this needed?

If you do not enable the Gmail APIs, you run in to a 401 error when trying out step13.
Click Credentials and click Create to create a new project.
Click Credentials and click the Create credentials drop-down.
Select OAuth client ID option.
Click Configure consent screen.
Enter the Product name that needs to be shown to users, enter values to any other fields you prefer to update, and click Save.
Select the Web application option.
Enter https://localhost:9443/commonauth as the Authorize redirect URIs text-box, and click Create.

The client ID and the client secret are displayed.
Copy the client ID and secret and keep it in a safe place as you require it for the next step.
Copy the URL below and replace the <ENTER_CLIENT_ID> tag with the generated Client ID. This is required to generate the authorization code.
Paste the updated URL into your browser.
1. Select the preferred Gmail account with which you wish to proceed.
2. Click Allow.
3. Obtain the authorization code using a SAML tracer on your browser.
To generate the access token, copy the following cURL command and replace the following place holders:
1. <CLIENT-ID> : Replace this with the client ID obtained in Step 10 above.
2. <CLIENT_SECRET> : Replace this with the client secret obtained in Step 10 above.
3. <AUTHORIZATION_CODE> : Replace this with the authorization code obtained in Step 12 above.
Paste the updated cURL command in your terminal to generate the OAuth2 access token, token validity period, and the refresh token.

Update the following configurations under the <AuthenticatorConfigs> section in the <IS_HOME>/repository/conf/identity/application-authentication.xml file.

If you need to send the content in a payload, you can introduce a property in a format <API> Payload and define the value. Similarly, you can define the Form Data.FormdataforSendgridAPIisgivenasan example.
You can use <API> URLParams, <API>AuthTokenType, <API>Failure and <API>TokenEndpoint property formats to specify the URL parameters, Authorization token type, Message to identify failure and Endpoint to get access token from refresh token respectively.
Value of <API> URLParams should be like; api_user=<API_USER>&api_key=<API_KEY>&data=<DATA>&list<LIST>

Property	Description
`GmailClientId`	Enter the Client ID you got in step 10. Example: `501390351749-ftjrp3ld9da4ohd1rulogejscpln646s.apps.googleusercontent.com`
`GmailClientSecret`	Enter the client secret you got in step 10. Example: `dj4st7_m3AclenZR1weFNo1V`
`SendgridAPIKey`	This property is only required if you are using the Sengrid method. Since you are using Gmail APIs, keep the default value.
`GmailRefreshToken`	Enter the refresh token that you got as the response in step 12. Example: `1/YgNiepY107SyzJdgpynmf-eMYP4qYTPNG_L73MXfcbv`
`GmailEmailEndpoint`	Enter your username of your Gmail account in place of the `[userId]` place holder. Example: `https://www.googleapis.com/gmail/v1/users/alex@gmail.com/messages/send`
`SendgridEmailEndpoint`	This property is only required if you are using the Sengrid method. Since you are using Gmail APIs, keep the default value.
`accessTokenRequiredAPIs`	Use the default value.
`apiKeyHeaderRequiredAPIs`	This property is only required if you are using the Sengrid method. Since you are using Gmail APIs, keep the default value.
`SendgridFormData=to`	This property is only required if you are using the Sengrid method. Since you are using Gmail APIs, keep the default value.
`SendgridURLParams`	This property is only required if you are using the Sengrid method. Since you are using Gmail APIs, keep the default value.
`GmailAuthTokenType`	Use the default value.
`GmailTokenEndpoint`	Use the the deafult value.
`SendgridAuthTokenType`	This property is only required if you are using the Sengrid method. Since you are using Gmail APIs, keep the default value.

Click here to see a sample configuration

<AuthenticatorConfig name="EmailOTP" enabled="true">
   <Parameter name="GmailClientId">501390351749-ftjrp3ld9da4ohd1rulogejscpln646s.apps.googleusercontent.com </Parameter>
   <Parameter name="GmailClientSecret">dj4st7_m3AclenZR1weFNo1V</Parameter>
   <Parameter name="SendgridAPIKey">sendgridAPIKeyValue</Parameter>
   <Parameter name="GmailRefreshToken">1/YgNiepY107SyzJdgpynmf-eMYP4qYTPNG_L73MXfcbv</Parameter>
   <Parameter name="GmailEmailEndpoint">https://www.googleapis.com/gmail/v1/users/alex@gmail.com/messages/send</Parameter>
   <Parameter name="SendgridEmailEndpoint">https://api.sendgrid.com/api/mail.send.json</Parameter>
   <Parameter name="accessTokenRequiredAPIs">Gmail</Parameter>
   <Parameter name="apiKeyHeaderRequiredAPIs">Sendgrid</Parameter>
   <Parameter name="SendgridFormData">sendgridFormDataValue</Parameter>
   <Parameter name="SendgridURLParams">sendgridURLParamsValue</Parameter>
   <Parameter name="GmailAuthTokenType">Bearer</Parameter>
   <Parameter name="GmailTokenEndpoint">https://www.googleapis.com/oauth2/v3/token</Parameter>
   <Parameter name="SendgridAuthTokenType">Bearer</Parameter>
   <Parameter name="redirectToMultiOptionPageOnFailure">false</Parameter>
   <Parameter name="usecase">association</Parameter>
   <Parameter name="useEventHandlerBasedEmailSender">true</Parameter>	
</AuthenticatorConfig>

[Back to Top]

Deploy the travelocity.com sample

Now that you have set up WSO2 IS or Gmail as the Email OTP provider, follow the steps below to deploy the travelocity.com sample application, which you can use to try out the Email OTP scenario.

To obtain and configure the single sign-on travelocity sample, follow the steps below.

Add the following entry to the /etc/hosts file of your machine to configure the hostname.
Why is this step needed?
Some browsers do not allow you to create cookies for a naked hostname, such as localhost. Cookies are required when working with SSO. Therefore, to ensure that the SSO capabilities work as expected in this tutorial, you need to configure the etc/host file as explained in this step.
The etc/host file is a read-only file. Therefore, you won't be able to edit it by opening the file via a text editor. To avoid this, edit the file using the terminal commands.
For example, use the following command if you are working on a Mac/Linux environment.
sudo nano /etc/hosts
```
127.0.0.1 	wso2is.local
```
Open the travelocity.properties file found in the is-samples/modules/samples/sso/sso-agent-sample/src/main/resources directory of the samples folder you just checked out. Configure the following property with the hostname (wso2is.local) that you configured above.
```
#The URL of the SAML 2.0 Assertion Consumer
SAML2.AssertionConsumerURL=http://wso2is.local:8080/travelocity.com/home.jsp
```
In your terminal, navigate to is-samples/modules/samples/sso/sso-agent-sample folder and build the sample using the following command. You must have Apache Maven installed to do this
```
mvn clean install
```
After successfully building the sample, a .war file named travelocity.com can be found inside the is-samples/sso/sso-agent-sample/ target directory. Deploy this sample web app on a web container. To do this, use the Apache Tomcat server.

Since this sample is written based on Servlet 3.0 it needs to be deployed on Tomcat 7.x.
Use the following steps to deploy the web app in the web container:
1. Stop the Apache Tomcat server if it is already running.
2. Copy the travelocity.com.war file to the <TOMCAT_HOME>/webapps directory.
3. Start the Apache Tomcat server.

Tip: If you wish to change properties like the issuer ID, consumer URL, and IdP URL, you can edit the travelocity.properties file found in the travelocity.com/WEB-INF/classes directory. If the service provider is configured in a tenant you can use the QueryParams property to send the tenant domain. For example, QueryParams=tenantDomain=wso2.com.

This sample uses the following default values.

Properties	Description
`SAML2.SPEntityId=travelocity.com`	A unique identifier for this SAML 2.0 Service Provider application.
`SAML2.AssertionConsumerURL=http://wso2is.local:8080/travelocity.com/home.jsp`	The URL of the SAML 2.0 Assertion Consumer.
`SAML2.IdPURL=https://localhost:9443/samlsso`	The URL of the SAML 2.0 Identity Provider.

If you edit the travelocity.properties file, you must restart the Apache Tomcat server for the changes to take effect.

Now the web application is successfully deployed on a web container.

[Back to Top]

Configure the Identity Provider

Follow the steps below to add an identity provider:

Click Add under Main > Identity > Identity Providers.
Provide a suitable name for the identity provider.
Expand the EmailOTPAuthenticator Configuration under Federated Authenticators.
1. Select the Enable and Default check boxes(If you are using Gmail or Sendgrid as the email OTP provider, provide values for Email API and Email fields as well).
2. Click Register.
You have now added the identity provider.

[Back to Top]

Configure the Service Provider

Follow the steps below add a service provider:

Return to the Management Console home screen.
Click Add under Add under Main > Identity > Service Providers .
Enter travelocity.com as the Service Provider Name.
Click Register.
Expand SAML2 Web SSO Configuration under Inbound Authentication Configuration.
Click Configure.
Now set the configuration as follows:
1. Issuer: travelocity.com
2. Assertion Consumer URL: http://localhost:8080/travelocity.com/home.jsp
3. Select the following check-boxes: Enable Response Signing, Enable Single Logout, Enable Attribute Profile, and Include Attributes in the Response Always.
Click Update to save the changes. Now you will be sent back to the Service Providers page.
Go to Claim Configuration and select the http://wso2.org/claims/emailaddress claim.
Go to Local and Outbound Authentication Configuration section.
1. Select the Advanced configuration radio button option.
2. Creating the first authentication step:
  1. Click Add Authentication Step.
  2. Click Add Authenticator that is under Local Authenticators of Step 1 to add the basic authentication as the first step.
    Adding basic authentication as a first step ensures that the first step of authentication will be done using the user's credentials that are configured with the WSO2 Identity Server
3. Creating the second authentication step:
  1. Click Add Authentication Step.
  2. Click Add Authenticator that is under Federated Authenticators of Step 2 to add the EMAIL OTP identity provider you created as the second step.
    EMAIL OTP is a second step that adds another layer of authentication and security.
Click Update.
You have now added and configured the service provider.

For more information on service provider configuration, see Configuring Single Sign-On.

[Back to Top]

Update the email address of the user

Follow the steps given below to update the user's email address.

Return to the WSO2 Identity Server Management Console home screen.
Click List under Add under Main > Identity > Users and Roles.
1. Click Users.
2. Click User Profile under Admin.
3. Update the email address.
4. Click Update.

[Back to Top]

Configure the user claims

Follow the steps below to map the user claims:

For more information about claims, see Adding Claim Mapping.

Click Add under Main > Identity > Claims.
1. Click Add Local Claim.
2. Select the Dialect from the drop down provided and enter the required information.
3. Add the following:
  1. Claim URI: http://wso2.org/claims/identity/emailotp_disabled
  2. Display Name: DisableEmailOTP
  3. Description: DisableEmailOTP
  4. Mapped Attribute (s): title
  5. Supported by Default: checked
4. Click Add.
  
  To disable this claim for the admin user, navigate to Users and Roles > List and click Users. Click on the User Profile link corresponding to admin account and then click Disable EmailOTP. This will disable the second factor authentication for the admin user.

[Back to Top]

Test the sample

To test the sample, go to the following URL: http://localhost:8080/travelocity.com
Click the link to log in with SAML from WSO2 Identity Server.
The basic authentication page appears. Use your WSO2 Identity Server credentials.
You receive a token to your email account. Enter the code to authenticate. If the authentication is successful, you are taken to the home page of the travelocity.com app.

[Back to Top]

What's next?

Want to see more federated authenticators? See, Configuring Federated Authentication
Try out enabling multi factor authentication using the SMSOTP feature of WSO2 IS.