snuffleupagus 0.0.5 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e4288788ee26dde9333de1e7f518346bb2d5aa46
-  data.tar.gz: 9adf0941f19f4d484e4e3e522d68e41b44c79862
+SHA256:
+  metadata.gz: 78ba5652942ab4bb945ced5e32696f91a5ca32133294f255ed22e6dc7c7ba5a5
+  data.tar.gz: f583416e9b741ee77d84de3f0cdcf0f5df5c71648b3156ee5f2bb0531b77426c
 SHA512:
-  metadata.gz: 397664498b71cf03b44c01aba6572995349ce5b4570f951d7f3b23b6d3d0146a18dead18b7094fef5e12fddb50ab332ddae9106fe84812160864c01d6c2e966d
-  data.tar.gz: b3df343dfc54a3ffa5959c456cd00e10d80cc1b8ce3c6078ae4d6d8c74cb3fb0e95f1b2bac4773b0f8442cd6b33b55ce7a3f2630d8ea7dc7506f16a964368676
+  metadata.gz: 25c0f294acc08273c4fc62cb203c73fdb539df5d888649a0af985e8d08042b61d755dcf63a31f27b987f85f5fd3cd42ada3e013c366e3f3da008e020a19c284d
+  data.tar.gz: 9f01b85aa3dc12dbd4b309773df728386a88dd19649a638b7b5ecbbe7049a6e16dc2970cd7cc2a0ef47030e0b754ddde29dd5d5f1236d2416c42ef2548632add

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'

data/.travis.yml

@@ -1,11 +1,9 @@
 language: ruby
 
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
   - 2.5
+  - 2.6
+  - 2.7
 
 install:
   - bundle install --retry=3

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+## Unreleased
+- none
+
+## [0.1.1](releases/tag/v0.1.1) - 2020-10-21
+### Updated
+- Use named parameters when creating and validating tokens
+
+## [0.1.1](releases/tag/v0.1.1) - 2020-10-21
+### Added
+- Add context to the create/check token to avoid replay in different contexts
+
+## [0.0.9](releases/tag/v0.0.9) - 2020-03-01
+### Fixed
+- Address CVE-2020-8130 - rake OS command injection vulnerability
+
+## [0.0.8](releases/tag/v0.0.8) - 2018-03-01
+### Added
+- Rake to gemfile dev dependencies
+
+## [0.0.7](releases/tag/v0.0.7) - 2018-03-01
+### Fixed
+- Fix missing openssl require
+
+## [0.0.6](releases/tag/v0.0.6) - 2018-03-01
+### Fixed
+- Fix Rakefile execute permission
+### Removed
+- gibberish require
+- gemfile.lock file
+
+## [0.0.5](releases/tag/v0.0.5) - 2018-03-01
+### Fixed
+- Rakefile configuration
+
+## [0.0.4](releases/tag/v0.0.4) - 2018-03-01
+### Added
+- Initial Rakefile
+- Rspec and Rubocop
+- Travis CI configuration
+
+## [0.0.3](releases/tag/v0.0.3) - 2018-03-01
+### Removed
+- Dependency on Gibberish gem
+
+## [0.0.2](releases/tag/v0.0.2) - 2014-09-23
+### Updated
+- Token validity to 2 minutes …
+
+## [0.0.1](releases/tag/v0.0.1) - 2014-08-28
+### Added
+- Initial release

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 gemspec

data/README.md

@@ -5,7 +5,7 @@ A little simple.. auth token generator
 
 Handles basic time-limited authentication token creation / validation
 
-Uses Gibberish::AES with 256 bit CBC encryption
+Uses OpenSSL AES with 256 bit CBC encryption
 
 ![Snuffy](/Snuffy.png "Snuffleupagus")
 
@@ -14,7 +14,7 @@ Uses Gibberish::AES with 256 bit CBC encryption
 Include it in your Gemfile:
 
 ```ruby
-gem 'snuffleupagus', :git => 'git@github.com:TutoringAustralasia/snuffleupagus.git'
+gem 'snuffleupagus'
 ```
 
 ## Basic Usage

data/Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'

data/lib/snuffleupagus.rb

@@ -1,3 +1,3 @@
-require 'gibberish'
+# frozen_string_literal: true
 
 require 'snuffleupagus/auth_token'

data/lib/snuffleupagus/auth_token.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
 module Snuffleupagus
   # Handles basic time-limited authentication token creation / validation
   #
@@ -20,18 +24,20 @@ module Snuffleupagus
   class AuthToken
     def initialize(key)
       @key = key
-      @cipher = OpenSSL::Cipher::AES256.new :CBC
+      @cipher = OpenSSL::Cipher.new('aes-256-cbc')
     end
 
-    def create_token
-      encode encrypt "#{CONSTANT}#{Time.now.to_i}"
+    def create_token(context:)
+      encode encrypt "#{CONSTANT}#{context}#{Time.now.to_i}"
     end
 
-    def check_token(token)
-      return false unless token && token.is_a?(String)
+    def token_valid?(token:, context:)
+      return false unless token.is_a? String
+
       decoded = decrypt decode token
