Giter Club home page Giter Club logo

pil's Introduction

PIL: Password Inclusion List

PIL is a gem for determining whether or not a given word is amongst the 10,000 most commonly-used passwords as defined by Mark Burnett's 10,000 Top Passwords.

Installation

You can let bundler install PIL by adding this line to your application's Gemfile:

gem 'pil'

And then execute:

bundle install

Or install it yourself with:

gem install pil

Usage

Password Inclusion

To determine if the password IS in the common list.

PIL returns FALSE if a given password cannot be found in its common password list; TRUE if the password is found and thus is commonly-used:

Pil.include?( 'good!password?' )  # => false
Pil.include?( 'password' )        # => true

Password Exclusion

To determine if the password IS NOT in the common list.

PIL returns TRUE if a given password cannot be found its common password list; FALSE if the password is found and thus is commonly-used:

Pil.exclude?( 'good!password?' )  # => true
Pil.exclude?( 'password' )        # => false

Instantiation

You can also instantiate PIL:

pil = Pil.new
pil.include?( 'areallylongpasswordwithathreeatheend3' )   # => false
pil.exclude?( 'areallylongpasswordwithathreeatheend3' )   # => true

With Rails

In your User model:

validates_with PasswordInclusionValidator

In /app/validators/ create a new class called PasswordInclusionValidator:

class PasswordInclusionValidator < ActiveModel::Validator
  def validate(record)
    if Pil.include?(record.password)
      record.errors[:password] << "Password is commonly used. Please choose a different password."
    end
  end
end

Contributing to PIL

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2012 Chris Cummer. See LICENSE.txt for further details.

pil's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.