rotp 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c42bc8b1ce8ab11bb556cef750ae50187a6640d
-  data.tar.gz: 165cbc7edb89427967f2777b7d8705b45486f18d
+  metadata.gz: ab533788e10594ef3290782dba5f044b4f6d259e
+  data.tar.gz: 39f4d7d06f29f05656374b5d2edef7d05f36fdd2
 SHA512:
-  metadata.gz: ac2979aa19949bedb563e5fc407171efec7d80785e0246d19fed92bc78fca4b64eacdd1ef5c01a848f37c77a7d5bbbc03dc84e1e49d5f84bd55710ffc36b33af
-  data.tar.gz: 8349669bdc320ff49ec55eb487eaaf38c352a52faa95bde3cfa8fde06b5ed7b889db670a254d2b2fd8b36286cb13bbaf03b86579466430e6b3d4850db1b0a770
+  metadata.gz: cfb56d25e3520f7d5875ce8d5d0a3b3d0a22cce6bb1c2b727ca5b95522b8a00cefe5ab43fe01b7d08038db675a902270662156dcffd3a0ed6d40f6bbe3375a66
+  data.tar.gz: a755331e53a9f06eb4627d820ec39db3092795dcd139c9e05dedaab7427e1c8c0ae1ae8c8fa21b23fdbb905c733206fb9decbc9d1ee36407abab2984d5f79c9c

data/.gitignore

@@ -1,5 +1,4 @@
 *.gem
 .bundle
