yubioath 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45db1b97a74e59b31a8b0070d1722b18d548bb20
-  data.tar.gz: 81ea24c84fac5bf8d48d79a9c2a01939f234d305
+  metadata.gz: f65371dc5c676a809ec0481fee24ed3b044acb12
+  data.tar.gz: b44a22b1b0e222ddd183d8dc76fbf9acaad74438
 SHA512:
-  metadata.gz: 37e6029de7cf3bde37755f1a7ab9d52a343ff3bddddb0160e3dccd4b2e6cf3d51d8b5cfacb61b0232c1ba7393ec61570033c989e234b7ef368c125f6f3551f92
-  data.tar.gz: 50f79cc8c96e6a53c199351b8c941f713dfc4afa52794aad6fd01cde1428cc4d8bde2c7bca58ee5a01e025e23922aa8e92e0320426239926fb0b27d9e0c1cf99
+  metadata.gz: ad49ada87e761639a55ae16752b476f68e636dd928409b751fdc9fe7dbe764d7f98493d56d2c149ae6e01bb0f4cb0ffe2b6d3e78210be69a678a22e78f54c580
+  data.tar.gz: 31d59e657ca027f7c315a3ea54202378e04479759a709f049228b4b4da5e00cad62ce42293aeb4d9e6bbe971d500f642c4e1bd5bc09cc3f7bd164004c367bfa3

data/Gemfile

@@ -3,15 +3,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in yubioath.gemspec
 gemspec
 
-group :development do
-  gem 'bundler'
-  gem 'rake'
-  gem 'rubocop'
-end
-
-group :test do
-  gem 'rspec', '~> 3.3'
-  gem 'rspec-its', '~> 1.2'
-  gem 'rspec-the', '~> 1.0'
-  gem 'smartcard', '~> 0.5.6'
-end
+gem 'bundler', '~> 1.12'
+gem 'rake', '~> 10.5'
+gem 'rspec', '~> 3.3'
+gem 'rspec-its', '~> 1.2'
+gem 'rspec-the', '~> 1.0'
+gem 'smartcard', '~> 0.5.6'

