has_unpublished_password 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3b72f37de09c2757a24ed07a9324a635caeb962a3cc8c947593ffe082bda976
+  data.tar.gz: a7717f80f508d92fe81359111d1e1ac79e4b73faf19dbcd64ad806d2a82025f4
+SHA512:
+  metadata.gz: 337475d798ece49c9cb9863a42c590dc300905d885d42622d037ce6d6376ccc4c41bc7724184f0ccd2494aab10efc675f051991548e6da16e5df5ef902b35dba
+  data.tar.gz: 527ca7b0b75f9cc5ac6d9e496c1eb8caa374efbfd81484808dd8d083bb738c6d4090b2e3d4510be217214ed87f18c70b0707e1389d4717031d6d2c05b72df245

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bloom
+pwned-passwords-sha1-ordered-by-count-v4.txt
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.3

data/.travis.yml

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

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 daniel@heath.cc. 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_unpublished_password.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    has_unpublished_password (0.2.0)
+      ruby-bitfield
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+    ruby-bitfield (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  has_unpublished_password!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Daniel Heath
+
+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,113 @@
+# HasUnpublishedPassword
+
+## What is it?
+
+This is a gem which performs offline checks against the [HIBP](https://haveibeenpwned.com/) master list.
+
+It can be used to ensure that your users are not using credentials which have previously been leaked.
+
+The checks are performed using a pre-built cuckoo filter.
+
+## Status
+
+I just threw this together and haven't used it in production yet.
+
+I've pre-built filters from three datasets (found in the `hibp-cuckoo-filter` gem):
+
+ * The 'top 560k passwords' filter is 992kb, with a 1.7% false positive rate. Uses 1mb ram once loaded.
+ * The 'top 5600k passwords' filter is 9.6mb, with a 2.1% false positive rate. Uses 8mb ram once loaded.
+ * The 'top 56m passwords' filter is 80mb, with a 2.6% false positive rate. Uses 67mb ram once loaded.
+
+On my recent macbook pro, checking a single password against the largest filter takes about 3.2 microseconds.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_unpublished_password'
+gem 'hibp-cuckoo-filter' # optional data files, if you don't want to build your own.
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_unpublished_password
+
+## Usage
+
+### Configuration
+
+Add an initializer (eg `config/initializers/has_unpublished_password.rb`):
+
+    HasUnpublishedPassword.configure do |config|
+      # Valid values: :small, :medium, :large
+      config.filter = :large
+    end
+
+
+### Validation
+
+`validates :password, never_leaked_to_hibp: true`
+
+### Low level usage
+```
+filter = HasUnpublishedPassword.import('serialized.json.gz')
+filter.has? Digest::SHA1.hexdigest('password') # true
+```
+
+## Development
+
+### Native component
+
+The [native component](https://github.com/DanielHeath/rust-cuckoofilter) is written in rust.
+
+To update it to a new version, cross compile it in release mode, then:
+```
+cd ../rust-cuckoofilter/cabi
+
+cargo build --target=x86_64-unknown-linux-gnu --release
+cp target/release/libcuckoofilter_cabi.d ../../has_unpublished_password/nativeext/x86_64/
+
+cargo build --target=x86_64-apple-darwin --release
+cp target/release/libcuckoofilter_cabi.dylib ../../has_unpublished_password/nativeext/x86_64/
+```
+
+### Building the filter
+
+First, download the master list from HIBP (I used the 'ordered by frequency' list) and decompress it.
+
+Then, run `data/prepare.sh <path-to-master-list-file>`.
+
+This takes quite awhile; it'll print how many lines it's completed periodically.
+
+This process writes its result to `serialized.json.gz` when complete.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/danielheath/has_unpublished_password. 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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the HasUnpublishedPassword project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/has_unpublished_password/blob/master/CODE_OF_CONDUCT.md).
+
+
+
+
+
+
+
+
+
+
+
+24 bits is 2mb. 1/3rd of values will be filled by 5 million rows.
+
+take 6 24-bit sequences (for 12mb). That yields a 0.13% collision chance. That's promising.

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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "has_unpublished_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/has_unpublished_password.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "has_unpublished_password/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_unpublished_password"
+  spec.version       = HasUnpublishedPassword::VERSION
+  spec.authors       = ["Daniel Heath"]
+  spec.email         = ["daniel@heath.cc"]
+
+  spec.summary       = %q{Prevent the use of passwords found in the HIBP breach dataset}
+  spec.description   = %q{Adds a new validation for ActiveRecord, 'has_unpublished_password'}
+  spec.homepage      = "https://github.com/danielheath/has_unpublished_password"
+  spec.license       = "MIT"
+
+  # 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|data)/}) } +
+    Dir.glob('serialized-top-11200000-p*.bloom')
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "ruby-bitfield"
+end

data/lib/has_unpublished_password/never_leaked_to_hibp_validator.rb

@@ -0,0 +1,9 @@
+# Must be a top-level constant so rails can find it.
+
+class NeverLeakedToHibpValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    if HasUnpublishedPassword.has_been_published? value
+      record.errors[attribute] << (options[:message] || "That's one of the first passwords a hacker would try.")
+    end
+  end
+end

data/lib/has_unpublished_password/sha_bloom.rb

@@ -0,0 +1,93 @@
+require 'bitfield'
+
+module HasUnpublishedPassword
+
+  class ShaBloom
+    BITS_PER_HEX_CHAR=4
+    class << self
+      attr_accessor :hash_bits_per_filter, :filter_count, :filter_window, :filter_step
+      def filter_window
+        self.hash_bits_per_filter / BITS_PER_HEX_CHAR
+      end
+    end
+    @hash_bits_per_filter = 24
+    @filter_count = 34
+    @filter_step = 1
+
+    class DefaultConfig < ShaBloom
+      @filter_count = 16
+      @hash_bits_per_filter = 24
+      @filter_step = 1
+    end
+
+    def initialize(filters=nil)
+      unless filters
+        filters = []
+        self.class.filter_count.times do |i|
+          filters[i] ||= Bitfield.new(2**self.class.hash_bits_per_filter)
+        end
+      end
+
+      @bitfields = filters
+    end
+
+    def inspect
+      to_s
+    end
+
+    def to_s
+      "#{self.class} filter with #{self.class.filter_count} blocks of size #{2**self.class.hash_bits_per_filter / 8 / 1024}kb"
+    end
+
+    def add_value(value)
+      add_shahash Digest::SHA1.hexdigest value
+    end
+
+    def check_value(value)
+      check_shahash Digest::SHA1.hexdigest value
+    end
+
+    def add_shahash(hash)
+      walk_hash(hash) do |row, idx|
+        row.set(idx)
+      end
+    end
+
+    def check_shahash(hash)
+      walk_hash(hash) do |row, idx|
+        return false unless row.get(idx)
+      end
+      return true
+    end
+
+    def serialize(pattern, verbose=false)
+      self.class.filter_count.times do |i|
+        fn = "#{pattern}-p#{i}.bloom"
+        bitfields[i].serialize(fn)
+        puts "wrote #{fn}" if verbose
+        puts `du -h #{fn}` if verbose
+      end
+    end
+
+    def self.deserialize(pattern)
+      filters = []
+      filter_count.times do |i|
+        fn = "#{pattern}-p#{i}.bloom"
+        filters << Bitfield.deserialize(fn, 2**hash_bits_per_filter)
+      end
+      new(filters)
+    end
+
+    private
+    attr_reader :bitfields
+
+    def walk_hash(hash)
+      self.class.filter_count.times do |i|
+        start  = i * self.class.filter_step
+        finish = i * self.class.filter_step + self.class.filter_window - 1
+        idx    = hash[start..finish].to_i(16)
+        yield bitfields[i], idx
+      end
+    end
+  end
+end

data/lib/has_unpublished_password/version.rb

@@ -0,0 +1,3 @@
+module HasUnpublishedPassword
+  VERSION = "0.2.0"
+end

data/lib/has_unpublished_password.rb

@@ -0,0 +1,32 @@
+require 'digest/sha1'
+
+if defined? ::ActiveModel
+  require 'has_unpublished_password/never_leaked_to_hibp_validator'
+end
+
+require "has_unpublished_password/version"
+require 'has_unpublished_password/sha_bloom'
+
+module HasUnpublishedPassword
+
+  class << self
+    attr_writer :filter
+    def filter
+      @filter ||= HasUnpublishedPassword::ShaBloom::DefaultConfig.deserialize(
+        File.join(File.dirname(__FILE__), '..', 'serialized-top-11200000')
+      )
+    end
+
+    def has_been_published?(password)
+      filter.check_value(password)
+    end
+  end
+
+end
+
+__END__
+
+u = User.last
+u.password = "password"
+u.valid?
+u.errors[:password]

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: has_unpublished_password
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Daniel Heath
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-03 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: ruby-bitfield
+  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: Adds a new validation for ActiveRecord, 'has_unpublished_password'
+email:
+- daniel@heath.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- has_unpublished_password.gemspec
+- lib/has_unpublished_password.rb
+- lib/has_unpublished_password/never_leaked_to_hibp_validator.rb
+- lib/has_unpublished_password/sha_bloom.rb
+- lib/has_unpublished_password/version.rb
+- serialized-top-11200000-p0.bloom
+- serialized-top-11200000-p1.bloom
+- serialized-top-11200000-p10.bloom
+- serialized-top-11200000-p11.bloom
+- serialized-top-11200000-p12.bloom
+- serialized-top-11200000-p13.bloom
+- serialized-top-11200000-p14.bloom
+- serialized-top-11200000-p15.bloom
+- serialized-top-11200000-p2.bloom
+- serialized-top-11200000-p3.bloom
+- serialized-top-11200000-p4.bloom
+- serialized-top-11200000-p5.bloom
+- serialized-top-11200000-p6.bloom
+- serialized-top-11200000-p7.bloom
+- serialized-top-11200000-p8.bloom
+- serialized-top-11200000-p9.bloom
+homepage: https://github.com/danielheath/has_unpublished_password
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Prevent the use of passwords found in the HIBP breach dataset
+test_files: []