nobspw 0.1.0

data/lib/nobspw.rb

@@ -0,0 +1,15 @@
+require "nobspw/version"
+
+module NOBSPW
+  autoload :PasswordChecker, 'nobspw/password_checker'
+  autoload :Configuration, 'nobspw/configuration'
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/nobspw/configuration.rb

@@ -0,0 +1,21 @@
+module NOBSPW
+  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 :domain_name
+    attr_accessor :blacklist
+
+    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
+      @domain_name              = nil
+      @blacklist                = nil
+    end
+  end
+end

data/lib/nobspw/password_checker.rb

@@ -0,0 +1,114 @@
+module NOBSPW
+  class PasswordChecker
+    CHECKS = %i(name_included_in_password
+                email_included_in_password
+                domain_included_in_password
+                password_too_short
+                password_too_long
+                not_enough_unique_characters
+                password_blacklisted
+                password_too_common)
+
+    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_password_reasons
+      check_password if @weak_password_reasons.nil?
+      @weak_password_reasons
+    end
+
+    private
+
+    def check_password
+      @weak_password_reasons = []
+
+      CHECKS.each do |check|
+        @weak_password_reasons << check if send("#{check}?")
+      end
+
+      @strong = @weak_password_reasons.empty?
+    end
+
+    def name_included_in_password?
+      return nil unless @name
+      words = remove_word_separators(@name).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.configuration.domain_name
+      return nil unless domain
+
+      words_included_in_password?(domain) ||
+      remove_word_separators(words_included_in_password?(domain)).gsub(' ', '')
+    end
+
+    def password_blacklisted?
+      return nil unless NOBSPW.configuration.blacklist
+      NOBSPW.configuration.blacklist.include?(@password)
+    end
+
+    def password_too_short?
+      @password.length < NOBSPW.configuration.min_password_length
+    end
+
+    def password_too_long?
+      @password.length > NOBSPW.configuration.max_password_length
+    end
+
+    def not_enough_unique_characters?
+      unique  = @password.split(//).uniq.size
+      minimum = NOBSPW.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?
+      `#{grep_command(NOBSPW.configuration.dictionary_path)}`
+
+      case $?.exitstatus
+      when 0
+        true
+      when 1
+        false
+      when 127
+        raise StandardError.new("Grep not found at: #{NOBSPW.configuration.grep_path}")
+      else
+        false
+      end
+    end
+
+    def grep_command(path)
+      "#{NOBSPW.configuration.grep_path} '^#{@password}$' #{path}"
+    end
+
+    def email_without_extension(email)
+      name, domain, whatev = email.split("@", 3)
+      "#{name}@#{domain}"
+    end
+
+    def remove_word_separators(str)
+      str.gsub(/-|_|\.|\'|\"|\@/, ' ')
+    end
+  end
+
+end

data/lib/nobspw/version.rb

@@ -0,0 +1,3 @@
+module NOBSPW
+  VERSION = "0.1.0"
+end

data/nobspw.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nobspw/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nobspw"
+  spec.version       = NOBSPW::VERSION
+  spec.authors       = ["Carl Mercier"]
+  spec.email         = ["foss@carlmercier.com"]
+
+  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/}
+  spec.homepage      = "https://github.com/cmer/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", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  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"
+
+  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,173 @@
+--- !ruby/object:Gem::Specification
+name: nobspw
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Mercier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 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: ruby_gntp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+description: No Bullshit Password strength checker. Inspired by "Password Rules are
+  Bullshit" by Jeff Atwood. https://blog.codinghorror.com/password-rules-are-bullshit/
+email:
+- foss@carlmercier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/db/dictionary.txt
+- lib/nobspw.rb
+- lib/nobspw/configuration.rb
+- lib/nobspw/password_checker.rb
+- lib/nobspw/version.rb
+- nobspw.gemspec
+homepage: https://github.com/cmer/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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: No Bullshit Password strength checker
+test_files: []