-      match = /^#{CONSTANT}([0-9]+)$/.match decoded
+      match = /\A#{CONSTANT}#{Regexp.escape(context)}([0-9]+)\z/.match decoded
       return false unless match
+
       (match[1].to_i - Time.now.to_i).abs < MAX_VALID_TIME_DIFFERENCE
     rescue StandardError
       false
@@ -39,7 +45,7 @@ module Snuffleupagus
 
     private
 
-    CONSTANT = 'date:'.freeze
+    CONSTANT = 'date:'
     MAX_VALID_TIME_DIFFERENCE = 120 # tokens are only valid for 2 minutes
 
     attr_reader :cipher
@@ -53,6 +59,7 @@ module Snuffleupagus
 
     def decrypt(data)
       raise ArgumentError, 'Data is too short' unless data.length >= 16
+
       salt = data[8..15]
       data = data[16..-1]
       setup_cipher(:decrypt, salt)

data/lib/snuffleupagus/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Snuffleupagus
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.1.2'
 end

data/snuffleupagus.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('lib/snuffleupagus/version', File.dirname(__FILE__))
 
 Gem::Specification.new do |s|
@@ -6,11 +8,13 @@ Gem::Specification.new do |s|
   s.platform                  = Gem::Platform::RUBY
   s.authors                   = ['Andrew Bromwich']
   s.email                     = ['abromwich@studiosity.com']
-  s.homepage                  = 'https://studiosity.com'
+  s.homepage                  = 'https://github.com/Studiosity/snuffleupagus'
   s.description               = 'Simple auth token generator/validator'
   s.summary                   = "snuffleupagus-#{s.version}"
   s.required_rubygems_version = '> 1.3.6'
+  s.required_ruby_version     = ['>= 2.5.0', '< 2.8.0']
 
+  s.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   s.add_development_dependency 'rspec', '~> 3'
   s.add_development_dependency 'rubocop', '~> 0.49'
   s.add_development_dependency 'timecop', '~> 0'

data/spec/snuffleupagus_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require './lib/snuffleupagus'
 require 'timecop'
 
@@ -5,58 +7,73 @@ describe Snuffleupagus::AuthToken do
   let(:snuffy) { Snuffleupagus::AuthToken.new('sup3r4w3s0m3p4ssw0rd') }
 
   describe '#create_token' do
-    subject { snuffy.create_token }
+    subject { snuffy.create_token context: 'my-context' }
 
     it { is_expected.to be_a String }
-    it { expect(subject.length).to eq 64 }
-    it { is_expected.to match(/\A[a-f0-9]{64}\z/) }
+    it { expect(subject.length).to eq 96 }
+    it { is_expected.to match(/\A[a-f0-9]{96}\z/) }
   end
 
-  describe '#check_token' do
-    subject { snuffy.check_token(token) }
+  describe '#token_valid?' do
+    subject { snuffy.token_valid?(token: token, context: 'my-context') }
 
     context 'with a valid token' do
-      let(:token) { snuffy.create_token }
+      let(:token) { snuffy.create_token context: 'my-context' }
+
       it { is_expected.to be_truthy }
     end
 
+    context 'when the context doesnt match' do
+      let(:token) { snuffy.create_token context: 'another-context' }
+
+      it { is_expected.to be_falsey }
+    end
+
     context 'with an invalid token' do
       let(:token) { 'F00B44' }
+
       it { is_expected.to be_falsey }
     end
 
     context 'with an empty token' do
       let(:token) { '' }
+
       it { is_expected.to be_falsey }
     end
 
     context 'with a nil token' do
       let(:token) { nil }
+
       it { is_expected.to be_falsey }
     end
 
     context 'testing expired tokens' do
-      let(:token) { snuffy.create_token }
+      let(:token) { snuffy.create_token context: 'my-context' }
+
       before { token } # pre-load the token
       after { Timecop.return }
 
       context 'just inside the time difference (expired token)' do
         before { Timecop.freeze Time.now - 119 }
+
         it { is_expected.to be_truthy }
       end
 
       context 'just outside the time difference (expired token)' do
         before { Timecop.freeze Time.now - 120 }
+
         it { is_expected.to be_falsey }
       end
 
       context 'just inside the time difference (future token)' do
         before { Timecop.freeze Time.now + 119 }
+
         it { is_expected.to be_truthy }
       end
 
       context 'just outside the time difference (future token)' do
         before { Timecop.freeze Time.now + 120 }
+
         it { is_expected.to be_falsey }
       end
     end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: snuffleupagus
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -62,8 +82,8 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - Snuffy.png
@@ -72,7 +92,7 @@ files:
 - lib/snuffleupagus/version.rb
 - snuffleupagus.gemspec
 - spec/snuffleupagus_spec.rb
-homepage: https://studiosity.com
+homepage: https://github.com/Studiosity/snuffleupagus
 licenses: []
 metadata: {}
 post_install_message: 
@@ -83,16 +103,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 2.8.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: snuffleupagus-0.0.5
+summary: snuffleupagus-0.1.2
 test_files: []