data/LICENSE.markdown

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015, James Ottaway
+Copyright (c) 2016, James Ottaway
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,58 +4,49 @@ A mostly-complete Ruby implementation of the [YubiOATH applet protocol](https://
 
 ## Usage
 
-The `YubiOATH` class accepts a `card`, which must respond to `#transmit(apdu)`.
-
-You probably want to use [costan/smartcard](https://github.com/costan/smartcard).
-
-```ruby
-yubioath = YubiOATH.new(card)
-```
-
-### Calculate
-
-Do calculate for one named code.
+The `YubiOATH` class accepts a `card`, which must respond to `#transmit(apdu)`. See [costan/smartcard](https://github.com/costan/smartcard) for more info.
 
 ``` ruby
-yubioath.calculate(name: 'foo', timestamp: Time.now)   # => '237893'
-```
-
-### Calculate All
-
-Do calculation for all available codes.
-
-``` ruby
-yubioath.calculate_all(timestamp: Time.now)   # => { 'foo' => '576238', 'bar' => '123895' }
-```
-
-### Delete
-
-Deletes an existing code.
-
-``` ruby
-yubioath.delete(name: 'foo')   # => true
-```
-
-### List
+yubioath = YubiOATH.new(card)
 
-List configured codes.
+yubioath.put(name: 'foo', secret: '123456')            # => true
+yubioath.calculate(name: 'foo', timestamp: Time.now)   # => '237846'
 
-``` ruby
-yubioath.list   # => { 'foo' => { type: :totp, algorithm: :sha256 } }
-```
+yubioath.put(name: 'bar', secret: '345678')   # => true
+yubioath.put(name: 'qux', secret: '567890')   # => true
+yubioath.list.keys                            # => ['foo', 'bar', 'qux']
+yubioath.calculate_all(timestamp: Time.now)   # => {'foo' => '234526', 'bar' => '293857', 'qux' => '934856'}
 
-### Put
+yubioath.delete('qux')   # => true
+yubioath.list.keys   # => ['foo', 'bar']
 
-Adds a new (or overwrites) OATH code.
-
-``` ruby
-yubioath.put(name: 'foo', secret: 'bar', …)   # => true
+yubioath.reset        # => true
+yubioath.list.empty?  # => true
 ```
 
-### Reset
+### Instructions
 
-Reset the applet to just-installed state.
+You can also trigger the instructions by instantiating the relevant class with a `card` and invoking its `#call` method.
 
 ``` ruby
-yubioath.reset   # => true
+calculate = YubiOATH::Calculate.new(card)
+calculate_all = YubiOATH::CalculateAll.new(card)
+delete = YubiOATH::Delete.new(card)
+list = YubiOATH::List.new(card)
+put = YubiOATH::Put.new(card)
+reset = YubiOATH::Reset.new(card)
+
+put.call(name: 'foo', secret: '123456')            # => true
+calculate.call(name: 'foo', timestamp: Time.now)   # => '237846'
+
+put.call(name: 'bar', secret: '345678')   # => true
+put.call(name: 'qux', secret: '567890')   # => true
+list.call.keys                            # => ['foo', 'bar', 'qux']
+calculate_all.call(timestamp: Time.now)   # => {'foo' => '234526', 'bar' => '293857', 'qux' => '934856'}
+
+delete.call('qux')   # => true
+list.call.keys   # => ['foo', 'bar']
+
+reset.call        # => true
+list.call.empty?  # => true
 ```

data/lib/yubioath.rb

@@ -1,77 +1,40 @@
-require 'bindata'
-require 'yubioath/instructions'
-require 'yubioath/response'
+require 'yubioath/calculate'
+require 'yubioath/calculate_all'
+require 'yubioath/delete'
+require 'yubioath/list'
+require 'yubioath/put'
+require 'yubioath/reset'
+require 'yubioath/select'
 
 class YubiOATH
   AID = [0xA0, 0x00, 0x00, 0x05, 0x27, 0x21, 0x01, 0x01]
-  ALGORITHMS = { SHA1: 0x1, SHA256: 0x2 }
-  TYPES = { HOTP: 0x1, TOTP: 0x2 }
-
-  RequestFailed = Class.new(StandardError)
 
   def initialize(card)
     @card = card
-    select(AID)
+    Select.new(@card).call(aid: AID)
   end
 
-  def calculate(name:, timestamp: Time.now)
-    data = Calculate::Request::Data.new(name: name, timestamp: timestamp.to_i / 30)
-    request = Calculate::Request.new(data: data.to_binary_s)
-    response = Response.read(@card.transmit(request.to_binary_s))
-    raise RequestFailed, response unless response.success?
-    Calculate::Response.read(response.data).code.to_s
+  def calculate(name:, timestamp:)
+    Calculate.new(@card).call(name: name, timestamp: timestamp)
   end
 
-  def calculate_all(timestamp: Time.now)
-    data = CalculateAll::Request::Data.new(timestamp: timestamp.to_i / 30)
-    request = CalculateAll::Request.new(data: data.to_binary_s)
-    response = Response.read(@card.transmit(request.to_binary_s))
-    raise RequestFailed, response unless response.success?
-    CalculateAll::Response.read(response.data)[:codes].map do |code|
-      [code.name, code.code.to_s]
-    end.to_h
+  def calculate_all(timestamp:)
+    CalculateAll.new(@card).call(timestamp: timestamp)
   end
 
   def delete(name:)
-    data = Delete::Request::Data.new(name: name)
-    request = Delete::Request.new(data: data.to_binary_s)
-    Response.read(@card.transmit(request.to_binary_s))
+    Delete.new(@card).call(name: name)
   end
 
   def list
-    request = List::Request.new.to_binary_s
-    response = Response.read(@card.transmit(request))
-    raise RequestFailed, response unless response.success?
-    List::Response.read(response.data)[:codes].map do |code|
-      [code.name, {
-        type: TYPES.key(code.type),
-        algorithm: ALGORITHMS.key(code.algorithm),
-      }]
-    end.to_h
+    List.new(@card).call
   end
 
   def put(name:, secret:, algorithm: :SHA256, type: :TOTP, digits: 6)
-    data = Put::Request::Data.new(
-      name: name,
-      type: TYPES.fetch(type),
-      algorithm: ALGORITHMS.fetch(algorithm),
-      digits: digits,
-      secret: secret,
-    )
-    request = Put::Request.new(data: data.to_binary_s)
-    Response.read(@card.transmit(request.to_binary_s))
-  end
-
-  def reset(confirm: false)
-    Response.read(@card.transmit(Reset::Request.new.to_binary_s)) if confirm
+    Put.new(@card).call(name: name, secret: secret, algorithm: algorithm, type: type, digits: digits)
   end
 
-  private
-
-  def select(aid)
-    request = Select::Request.new(aid: aid).to_binary_s
-    response = Response.read(@card.transmit(request))
-    raise RequestFailed, response unless response.success?
-    Select::Response.read(response.data)
+  def reset
+    Reset.new(@card).call
   end
 end

data/lib/yubioath/algorithms.rb

@@ -0,0 +1,3 @@
+class YubiOATH
+  ALGORITHMS = {SHA1: 0x1, SHA256: 0x2}
+end

data/lib/yubioath/calculate.rb

@@ -2,6 +2,18 @@ require 'bindata'
 
 class YubiOATH
   class Calculate
+    def initialize(card)
+      @card = card
+    end
+
+    def call(name:, timestamp:)
+      data = Request::Data.new(name: name, timestamp: timestamp.to_i / 30)
+      request = Request.new(data: data.to_binary_s)
+      bytes = @card.transmit(request.to_binary_s)
+      response = Response.read(bytes)
+      response.code.to_s
+    end
+
     class Request < BinData::Record
       uint8 :cla, value: 0x00
       uint8 :ins, value: 0xA2

data/lib/yubioath/calculate_all.rb

@@ -2,6 +2,21 @@ require 'bindata'
 
 class YubiOATH
   class CalculateAll
+    def initialize(card)
+      @card = card
+    end
+
+    def call(timestamp:)
+      data = Request::Data.new(timestamp: timestamp.to_i / 30)
+      request = Request.new(data: data.to_binary_s)
+      bytes = @card.transmit(request.to_binary_s)
+      response = Response.read(bytes)
+
+      response[:codes].map do |code|
+        [code.name, code.code.to_s]
+      end.to_h
+    end
+
     class Request < BinData::Record
       uint8 :cla, value: 0x00
       uint8 :ins, value: 0xA4

data/lib/yubioath/delete.rb

@@ -1,7 +1,19 @@
 require 'bindata'
+require 'yubioath/response'
 
 class YubiOATH
   class Delete
+    def initialize(card)
+      @card = card
+    end
+
+    def call(name:)
+      data = Request::Data.new(name: name)
+      request = Request.new(data: data.to_binary_s)
+      bytes = @card.transmit(request.to_binary_s)
+      Response.read(bytes).success?
+    end
+
     class Request < BinData::Record
       uint8 :cla, value: 0x00
       uint8 :ins, value: 0x02

data/lib/yubioath/list.rb

@@ -1,7 +1,26 @@
 require 'bindata'
+require 'yubioath/algorithms'
+require 'yubioath/types'
 
 class YubiOATH
   class List
+    def initialize(card)
+      @card = card
+    end
+
+    def call
+      request = Request.new
+      bytes = @card.transmit(request.to_binary_s)
+      response = Response.read(bytes)
+
+      response[:codes].map do |code|
+        [code.name, {
+          type: TYPES.key(code.type),
+          algorithm: ALGORITHMS.key(code.algorithm),
+        }]
+      end.to_h
+    end
+
     class Request < BinData::Record
       uint8 :cla, value: 0x00
       uint8 :ins, value: 0xA1

data/lib/yubioath/put.rb

@@ -1,7 +1,27 @@
 require 'bindata'
+require 'yubioath/algorithms'
+require 'yubioath/response'
+require 'yubioath/types'
 
 class YubiOATH
   class Put
+    def initialize(card)
+      @card = card
+    end
+
+    def call(name:, secret:, algorithm:, type:, digits:)
+      data = Request::Data.new(
+        name: name,
+        type: TYPES.fetch(type),
+        algorithm: ALGORITHMS.fetch(algorithm),
+        digits: digits,
+        secret: secret,
+      )
+      request = Request.new(data: data.to_binary_s)
+      bytes = @card.transmit(request.to_binary_s)
+      Response.read(bytes).success?
+    end
+
     class Request < BinData::Record
       uint8 :cla, value: 0x00
       uint8 :ins, value: 0x01

data/lib/yubioath/reset.rb

@@ -1,7 +1,18 @@
 require 'bindata'
+require 'yubioath/response'
 
 class YubiOATH
   class Reset
+    def initialize(card)
+      @card = card
+    end
+
+    def call
+      request = Reset::Request.new
+      bytes = @card.transmit(request.to_binary_s)
+      Response.read(bytes).success?
+    end
+
     class Request < BinData::Record
       uint8 :cla, value: 0x00
       uint8 :ins, value: 0x04

data/lib/yubioath/select.rb

@@ -2,6 +2,16 @@ require 'bindata'
 
 class YubiOATH
   class Select
+    def initialize(card)
+      @card = card
+    end
+
+    def call(aid:)
+      request = Request.new(aid: aid)
+      bytes = @card.transmit(request.to_binary_s)
+      Response.read(bytes)
+    end
+
     class Request < BinData::Record
       uint8 :cla, value: 0x00
       uint8 :ins, value: 0xA4

data/lib/yubioath/types.rb

@@ -0,0 +1,3 @@
+class YubiOATH
+  TYPES = {HOTP: 0x1, TOTP: 0x2}
+end

data/yubioath.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'yubioath'
-  spec.version       = '1.1.0'
+  spec.version       = '1.2.0'
   spec.authors       = ['James Ottaway']
   spec.email         = ['yubioath@james.ottaway.io']
   spec.summary       = 'A mostly-complete Ruby implementation of the YubiOATH applet protocol'
@@ -15,5 +15,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'bindata', '~> 2.1'
+  spec.add_dependency 'bindata', '~> 2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yubioath
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - James Ottaway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2016-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.0'
 description: 
 email:
 - yubioath@james.ottaway.io
@@ -32,25 +32,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".ruby-version"
 - Gemfile
 - LICENSE.markdown
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/yubioath.rb
+- lib/yubioath/algorithms.rb
 - lib/yubioath/calculate.rb
 - lib/yubioath/calculate_all.rb
 - lib/yubioath/delete.rb
-- lib/yubioath/instructions.rb
 - lib/yubioath/list.rb
 - lib/yubioath/put.rb
 - lib/yubioath/reset.rb
 - lib/yubioath/response.rb
 - lib/yubioath/select.rb
+- lib/yubioath/types.rb
 - yubioath.gemspec
 homepage: https://github.com/jamesottaway/yubioath
 licenses:
@@ -72,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A mostly-complete Ruby implementation of the YubiOATH applet protocol

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,26 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-AllCops:
-  Exclude:
-    - 'yubioath.gemspec'
-
-Metrics/LineLength:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/SpaceAroundOperators:
-  Enabled: false
-
-Style/SpaceInsideHashLiteralBraces:
-  Enabled: false
-
-Style/TrailingComma:
-  EnforcedStyleForMultiline: comma
-
-Style/BracesAroundHashParameters:
-  Enabled: false
-
-Style/IndentHash:
-  Enabled: false

data/.rubocop_todo.yml

@@ -1,16 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-07-04 16:09:47 +1000 using RuboCop version 0.29.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 2
-Metrics/AbcSize:
-  Max: 19
-
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/SignalException:
-  Enabled: false

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2015 James Ottaway
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/yubioath/instructions.rb

@@ -1,7 +0,0 @@
-require 'yubioath/calculate'
-require 'yubioath/calculate_all'
-require 'yubioath/delete'
-require 'yubioath/list'
-require 'yubioath/put'
-require 'yubioath/reset'
-require 'yubioath/select'