aspnet_password_hasher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b06e4dc5a1b9d924d3ab268a0558d86411b66f321cdc4dbbf1231875d7f8f967
+  data.tar.gz: 30a00eaece15084ac2422c48b9675be4e38b481513a05023f400507b0bac2c81
+SHA512:
+  metadata.gz: 21390413464568ba498eca11652e1d7a48d604331da2d04de19d1e70236850396a862514ccf02011a1b5388e6eae1da4189120193bc6ded573b5e8f35a5819e2
+  data.tar.gz: 11c9ed3b3bc76420f9e8ab9ab8b29dba7b1541ea3bcf771f6f96f50d17c8a7ece344fc7775cd9f1b999bf15ac23413f099f56bb2cce0206283336690d32522c5

data/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 0 * * 0'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [3.0, 2.7, 2.6, 2.5, 2.4]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+
+    - name: Run test
+      run: |
+        bundle update
+        bundle exec rake
+
+    - name: Upload coverage
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: coverage-ruby-${{ matrix.ruby_version }}
+        path: coverage
+
+    - name: Show coverage
+      if: always()
+      run: |
+        cat coverage/coverage.txt

data/.gitignore

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

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+
+gem "rspec"
+gem "rspec-parameterized"
+gem "simplecov"
+gem "simplecov-erb"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Kazuki Nishikawa
+
+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,84 @@
+![](https://github.com/kzkn/aspnet_password_hasher/workflows/CI/badge.svg)
+
+# AspnetPasswordHasher
+
+An implementation of password hashing compatible with [ASP.NET Identity PasswordHasher](https://github.com/dotnet/aspnetcore/blob/main/src/Identity/Extensions.Core/src/PasswordHasher.cs).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aspnet_password_hasher'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install aspnet_password_hasher
+
+## Usage
+
+Password hashing:
+
+```ruby
+hasher = AspnetPasswordHasher::PasswordHasher.new
+raw_password = 'my password'
+hashed_password = hasher.hash_password(raw_password)
+```
+
+Verify password:
+
+```ruby
+hasher = AspnetPasswordHasher::PasswordHasher.new
+raw_password = 'my password'
+hashed_password = hasher.hash_password(raw_password)
+hasher.verify_hashed_password(hashed_password, raw_password) # => :success
+hasher.verify_hashed_password(hashed_password, 'bad password') # => :failed
+```
+
+If a hashed string with a weaker algorithm is given, report it:
+```ruby
+hasher = AspnetPasswordHasher::PasswordHasher.new
+raw_password = 'my password'
+hashed_password = hasher.hash_password(raw_password)
+
+hasher_v2 = AspnetPasswordHasher::PasswordHasher.new(mode: :v2)
+hasher_v2.verify_hashed_password(hashed_password, raw_password) # => :success_rehash_needed
+
+hasher_fewer_iters = AspnetPasswordHasher::PasswordHasher.new(iter_count: 100)
+hasher_fewer_iters.verify_hashed_password(hashed_password, raw_password) # => :success_rehash_needed
+```
+
+You can pass parameters similar to PasswordHasher:
+
+```ruby
+# compatibility mode, version 2
+hasher = AspnetPasswordHasher::PasswordHasher.new(mode: :v2)
+
+# compatibility mode, version 3 (default)
+hasher = AspnetPasswordHasher::PasswordHasher.new(mode: :v3)
+
+# custom iteration count (default is 10000)
+hasher = AspnetPasswordHasher::PasswordHasher.new(iter_count: 99999)
+
+# custom random number generator (default is SecureRandom)
+hasher = AspnetPasswordHasher::PasswordHasher.new(random_number_generator: Random.new)
+```
+
+## 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 the created tag, 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/kzkn/aspnet_password_hasher.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/aspnet_password_hasher.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/aspnet_password_hasher/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "aspnet_password_hasher"
+  spec.version       = AspnetPasswordHasher::VERSION
+  spec.authors       = ["Kazuki Nishikawa"]
+  spec.email         = ["kzkn@users.noreply.github.com"]
+
+  spec.summary       = "An implementation of password hashing compatible with ASP.NET Identity"
+  spec.description   = "An implementation of password hashing compatible with ASP.NET Identity"
+  spec.homepage      = "https://github.com/kzkn/aspnet_password_hasher"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kzkn/aspnet_password_hasher"
+  spec.metadata["changelog_uri"] = "https://github.com/kzkn/aspnet_password_hasher/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "aspnet_password_hasher"
+
+# 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/aspnet_password_hasher.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "aspnet_password_hasher/password_hasher"
+require_relative "aspnet_password_hasher/version"

data/lib/aspnet_password_hasher/password_hasher.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'securerandom'
+require 'base64'
+
+module AspnetPasswordHasher
+  class PasswordHasher
+    def initialize(options = {})
+      @mode = options[:mode] || :v3
+      @rng = options[:random_number_generator] || SecureRandom
+
+      case @mode
+      when :v2
+        @iter_count = 0
+      when :v3
+        @iter_count = options[:iter_count] || 10000
+        if @iter_count < 1
+          raise ArgumentError, "Invalid password hasher iteration count"
+        end
+      else
+        raise ArgumentError, "Invalid password hasher compatibility mode"
+      end
+    end
+
+    def hash_password(password)
+      bytes = case @mode
+              when :v2
+                hash_password_v2(password)
+              when :v3
+                hash_password_v3(password)
+              end
+      Base64.strict_encode64(bytes)
+    end
+
+    def verify_hashed_password(hashed_password, provided_password)
+      decoded_hashed_password = Base64.strict_decode64(hashed_password)
+      case decoded_hashed_password[0]
+      when "\x00"
+        # v2
+        if verify_hashed_password_v2(decoded_hashed_password, provided_password)
+          @mode == :v3 ? :success_rehash_needed : :success
+        else
+          :failed
+        end
+      when "\x01"
+        # v3
+        result, embed_iter_count = verify_hashed_password_v3(decoded_hashed_password, provided_password)
+        if result
+          embed_iter_count < @iter_count ? :success_rehash_needed : :success
+        else
+          :failed
+        end
+      else
+        :failed
+      end
+    end
+
+    private
+
+    def hash_password_v2(password)
+      iter_count = 1000 # default for Rfc2898DeriveBytes
+      subkey_len = 256 / 8 # 256 bits
+      salt_size = 128 / 8 # 128 bits
+
+      salt = @rng.bytes(salt_size)
+      digest = OpenSSL::Digest::SHA1.new
+      subkey = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, iter_count, subkey_len, digest)
+
+      output_bytes = String.new
+      output_bytes << "\x00" # format marker
+      output_bytes << salt
+      output_bytes << subkey
+      output_bytes
+    end
+
+    def hash_password_v3(password)
+      prf = 1 # HMACSHA256
+      salt_size = 128 / 8
+      num_bytes_requested = 256 / 8
+
+      salt = @rng.bytes(salt_size)
+      digest = OpenSSL::Digest::SHA256.new
+      subkey = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, @iter_count, num_bytes_requested, digest)
+
+      output_bytes = String.new
+      output_bytes << "\x01" # format marker
+      [prf].pack('N', buffer: output_bytes)
+      [@iter_count].pack('N', buffer: output_bytes)
+      [salt_size].pack('N', buffer: output_bytes)
+      output_bytes << salt
+      output_bytes << subkey
+      output_bytes
+    end
+
+    def verify_hashed_password_v2(hashed_password, password)
+      iter_count = 1000 # default for Rfc2898DeriveBytes
+      subkey_len = 256 / 8 # 256 bits
+      salt_size = 128 / 8 # 128 bits
+
+      if hashed_password.length != 1 + subkey_len + salt_size
+        return false # bad size
+      end
+
+      salt = hashed_password[1..salt_size]
+      expected_subkey = hashed_password[(salt_size + 1)...hashed_password.length]
+
+      digest = OpenSSL::Digest::SHA1.new
+      actual_subkey = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, iter_count, subkey_len, digest)
+      expected_subkey == actual_subkey
+    end
+
+    def verify_hashed_password_v3(hashed_password, password)
+      prf = hashed_password[1..4].unpack('N')[0]
+      iter_count = hashed_password[5..8].unpack('N')[0]
+      salt_len = hashed_password[9..12].unpack('N')[0]
+      # salt must be >= 128 bits
+      if salt_len < 128 / 8
+        return [false, nil]
+      end
+
+      salt = hashed_password[13...(13 + salt_len)]
+      subkey_len = hashed_password.length - 13 - salt_len
+      # subkey must by >= 128 bits
+      if subkey_len < 128 / 8
+        return [false, nil]
+      end
+
+      expected_subkey = hashed_password[(13 + salt_len)...hashed_password.length]
+
+      digest = case prf
+               when 0
+                 OpenSSL::Digest::SHA1.new
+               when 1
+                 OpenSSL::Digest::SHA256.new
+               when 2
+                 OpenSSL::Digest::SHA512.new
+               end
+      actual_subkey = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, iter_count, subkey_len, digest)
+
+      [expected_subkey == actual_subkey, iter_count]
+    rescue StandardError
+      [false, nil]
+    end
+  end
+end

data/lib/aspnet_password_hasher/version.rb

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

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: aspnet_password_hasher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kazuki Nishikawa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-01 00:00:00.000000000 Z
+dependencies: []
+description: An implementation of password hashing compatible with ASP.NET Identity
+email:
+- kzkn@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aspnet_password_hasher.gemspec
+- bin/console
+- bin/setup
+- lib/aspnet_password_hasher.rb
+- lib/aspnet_password_hasher/password_hasher.rb
+- lib/aspnet_password_hasher/version.rb
+homepage: https://github.com/kzkn/aspnet_password_hasher
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kzkn/aspnet_password_hasher
+  source_code_uri: https://github.com/kzkn/aspnet_password_hasher
+  changelog_uri: https://github.com/kzkn/aspnet_password_hasher/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: An implementation of password hashing compatible with ASP.NET Identity
+test_files: []