Ruby One Time Password library
Ruby Groff
Latest commit f9f0a68 Aug 25, 2016 @mdp Update dev deps
- Update JSON to 1.8.3 to keep Ruby 1.9 support for now
- Update RSpec, Rake and Timecop
- Fix warning on Rspec test

Squashed commit of the following:

commit 21157d1
Author: mdp <m@mdp.im>
Date:   Thu Aug 25 15:16:42 2016 -0700

    Keep JSON 1.8.3 for <2.0 ruby support for now

commit bd16c20
Author: mdp <m@mdp.im>
Date:   Thu Aug 25 15:10:33 2016 -0700

    Update development deps

    - Fix Travis with updated deps
    - Remove unused dev deps

README.md

The Ruby One Time Password Library

Build Status Gem Version License

A ruby library for generating one time passwords (HOTP & TOTP) according to RFC 4226 and RFC 6238.

ROTP is compatible with the Google Authenticator available for Android and iPhone.

Many websites use this for multi-factor authentication, such as GMail, Facebook, Amazon EC2, WordPress, and Salesforce. You can find the whole list here.

Dependencies

  • OpenSSL
  • Ruby 1.9.3 or higher

Installation

gem install rotp

Library Usage

Time based OTP's

totp = ROTP::TOTP.new("base32secret3232")
totp.now # => "492039"

# OTP verified for current time
totp.verify("492039") # => true
sleep 30
totp.verify("492039") # => false

Optionally, you can provide an issuer which will be used as a title in Google Authenticator.

totp = ROTP::TOTP.new("base32secret3232", issuer: "My Service")
totp.provisioning_uri("alice@google.com")

Counter based OTP's

hotp = ROTP::HOTP.new("base32secretkey3232")
hotp.at(0) # => "260182"
hotp.at(1) # => "055283"
hotp.at(1401) # => "316439"

# OTP verified with a counter
hotp.verify("316439", 1401) # => true
hotp.verify("316439", 1402) # => false

Verifying a Time based OTP with drift

Some users devices may be slightly behind or ahead of the actual time. ROTP allows users to verify an OTP code with an specific amount of 'drift'

totp = ROTP::TOTP.new("base32secret3232")
totp.now # => "492039"

# OTP verified for current time with 120 seconds allowed drift
totp.verify_with_drift("492039", 60, Time.now - 30) # => true
totp.verify_with_drift("492039", 60, Time.now - 90) # => false

Preventing reuse of Time based OTP's

In order to prevent reuse of time based tokens within the interval window (default 30 seconds) it is necessary to store the last time an OTP was used. The following is an example of this in action:

User.find(someUserID)
totp = ROTP::TOTP.new(user.otp_secret)
totp.now # => "492039"

user.last_otp_at # => 1472145530

# Verify the OTP
verified_at_timestamp = totp.verify_with_drift_and_prior("492039", 0, user.last_otp_at) #=> 1472145760
# Store this on the user's account
user.update(last_otp_at: verified_at_timestamp)
verified_at_timestamp = totp.verify_with_drift_and_prior("492039", 0, user.last_otp_at) #=> false

Generating a Base32 Secret key

ROTP::Base32.random_base32  # returns a 16 character base32 secret. Compatible with Google Authenticator

Note: The Base32 format conforms to RFC 4648 Base32

Google Authenticator Compatible URI's

Provisioning URI's generated by ROTP are compatible with the Google Authenticator App to be scanned with the in-built QR Code scanner.

totp.provisioning_uri("alice@google.com") # => 'otpauth://totp/issuer:alice@google.com?secret=JBSWY3DPEHPK3PXP'
hotp.provisioning_uri("alice@google.com", 0) # => 'otpauth://hotp/issuer:alice@google.com?secret=JBSWY3DPEHPK3PXP&counter=0'

This can then be rendered as a QR Code which can then be scanned and added to the users list of OTP credentials.

Working example

Scan the following barcode with your phone, using Google Authenticator

QR Code for OTP

Now run the following and compare the output

require 'rubygems'
require 'rotp'
totp = ROTP::TOTP.new("JBSWY3DPEHPK3PXP")
p "Current OTP: #{totp.now}"

Testing

bundle install
bundle exec rspec

Executable Usage

Once the rotp rubygem is installed on your system, you should be able to run the rotp executable (if not, you might find trouble-shooting help at this stackoverflow question).

# Try this to get an overview of the commands
rotp --help

# Examples
rotp --secret p4ssword                       # Generates a time-based one-time password
rotp --hmac --secret p4ssword --counter 42   # Generates a counter-based one-time password

Contributors

Have a look at the contributors graph on Github.

License

MIT Copyright (C) 2011 by Mark Percival, see LICENSE for details.

Other implementations

A list can be found at Wikipedia.