has_secure_password_argon2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c990d360c7a1d242ff39c09b18228e22c2246cdfbd36bfbd3da2c7ddb3fe17db
+  data.tar.gz: 7c98b094c25dce72089d4cb6697b192a8e61346f2586c4243cc58b4280839d57
+SHA512:
+  metadata.gz: 83993960febf56ffc67257c7156d2dcc7733282f54f911f4ea404da63d301cbe9304df1676210a97113ca60e1ff26d65714f3f4d31edb533f4634dcbb5622b61
+  data.tar.gz: 4336454d9240e04c3e43be2aed3edf489a57e90c9864097381c049fae17fdfce5a7a588c43dba10aebdbd93ba9f91a796450b950c2da479fc3058e4adff41962

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v1.0.0
+
+* Initial version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matt@venabl.es. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in has_secure_password_argon2.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    has_secure_password_argon2 (1.0.0)
+      activerecord (>= 4.2.6)
+      activesupport (>= 4.2.6)
+      argon2 (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    argon2 (2.0.2)
+      ffi (~> 1.9)
+      ffi-compiler (>= 0.1)
+    bcrypt (3.1.13)
+    concurrent-ruby (1.1.5)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    docile (1.1.5)
+    ffi (1.11.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (1.8.6)
+    minitest (5.11.3)
+    rake (10.5.0)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sqlite3 (1.4.1)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.6.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bcrypt (~> 3.1)
+  bundler (~> 1.17)
+  coveralls
+  has_secure_password_argon2!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  simplecov (~> 0.11.2)
+  sqlite3 (~> 1.3)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Matt Venables <matt@venabl.es>
+
+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,48 @@
+# has_secure_password_argon2
+
+[![Build Status](https://travis-ci.org/venables/has_secure_password_argon2.svg?branch=master)](https://travis-ci.org/venables/has_secure_password_argon2)
+[![Coverage Status](https://coveralls.io/repos/github/venables/has_secure_password_argon2/badge.svg?branch=master)](https://coveralls.io/github/venables/has_secure_password_argon2?branch=master)
+
+Drop-in replacement for Ruby on Rails' `has_secure_password`, but this one uses [argon2](https://en.wikipedia.org/wiki/Argon2) to hash the password.
+
+**No code changes necessary.**  Just add this gem to your project and your users will be using `argon2`
+
+## Installation
+
+Add it to your bundle:
+
+```sh
+bundle add has_secure_password_argon2
+```
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem 'has_secure_password_argon2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_secure_password_argon2
+
+## Usage
+
+Just add this gem to your Gemfile and `has_secure_password` will start to use `argon2` for password hashing.
+
+If you already have users authenticating with Rails' version of `has_secure_password`, this gem will automatically upgrade users to `argon2` during their next login.  In this case, please leave `bcrypt` installed to support he upgrade process.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/venables/has_secure_password_argon2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+[MIT](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/has_secure_password_argon2/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/has_secure_password_argon2.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_secure_password_argon2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'has_secure_password_argon2'
+  spec.version       = HasSecurePasswordArgon2::VERSION
+  spec.authors       = ['Matt Venables']
+  spec.email         = ['matt@venabl.es']
+
+  spec.summary       = 'Drop-in replacement for has_secure_password that uses argon2'
+  spec.homepage      = 'https://github.com/venables/has_secure_password_argon2'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/venables/has_secure_password_argon2'
+    spec.metadata['changelog_uri'] = 'https://github.com/venables/has_secure_password_argon2/blob/master/CHANGELOG.md'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activerecord', '>= 4.2.6'
+  spec.add_runtime_dependency 'activesupport', '>= 4.2.6'
+  spec.add_runtime_dependency 'argon2', '~> 2.0'
+
+  spec.add_development_dependency 'bcrypt', '~> 3.1'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'simplecov', '~> 0.11.2'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+end

data/lib/has_secure_password_argon2.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'argon2'
+require 'active_record'
+require 'active_support/all'
+require 'has_secure_password_argon2/version'
+
+module HasSecurePasswordArgon2
+  extend ActiveSupport::Concern
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :time_cost
+    attr_accessor :memory_cost
+    attr_accessor :secret
+  end
+  self.time_cost = 2 # 1..10
+  self.memory_cost = 16 # 1..31
+
+  module ClassMethods
+    def has_secure_password(options = {})
+      super options
+      include InstanceMethodsOnActivation
+    end
+  end
+
+  module InstanceMethodsOnActivation
+    # Returns +self+ if the password is correct, otherwise +false+.
+    #
+    #   class User < ActiveRecord::Base
+    #     has_secure_password validations: false
+    #   end
+    #
+    #   user = User.new(name: 'david', password: 'mUc3m00RsqyRe')
+    #   user.save
+    #   user.authenticate('notright')      # => false
+    #   user.authenticate('mUc3m00RsqyRe') # => user
+    def authenticate(unencrypted_password)
+      if password_digest.start_with?('$argon2')
+        Argon2::Password.verify_password(unencrypted_password, password_digest, HasSecurePasswordArgon2.secret) && self
+      elsif super(unencrypted_password)
+        self.password = hash_argon2_password(unencrypted_password)
+        save(validate: false)
+        self
+      else
+        false
+      end
+    end
+
+    attr_reader :password
+
+    # Encrypts the password into the +password_digest+ attribute, only if the
+    # new password is not empty.
+    #
+    #   class User < ActiveRecord::Base
+    #     has_secure_password validations: false
+    #   end
+    #
+    #   user = User.new
+    #   user.password = nil
+    #   user.password_digest # => nil
+    #   user.password = 'mUc3m00RsqyRe'
+    #   user.password_digest # => "$2a$10$4LEA7r4YmNHtvlAvHhsYAeZmk/xeUVtMTYqwIvYY76EW5GUqDiP4."
+    def password=(unencrypted_password)
+      if unencrypted_password.nil?
+        self.password_digest = nil
+      elsif !unencrypted_password.empty?
+        @password = unencrypted_password
+        self.password_digest = hash_argon2_password(unencrypted_password)
+      end
+    end
+
+    private
+
+    def hash_argon2_password(unencrypted_password)
+      hasher = Argon2::Password.new t_cost: HasSecurePasswordArgon2.time_cost,
+                                    m_cost: HasSecurePasswordArgon2.memory_cost,
+                                    secret: HasSecurePasswordArgon2.secret
+
+      hasher.create unencrypted_password
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, HasSecurePasswordArgon2

data/lib/has_secure_password_argon2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HasSecurePasswordArgon2
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: has_secure_password_argon2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Venables
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: argon2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- matt@venabl.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- has_secure_password_argon2.gemspec
+- lib/has_secure_password_argon2.rb
+- lib/has_secure_password_argon2/version.rb
+homepage: https://github.com/venables/has_secure_password_argon2
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/venables/has_secure_password_argon2
+  source_code_uri: https://github.com/venables/has_secure_password_argon2
+  changelog_uri: https://github.com/venables/has_secure_password_argon2/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Drop-in replacement for has_secure_password that uses argon2
+test_files: []