bcrypt_hmac 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dc8ded37446060c52250bd5b78d9192b692a6ae
+  data.tar.gz: e74a7a2c83e4d54b0d58a663f50fec0a685a25e7
+SHA512:
+  metadata.gz: e251ea5c2ae86722e37ebcb857736e4591c1a8b2d80ca6b31140cce51057870903166d3aa9cc0ced0917433512878f8b5ccff98f381b30325656740d8d522413
+  data.tar.gz: f9b152d4eed9407a807014a1edfce5ef50b6554467d9ed8024bee5806179c5052bbe2b3df324ca85c8de99847f8875f9a915b31701b98f72e7a8db1976c5d0eb

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,153 @@
+PATH
+  remote: .
+  specs:
+    bcrypt_hmac (0.1.2)
+      bcrypt (~> 3)
+      devise-encryptable (~> 0)
+      rails (~> 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.6)
+      actionview (= 4.2.6)
+      activesupport (= 4.2.6)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.6)
+      activesupport (= 4.2.6)
+      globalid (>= 0.3.0)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    bcrypt (3.1.11)
+    builder (3.2.2)
+    coderay (1.1.0)
+    concurrent-ruby (1.0.2)
+    devise (4.1.1)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0, < 5.1)
+      responders
+      warden (~> 1.2.3)
+    devise-encryptable (0.2.0)
+      devise (>= 2.1.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    orm_adapter (0.5.0)
+    pkg-config (1.1.7)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.6)
+      actionmailer (= 4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      activemodel (= 4.2.6)
+      activerecord (= 4.2.6)
+      activesupport (= 4.2.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.6)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.6)
+      actionpack (= 4.2.6)
+      activesupport (= 4.2.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    responders (2.2.0)
+      railties (>= 4.2.0, < 5.1)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    slop (3.6.0)
+    sprockets (3.6.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.4)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    warden (1.2.6)
+      rack (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bcrypt_hmac!
+  bundler (~> 1.6)
+  pry (~> 0.10)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Spreemo
+
+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/README.md

@@ -0,0 +1,4 @@
+bcrypt_hmac
+===========
+
+bcrypt + hmac password encryption for devise

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test:    :spec

data/bcrypt_hmac.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bcrypt_hmac/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bcrypt_hmac'
+  spec.version       = BcryptHmac::VERSION
+  spec.authors       = ['ben lamothe']
+  spec.email         = ['ben.lamothe@spreemo.com']
+  spec.summary       = 'Devise BCrypt + SHA256-HMAC Encryptor'
+  spec.homepage      = 'https://github.com/spreemo/bcrypt_hmac'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bcrypt', '~> 3'
+  spec.add_dependency 'devise-encryptable', '~> 0'
+  spec.add_dependency 'rails', '~> 4'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/lib/bcrypt_hmac.rb

@@ -0,0 +1,51 @@
+require 'devise'
+require 'devise-encryptable'
+require 'bcrypt'
+require 'bcrypt_hmac/railtie' if defined?(Rails)
+
+module BcryptHmac
+  class Encryptor < Devise::Encryptable::Encryptors::Base
+    def self.digest(password, stretches = nil, _salt = nil, pepper = nil)
+      pre_bcrypt_hash = prepare_for_bcrypt(password, pepper.to_s)
+
+      if stretches
+        BCrypt::Password.create(pre_bcrypt_hash, cost: stretches.to_i)
+      else
+        BCrypt::Password.create(pre_bcrypt_hash)
+      end
+    end
+
+    def self.compare(encrypted_password, password, _stretches = nil,
+                     _salt = nil, pepper = nil)
+      sanitized_bcrypt_hash = ruby_sanitize(encrypted_password)
+      correct_password = BCrypt::Password.new(sanitized_bcrypt_hash)
+      proposed_password = prepare_for_bcrypt(password, pepper.to_s)
+
+      correct_password == proposed_password
+    end
+
+    # bcrypt-ruby doesn't support the '2y' prefix in hashes generated in php and
+    # other languages. '2y' has to be replaced with '2a' in order to recognize
+    # these hashes in ruby. See http://stackoverflow.com/a/20981781/1545518
+    def self.ruby_sanitize(bcrypt_hash)
+      if bcrypt_hash.starts_with?('$2y')
+        bcrypt_hash.sub('$2y', '$2a')
+      else
+        bcrypt_hash
+      end
+    end
+    private_class_method :ruby_sanitize
+
+    def self.prepare_for_bcrypt(password, hmac_key)
+      Base64.encode64(sha256_hash(password, hmac_key))
+    end
+    private_class_method :prepare_for_bcrypt
+
+    def self.sha256_hash(password, hmac_key)
+      sha256 = OpenSSL::Digest.new('sha256')
+      OpenSSL::HMAC.digest(sha256, hmac_key, password)
+    end
+    private_class_method :sha256_hash
+
+  end
+end

data/lib/bcrypt_hmac/railtie.rb

@@ -0,0 +1,10 @@
+require 'devise'
+require 'devise-encryptable'
+
+module BcryptHmac
+  class Railtie < Rails::Railtie
+    initializer 'bcrypt_hmac.define_devise_encryptor' do
+      Devise::Encryptable::Encryptors.const_set 'BcryptHmac', BcryptHmac::Encryptor
+    end
+  end
+end

data/lib/bcrypt_hmac/version.rb

@@ -0,0 +1,3 @@
+module BcryptHmac
+  VERSION = '0.1.2'.freeze
+end

data/spec/bcrypt_hmac_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe BcryptHmac::Encryptor do
+  let(:hmac_key) do
+    'MzFjMzFlNGQ5MjQ3YmViZGYyOGI3NTkyYzA2YzE5NDQ1OWE2ZTMxYw=='
+  end
+
+  let(:bcrypt_cost) { '12' }
+
+  let(:password) { 'super secret password' }
+
+  let(:sha256_hmac_hashed_password) do
+    OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), hmac_key, password)
+  end
+
+  let(:base64_encoded_hmac_hash) do
+    Base64.encode64(sha256_hmac_hashed_password)
+  end
+
+  let(:bcrypt_hashed_password) do
+    BCrypt::Password.create(base64_encoded_hmac_hash, cost: bcrypt_cost.to_i)
+  end
+
+  describe '::digest' do
+    subject do
+      BcryptHmac::Encryptor.digest(password, bcrypt_cost, nil, hmac_key)
+    end
+
+    it { is_expected.to eq(base64_encoded_hmac_hash) }
+  end
+
+  describe '::compare' do
+    subject do
+      BcryptHmac::Encryptor.compare(bcrypt_hashed_password, password,
+                                    bcrypt_cost, nil, hmac_key)
+    end
+
+    it { is_expected.to be_truthy }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'bcrypt_hmac'
+require 'pry'
+
+require 'bundler/setup'
+Bundler.setup
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: bcrypt_hmac
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- ben lamothe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: devise-encryptable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- ben.lamothe@spreemo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bcrypt_hmac.gemspec
+- lib/bcrypt_hmac.rb
+- lib/bcrypt_hmac/railtie.rb
+- lib/bcrypt_hmac/version.rb
+- spec/bcrypt_hmac_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spreemo/bcrypt_hmac
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Devise BCrypt + SHA256-HMAC Encryptor
+test_files:
+- spec/bcrypt_hmac_spec.rb
+- spec/spec_helper.rb
+has_rdoc: