Project

qr-to-otp

0.02
No commit activity in last 3 years
No release in over 3 years
It converts base64 image or QR image to time based Google Authenticator one time password
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.12
~> 1.7.0
~> 3.0

Runtime

~> 0.3.2
~> 0.0.1
~> 12.3.1
 Project Readme

The Ruby QR Image to OTP Library

A Ruby library for generating Google Authenticator time based password, based on base64 image or a QR code image. Additionally, it does a device identity based validation too, which is optional.

Dependencies

  • OpenSSL
  • Ruby 2.3.0 or higher
  • Qrio

Installation

gem install qr-to-otp

Usage

Time based OTP's

#Scan the QR code in path ../fixtures/qrcode.png and verify with below code
image = File.join(File.dirname(__FILE__), '../fixtures/qrcode.png')
auth = QrToOtp::OTP.new(image)
auth.get()

Optionally, you can provide device identity.

image = File.join(File.dirname(__FILE__), '../fixtures/qrcode.png')
auth = QrToOtp::OTP.new(image, {'device_identity': 'a5b1b2'})
auth.get()

Testing

bundle install
bundle exec rspec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tusharmetkar/qr-to-otp