Two-factor authentication using Ruby

To implement Two-factor use case, you can create and deploy a PHLO with a few clicks on the PHLO canvas. PHLO also lets you visually construct your entire use-case. With PHLO, you only pay for SMS you send/receive, and building with PHLO is free.

Implementation

In this section, we will guide you to create a PHLO to implement Two-factor use-case.

Prerequisites

• Plivo Auth Id and Auth Token: You will find your Plivo Auth Id and Auth Token on the home screen of your Plivo Console. Click here to sign-up for a Plivo account if you haven’t already!

  

• Plivo Phone Number(Optional): To send messages to the United States and Canada, you must have a Plivo phone number that supports SMS. Numbers can be purchased from the Numbers section of your Plivo Console and use the same as the source number/from number for the outbound SMS. This number will also help you receive incoming SMS as you must have a SMS-enabled Plivo phone number to do the same. Please note that you can also purchase numbers using the Numbers API.

  

• Github account(Optional): To get the code from the repository, clone it. Otherwise, since the repository is open to the public, we can download the code and run it locally.

Create the PHLO

With PHLO, you can quickly create a workflow that suits your use case. To use PHLO, make sure to register and log on to Plivo Console. There is already a prototype for this use-case; all you need to do is select the PHLO and give it a friendly name.

Set up Your Ruby Dev Environment

You must set up and install Ruby and Plivo’s Ruby SDK to make a bulk call. Here’s how.

Install Ruby

Set Up the Demo app locally

• Clone the repository from Github

 $ git clone https://github.com/plivo/2fa-ruby-demo.git

• Change your working directory to 2fa-ruby-demo

 $ cd 2fa-ruby-demo

• Install the dependencies using the Gemfile file. You can use the below command.

 $ bundle install

• Change the placeholders in the config.yaml file. You should replace the PLIVO_AUTH_ID, PLIVO_AUTH_TOKEN, PLIVO_NUMBER & PHLO_IDplaceholders.

• Turn on the redis server by entering the following command in your terminal

 $ redis-server

• The different steps that are involved in this app are as follows:

Step 1 : Generate the OTP

Generate an exclusive six-digit authentication code (OTP). To create the OTP, we will use the Time Based OTP generation algorithm. here’s how it’s done in Ruby.

1
code = rand(999_999)

Step 2 : Send SMS & Make a call

A single function help us to trigger to Send SMS and Make call via PHLO and the rest is done by the PHLO in your console. The main argument which tells PHLO to trigger call or an SMS is mode the values passed within are sms & call.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
def initiate_phlo(dst_number, mode)
    code = rand(999_999)
    begin
      phlo = @phloclient.phlo.get(@phlo_id)
      # parameters set in PHLO - params
      params = {
        from: @app_number,
        to: dst_number,
        otp: code,
        mode: mode
      }
      phlo.run(params)
      code
    rescue PlivoRESTError => e
      puts 'Exception: ' + e.message
    end
  end

Step 3 : Verify the OTP

Once the user enters the OTP received to their handset, the code will be verified and here’s how it’s done in Ruby.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
get '/verify/:number' do
  number = params['number']
  ##
  # verify(number) accepts a number and initiates verification for it.
#
  code = if config['phlo_id'].nil?
           twofactor.send_verification_code_sms(number, 'Your verification code is __code__. Code will expire in 1 minute.')
         else
           twofactor.initiate_phlo(number, 'sms')
         end
  r.setex('number:%s:code' % number, 60, code) # Verification code is valid for 1 min
  content_type :json
  { status: 'success', message: 'verification initiated' }.to_json
end

Test and Validate

In order to run the app, run the following command.

$ ruby app.rb

You check the app in action on https://3b3e783f.ngrok.io/

The finished app should look like this.