-Gemfile.lock
 .yardoc
 pkg/*

data/.travis.yml

@@ -3,3 +3,5 @@ rvm:
   - 2.1.0
   - 2.0.0
   - 1.9.3
+script:
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+### Changelog
+
+#### 2.1.0
+
+- Add a CLI for generating OTP's mdp/rotp/pull/35
+
+#### 2.0.0
+
+- Move to only comparing string OTP's.
+
+#### 1.7.0
+
+- Move to only comparing string OTP's. See mdp/rotp/issues/32 - Moved to 2.0.0 - yanked from RubyGems
+
+#### 1.6.1
+
+- Remove deprecation warning in Ruby 2.1.0 (@ylansegal)
+- Add Ruby 2.0 and 2.1 to Travis
+
+#### 1.6.0
+
+- Add verify_with_retries to HOTP
+- Fix 'cgi' require and global DEFAULT_INTERVAL
+
+#### 1.5.0
+
+- Add support for "issuer" parameter on provisioning url
+- Add support for "period/interval" parameter on provisioning url
+
+#### 1.4.6
+
+- Revert to previous Base32
+
+#### 1.4.5
+
+- Fix and test correct implementation of Base32
+
+#### 1.4.4
+
+- Fix issue with base32 decoding of strings in a length that's not a multiple of 8
+
+#### 1.4.3
+
+- Bugfix on padding
+
+#### 1.4.2
+
+- Better padding options (Pad the output with leading 0's)
+
+#### 1.4.1
+
+- Clean up drift logic
+
+#### 1.4.0
+
+- Added clock drift support via 'verify_with_drift' for TOTP
+
+####1.3.0
+
+- Added support for Ruby 1.9.x
+- Removed dependency on Base32

data/Gemfile

@@ -1,2 +1,2 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    rotp (2.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    guard (2.11.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.0)
+    guard-rspec (4.5.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hitimes (1.2.2)
+    listen (2.8.5)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    nenv (0.1.1)
+    notiffany (0.0.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    timecop (0.7.1)
+    timers (4.0.1)
+      hitimes
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec (~> 4.5.0)
+  rake (~> 10.4.2)
+  rotp!
+  rspec (~> 3.1.0)
+  timecop (~> 0.7.1)

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec --format progress' do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -0,0 +1,118 @@
+# The Ruby One Time Password Library
+
+[![Build Status](https://secure.travis-ci.org/mdp/rotp.png)](https://travis-ci.org/mdp/rotp)
+[![Gem Version](https://badge.fury.io/rb/rotp.svg)](https://rubygems.org/gems/rotp)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/mdp/rotp/blob/master/LICENSE)
+
+A ruby library for generating one time passwords (HOTP & TOTP) according to [RFC 4226](http://tools.ietf.org/html/rfc4226) and [RFC 6238](http://tools.ietf.org/html/rfc6238).
+
+ROTP is compatible with the [Google Authenticator](https://github.com/google/google-authenticator) available for [Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) and [iPhone](https://itunes.apple.com/en/app/google-authenticator/id388497605).
+
+Many websites use this for [multi-factor authentication](https://www.youtube.com/watch?v=17rykTIX_HY), such as GMail, Facebook, Amazon EC2, WordPress, and Salesforce. You can find the whole [list here](https://en.wikipedia.org/wiki/Google_Authenticator#Usage).
+
+## Dependencies
+
+* OpenSSL
+* Ruby 1.9.3 or higher
+
+## Installation
+
+```bash
+gem install rotp
+```
+
+## Library Usage
+
+### Time based OTP's
+
+```ruby
+totp = ROTP::TOTP.new("base32secret3232")
+totp.now # => "492039"
+
+# OTP verified for current time
+totp.verify("492039") # => true
+sleep 30
+totp.verify("492039") # => false
+```
+
+### Counter based OTP's
+
+```ruby
+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
+```
+
+### Generating a Base32 Secret key
+
+```ruby
+ROTP::Base32.random_base32  # returns a 16 character base32 secret. Compatible with Google Authenticator
+```
+
+Note: The Base32 format conforms to [RFC 4648 Base32](http://en.wikipedia.org/wiki/Base32#RFC_4648_Base32_alphabet)
+
+### 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.
+
+```ruby
+totp.provisioning_uri("alice@google.com") # => 'otpauth://totp/alice@google.com?secret=JBSWY3DPEHPK3PXP'
+hotp.provisioning_uri("alice@google.com", 0) # => 'otpauth://hotp/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](http://chart.apis.google.com/chart?cht=qr&chs=250x250&chl=otpauth%3A%2F%2Ftotp%2Falice%40google.com%3Fsecret%3DJBSWY3DPEHPK3PXP)
+
+Now run the following and compare the output
+
+```ruby
+require 'rubygems'
+require 'rotp'
+totp = ROTP::TOTP.new("JBSWY3DPEHPK3PXP")
+p "Current OTP: #{totp.now}"
+```
+
+### Testing
+
+```bash
+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](http://stackoverflow.com/a/909980)).
+
+```bash
+# 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](https://github.com/mdp/rotp/graphs/contributors) on Github.
+
+## License
+
+MIT Copyright (C) 2011 by Mark Percival, see [LICENSE](https://github.com/mdp/rotp/blob/master/LICENSE) for details.
+
+## Other implementations
+
+A list can be found at [Wikipedia](https://en.wikipedia.org/wiki/Google_Authenticator#Implementations).

data/Rakefile

@@ -4,7 +4,6 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:rspec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
-  spec.rspec_opts = ['-cfs --backtrace']
 end
 
 task :default => :rspec

data/bin/rotp

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+require 'rotp'
+require 'rotp/cli'
+
+ROTP::CLI.new(File.basename(__FILE__), ARGV).run

data/lib/rotp/arguments.rb

@@ -0,0 +1,89 @@
+require 'optparse'
+require 'ostruct'
+
+module ROTP
+  class Arguments
+
+    def initialize(filename, arguments)
+      @filename = filename
+      @arguments = Array(arguments)
+    end
+
+    def options
+      parse
+      options!
+    end
+
+    def to_s
+      parser.help + "\n"
+    end
+
+    private
+
+    attr_reader :arguments, :filename
+
+    def options!
+      @options ||= default_options
+    end
+
+    def default_options
+      OpenStruct.new time: true, counter: 0, mode: :time
+    end
+
+    def parse
+      return options!.mode = :help if arguments.empty?
+      parser.parse arguments
+
+    rescue OptionParser::InvalidOption => exception
+      options!.mode = :help
+      options!.warnings = red(exception.message +  '. Try --help for help.')
+    end
+
+    def parser
+      OptionParser.new do |parser|
+        parser.banner = ''
+        parser.separator green('  Usage: ') + bold("#{filename} [options]")
+        parser.separator ''
+        parser.separator green '  Examples:   '
+        parser.separator '    ' + bold("#{filename} --secret p4ssword") + '                       # Generates a time-based one-time password'
+        parser.separator '    ' + bold("#{filename} --hmac --secret p4ssword --counter 42") + '   # Generates a counter-based one-time password'
+        parser.separator ''
+        parser.separator green '  Options:'
+
+        parser.on('-s', '--secret [SECRET]', 'The shared secret') do |secret|
+          options!.secret = secret
+        end
+
+        parser.on('-c', '--counter [COUNTER]', 'The counter for counter-based hmac OTP') do |counter|
+          options!.counter = counter.to_i
+        end
+
+        parser.on('-t', '--time', 'Use time-based OTP according to RFC 6238 (default)') do
+          options!.mode = :time
+        end
+
+        parser.on('-m', '--hmac', 'Use counter-based OTP according to RFC 4226') do
+          options!.mode = :hmac
+        end
+
+        parser.on_tail('-h', '--help', 'Show this message') do
+          options!.mode = :help
+        end
+      end
+    end
+
+    def bold(string)
+      "\033[1m#{string}\033[22m"
+    end
+
+    def green(string)
+      "\033[32m#{string}\033[0m"
+    end
+
+    def red(string)
+      "\033[31m#{string}\033[0m"
+    end
+
+  end
+end
+

data/lib/rotp/cli.rb

@@ -0,0 +1,56 @@
+require 'rotp/arguments'
+
+module ROTP
+  class CLI
+    attr_reader :filename, :argv
+
+    def initialize(filename, argv)
+      @filename = filename
+      @argv = argv
+    end
+
+    def run
+      puts output
+    end
+
+    def errors
+      if [:time, :hmac].include?(options.mode)
+        if options.secret.to_s == ''
+          red 'You must also specify a --secret. Try --help for help.'
+        elsif options.secret.to_s.chars.any? { |c| ROTP::Base32::CHARS.index(c.downcase) == nil }
+          red 'Secret must be in RFC4648 Base32 format - http://en.wikipedia.org/wiki/Base32#RFC_4648_Base32_alphabet'
+        end
+      elsif options.mode == :hmac && options.counter.to_i < 0
+        red 'You must also specify a --counter. Try --help for help.'
+      end
+    end
+
+    def output
+      return options.warnings if options.warnings
+      return errors if errors
+      return arguments.to_s if options.mode == :help
+
+      if options.mode == :time
+        ROTP::TOTP.new(options.secret).now
+      elsif options.mode == :hmac
+        ROTP::HOTP.new(options.secret).at options.counter
+
+      else
+        fail NotImplementedError
+      end
+    end
+
+    def arguments
+      @arguments ||= ROTP::Arguments.new(filename, argv)
+    end
+
+    def options
+      arguments.options
+    end
+
+    def red(string)
+      "\033[31m#{string}\033[0m"
+    end
+
+  end
+end