rotp 4.0.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72d869e33ff8ede2ef4233ed0398b730a1fc14e2b764295b090492bed133c4fc
-  data.tar.gz: 5ee5f47d3cee494762fcaaabb4dff1dfc247bab7faa0207fc6a3b7ff7b672f05
+  metadata.gz: 72a52a1f0f26257e83977969144abf6324fee40c65ef4f6b3b910d30c3bb1e36
+  data.tar.gz: 212a5ca91186490c07221f7f17e4d39cc05778b89ebf22cf53712de2cfb8944a
 SHA512:
-  metadata.gz: 42c5bb89a97375204c3198dd9d07080f4728162307c9b99eb6f7c46152bfa8aa21d7e02699fc911c9991ef6ae17c9465f2c8e438bf223b2097cbc9b72766912b
-  data.tar.gz: 45dc82dd282328c5e3651a5b660ac327c1d10f07b7ca21025139fbe3edf418b661e1b67648081027e04ea9bce639195ec21d44ada7d6af9ac607984e8fcda47b
+  metadata.gz: 41b36b57154571a35d8d3f59961c3f1754c2bfb3bf06e2a29e2360b24ba884e7d632f86d3d5491341034a30654ba971d96bfcfecae85687a701230cf8e4523ba
+  data.tar.gz: d70217238c2d859b674f9cc702e9ffcb4fcb5cdf3a75d9b40306d0dee8f28198363d6001510e2cbc2b507d24cb753127d602b6dec211da77287d7ac04fabef98

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
-before_install: gem install bundler
+before_install: gem install bundler -v '<2'
 rvm:
-  - 2.3.0
-  - 2.1.0
-  - 2.0.0
+  - 2.6
+  - 2.5
+  - 2.0
 script:
   - bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ### Changelog
 
+### 4.1.0
+
+- Add a digest option to the CLI #83
+- Fix provisioning URI is README #82
+- Improvements to docs
+
 ### 4.0.2
 
 - Fix gemspec requirment for Addressable

data/Dockerfile-2.0

@@ -0,0 +1,11 @@
+FROM ruby:2.0
+
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+
+COPY Gemfile /usr/src/app/
+COPY . /usr/src/app
+RUN bundle install
+
+CMD ["bundle", "exec", "rspec"]
+

data/Dockerfile-2.5

@@ -0,0 +1,10 @@
+FROM ruby:2.5
+
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+
+COPY Gemfile /usr/src/app/
+COPY . /usr/src/app
+RUN bundle install
+
+CMD ["bundle", "exec", "rspec"]

data/Dockerfile-2.6

