GSoC 2017 - Two-Factor Authentication

Target release
Project status


Document status
Document owner Alex Ivanov


The goal of the project is to implement Two-Factor authentication for Fineract and add support for 2FA to the community-app and the Android client. With two-factor authentication enabled the system administrator will have the ability to configure how one time passwords are sent to the user - either via Email or SMS. The integration of two-factor authentication would improve the security of Fineract and its users.

During the project I will implement support for two-factor authentication into Fineract. The workflow of the process of generating and using one time passwords is described below. The existing supported front-end application(the community-app and the Android app) will be updated to support 2FA.

I would like to give as much flexibility as possible to the users and system administrator to allow for a flawless authentication without much hassle - we would allow the system administrator to select the delivery method of the one time passwords. Currently it is planned to support delivery via SMS / Email but the system should be made so it could be easily extended to support time-based one-time passwords(RFC 6238). 

Project details

Two-factor authentication workflow

  1. User authenticates via basic auth / Oauth2

  2. If successful, field(isTwoFactorAuthenticationRequired) indicates whether 2FA is enabled

  3. If 2FA is enabled, the client sends a request to get a list of available delivery methods to authenticated user(see Getting a list of delivery methods)

  4. The client sends a request to to generate & send OTP via their selected method(see Requesting OTP)

    1. OTP token is generated and saved in-memory

    2. Token is sent via SMS/Email bridge

    3. Information returned: OTP delivery method, delivery destination(email / phone number), OTP validity period

    4. User has at most one active OTP request. If another OTP is requested, all previous OTP requests are invalidated

  5. User receives token and the client sends it to an endpoint to validate it (see Validating OTP)

    1. If token is valid and hasn’t expired

    2. Information returned: access token, access token expiry time

  6. User sends the access token as a header(Fineract-Platform-TFA-Token) on every request

  7. User is allowed to have multiple two-factor access tokens:

    1. Can support multiple devices

  8. Client invalidates access token on logout / session end.(see Invalidating Access Token)

Fineract Implementation Details

Enabling Two-Factor Authentication

Two-Factor Authentication can be enabled by adding an active twofactor profile to Fineract(e.g. in or with a start parameter). -Ptwofactor=enabled parameter can be used with Gradle build job.

Bypassing two-factor authentication

Users that are granted the BYPASS_TWOFACTOR can bypass two-factor authentication. The permission has to be granted explicitly. User with ALL_FUNCTIONS permission but without BYPASS_TWOFACTOR would still be required to authenticate.


Delivery methods and token parameters are configurable. Configuration is done via the configuration endpoint.

List of configuration parameters:

NameTypeDefault ValueDescriptionNotes
otp-delivery-sms-enablebooleantrueWhether to enable the email delivery method

Email delivery uses Email External Service configurations for mail sending. Please configure SMTP details before using email OTP delivery.

See External Services.

otp-delivery-email-subjectstringFineract Two-Factor Authentication TokenEmail subject - supports template data
otp-delivery-email-bodystringHello {{username}}.\n\nYour OTP login token is {{token}}.Email body - supports template data
otp-delivery-sms-enablebooleanfalseWhether to enable the email delivery method

SMS OTP delivery requires messaging gateway and SMS external service configured.

See Message Gateway Configuration - using a twilio account, SMS Campaigns.

otp-delivery-sms-providerint1SMS provider ID
otp-delivery-sms-textstringYour authentication token for Fineract is {{token}}.SMS text - supports template data


character length of the OTP
otp-token-live-timeint300validity time of the OTP request in seconds
access-token-live-timeint86400validity time of standard access token in seconds
access-token-live-time-extendedint604800validity time of extended access token in seconds

Message parameters support template data. List of supported template parameters:

  • username, email, mobileno(if user has mobileno)
  • firstname, lastname
  • token, tokenlivetime
  • requestdate, requesttime
  • expiredate, expiretime

API Endpoints

There are 3 endpoints that serve two-factor authentication requests:

  • /twofactor - OTP operations
  • /twofactor/validate - access token generation 
  • /twofactor/configure - configuration

Getting delivery methods

Returns a list of possible OTP delivery methods for the current user

Requres first-factor authenticated user.

Example RequestExample Response
GET /api/v1/twofactor
        "name": "sms",
        "target": "08888888888"
        "name": "email",
        "target": ""

Requesting OTP

Requests an OTP.

Requres first-factor authenticated user.

Example RequestExample Response

POST /api/v1/twofactor?deliveryMethod=sms&extendedToken=false


  • deliveryMethod(string) - name of delivery method
  • extendedToken(boolean) - optional, whether to request an extended token, default false
    "requestTime": 1500000000000,
    "tokenLiveTimeInSec": 300,
    "extendedAccessToken": false,
    "deliveryMethod": {
        "name": "sms",
        "target": "08888888888"

Validating OTP

Validates an OTP. If the OTP is valid, an access token is created.

The returned access token is later sent as a header Fineract-Platform-TFA-Token.

Requres first-factor authenticated user.

Example RequestExample Response

POST /api/v1/twofactor/validate?token=YYYYY


  • token(string) - mandatory, the OTP to validate
    "token": "cb0bb6e33fc540709d50a16eb2e555f9",
    "validFrom": 1501530702801,
    "validTo": 1501617102801

Invalidating Access Token

Invalidates an active access token.

Requires fully authenticated user.

Example RequestExample Response

POST /api/v1/twofactor/invalidate

    "token": "fa368f984b0d4e96a73ea57dca4e110d"
    "resourceIdentifier": "fa368f984b0d4e96a73ea57dca4e110d"

Get configuration settings 

Returns all two-factor configuration settings.

Requires fully authenticated user.

Example RequestExample Response

GET /api/v1/twofactor/configure

    "otp-delivery-email-body": "Hello {{username}}.\n\nYour OTP login token is {{token}}.",
    "otp-delivery-sms-enable": true,
    "otp-delivery-sms-provider": 6,
    "otp-delivery-email-subject": "Fineract Two-Factor Authentication Token",
    "otp-token-length": 5,
    "access-token-live-time-extended": 604800,
    "otp-delivery-email-enable": true,
    "otp-token-live-time": 300,
    "otp-delivery-sms-text": "Your authentication token for Fineract is {{token}}. das",
    "access-token-live-time": 86400

Update two-factor configuration settings

Update two-factor configuration.

Requires fully authenticated user.

Example RequestExample Response

POST /api/v1/twofactor/configure

    "otp-delivery-sms-provider": 7
    "otp-delivery-sms-enable": false
    "changes": {
        "otp-delivery-sms-enable": false,
        "otp-delivery-sms-provider": 7


Phase 1: May 30 - June 26
  • Fineract:
    • 2FA Configuration
    • OTP generation & verification services
Evaluation 1: June 26 - June 30

Phase 2: June 30 - July 24


  • OTP request & validation endpoint
  • GUID generation
  • 2FA Filter

Community-app, android-app:

  • Add 2FA login support
  • 2Fa configuration support in the community-app

Evaluation 2: July 24 - July 30

Phase 2: July 30 - August 21/29


  • Documentation
  • access token invalidation endpoint
  • Work on time-based 2fa(optional)

Community-app, Android client:

  • Remember me functionality