multi_password 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3bedf3cb4f2713cd269dc2299186bfc4b9da288d336a59e20d0e6c11fc467541
+  data.tar.gz: c69c01925c5588d2d95ec94984977304655e1090b9e6c1e8040c2f41df15943b
+SHA512:
+  metadata.gz: 5033e7251658eb78f0925e65fcb93103d2d110cbc3df3513ecf4e5a0f8b489162d3834c5f1956dac2403a9e084f2e3dc21409798f7bd807b44a8264fce0656ed
+  data.tar.gz: 6c0d5089fa54596cfe0d531fcd3d38c33fff7b5756edd6bad13c66a85920bab3e0b89e3f7cb3202780e079142bebd9cc5cf376785f1fdf6efb4de0ed719a1035

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+name: RSpec
+
+on: [push, pull_request]
+
+env:
+  RUBY_VERSION: 2.7.2
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        id: ruby
+        with:
+          ruby-version: ${{ env.RUBY_VERSION }}
+
+      - uses: actions/cache@v1
+        id: cache
+        with:
+          path: vendor/bundle
+          key: bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - name: Build
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+
+      - name: run rspec
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in multi_password.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem 'argon2'
+gem 'bcrypt'
+gem 'scrypt'
+gem 'byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Hieu Nguyen
+
+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,91 @@
+# MultiPassword
+
+MultiPassword provides a generic interface for popular password hashing algorithm,
+so that user can easily switch between different algorithms without worrying
+about changing application code in multiple places.
+
+MultiPassword also supports running multiple algorithms in one application, which is
+great when you want to migrate from one algorithm to another.
+
+Currently MultiPassword supports 3 algorithms:
+
+- SCrypt
+- BCrypt
+- Argon2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multi_password'
+
+# if you want to use scrypt, you need to include the gem manually:
+gem 'scrypt'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install multi_password
+
+## Usage
+
+### Configuration
+
+You can specify an application-wide default algorithm:
+
+```ruby
+# require the strategy you want to use here
+require 'multi_password/strategies/scrypt'
+
+MultiPassword.configure do |config|
+  config.default_algorithm = :scrypt
+
+  # support all options that SCrypt accepts
+  config.default_options = { key_len: 64, max_time: 1 }
+end
+```
+
+You can also specify algorithm and options on-the-fly:
+
+```ruby
+manager = MultiPassword.new(algorithm: :scrypt, options: { key_len: 64, max_time: 1 })
+```
+
+### Interface
+
+MultiPassword provides 2 methods: `create` for hashing password and `verify` for
+verifying input password:
+
+```ruby
+require 'multi_password/strategies/scrypt'
+
+manager = MultiPassword.new(algorithm: :scrypt)
+
+encrypted_password = manager.create('password')
+# => "4000$8$2$df55d1c7bc475c6d4a7db9dac5c4d0469121419355f54c4ae23f61556f7198ac$2933bd4ed4b1d902951babe856aeb160ef3f061d7927ed46c749036b1edea509"
+
+manager.verify('password', encrypted_password)
+# => true
+```
+
+###
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/multi_password.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "multi_password"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/multi_password.rb

@@ -0,0 +1,60 @@
+require "multi_password/version"
+require 'multi_password/errors'
+require 'multi_password/strategy'
+require 'dry/configurable'
+require 'concurrent/hash'
+
+class MultiPassword
+  extend Dry::Configurable
+
+  setting :default_algorithm
+  setting :default_options, {}
+
+  @registers = Concurrent::Hash.new
+
+  def self.registers
+    @registers
+  end
+
+  def self.register(algorithm, klass)
+    if registers[algorithm]
+      Warning.warn <<-MSG
+[MultiPassword] #{algorithm} is already registered by #{registers[algorithm]} but is overwritten by #{klass} in:
+      #{caller.first}
+      MSG
+    end
+
+    registers[algorithm] = klass
+  end
+
+  def self.unregister(algorithm)
+    registers.delete(algorithm)
+  end
+
+  def initialize(algorithm: config.default_algorithm, options: config.default_options)
+    @strategy = registers.fetch(algorithm).new
+    @options = options
+  rescue KeyError
+    raise AlgorithmNotRegistered.new(algorithm)
+  end
+
+  def create(password)
+    strategy.create(password, options)
+  end
+
+  def verify(password, encrypted_password)
+    strategy.verify(password, encrypted_password)
+  end
+
+  private
+
+  attr_reader :strategy, :options
+
+  def config
+    self.class.config
+  end
+
+  def registers
+    self.class.registers
+  end
+end

