nobspw_rails7 0.6.5

data/lib/nobspw_rails7/configuration.rb

@@ -0,0 +1,27 @@
+module NOBSPW_RAILS7
+  class Configuration
+    attr_accessor :min_password_length
+    attr_accessor :max_password_length
+    attr_accessor :min_unique_characters
+    attr_accessor :dictionary_path
+    attr_accessor :grep_path
+    attr_accessor :use_ruby_grep
+    attr_accessor :domain_name
+    attr_accessor :blacklist
+    attr_accessor :validation_methods
+    attr_accessor :interrupt_validation_for
+
+    def initialize
+      @min_password_length      = 10
+      @max_password_length      = 256
+      @min_unique_characters    = 5
+      @dictionary_path          = File.join(File.dirname(__FILE__), "..", "db", "dictionary.txt")
+      @grep_path                = `which grep`.strip
+      @use_ruby_grep            = @grep_path.empty?
+      @domain_name              = nil
+      @blacklist                = nil
+      @validation_methods       = NOBSPW_RAILS7::ValidationMethods::DEFAULT_VALIDATION_METHODS
+      @interrupt_validation_for = NOBSPW_RAILS7::ValidationMethods::INTERRUPT_VALIDATION_FOR
+    end
+  end
+end

data/lib/nobspw_rails7/password_checker.rb

@@ -0,0 +1,41 @@
+require 'shellwords'
+
+module NOBSPW_RAILS7
+  class PasswordChecker
+    include NOBSPW_RAILS7::ValidationMethods
+
+    def initialize(name: nil, username: nil, email: nil, password:)
+      @name, @username, @email, @password = \
+        name&.strip, username&.strip, email&.strip, (password || '').strip
+    end
+
+    def strong?
+      check_password if @strong.nil?
+      @strong
+    end
+
+    def weak?
+      !strong?
+    end
+
+    def weak_password_reasons
+      check_password if @weak_password_reasons.nil?
+      @weak_password_reasons
+    end
+    alias_method :reasons, :weak_password_reasons
+
+    private
+
+    def check_password
+      @weak_password_reasons = []
+      NOBSPW_RAILS7.configuration.validation_methods.each do |method|
+        if send("#{method}")
+          @weak_password_reasons << method.to_s.sub(/\?$/, '').to_sym
+          break if NOBSPW_RAILS7.configuration.interrupt_validation_for.include?(method)
+        end
+      end
+
+      @strong = @weak_password_reasons.empty?
+    end
+  end
+end

data/lib/nobspw_rails7/validation_methods.rb

