Passweird

A library to assess password security by giving the ability to check it against an arbitrary blacklist

$ Passweird::Checker.blacklisted?("my-password")

This will check if the given string, Its substrings or leet speak equivalents are registered in the blacklist.

The blacklist is managed in the database through Active Record.

$ Passweird::BlacklistedTerm.create(term: "banned-term") # Add to blacklist

There is no further set up needed if within a Ruby on Rails application, otherwise you need to establish the connection with the database yourself; see docs.

Install the gem and add to the application's Gemfile by executing:

$ bundle add passweird

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install passweird

In a rails environment, run this migration script to automatically generate the required table

$ bin/rails generate migration CreatePassweirdBlacklistedTerms term:string:index

Otherwise, run these SQL commands in your database to generate the table manually

$ CREATE TABLE `passweird_blacklisted_terms` (`id` int(11) auto_increment PRIMARY KEY, `term` varchar(255) NOT NULL, `created_at` datetime, `updated_at` datetime);

$ CREATE INDEX index_passweird_blacklisted_terms_on_term ON passweird_blacklisted_terms (term);

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.

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 the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/passweird. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Passweird project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.