data/lib/multi_password/errors.rb

@@ -0,0 +1,15 @@
+class MultiPassword
+  class Error < StandardError; end
+
+  class MethodNotImplemented < NoMethodError
+    def initialize(method_name, *args, **options)
+      super("subclass does not implement ##{method_name}", *args, **options)
+    end
+  end
+
+  class AlgorithmNotRegistered < Error
+    def initialize(algorithm)
+      super("Algorithm #{algorithm} is not registered. Try requiring 'multi_password/strategies/#{algorithm}'.")
+    end
+  end
+end

data/lib/multi_password/strategies/argon2.rb

@@ -0,0 +1,20 @@
+require 'argon2'
+require 'multi_password/strategy'
+
+class MultiPassword
+  module Strategies
+    class Argon2
+      include Strategy
+
+      register :argon2
+
+      def create(password, options = {})
+        ::Argon2::Password.new(options).create(password)
+      end
+
+      def verify(password, encrypted_password)
+        ::Argon2::Password.verify_password(password, encrypted_password)
+      end
+    end
+  end
+end

data/lib/multi_password/strategies/bcrypt.rb

@@ -0,0 +1,20 @@
+require 'bcrypt'
+require 'multi_password/strategy'
+
+class MultiPassword
+  module Strategies
+    class BCrypt
+      include Strategy
+
+      register :bcrypt
+
+      def create(password, options = {})
+        ::BCrypt::Password.create(password, options).to_s
+      end
+
+      def verify(password, encrypted_password)
+        ::BCrypt::Password.new(encrypted_password) == password
+      end
+    end
+  end
+end

data/lib/multi_password/strategies/scrypt.rb

@@ -0,0 +1,20 @@
+require 'scrypt'
+require 'multi_password/strategy'
+
+class MultiPassword
+  module Strategies
+    class SCrypt
+      include Strategy
+
+      register :scrypt
+
+      def create(password, options = {})
+        ::SCrypt::Password.create(password, options).to_s
+      end
+
+      def verify(password, encrypted_password)
+        ::SCrypt::Password.new(encrypted_password) == password
+      end
+    end
+  end
+end

data/lib/multi_password/strategy.rb

@@ -0,0 +1,21 @@
+require_relative 'errors'
+
+class MultiPassword
+  module Strategy
+    def self.included(klass)
+      klass.class_eval do
+        def self.register(algorithm)
+          MultiPassword.register(algorithm, self)
+        end
+      end
+    end
+
+    def create(_password, _options = {})
+      raise MethodNotImplemented, 'create'
+    end
+
+    def verify(_password, _encrypted_password)
+      raise MethodNotImplemented, 'verify'
+    end
+  end
+end

data/lib/multi_password/version.rb

@@ -0,0 +1,3 @@
+class MultiPassword
+  VERSION = "0.1.0"
+end

data/multi_password.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/multi_password/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi_password"
+  spec.version       = MultiPassword::VERSION
+  spec.authors       = ["Hieu Nguyen"]
+  spec.email         = ["hieu.nguyen@ascendaloyalty.com"]
+
+  spec.summary       = %q{Generic swappable password algorithm handler}
+  spec.description   = %q{Provide a generic interface that allows application to easily switch password algorithm}
+  spec.homepage      = "https://github.com/kaligo/multi_password"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kaligo/multi_password"
+  spec.metadata["changelog_uri"] = "https://github.com/kaligo/multi_password/blob/master/CHANGELOG"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'dry-configurable'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: multi_password
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hieu Nguyen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  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: dry-configurable
+  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'
+description: Provide a generic interface that allows application to easily switch
+  password algorithm
+email:
+- hieu.nguyen@ascendaloyalty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multi_password.rb
+- lib/multi_password/errors.rb
+- lib/multi_password/strategies/argon2.rb
+- lib/multi_password/strategies/bcrypt.rb
+- lib/multi_password/strategies/scrypt.rb
+- lib/multi_password/strategy.rb
+- lib/multi_password/version.rb
+- multi_password.gemspec
+homepage: https://github.com/kaligo/multi_password
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaligo/multi_password
+  source_code_uri: https://github.com/kaligo/multi_password
+  changelog_uri: https://github.com/kaligo/multi_password/blob/master/CHANGELOG
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Generic swappable password algorithm handler
+test_files: []