zxcvbn-ruby 0.0.3 → 0.1.0

data/README.md

@@ -7,7 +7,7 @@ Ruby port of [zxcvbn.js](https://github.com/dropbox/zxcvbn)
 Gemfile:
 
 ```ruby
-gem "zxcvbn-ruby", :require => 'zxcvbn'
+gem 'zxcvbn-ruby', require: 'zxcvbn'
 ```
 
 Example usage:
@@ -20,4 +20,20 @@ $ irb
 => #<Zxcvbn::Score:0x007fd467803098 @entropy=7.895, @crack_time=0.012, @crack_time_display="instant", @score=0, @match_sequence=[#<Zxcvbn::Match matched_word="alfred", token="@lfred", i=0, j=5, rank=1, pattern="dictionary", dictionary_name="user_inputs", l33t=true, sub={"@"=>"a"}, sub_display"@ -> a", base_entropy0.0, uppercase_entropy0.0, l33t_entropy1, entropy1.0, #<Zxcvbn::Match i=6, j=9, token="2004", pattern="year", entropy=6.894817763307944], @password="@lfred2004", @calc_time=0.003436>
 >> Zxcvbn.test('asdfghju7654rewq', ['alfred'])
 => #<Zxcvbn::Score:0x007fd4689c1168 @entropy=29.782, @crack_time=46159.451, @crack_time_display="14 hours", @score=2, @match_sequence=[#<Zxcvbn::Match pattern="spatial", i=0, j=15, token="asdfghju7654rewq", graph="qwerty", turns=5, shifted_count=0, entropy=29.7820508329166>], password"asdfghju7654rewq", calc_time0.00526
+```
+
+## Testing Multiple Passwords
+
+The dictionaries used for password strength testing are loaded each request to `Zxcvbn.test`. If you you'd prefer to persist the dictionaries in memory (approx 20MB RSS) to perform lots of password tests in succession then you can use the `Zxcvbn::Tester` API:
+
+```ruby
+$ irb
+>> require 'zxcvbn'
+=> true
+>> tester = Zxcvbn::Tester.new
+=> #<Zxcvbn::Tester:0x3fe99d869aa4>
+>> tester.test('@lfred2004', ['alfred'])
+=> #<Zxcvbn::Score:0x007fd4689c1168 @entropy=29.782, @crack_time=46159.451, @crack_time_display="14 hours", @score=2, @match_sequence=[#<Zxcvbn::Match pattern="spatial", i=0, j=15, token="asdfghju7654rewq", graph="qwerty", turns=5, shifted_count=0, entropy=29.7820508329166>], password"asdfghju7654rewq", calc_time0.00526
+>> tester.test('@lfred2004', ['alfred'])
+=> #<Zxcvbn::Score:0x007fd4689c1168 @entropy=29.782, @crack_time=46159.451, @crack_time_display="14 hours", @score=2, @match_sequence=[#<Zxcvbn::Match pattern="spatial", i=0, j=15, token="asdfghju7654rewq", graph="qwerty", turns=5, shifted_count=0, entropy=29.7820508329166>], password"asdfghju7654rewq", calc_time0.00526
 ```

data/lib/zxcvbn.rb

@@ -1,46 +1,20 @@
-require 'json'
 require 'pathname'
-
 require 'zxcvbn/version'
-require 'zxcvbn/match'
-require 'zxcvbn/matchers/regex_helpers'
-require 'zxcvbn/matchers/dictionary'
-require 'zxcvbn/matchers/l33t'
-require 'zxcvbn/matchers/spatial'
-require 'zxcvbn/matchers/sequences'
-require 'zxcvbn/matchers/repeat'
-require 'zxcvbn/matchers/digits'
-require 'zxcvbn/matchers/year'
-require 'zxcvbn/matchers/date'
-require 'zxcvbn/dictionary_ranker'
-require 'zxcvbn/omnimatch'
-require 'zxcvbn/math'
-require 'zxcvbn/entropy'
-require 'zxcvbn/crack_time'
-require 'zxcvbn/score'
-require 'zxcvbn/scorer'
-require 'zxcvbn/password_strength'
+require 'zxcvbn/tester'
 
 module Zxcvbn
   extend self
 
   DATA_PATH = Pathname(File.expand_path('../../data', __FILE__))
-  ADJACENCY_GRAPHS = JSON.load(DATA_PATH.join('adjacency_graphs.json').read)
-  FREQUENCY_LISTS_PATH = DATA_PATH.join("frequency_lists")
-  RANKED_DICTIONARIES = DictionaryRanker.rank_dictionaries(
-    "english" =>      FREQUENCY_LISTS_PATH.join("english.txt").read.split,
-    "female_names" => FREQUENCY_LISTS_PATH.join("female_names.txt").read.split,
-    "male_names" =>   FREQUENCY_LISTS_PATH.join("male_names.txt").read.split,
-    "passwords" =>    FREQUENCY_LISTS_PATH.join("passwords.txt").read.split,
-    "surnames" =>     FREQUENCY_LISTS_PATH.join("surnames.txt").read.split
-  )
-
-  def test(password, user_inputs = [])
-    zxcvbn = PasswordStrength.new
-    zxcvbn.test(password, user_inputs)
-  end
 
-  def add_word_list(name, list)
-    RANKED_DICTIONARIES[name] = DictionaryRanker.rank_dictionary(list)
+  # Returns a Zxcvbn::Score for the given password
+  #
+  # Example:
+  #
+  #   Zxcvbn.test("password").score #=> 0
+  def test(password, user_inputs = [], word_lists = {})
+    tester = Tester.new
+    tester.add_word_lists(word_lists)
+    tester.test(password, user_inputs)
   end
 end

data/lib/zxcvbn/crack_time.rb

@@ -1,51 +1,53 @@
-module Zxcvbn::CrackTime
-  SINGLE_GUESS = 0.010
-  NUM_ATTACKERS = 100
+module Zxcvbn
+  module CrackTime
+    SINGLE_GUESS = 0.010
+    NUM_ATTACKERS = 100
 
-  SECONDS_PER_GUESS = SINGLE_GUESS / NUM_ATTACKERS
+    SECONDS_PER_GUESS = SINGLE_GUESS / NUM_ATTACKERS
 
-  def entropy_to_crack_time(entropy)
-    0.5 * (2 ** entropy) * SECONDS_PER_GUESS
-  end
+    def entropy_to_crack_time(entropy)
+      0.5 * (2 ** entropy) * SECONDS_PER_GUESS
+    end
 
-  def crack_time_to_score(seconds)
-    case
-    when seconds < 10**2
-      0
-    when seconds < 10**4
-      1
-    when seconds < 10**6
-      2
-    when seconds < 10**8
-      3
-    else
-      4
+    def crack_time_to_score(seconds)
+      case
+      when seconds < 10**2
+        0
+      when seconds < 10**4
+        1
+      when seconds < 10**6
+        2
+      when seconds < 10**8
+        3
+      else
+        4
+      end
     end
-  end
 
-  def display_time(seconds)
-    minute  = 60
-    hour    = minute * 60
-    day     = hour * 24
-    month   = day * 31
-    year    = month * 12
-    century = year * 100
+    def display_time(seconds)
+      minute  = 60
+      hour    = minute * 60
+      day     = hour * 24
+      month   = day * 31
+      year    = month * 12
+      century = year * 100
 
-    case
-    when seconds < minute
-      'instant'
-    when seconds < hour
-      "#{1 + (seconds / minute).ceil} minutes"
-    when seconds < day
-      "#{1 + (seconds / hour).ceil} hours"
-    when seconds < month
-      "#{1 + (seconds / day).ceil} days"
-    when seconds < year
-      "#{1 + (seconds / month).ceil} months"
-    when seconds < century
-      "#{1 + (seconds / year).ceil} years"
-    else
-      'centuries'
+      case
+      when seconds < minute
+        'instant'
+      when seconds < hour
+        "#{1 + (seconds / minute).ceil} minutes"
+      when seconds < day
+        "#{1 + (seconds / hour).ceil} hours"
+      when seconds < month
+        "#{1 + (seconds / day).ceil} days"
+      when seconds < year
+        "#{1 + (seconds / month).ceil} months"
+      when seconds < century
+        "#{1 + (seconds / year).ceil} years"
+      else
+        'centuries'
+      end
     end
   end
 end

data/lib/zxcvbn/data.rb

@@ -0,0 +1,29 @@
+require 'json'
+require 'zxcvbn/dictionary_ranker'
+
+module Zxcvbn
+  class Data
+    def initialize
+      @ranked_dictionaries = DictionaryRanker.rank_dictionaries(
+        "english" =>      read_word_list("english.txt"),
+        "female_names" => read_word_list("female_names.txt"),
+        "male_names" =>   read_word_list("male_names.txt"),
+        "passwords" =>    read_word_list("passwords.txt"),
+        "surnames" =>     read_word_list("surnames.txt")
+      )
+      @adjacency_graphs = JSON.load(DATA_PATH.join('adjacency_graphs.json').read)
+    end
+
+    attr_reader :ranked_dictionaries, :adjacency_graphs
+
+    def add_word_list(name, list)
+      @ranked_dictionaries[name] = DictionaryRanker.rank_dictionary(list)
+    end
+
+    private
+
+    def read_word_list(file)
+      DATA_PATH.join("frequency_lists", file).read.split
+    end
+  end
+end

data/lib/zxcvbn/dictionary_ranker.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Zxcvbn
   class DictionaryRanker
     def self.rank_dictionaries(lists)

data/lib/zxcvbn/entropy.rb

@@ -1,3 +1,5 @@
+require 'zxcvbn/math'
+
 module Zxcvbn::Entropy
   include Zxcvbn::Math
 

data/lib/zxcvbn/matchers/date.rb

@@ -1,3 +1,5 @@
+require 'zxcvbn/matchers/regex_helpers'
+
 module Zxcvbn
   module Matchers
     class Date

data/lib/zxcvbn/matchers/dictionary.rb

@@ -1,3 +1,5 @@
+require 'zxcvbn/match'
+
 module Zxcvbn
   module Matchers
     # Given a password and a dictionary, match on any sequential segment of

data/lib/zxcvbn/matchers/digits.rb

@@ -1,3 +1,5 @@
+require 'zxcvbn/matchers/regex_helpers'
+
 module Zxcvbn
   module Matchers
     class Digits

data/lib/zxcvbn/matchers/regex_helpers.rb

@@ -1,3 +1,5 @@
+require 'zxcvbn/match'
+
 module Zxcvbn
   module Matchers
     module RegexHelpers

data/lib/zxcvbn/matchers/repeat.rb

@@ -1,3 +1,5 @@
+require 'zxcvbn/match'
+
 module Zxcvbn
   module Matchers
     class Repeat

data/lib/zxcvbn/matchers/sequences.rb

@@ -1,3 +1,5 @@
+require 'zxcvbn/match'
+
 module Zxcvbn
   module Matchers
     class Sequences

data/lib/zxcvbn/matchers/spatial.rb

@@ -1,3 +1,5 @@
+require 'zxcvbn/match'
+
 module Zxcvbn
   module Matchers
     class Spatial

data/lib/zxcvbn/matchers/year.rb

@@ -1,3 +1,5 @@
+require 'zxcvbn/matchers/regex_helpers'
+
 module Zxcvbn
   module Matchers
     class Year

data/lib/zxcvbn/math.rb

@@ -41,14 +41,14 @@ module Zxcvbn
     end
 
     def average_degree_for_graph(graph_name)
-      graph = Zxcvbn::ADJACENCY_GRAPHS[graph_name]
+      graph = data.adjacency_graphs[graph_name]
       degrees = graph.map { |_, neighbors| neighbors.compact.size }
       sum = degrees.inject(0, :+)
       sum.to_f / graph.size
     end
 
     def starting_positions_for_graph(graph_name)
-      Zxcvbn::ADJACENCY_GRAPHS[graph_name].length
+      data.adjacency_graphs[graph_name].length
     end
   end
 end

data/lib/zxcvbn/omnimatch.rb

@@ -1,6 +1,17 @@
+require 'zxcvbn/dictionary_ranker'
+require 'zxcvbn/matchers/dictionary'
+require 'zxcvbn/matchers/l33t'
+require 'zxcvbn/matchers/spatial'
+require 'zxcvbn/matchers/digits'
+require 'zxcvbn/matchers/repeat'
+require 'zxcvbn/matchers/sequences'
+require 'zxcvbn/matchers/year'
+require 'zxcvbn/matchers/date'
+
 module Zxcvbn
   class Omnimatch
-    def initialize
+    def initialize(data)
+      @data = data
       @matchers = build_matchers
     end
 
@@ -24,14 +35,14 @@ module Zxcvbn
 
     def build_matchers
       matchers = []
-      dictionary_matchers = RANKED_DICTIONARIES.map do |name, dictionary|
+      dictionary_matchers = @data.ranked_dictionaries.map do |name, dictionary|
         Matchers::Dictionary.new(name, dictionary)
       end
       l33t_matcher = Matchers::L33t.new(dictionary_matchers)
       matchers += dictionary_matchers
       matchers += [
         l33t_matcher,
-        Matchers::Spatial.new(ADJACENCY_GRAPHS),
+        Matchers::Spatial.new(@data.adjacency_graphs),
         Matchers::Digits.new,
         Matchers::Repeat.new,
         Matchers::Sequences.new,

data/lib/zxcvbn/password_strength.rb

@@ -1,10 +1,12 @@
 require 'benchmark'
+require 'zxcvbn/omnimatch'
+require 'zxcvbn/scorer'
 
 module Zxcvbn
   class PasswordStrength
-    def initialize
-      @omnimatch = Omnimatch.new
-      @scorer = Scorer.new
+    def initialize(data)
+      @omnimatch = Omnimatch.new(data)
+      @scorer = Scorer.new(data)
     end
 
     def test(password, user_inputs = [])

data/lib/zxcvbn/scorer.rb

@@ -1,5 +1,16 @@
+require 'zxcvbn/entropy'
+require 'zxcvbn/crack_time'
+require 'zxcvbn/score'
+require 'zxcvbn/match'
+
 module Zxcvbn
   class Scorer
+    def initialize(data)
+      @data = data
+    end
+
+    attr_reader :data
+
     include Entropy
     include CrackTime
 

data/lib/zxcvbn/tester.rb

@@ -0,0 +1,35 @@
+require 'zxcvbn/data'
+require 'zxcvbn/password_strength'
+
+module Zxcvbn
+  # Allows you to test the strength of multiple passwords without reading and
+  # parsing the dictionary data from disk each test. Dictionary data is read
+  # once from disk and stored in memory for the life of the Tester object.
+  #
+  # Example:
+  #
+  #   tester = Zxcvbn::Tester.new
+  #
+  #   tester.add_word_lists("custom" => ["words"])
+  #
+  #   tester.test("password 1")
+  #   tester.test("password 2")
+  #   tester.test("password 3")
+  class Tester
+    def initialize
+      @data = Data.new
+    end
+
+    def test(password, user_inputs = [])
+      PasswordStrength.new(@data).test(password, user_inputs)
+    end
+
+    def add_word_lists(lists)
+      lists.each_pair {|name, words| @data.add_word_list(name, words)}
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{self.__id__.to_s(16)}>"
+    end
+  end
+end

data/lib/zxcvbn/version.rb

@@ -1,3 +1,3 @@
 module Zxcvbn
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/matchers/dictionary_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Zxcvbn::Matchers::Dictionary do
   let(:matcher) { described_class.new('english', dictionary) }
-  let(:dictionary) { Zxcvbn::RANKED_DICTIONARIES['english'] }
+  let(:dictionary) { Zxcvbn::Data.new.ranked_dictionaries['english'] }
 
   it 'finds all the matches' do
     matches = matcher.matches('whatisinit')

data/spec/matchers/l33t_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Zxcvbn::Matchers::L33t do
   let(:matcher) { described_class.new([dictionary_matcher]) }
-  let(:dictionary) { Zxcvbn::RANKED_DICTIONARIES['english'] }
+  let(:dictionary) { Zxcvbn::Data.new.ranked_dictionaries['english'] }
   let(:dictionary_matcher) { Zxcvbn::Matchers::Dictionary.new('english', dictionary) }
 
   describe '#relevant_l33t_substitutions' do

data/spec/matchers/spatial_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Zxcvbn::Matchers::Spatial do
   let(:matcher) { Zxcvbn::Matchers::Spatial.new(graphs) }
-  let(:graphs)  { Zxcvbn::ADJACENCY_GRAPHS }
+  let(:graphs)  { Zxcvbn::Data.new.adjacency_graphs }
 
   describe '#matches' do
     let(:matches) { matcher.matches('rtyikm') }

data/spec/omnimatch_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Zxcvbn::Omnimatch do
   before(:all) do
-    @omnimatch = described_class.new
+    @omnimatch = described_class.new(Zxcvbn::Data.new)
   end
 
   def omnimatch(password)

data/spec/scoring/entropy_spec.rb

@@ -6,6 +6,9 @@ describe Zxcvbn::Entropy do
   let(:entropy) {
     Class.new do
       include Zxcvbn::Entropy
+      def data
+        Zxcvbn::Data.new
+      end
     end.new
   }
 
@@ -163,7 +166,7 @@ describe Zxcvbn::Entropy do
     context 'when keyboard is qwerty' do
       it 'should return the correct entropy' do
         match.graph = 'qwerty'
-        
+
         entropy.spatial_entropy(match).should eql 11.562242424221074
       end
     end

data/spec/scoring/math_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 describe Zxcvbn::Math do
   include Zxcvbn::Math
 
+  def data
+    Zxcvbn::Data.new
+  end
+
   describe '#bruteforce_cardinality' do
     context 'when empty password' do
       it 'should return 0 if empty password' do

data/spec/tester_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Zxcvbn::Tester do
+  let(:tester) { Zxcvbn::Tester.new }
+
+  TEST_PASSWORDS.each do |password|
+    it "gives back the same score for #{password}" do
+      ruby_result = tester.test(password)
+      js_result = js_zxcvbn(password)
+
+      ruby_result.calc_time.should_not be_nil
+      ruby_result.password.should eq js_result['password']
+      ruby_result.entropy.should eq js_result['entropy']
+      ruby_result.crack_time.should eq js_result['crack_time']
+      ruby_result.crack_time_display.should eq js_result['crack_time_display']
+      ruby_result.score.should eq js_result['score']
+      ruby_result.pattern.should eq js_result['pattern']
+      ruby_result.match_sequence.count.should eq js_result['match_sequence'].count
+    end
+  end
+
+  context 'with a custom user dictionary' do
+    it 'scores them against the user dictionary' do
+      result = tester.test('themeforest', ['themeforest'])
+      result.entropy.should eq 0
+      result.score.should eq 0
+    end
+
+    it 'matches l33t substitutions on this dictionary' do
+      result = tester.test('th3m3for3st', ['themeforest'])
+      result.entropy.should eq 1
+      result.score.should eq 0
+    end
+  end
+
+  context 'with a custom global dictionary' do
+    before { tester.add_word_lists('envato' => ['envato']) }
+
+    it 'scores them against the dictionary' do
+      result = tester.test('envato')
+      result.entropy.should eq 0
+      result.score.should eq 0
+    end
+  end
+
+  context 'nil password' do
+    specify do
+      expect { tester.test(nil) }.to_not raise_error
+    end
+  end
+end

data/spec/zxcvbn_spec.rb

@@ -1,49 +1,24 @@
 require 'spec_helper'
 
-describe 'zxcvbn over a set of example passwords' do
-  TEST_PASSWORDS.each do |password|
-    it "gives back the same score for #{password}" do
-      ruby_result = Zxcvbn.test(password)
-      js_result = js_zxcvbn(password)
-
-      ruby_result.calc_time.should_not be_nil
-      ruby_result.password.should eq js_result['password']
-      ruby_result.entropy.should eq js_result['entropy']
-      ruby_result.crack_time.should eq js_result['crack_time']
-      ruby_result.crack_time_display.should eq js_result['crack_time_display']
-      ruby_result.score.should eq js_result['score']
-      ruby_result.pattern.should eq js_result['pattern']
-      ruby_result.match_sequence.count.should eq js_result['match_sequence'].count
+describe 'Zxcvbn.test' do
+  context 'with a password' do
+    it 'returns a result' do
+      result = Zxcvbn.test('password')
+      expect(result.entropy).to_not be_nil
     end
   end
 
-  context 'with a custom user dictionary' do
-    it 'scores them against the user dictionary' do
-      result = Zxcvbn.test('themeforest', ['themeforest'])
-      result.entropy.should eq 0
-      result.score.should eq 0
-    end
-
-    it 'matches l33t substitutions on this dictionary' do
-      result = Zxcvbn.test('th3m3for3st', ['themeforest'])
-      result.entropy.should eq 1
-      result.score.should eq 0
-    end
-  end
-
-  context 'with a custom global dictionary' do
-    before { Zxcvbn.add_word_list('envato', ['envato']) }
-
-    it 'scores them against the dictionary' do
-      result = Zxcvbn.test('envato')
-      result.entropy.should eq 0
-      result.score.should eq 0
+  context 'with a password and user input' do
+    it 'returns a result' do
+      result = Zxcvbn.test('password', ['inputs'])
+      expect(result.entropy).to_not be_nil
     end
   end
 
-  context 'nil password' do
-    specify do
-      expect { Zxcvbn.test(nil) }.to_not raise_error
+  context 'with a password, user input and custom word lists' do
+    it 'returns a result' do
+      result = Zxcvbn.test('password', ['inputs'], {'list' => ['words']})
+      expect(result.entropy).to_not be_nil
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zxcvbn-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: therubyracer
@@ -66,6 +66,7 @@ files:
 - data/frequency_lists/surnames.txt
 - lib/zxcvbn.rb
 - lib/zxcvbn/crack_time.rb
+- lib/zxcvbn/data.rb
 - lib/zxcvbn/dictionary_ranker.rb
 - lib/zxcvbn/entropy.rb
 - lib/zxcvbn/match.rb
@@ -84,6 +85,7 @@ files:
 - lib/zxcvbn/password_strength.rb
 - lib/zxcvbn/score.rb
 - lib/zxcvbn/scorer.rb
+- lib/zxcvbn/tester.rb
 - lib/zxcvbn/version.rb
 - spec/dictionary_ranker_spec.rb
 - spec/matchers/date_spec.rb
@@ -111,6 +113,7 @@ files:
 - spec/support/js_source/scoring.coffee
 - spec/support/js_source/scoring.js
 - spec/support/matcher.rb
+- spec/tester_spec.rb
 - spec/zxcvbn_spec.rb
 - zxcvbn-ruby.gemspec
 homepage: http://github.com/envato/zxcvbn-ruby
@@ -127,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1798543645320205772
+      hash: 3120558835973257605
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -136,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1798543645320205772
+      hash: 3120558835973257605
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2
@@ -170,4 +173,5 @@ test_files:
 - spec/support/js_source/scoring.coffee
 - spec/support/js_source/scoring.js
 - spec/support/matcher.rb
+- spec/tester_spec.rb
 - spec/zxcvbn_spec.rb