@@ -0,0 +1,11 @@
+FROM ruby:2.6
+
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+
+COPY Gemfile /usr/src/app/
+COPY . /usr/src/app
+RUN bundle install
+
+CMD ["bundle", "exec", "rspec"]
+

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/mdp/rotp.svg?branch=master)](https://travis-ci.org/mdp/rotp)
 [![Gem Version](https://badge.fury.io/rb/rotp.svg)](https://rubygems.org/gems/rotp)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/github/mdp/rotp/master)
 [![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 and validating one time passwords (HOTP & TOTP) according to [RFC 4226](http://tools.ietf.org/html/rfc4226) and [RFC 6238](http://tools.ietf.org/html/rfc6238).
@@ -72,14 +73,17 @@ User.find(someUserID)
 totp = ROTP::TOTP.new(user.otp_secret)
 totp.now # => "492039"
 
+# Let's take a look at the last time the user authenticated with an OTP
 user.last_otp_at # => 1432703530
 
 # Verify the OTP
 last_otp_at = totp.verify("492039", after: user.last_otp_at) #=> 1472145760
 # ROTP returns the timestamp(int) of the current period
+
 # Store this on the user's account
 user.update(last_otp_at: last_otp_at)
-# Someone attempts to reused the OTP inside the 30s window
+
+# Someone attempts to reuse the OTP inside the 30s window
 last_otp_at = totp.verify("492039", after: user.last_otp_at) #=> nil
 # It fails to verify because we are still in the same 30s interval window
 ```
@@ -115,8 +119,11 @@ Provisioning URI's generated by ROTP are compatible with most One Time Password
 Google Authenticator.
 
 ```ruby
-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'
+totp = ROTP::TOTP.new("base32secret3232", issuer: "My Service")
+totp.provisioning_uri("alice@google.com") # => 'otpauth://totp/My%20Service:alice@google.com?secret=base32secret3232&issuer=My+Service'
+
+hotp = ROTP::HOTP.new("base32secret3232", issuer: "My Service")
+hotp.provisioning_uri("alice@google.com", 0) # => 'otpauth://hotp/alice@google.com?secret=base32secret3232&counter=0'
 ```
 
 This can then be rendered as a QR Code which the user can scan using their mobile phone and the appropriate application.
@@ -143,6 +150,16 @@ bundle install
 bundle exec rspec
 ```
 
+### Testign with Docker
+
+In order to make it easier to test against different ruby version, ROTP comes
+with a set of Dockerfiles for each version that we test against in Travis
+
+```bash
+docker build -f Dockerfile-2.6 -t rotp_2.6 .
+docker run --rm -v $(pwd):/usr/src/app rotp_2.6
+```
+
 ## Executable Usage
 
 The rotp rubygem includes an executable for helping with testing and debugging
@@ -162,7 +179,7 @@ Have a look at the [contributors graph](https://github.com/mdp/rotp/graphs/contr
 
 ## License
 
-MIT Copyright (C) 2016 by Mark Percival, see [LICENSE](https://github.com/mdp/rotp/blob/master/LICENSE) for details.
+MIT Copyright (C) 2019 by Mark Percival, see [LICENSE](https://github.com/mdp/rotp/blob/master/LICENSE) for details.
 
 ## Other implementations
 

data/lib/rotp/arguments.rb

@@ -68,6 +68,10 @@ module ROTP
         parser.on_tail('-h', '--help', 'Show this message') do
           options!.mode = :help
         end
+
+        parser.on('-d', '--digest [ALGORITHM]', 'Use algorithm for the digest (default sha1)') do |digest|
+          options!.digest = digest
+        end
       end
     end
 

data/lib/rotp/cli.rb

@@ -31,9 +31,9 @@ module ROTP
       return arguments.to_s if options.mode == :help
 
       if options.mode == :time
-        ROTP::TOTP.new(options.secret).now
+        ROTP::TOTP.new(options.secret, options).now
       elsif options.mode == :hmac
-        ROTP::HOTP.new(options.secret).at options.counter
+        ROTP::HOTP.new(options.secret, options).at options.counter
       end
     end
 

data/lib/rotp/otp.rb

@@ -5,10 +5,10 @@ module ROTP
 
     # @param [String] secret in the form of base32
     # @option options digits [Integer] (6)
-    #     Number of integers in the OTP
+    #     Number of integers in the OTP.
     #     Google Authenticate only supports 6 currently
     # @option options digest [String] (sha1)
-    #     Digest used in the HMAC
+    #     Digest used in the HMAC.
     #     Google Authenticate only supports 'sha1' currently
     # @returns [OTP] OTP instantiation
     def initialize(s, options = {})

data/lib/rotp/version.rb

@@ -1,3 +1,3 @@
 module ROTP
-  VERSION = '4.0.2'.freeze
+  VERSION = '4.1.0'.freeze
 end

data/spec/lib/rotp/cli_spec.rb

@@ -18,6 +18,14 @@ RSpec.describe ROTP::CLI do
     end
   end
 
+  context 'generating a TOTP with sha256 digest' do
+    let(:argv) { %w[--secret JBSWY3DPEHPK3PXP --digest sha256] }
+
+    it 'prints the corresponding token' do
+      expect(output).to eq '544902'
+    end
+  end
+
   context 'generating a TOTP with no secret' do
     let(:argv) { %w[--time --secret] }
 
@@ -49,4 +57,12 @@ RSpec.describe ROTP::CLI do
       expect(output).to eq '161024'
     end
   end
+
+  context 'generating a HOTP' do
+    let(:argv) { %W[--hmac --secret #{'a' * 32} --counter 1234 --digest sha256] }
+
+    it 'prints the corresponding token' do
+      expect(output).to eq '325941'
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rotp
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.1.0
 platform: ruby
 authors:
 - Mark Percival
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2019-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -92,9 +92,9 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
-- Dockerfile-1.9
-- Dockerfile-2.1
-- Dockerfile-2.3
+- Dockerfile-2.0
+- Dockerfile-2.5
+- Dockerfile-2.6
 - Gemfile
 - Guardfile
 - LICENSE
@@ -158,10 +158,4 @@ rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Ruby library for generating and verifying one time passwords
-test_files:
-- spec/lib/rotp/arguments_spec.rb
-- spec/lib/rotp/base32_spec.rb
-- spec/lib/rotp/cli_spec.rb
-- spec/lib/rotp/hotp_spec.rb
-- spec/lib/rotp/totp_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/Dockerfile-1.9

@@ -1,15 +0,0 @@
-FROM ruby:1.9
-
-# throw errors if Gemfile has been modified since Gemfile.lock
-RUN bundle config --global frozen 1
-
-RUN mkdir -p /usr/src/app
-WORKDIR /usr/src/app
-
-COPY Gemfile /usr/src/app/
-COPY Gemfile.lock /usr/src/app/
-COPY . /usr/src/app
-RUN bundle install
-
-CMD ["bundler", "exec", "rspec"]
-

data/Dockerfile-2.1

@@ -1,16 +0,0 @@
-FROM ruby:2.1
-
-# throw errors if Gemfile has been modified since Gemfile.lock
-RUN bundle config --global frozen 1
-
-RUN mkdir -p /usr/src/app
-WORKDIR /usr/src/app
-
-COPY Gemfile /usr/src/app/
-COPY Gemfile.lock /usr/src/app/
-COPY . /usr/src/app
-RUN bundle install
-
-
-CMD ["bundler", "exec", "rspec"]
-

data/Dockerfile-2.3

@@ -1,16 +0,0 @@
-FROM ruby:2.3
-
-# throw errors if Gemfile has been modified since Gemfile.lock
-RUN bundle config --global frozen 1
-
-RUN mkdir -p /usr/src/app
-WORKDIR /usr/src/app
-
-COPY Gemfile /usr/src/app/
-COPY Gemfile.lock /usr/src/app/
-COPY . /usr/src/app
-RUN bundle install
-
-
-CMD ["bundler", "exec", "rspec"]
-