zxcvbn 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f102d8ba269aad3742c05649bbb698c01d639ee794c8adc9abe66fb285674f42
-  data.tar.gz: 2f01f158959ed48ad413bb91970c7824efeb42392aca97b91e4d1be50a149e47
+  metadata.gz: 8ed77be628881ddd6bd6df0f7a60935e193db7cf91f5c928319eed9ac24295bf
+  data.tar.gz: 20906d11011e8ab3f95dcc9f20cae21b6945999a979b11c452b23f02726abda6
 SHA512:
-  metadata.gz: c05246356ff182b57ca9acd01b6ee95269c4264a5d9cb1d947229de9ee9974e30a3860e4d860cec946c1ef22d9d9baa90dcf2f89bf843d8f5c749b3a0d64867c
-  data.tar.gz: 1dc9944425d5a9105ebe59eb0b1dab1a06bb98ff94e032b476714ebc23281560ea78a0ffebb4a086f7da42a6fdcd1502f296a1f45f84d94b99d63461d00c25eb
+  metadata.gz: a6ac81d9c47f5f4a006b7e5e071f0f2fd119d0f9f721d28d7725ab07f8eafa4478f727652b7e51a87d82d5022e761550cecc6f83ff2f38b8cd0171d51061f97b
+  data.tar.gz: ec59a970bc9037714b93c3d73738b995afa224c25cdca4dd8309e74f7e11df58fe7f618f72805ea004f23ac3387a8f98fa2548d9d2c00419231f7e0e07307db7

data/.rubocop.yml

@@ -1,5 +1,31 @@
 AllCops:
   TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/LineLength:
+  Max: 120
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
 
 Style/StringLiterals:
   Enabled: true
@@ -9,5 +35,11 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
-Layout/LineLength:
-  Max: 120
+Style/NegatedIf:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false

data/.travis.yml

@@ -2,5 +2,5 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.6
+  - 2.5.9
 before_install: gem install bundler -v 2.2.15

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-## [Unreleased]
+## [0.1.6] - 2021-05-28
+- Added test methods for compatibility with zxcvbn-js and zxcvbn-ruby.
+
+## [0.1.5] - 2021-05-27
+- Fix classification of scoring causing differences between js and ruby.
+
+## [0.1.4] - 2021-05-16
+
+- Bunch of fixes, all example passwords included have same result as js version.
+- consistent code style applied.
+
 
 ## [0.1.0] - 2021-05-16
 

data/Gemfile

@@ -5,8 +5,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in zxcvbn.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+group :development do
+  gem "mini_racer"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.7"
 
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.7"
+  gem "pry"
+  gem "pry-byebug"
+  gem "simplecov", require: false
+end

data/Gemfile.lock

@@ -1,16 +1,30 @@
 PATH
   remote: .
   specs:
