zxcvbn-ruby 0.0.3 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 871b2fb9d5b2db321db8625aae3ecff0f0ae13f3e9eb834ca79153c950951a89
+  data.tar.gz: 1eba0af7e3e6b6e982149d45a43356f91890b71328db17d03ee0bfa3cc45f37e
+SHA512:
+  metadata.gz: 6dd4ec7906a109a2094e6f2d44606748a778c6aa35111f967cbaa143313b8b7e149b21bb926dc9d31d96c14a53489a7ec879fbc5618c6f804117a262673b5d81
+  data.tar.gz: d2b3b14f62904c31db52da50066fe6a4cccdb3acb058407fd1fdef5bbdac0b9e045eca99835f2875c8cb31350158f868276976a3f54d15e85d4d02ce5f3052db

data/.travis.yml

@@ -0,0 +1,12 @@
+before_install:
+  - gem install bundler
+language: ruby
+rvm:
+  - '2.5'
+  - '2.6'
+  - '2.7'
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/envato/zxcvbn-ruby/compare/v1.1.0...HEAD
+
+## [1.1.0] - 2020-07-16
+### Added
+ - Support for Ruby 2.7 ([#29])
+ - Gem metadata ([#29])
+
+### Removed
+ - Support for Ruby 2.3 ([#29])
+ - Support for Ruby 2.4 ([#29])
+
+### Fixed
+ - Invalid user dictionaries are handled more robustly ([#28])
+
+[1.1.0]: https://github.com/envato/zxcvbn-ruby/compare/v1.0.0...v1.1.0
+[28]: https://github.com/envato/zxcvbn-ruby/pull/28
+[29]: https://github.com/envato/zxcvbn-ruby/pull/29
+
+## [1.0.0] - 2019-05-14
+### Added
+ - License info in the gemspec ([#21])
+ - More ported password checking features to bring this gem more up to date. ([#22])
+    - spatial - Keyboard patterns
+    - repeat - Repeated characters
+    - sequence - easily guessable sequences
+    - date - date associations
+
+### Removed
+- This gem will no longer run on Ruby versions < 2.3 ([#25])
+
+[1.0.0]: https://github.com/envato/zxcvbn-ruby/compare/v0.1.2...v1.0.0
+[#21]: https://github.com/envato/zxcvbn-ruby/pull/21
+[#22]: https://github.com/envato/zxcvbn-ruby/pull/22
+[#25]: https://github.com/envato/zxcvbn-ruby/pull/25

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,130 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+pete.johns@envato.com
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
+

data/Gemfile

@@ -1,3 +1,10 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-bundler', require: false
+  gem 'guard-rspec', require: false
+  gem 'rake'
+end

data/Guardfile

@@ -0,0 +1,26 @@
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,13 +1,28 @@
 # zxcvbn-ruby
 
-Ruby port of [zxcvbn.js](https://github.com/dropbox/zxcvbn)
+This is a Ruby port of Dropbox's [zxcvbn.js][zxcvbn.js] JavaScript library.
 
-## Usage
+## Development status [![Build Status](https://travis-ci.org/envato/zxcvbn-ruby.svg?branch=master)](https://travis-ci.org/envato/zxcvbn-ruby)
 
-Gemfile:
+`zxcvbn-ruby` is considered stable and is used in projects around [Envato][envato].
+
+After checking out the repository, run `bundle install` to install dependencies.
+Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+
+## Getting started [![Gem version](https://img.shields.io/gem/v/zxcvbn-ruby.svg?style=flat-square)](https://github.com/envato/zxcvbn-ruby) [![Gem downloads](https://img.shields.io/gem/dt/zxcvbn-ruby.svg?style=flat-square)](https://rubygems.org/gems/zxcvbn-ruby)
+
+Add the following to your project's `Gemfile`:
 
 ```ruby
-gem "zxcvbn-ruby", :require => 'zxcvbn'
+gem 'zxcvbn-ruby', require: 'zxcvbn'
 ```
 
 Example usage:
@@ -16,8 +31,149 @@ Example usage:
 $ irb
 >> require 'zxcvbn'
 => true
->> Zxcvbn.test('@lfred2004', ['alfred'])
-=> #<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
-```
+>> pp Zxcvbn.test('@lfred2004', ['alfred'])
+#<Zxcvbn::Score:0x00007f7f590610c8
+ @calc_time=0.0055760000250302255,
+ @crack_time=0.012,
+ @crack_time_display="instant",
+ @entropy=7.895,
+ @feedback=
+  #<Zxcvbn::Feedback:0x00007f7f59060150
+   @suggestions=
+    ["Add another word or two. Uncommon words are better.",
+     "Predictable substitutions like '@' instead of 'a' don't help very much"],
+   @warning=nil>,
+ @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_entropy=0.0, uppercase_entropy=0.0, l33t_entropy=1, entropy=1.0>,
+   #<Zxcvbn::Match i=6, j=9, token="2004", pattern="year", entropy=6.894817763307944>],
+ @password="@lfred2004",
+ @score=0>
+=> #<Zxcvbn::Score:0x00007f7f59060150>
+>> pp Zxcvbn.test('asdfghju7654rewq', ['alfred'])
+#<Zxcvbn::Score:0x00007f7f5a9e9248
+ @calc_time=0.007504999986849725,
+ @crack_time=46159.451,
+ @crack_time_display="14 hours",
+ @entropy=29.782,
+ @feedback=
+  #<Zxcvbn::Feedback:0x00007f7f5a9e9130
+   @suggestions=
+    ["Add another word or two. Uncommon words are better.",
+     "Use a longer keyboard pattern with more turns"],
+   @warning="Short keyboard patterns are easy to guess">,
+ @match_sequence=
+  [#<Zxcvbn::Match pattern="spatial", i=0, j=15, token="asdfghju7654rewq", graph="qwerty", turns=5, shifted_count=0, entropy=29.7820508329166>],
+ @password="asdfghju7654rewq",
+ @score=2>
+=> #<Zxcvbn::Score:0x00007f7f5a9e9248>
+```
+
+## 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>
+>> pp tester.test('@lfred2004', ['alfred'])
+#<Zxcvbn::Score:0x00007f7f586fcf50
+ @calc_time=0.00631899997824803,
+ @crack_time=0.012,
+ @crack_time_display="instant",
+ @entropy=7.895,
+ @feedback=
+  #<Zxcvbn::Feedback:0x00007f7f586fcac8
+   @suggestions=
+    ["Add another word or two. Uncommon words are better.",
+     "Predictable substitutions like '@' instead of 'a' don't help very much"],
+   @warning=nil>,
+ @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_entropy=0.0, uppercase_entropy=0.0, l33t_entropy=1, entropy=1.0>,
+   #<Zxcvbn::Match i=6, j=9, token="2004", pattern="year", entropy=6.894817763307944>],
+ @password="@lfred2004",
+ @score=0>
+=> #<Zxcvbn::Score:0x00007f7f586fcf50>
+>> pp tester.test('@lfred2004', ['alfred'])
+#<Zxcvbn::Score:0x00007f7f56d57438
+ @calc_time=0.001986999996006489,
+ @crack_time=0.012,
+ @crack_time_display="instant",
+ @entropy=7.895,
+ @feedback=
+  #<Zxcvbn::Feedback:0x00007f7f56d56bf0
+   @suggestions=
+    ["Add another word or two. Uncommon words are better.",
+     "Predictable substitutions like '@' instead of 'a' don't help very much"],
+   @warning=nil>,
+ @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_entropy=0.0, uppercase_entropy=0.0, l33t_entropy=1, entropy=1.0>,
+   #<Zxcvbn::Match i=6, j=9, token="2004", pattern="year", entropy=6.894817763307944>],
+ @password="@lfred2004",
+ @score=0>
+=> #<Zxcvbn::Score:0x00007f7f56d57438>
+```
+
+**Note**: Storing the entropy of an encrypted or hashed value provides
+information that can make cracking the value orders of magnitude easier for an
+attacker. For this reason we advise you not to store the results of
+`Zxcvbn::Tester#test`. Further reading: [A Tale of Security Gone Wrong](http://gavinmiller.io/2016/a-tale-of-security-gone-wrong/).
+
+## Contact
+
+ - [GitHub project](https://github.com/envato/zxcvbn-ruby)
+ - Bug reports and feature requests are welcome via [GitHub Issues](https://github.com/envato/zxcvbn-ruby/issues)
+
+## Maintainers
+
+ - [Pete Johns](https://github.com/johnsyweb)
+ - [Steve Hodgkiss](https://github.com/stevehodgkiss)
+
+## Authors
+
+ - [Steve Hodgkiss](https://github.com/stevehodgkiss)
+ - [Matthieu Aussaguel](https://github.com/matthieua)
+ - [_et al._](https://github.com/envato/zxcvbn-ruby/graphs/contributors)
+
+## License [![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://github.com/envato/zxcvbn-ruby/blob/master/LICENSE.txt)
+
+`zxcvbn-ruby` uses MIT license, the same as [zxcvbn.js][zxcvbn.js] itself. See
+[`LICENSE.txt`](https://github.com/envato/zxcvbn-ruby/blob/master/LICENSE.txt)
+for details.
+
+## Code of Conduct
+
+We welcome contribution from everyone. Read more about it in
+[`CODE_OF_CONDUCT.md`](https://github.com/envato/zxcvbn-ruby/blob/master/CODE_OF_CONDUCT.md).
+
+## Contributing [![PRs welcome](https://img.shields.io/badge/PRs-welcome-orange.svg?style=flat-square)](https://github.com/envato/zxcvbn-ruby/issues)
+
+For bug fixes, documentation changes, and features:
+
+1. [Fork it](./fork)
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request
+
+For larger new features: Do everything as above, but first also make contact with the project maintainers to be sure your change fits with the project direction and you won't be wasting effort going in the wrong direction.
+
+## About [![code with heart by Envato](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-Envato-ff69b4.svg?style=flat-square)](https://github.com/envato/zxcvbn-ruby)
+
+This project is maintained by the [Envato engineering team][webuild] and funded by [Envato][envato].
+
+[<img src="http://opensource.envato.com/images/envato-oss-readme-logo.png" alt="Envato logo">][envato]
+
+Encouraging the use and creation of open source software is one of the ways we
+serve our community. See [our other projects][oss] or [come work with us][careers]
+where you'll find an incredibly diverse, intelligent and capable group of people
+who help make our company succeed and make our workplace fun, friendly and
+happy.
+
+ [careers]: https://envato.com/careers/?utm_source=github
+ [envato]: https://envato.com?utm_source=github
+ [oss]: https://opensource.envato.com/?utm_source=github
+ [webuild]: https://webuild.envato.com?utm_source=github
+ [zxcvbn.js]: https://github.com/dropbox/zxcvbn

data/Rakefile

@@ -1,6 +1,10 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
 require "bundler/setup"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task default: [:spec]
 
 task :console do
   require 'zxcvbn'
@@ -15,4 +19,4 @@ end
 task :compile_coffeescript do
   `coffee --compile --bare spec/support/js_source/{matching,scoring,init}.coffee`
   `cat spec/support/js_source/{matching,scoring,adjacency_graphs,frequency_lists,init}.js > spec/support/js_source/compiled.js`
-end
+end

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