@@ -0,0 +1,127 @@
+require 'shellwords'
+require 'open3'
+
+module NOBSPW_RAILS7
+  module ValidationMethods
+    DEFAULT_VALIDATION_METHODS = %i(password_empty?
+                                    name_included_in_password?
+                                    username_included_in_password?
+                                    email_included_in_password?
+                                    domain_included_in_password?
+                                    password_too_short?
+                                    password_too_long?
+                                    not_enough_unique_characters?
+                                    password_not_allowed?
+                                    password_too_common?)
+
+    INTERRUPT_VALIDATION_FOR   = %i(password_empty?)
+    STDIN_GREP_COMMAND         = ['/usr/bin/grep', '-m 1', '-f', '/dev/stdin',
+                                  NOBSPW_RAILS7.configuration.dictionary_path]
+
+    private
+
+    def password_empty?
+      @password.nil? || @password.strip == ''
+    end
+
+    def name_included_in_password?
+      return nil unless @name
+      words = remove_word_separators(@name).split(' ')
+      words_included_in_password?(words)
+    end
+
+    def username_included_in_password?
+      return nil unless @username
+      words = remove_word_separators(@username).split(' ')
+      words_included_in_password?(words)
+    end
+
+    def email_included_in_password?
+      return nil unless @email
+      words = remove_word_separators(email_without_extension(@email)).split(' ')
+      words_included_in_password?(words)
+    end
+
+    def domain_included_in_password?
+      domain = NOBSPW_RAILS7.configuration.domain_name
+      return nil unless domain
+      domain = strip_extension_from_domain(domain)
+      domain_without_separator = remove_word_separators(domain).gsub(' ', '')
+      words_included_in_password?([domain, domain_without_separator])
+    end
+
+    def password_not_allowed?
+      return nil unless NOBSPW_RAILS7.configuration.blacklist
+
+      NOBSPW_RAILS7.configuration.blacklist.each do |expression|
+        if expression.is_a?(Regexp)
+          return true if @password.match?(expression)
+        else
+          return true if expression.to_s == @password
+        end
+      end
+
+      false
+    end
+
+    def password_too_short?
+      @password.length < NOBSPW_RAILS7.configuration.min_password_length
+    end
+
+    def password_too_long?
+      @password.length > NOBSPW_RAILS7.configuration.max_password_length
+    end
+
+    def not_enough_unique_characters?
+      unique  = @password.split(//).uniq.size
+      minimum = NOBSPW_RAILS7.configuration.min_unique_characters
+      !(unique >= minimum)
+    end
+
+    def words_included_in_password?(words)
+      downcased_pw = @password.downcase
+      words.each do |word|
+        return true if word.length > 2 && downcased_pw.index(word.downcase)
+      end; false
+    end
+
+    def password_too_common?
+      NOBSPW_RAILS7.configuration.use_ruby_grep ? ruby_grep : shell_grep
+    end
+
+    # Helper methods
+
+    def shell_grep
+      raise StandardError.new("Grep not found at: #{NOBSPW_RAILS7.configuration.grep_path}") \
+        if !File.exist?(NOBSPW_RAILS7.configuration.grep_path)
+
+      output = Open3.popen3(STDIN_GREP_COMMAND.join(" "), out: '/dev/null') { |stdin, stdout, stderr, wait_thr|
+        stdin.puts "^#{escaped_password}$"
+        stdin.close
+        wait_thr.value
+      }
+      output.success?
+    end
+
+    def ruby_grep
+      File.open(NOBSPW_RAILS7.configuration.dictionary_path).grep(/^#{escaped_password}$/).any?
+    end
+
+    def email_without_extension(email)
+      name, domain, whatev = email&.split("@", 3)
+      "#{name}@#{strip_extension_from_domain(domain)}"
+    end
+
+    def strip_extension_from_domain(domain)
+      domain&.split(".")&.first
+    end
+
+    def remove_word_separators(str)
+      str&.gsub(/-|_|\.|\'|\"|\@/, ' ')
+    end
+
+    def escaped_password(password = @password)
+      Shellwords.escape(password)
+    end
+  end
+end

data/lib/nobspw_rails7/version.rb

@@ -0,0 +1,3 @@
+module NOBSPW_RAILS7
+  VERSION = '0.6.5'
+end

data/lib/nobspw_rails7.rb

@@ -0,0 +1,24 @@
+require "nobspw_rails7/version"
+
+module NOBSPW_RAILS7
+  autoload :PasswordChecker, 'nobspw_rails7/password_checker'
+  autoload :ValidationMethods, 'nobspw_rails7/validation_methods'
+  autoload :Configuration, 'nobspw_rails7/configuration'
+
+  if (defined?(::ActiveModel) && ActiveModel::VERSION::MAJOR >= 4) && defined?(I18n)
+    require_relative 'active_model/validations/password_validator'
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/misc/grep_benchmark.rb

@@ -0,0 +1,73 @@
+#! /usr/bin/env ruby
+
+require 'benchmark'
+require 'shellwords'
+require 'open3'
+require 'subprocess'
+
+ITERATIONS         = 100
+DICTIONARY_PATH    = File.join(File.dirname(__FILE__), '..', 'lib/db/dictionary.txt')
+STDIN_GREP_COMMAND = ['/usr/bin/grep', '-m 1', '-f', '/dev/stdin', DICTIONARY_PATH]
+
+password = 'swordfish'
+
+def shell_grep(password)
+  password = Shellwords.escape(password)
+  `/usr/bin/grep -m 1 '^#{password}$' #{DICTIONARY_PATH}`
+  $?.exitstatus == 0
+end
+
+def shell_grep_open3(password)
+  password = Shellwords.escape(password)
+
+  output = Open3.popen3(STDIN_GREP_COMMAND.join(" "), out: '/dev/null') { |stdin, stdout, stderr, wait_thr|
+    stdin.puts "^#{password}$"
+    stdin.close
+    wait_thr.value
+  }
+  output.success?
+end
+
+def shell_grep_subprocess(password)
+  password = Shellwords.escape(password)
+
+  Subprocess.check_call(STDIN_GREP_COMMAND, stdin: Subprocess::PIPE, stdout: '/dev/null') do |p|
+    p.communicate("^#{password}$")
+  end
+  true
+rescue Subprocess::NonZeroExit
+  false
+end
+
+def ruby_grep(password)
+  File.open(DICTIONARY_PATH).grep(/^#{password}$/)
+end
+
+def ruby_loop(password)
+  File.open(DICTIONARY_PATH).read_line do |l|
+    return true if l.match?(/^#{password}$/)
+  end
+  false
+end
+
+Benchmark.bm(17) do |benchmark|
+  benchmark.report("Shell") do
+    ITERATIONS.times { shell_grep(password) }
+  end
+
+  benchmark.report("Ruby Grep") do
+    ITERATIONS.times { ruby_grep(password) }
+  end
+
+  benchmark.report("Ruby Loop") do
+    ITERATIONS.times { ruby_grep(password) }
+  end
+
+  benchmark.report("Open3 stdin") do
+    ITERATIONS.times { shell_grep_open3(password) }
+  end
+
+  benchmark.report("Subprocess stdin") do
+    ITERATIONS.times { shell_grep_subprocess(password) }
+  end
+end

data/nobspw_rails7.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nobspw_rails7/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nobspw_rails7"
+  spec.version       = NOBSPW_RAILS7::VERSION
+  spec.authors       = ["Carl Mercier", "Nao"]
+  spec.email         = ["foss@carlmercier.com", "nao@naomie.digital"]
+
+  spec.summary       = %q{No Bullshit Password strength checker}
+  spec.description   = %q{No Bullshit Password strength checker. Inspired by "Password Rules are Bullshit" by Jeff Atwood. https://blog.codinghorror.com/password-rules-are-bullshit/ (Fixed to work with Rails 7)}
+  spec.homepage      = "https://github.com/nomadnaomie/nobspw"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.13"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7.3"
+  spec.add_development_dependency "activemodel", "~> 5.0"
+  spec.add_development_dependency "i18n", "~> 0.8.1"
+  spec.add_development_dependency "subprocess"
+  spec.add_development_dependency "byebug"
+
+  if RUBY_PLATFORM =~ /darwin/
+    spec.add_development_dependency 'ruby_gntp', "~> 0.3.4"
+    spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6.1'
+  end
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: nobspw_rails7
+version: !ruby/object:Gem::Version
+  version: 0.6.5
+platform: ruby
+authors:
+- Carl Mercier
+- Nao
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: subprocess
+  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: byebug
+  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'
+description: No Bullshit Password strength checker. Inspired by "Password Rules are
+  Bullshit" by Jeff Atwood. https://blog.codinghorror.com/password-rules-are-bullshit/
+  (Fixed to work with Rails 7)
+email:
+- foss@carlmercier.com
+- nao@naomie.digital
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/active_model/validations/password_validator.rb
+- lib/db/dictionary.txt
+- lib/nobspw_rails7.rb
+- lib/nobspw_rails7/configuration.rb
+- lib/nobspw_rails7/password_checker.rb
+- lib/nobspw_rails7/validation_methods.rb
+- lib/nobspw_rails7/version.rb
+- misc/grep_benchmark.rb
+- nobspw_rails7.gemspec
+homepage: https://github.com/nomadnaomie/nobspw
+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.3.7
+signing_key:
+specification_version: 4
+summary: No Bullshit Password strength checker
+test_files: []