-    zxcvbn (0.1.0)
+    zxcvbn (0.1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
     diff-lcs (1.4.4)
+    docile (1.4.0)
+    libv8-node (15.14.0.1-x86_64-darwin-19)
+    libv8-node (15.14.0.1-x86_64-linux)
+    method_source (1.0.0)
+    mini_racer (0.4.0)
+      libv8-node (~> 15.14.0.0)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
@@ -40,15 +54,26 @@ GEM
     rubocop-ast (1.5.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     unicode-display_width (2.0.0)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
+  mini_racer
+  pry
+  pry-byebug
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)
+  simplecov
   zxcvbn!
 
 BUNDLED WITH

data/README.md

@@ -1,7 +1,11 @@
 # Zxcvbn
 
-This is a direct Ruby port of Dropbox's [zxcvbn.js][zxcvbn.js] JavaScript library.
-The intention is to provide all the same features and same results as close to the original JS fucntion would do.
+[![Gem Version](https://badge.fury.io/rb/zxcvbn.svg)](https://badge.fury.io/rb/zxcvbn)
+[![Build Status](https://travis-ci.com/formigarafa/zxcvbn-rb.svg?branch=master)](https://travis-ci.com/formigarafa/zxcvbn-rb)
+
+Ruby port of Dropbox's [zxcvbn.js][zxcvbn.js] JavaScript library running completely in Ruby (no need to load execjs or libv8).
+
+The intention is to provide an option 100% Ruby solution with all the same features and same results (or as close to the original JS function as possible).
 
 ## Installation
 
@@ -24,49 +28,53 @@ Or install it yourself as:
 ```
 Zxcvbn.zxcvbn("password")
 => {
-  :password => "pasword",
-  :guesses => 3566,
-  :guesses_log10 => 3.5521813388393357,
-  :sequence => [
+  "password" => "password",
+  "guesses" => 3,
+  "guesses_log10" => 0.47712125471966244,
+  "sequence" => [
     {
-      :pattern => "dictionary",
-      :i => 0,
-      :j => 6,
-      :token => "pasword",
-      :matched_word => "pasword",
-      :rank => 3565,
-      :dictionary_name => "passwords",
-      :reversed => false,
-      :l33t => false,
-      :base_guesses => 3565,
-      :uppercase_variations => 1,
-      :l33t_variations => 1,
-      :guesses => 3565,
-      :guesses_log10 => 3.5520595341878844
+      "pattern" => "dictionary",
+      "i" => 0,
+      "j" => 7,
+      "token" => "password",
+      "matched_word" => "password",
+      "rank" => 2,
+      "dictionary_name" => "passwords",
+      "reversed" => false,
+      "l33t" => false,
+      "base_guesses" => 2,
+      "uppercase_variations" => 1,
+      "l33t_variations" => 1,
+      "guesses" => 2,
+      "guesses_log10" => 0.3010299956639812
     }
   ],
-  :calc_time => 0,
-  :crack_times_seconds => {
-    :online_throttling_100_per_hour => 128376.0,
-    :online_no_throttling_10_per_second => 356.6,
-    :offline_slow_hashing_1e4_per_second => 0.3566,
-    :offline_fast_hashing_1e10_per_second => 3.566e-07
-  },
-  :crack_times_display => {
-    :online_throttling_100_per_hour => "1 day",
-    :online_no_throttling_10_per_second => "6 minutes",
-    :offline_slow_hashing_1e4_per_second => "less than a second",
-    :offline_fast_hashing_1e10_per_second => "less than a second"
+  "calc_time" => 1,
+  "crack_times_seconds" => {
+    "online_throttling_100_per_hour" => 108.0,
+    "online_no_throttling_10_per_second" => 0.3,
+    "offline_slow_hashing_1e4_per_second" => 0.0003,
+    "offline_fast_hashing_1e10_per_second" => 3.0e-10},
+  "crack_times_display" => {
+    "online_throttling_100_per_hour" => "2 minutes",
+    "online_no_throttling_10_per_second" => "less than a second",
+    "offline_slow_hashing_1e4_per_second" => "less than a second",
+    "offline_fast_hashing_1e10_per_second" => "less than a second"
   },
-  :score => 1,
-  :feedback =>
-  {
-    :warning => "This is a very common password",
-    :suggestions => ["Add another word or two. Uncommon words are better."]
+  "score" => 0,
+  "feedback" => {
+    "warning" => "This is a top-10 common password",
+    "suggestions" => [
+      "Add another word or two. Uncommon words are better."
+    ]
   }
 }
 ```
 
+### Compatible with `zxcvbn-js` and `zxcvbn-ruby`
+
+This gem include a compatible interface so it can be used as a drop-in substitution for `zxcvbn-js` or `zxcvbn-ruby`. You can just call `Zxcvbn.test` or use `Zxcvbn::Tester.new` the same way as you would if you were using `zxcvbn-js` or `zxcvbn-ruby`.
+
 ## 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.

data/bin/console

@@ -11,5 +11,8 @@ require "zxcvbn"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+# require "irb"
+# IRB.start(__FILE__)
+
+require "pry"
+Pry.start("main")

data/lib/zxcvbn.rb

@@ -14,21 +14,29 @@ module Zxcvbn
   def self.zxcvbn(password, user_inputs = [])
     start = (Time.now.to_f * 1000).to_i
     # reset the user inputs matcher on a per-request basis to keep things stateless
-    sanitized_inputs = [];
+    sanitized_inputs = []
     user_inputs.each do |arg|
-      if arg.is_a?(String) || arg.is_a?(Numeric) || arg == true || arg == false
-        sanitized_inputs << arg.to_s.downcase
-      end
+      sanitized_inputs << arg.to_s.downcase if arg.is_a?(String) || arg.is_a?(Numeric) || arg == true || arg == false
     end
-    Matching.set_user_input_dictionary(sanitized_inputs)
+    Matching.user_input_dictionary = sanitized_inputs
     matches = Matching.omnimatch(password)
     result = Scoring.most_guessable_match_sequence(password, matches)
-    result[:calc_time] = (Time.now.to_f * 1000).to_i - start
-    attack_times = TimeEstimates.estimate_attack_times(result[:guesses])
+    result["calc_time"] = (Time.now.to_f * 1000).to_i - start
+    attack_times = TimeEstimates.estimate_attack_times(result["guesses"])
     attack_times.each do |prop, val|
       result[prop] = val
     end
-    result[:feedback] = Feedback.get_feedback(result[:score], result[:sequence])
-    return result
+    result["feedback"] = Feedback.get_feedback(result["score"], result["sequence"])
+    result
+  end
+
+  def self.test(password, user_inputs = [])
+    OpenStruct.new(Zxcvbn.zxcvbn(password, user_inputs))
+  end
+
+  class Tester
+    def test(password, user_inputs = [])
+      Zxcvbn.test(password, user_inputs)
+    end
   end
 end

data/lib/zxcvbn/adjacency_graphs.rb

@@ -2,10 +2,12 @@
 
 # generated by scripts/build_keyboard_adjacency_graphs.py
 module Zxcvbn
+  # rubocop:disable Layout/SpaceInsideArrayLiteralBrackets
+  # rubocop:disable Layout/ExtraSpacing
   ADJACENCY_GRAPHS = {
-    qwerty: {
+    "qwerty" => {
       "!" => ["`~",  nil,  nil, "2@", "qQ",  nil],
-      "\"" => [";:", "[{", "]}",  nil,  nil, "/?"],
+      "\"" => [";:", "[{", "]}", nil,  nil, "/?"],
       "#" => ["2@",  nil,  nil, "4$", "eE", "wW"],
       "$" => ["3#",  nil,  nil, "5%", "rR", "eE"],
       "%" => ["4$",  nil,  nil, "6^", "tT", "rR"],
@@ -18,7 +20,7 @@ module Zxcvbn
       "," => ["mM", "kK", "lL", ".>",  nil,  nil],
       "-" => ["0)",  nil,  nil, "=+", "[{", "pP"],
       "." => [",<", "lL", ";:", "/?",  nil,  nil],
-      "/" => [".>", ";:", "'\"",  nil,  nil,  nil],
+      "/" => [".>", ";:", "'\"", nil,  nil,  nil],
       "0" => ["9(",  nil,  nil, "-_", "pP", "oO"],
       "1" => ["`~",  nil,  nil, "2@", "qQ",  nil],
       "2" => ["1!",  nil,  nil, "3#", "wW", "qQ"],
@@ -34,7 +36,7 @@ module Zxcvbn
       "<" => ["mM", "kK", "lL", ".>",  nil,  nil],
       "=" => ["-_",  nil,  nil,  nil, "]}", "[{"],
       ">" => [",<", "lL", ";:", "/?",  nil,  nil],
-      "?" => [".>", ";:", "'\"",  nil,  nil,  nil],
+      "?" => [".>", ";:", "'\"", nil,  nil,  nil],
       "@" => ["1!",  nil,  nil, "3#", "wW", "qQ"],
       "A" => [ nil, "qQ", "wW", "sS", "zZ",  nil],
       "B" => ["vV", "gG", "hH", "nN",  nil,  nil],
@@ -63,8 +65,8 @@ module Zxcvbn
       "Y" => ["tT", "6^", "7&", "uU", "hH", "gG"],
       "Z" => [ nil, "aA", "sS", "xX",  nil,  nil],
       "[" => ["pP", "-_", "=+", "]}", "'\"", ";:"],
-      "\\" => ["]}",  nil,  nil,  nil,  nil,  nil],
-      "]" => ["[{", "=+",  nil, "\\|",  nil, "'\""],
+      "\\" => ["]}", nil,  nil,  nil,  nil,  nil],
+      "]" => ["[{", "=+",  nil, "\\|", nil, "'\""],
       "^" => ["5%",  nil,  nil, "7&", "yY", "tT"],
       "_" => ["0)",  nil,  nil, "=+", "[{", "pP"],
       "`" => [ nil,  nil,  nil, "1!",  nil,  nil],
@@ -96,12 +98,12 @@ module Zxcvbn
       "z" => [ nil, "aA", "sS", "xX",  nil,  nil],
       "{" => ["pP", "-_", "=+", "]}", "'\"", ";:"],
       "|" => ["]}",  nil,  nil,  nil,  nil,  nil],
-      "}" => ["[{", "=+",  nil, "\\|",  nil, "'\""],
+      "}" => ["[{", "=+",  nil, "\\|", nil, "'\""],
       "~" => [ nil,  nil,  nil, "1!",  nil,  nil]
     },
-    dvorak: {
-      "!" => ["`~",  nil,  nil, "2@", "'\"",  nil],
-      "\"" => [ nil, "1!", "2@", ",<", "aA",  nil],
+    "dvorak" => {
+      "!" => ["`~",  nil,  nil, "2@", "'\"", nil],
+      "\"" => [ nil, "1!", "2@", ",<", "aA", nil],
       "#" => ["2@",  nil,  nil, "4$", ".>", ",<"],
       "$" => ["3#",  nil,  nil, "5%", "pP", ".>"],
       "%" => ["4$",  nil,  nil, "6^", "yY", "pP"],
@@ -110,13 +112,13 @@ module Zxcvbn
       "(" => ["8*",  nil,  nil, "0)", "rR", "cC"],
       ")" => ["9(",  nil,  nil, "[{", "lL", "rR"],
       "*" => ["7&",  nil,  nil, "9(", "cC", "gG"],
-      "+" => ["/?", "]}",  nil, "\\|",  nil, "-_"],
+      "+" => ["/?", "]}",  nil, "\\|", nil, "-_"],
       "," => ["'\"", "2@", "3#", ".>", "oO", "aA"],
       "-" => ["sS", "/?", "=+",  nil,  nil, "zZ"],
       "." => [",<", "3#", "4$", "pP", "eE", "oO"],
       "/" => ["lL", "[{", "]}", "=+", "-_", "sS"],
       "0" => ["9(",  nil,  nil, "[{", "lL", "rR"],
-      "1" => ["`~",  nil,  nil, "2@", "'\"",  nil],
+      "1" => ["`~",  nil,  nil, "2@", "'\"", nil],
       "2" => ["1!",  nil,  nil, "3#", ",<", "'\""],
       "3" => ["2@",  nil,  nil, "4$", ".>", ",<"],
       "4" => ["3#",  nil,  nil, "5%", "pP", ".>"],
@@ -132,7 +134,7 @@ module Zxcvbn
       ">" => [",<", "3#", "4$", "pP", "eE", "oO"],
       "?" => ["lL", "[{", "]}", "=+", "-_", "sS"],
       "@" => ["1!",  nil,  nil, "3#", ",<", "'\""],
-      "A" => [ nil, "'\"", ",<", "oO", ";:",  nil],
+      "A" => [ nil, "'\"", ",<", "oO", ";:", nil],
       "B" => ["xX", "dD", "hH", "mM",  nil,  nil],
       "C" => ["gG", "8*", "9(", "rR", "tT", "hH"],
       "D" => ["iI", "fF", "gG", "hH", "bB", "xX"],
@@ -159,12 +161,12 @@ module Zxcvbn
       "Y" => ["pP", "5%", "6^", "fF", "iI", "uU"],
       "Z" => ["vV", "sS", "-_",  nil,  nil,  nil],
       "[" => ["0)",  nil,  nil, "]}", "/?", "lL"],
-      "\\" => ["=+",  nil,  nil,  nil,  nil,  nil],
+      "\\" => ["=+", nil,  nil,  nil,  nil,  nil],
       "]" => ["[{",  nil,  nil,  nil, "=+", "/?"],
       "^" => ["5%",  nil,  nil, "7&", "fF", "yY"],
       "_" => ["sS", "/?", "=+",  nil,  nil, "zZ"],
       "`" => [ nil,  nil,  nil, "1!",  nil,  nil],
-      "a" => [ nil, "'\"", ",<", "oO", ";:",  nil],
+      "a" => [ nil, "'\"", ",<", "oO", ";:", nil],
       "b" => ["xX", "dD", "hH", "mM",  nil,  nil],
       "c" => ["gG", "8*", "9(", "rR", "tT", "hH"],
       "d" => ["iI", "fF", "gG", "hH", "bB", "xX"],
@@ -195,40 +197,42 @@ module Zxcvbn
       "}" => ["[{",  nil,  nil,  nil, "=+", "/?"],
       "~" => [ nil,  nil,  nil, "1!",  nil,  nil]
     },
-    keypad: {
-      "*" => ["/",  nil,  nil,  nil, "-", "+", "9", "8"],
-      "+" => ["9", "*", "-",  nil,  nil,  nil,  nil, "6"],
-      "-" => ["*",  nil,  nil,  nil,  nil,  nil, "+", "9"],
-      "." => ["0", "2", "3",  nil,  nil,  nil,  nil,  nil],
-      "/" => [ nil,  nil,  nil,  nil, "*", "9", "8", "7"],
-      "0" => [ nil, "1", "2", "3", ".",  nil,  nil,  nil],
-      "1" => [ nil,  nil, "4", "5", "2", "0",  nil,  nil],
-      "2" => ["1", "4", "5", "6", "3", ".", "0",  nil],
-      "3" => ["2", "5", "6",  nil,  nil,  nil, ".", "0"],
-      "4" => [ nil,  nil, "7", "8", "5", "2", "1",  nil],
+    "keypad" => {
+      "*" => ["/", nil, nil, nil, "-", "+", "9", "8"],
+      "+" => ["9", "*", "-", nil, nil, nil, nil, "6"],
+      "-" => ["*", nil, nil, nil, nil, nil, "+", "9"],
+      "." => ["0", "2", "3", nil, nil, nil, nil, nil],
+      "/" => [nil, nil, nil, nil, "*", "9", "8", "7"],
+      "0" => [nil, "1", "2", "3", ".", nil, nil, nil],
+      "1" => [nil, nil, "4", "5", "2", "0", nil, nil],
+      "2" => ["1", "4", "5", "6", "3", ".", "0", nil],
+      "3" => ["2", "5", "6", nil, nil, nil, ".", "0"],
+      "4" => [nil, nil, "7", "8", "5", "2", "1", nil],
       "5" => ["4", "7", "8", "9", "6", "3", "2", "1"],
-      "6" => ["5", "8", "9", "+",  nil,  nil, "3", "2"],
-      "7" => [ nil,  nil,  nil, "/", "8", "5", "4",  nil],
-      "8" => ["7",  nil, "/", "*", "9", "6", "5", "4"],
-      "9" => ["8", "/", "*", "-", "+",  nil, "6", "5"]
+      "6" => ["5", "8", "9", "+", nil, nil, "3", "2"],
+      "7" => [nil, nil, nil, "/", "8", "5", "4", nil],
+      "8" => ["7", nil, "/", "*", "9", "6", "5", "4"],
+      "9" => ["8", "/", "*", "-", "+", nil, "6", "5"]
     },
-    mac_keypad: {
-      "*" => ["/",  nil,  nil,  nil,  nil,  nil, "-", "9"],
-      "+" => ["6", "9", "-",  nil,  nil,  nil,  nil, "3"],
-      "-" => ["9", "/", "*",  nil,  nil,  nil, "+", "6"],
-      "." => ["0", "2", "3",  nil,  nil,  nil,  nil,  nil],
-      "/" => ["=",  nil,  nil,  nil, "*", "-", "9", "8"],
-      "0" => [ nil, "1", "2", "3", ".",  nil,  nil,  nil],
-      "1" => [ nil,  nil, "4", "5", "2", "0",  nil,  nil],
-      "2" => ["1", "4", "5", "6", "3", ".", "0",  nil],
-      "3" => ["2", "5", "6", "+",  nil,  nil, ".", "0"],
-      "4" => [ nil,  nil, "7", "8", "5", "2", "1",  nil],
+    "mac_keypad" => {
+      "*" => ["/", nil, nil, nil, nil, nil, "-", "9"],
+      "+" => ["6", "9", "-", nil, nil, nil, nil, "3"],
+      "-" => ["9", "/", "*", nil, nil, nil, "+", "6"],
+      "." => ["0", "2", "3", nil, nil, nil, nil, nil],
+      "/" => ["=", nil, nil, nil, "*", "-", "9", "8"],
+      "0" => [nil, "1", "2", "3", ".", nil, nil, nil],
+      "1" => [nil, nil, "4", "5", "2", "0", nil, nil],
+      "2" => ["1", "4", "5", "6", "3", ".", "0", nil],
+      "3" => ["2", "5", "6", "+", nil, nil, ".", "0"],
+      "4" => [nil, nil, "7", "8", "5", "2", "1", nil],
       "5" => ["4", "7", "8", "9", "6", "3", "2", "1"],
-      "6" => ["5", "8", "9", "-", "+",  nil, "3", "2"],
-      "7" => [ nil,  nil,  nil, "=", "8", "5", "4",  nil],
-      "8" => ["7",  nil, "=", "/", "9", "6", "5", "4"],
+      "6" => ["5", "8", "9", "-", "+", nil, "3", "2"],
+      "7" => [nil, nil, nil, "=", "8", "5", "4", nil],
+      "8" => ["7", nil, "=", "/", "9", "6", "5", "4"],
       "9" => ["8", "=", "/", "*", "-", "+", "6", "5"],
-      "=" => [ nil,  nil,  nil,  nil, "/", "9", "8", "7"]
+      "=" => [nil, nil, nil, nil, "/", "9", "8", "7"]
     }
-  }
+  }.freeze
+  # rubocop:enable Layout/ExtraSpacing
+  # rubocop:enable Layout/SpaceInsideArrayLiteralBrackets
 end