password_reuse_policy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 011e5cab70f40a3ca19c0ef4b9e7a2b620dfd877
+  data.tar.gz: e0e8e781906132b4801aeda27e84e5d46ec0b402
+SHA512:
+  metadata.gz: 3d4088f9e8055eee4c4186013cff6ee26e35c4962e30b15818c0efc0ce14edcca3aa23f36bb9d36f195447f279d881837780442218de3c448218885e103ad26f
+  data.tar.gz: d9bae617a363acaf216344d33fd05bacf5aa1dadf30b7544f59d40a1941a24b29d1eadced5e65658478fffab7bca8735cef9f54add90d16d983d97f0ecf35aa7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+password_reuse_policy

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at naveenagarwal287@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in password_reuse_policy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Naveen Agarwal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# PasswordReusePolicy
+
+It is a module/gem to set the password resue policy for the registered users. Means you can set a limit, only after which a user will be able to resue the same password. For example if a user's password is "12345" and limit is 3, then he can only use password "12345" again after setting three different password.
+
+It should work with any authentication library which supports either active record or mongoid ORM. In case you have any difficulty in using this module in your applicaition do write me at [naveenagarwal287@gmail.com](mailto:naveenagarwal287@gmail.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'password_reuse_policy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install password_reuse_policy
+
+## Usage
+
+I am setting the example here for rails app, you can use it in any ruby app.
+
+Configuration:
+
+create a file named `password_reuse_policy.rb`
+
+To add default configuration:
+
+```ruby
+PasswordReusePolicy::Configuration.default!
+``` 
+
+To override default configuration:
+
+```ruby
+PasswordReusePolicy::Configuration.config do |c|
+  c.number_of_passwords_cannot_be_used = 3 #default, number of last used password which can not be used
+  c.error_field_name = :password #default, error field name in which error will be set
+  c.password_field_name = :password #default, field name from which password should be picked
+endc
+``` 
+
+Link to sample applciation, devise is used for authentication, it uses password field name by default in the model.
+
+To check the usage with active record visit
+[https://github.com/naveenagarwal/password_reuse_policy_testapp](https://github.com/naveenagarwal/password_reuse_policy_testapp)
+
+To check the usage with mongoid visit
+[https://github.com/naveenagarwal/password_reuse_policy_testapp/tree/mogoid_module_test](https://github.com/naveenagarwal/password_reuse_policy_testapp/tree/mogoid_module_test)
+
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/password_reuse_policy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+# require "rspec/core/rake_task"
+
+# RSpec::Core::RakeTask.new(:spec)
+
+desc "run all tests in spec folder"
+task :test do
+  files = Dir.glob('spec/**/*.rb')
+  files.each do |file|
+    next if file == "spec/spec_helper.rb"
+    puts `ruby #{file}` if file.end_with? "_spec.rb"
+  end
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "password_reuse_policy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/password_reuse_policy.rb

@@ -0,0 +1,10 @@
+require "password_reuse_policy/version"
+require "password_reuse_policy/configuration"
+require "password_reuse_policy/instance_methods"
+require "password_reuse_policy/errors"
+require "password_reuse_policy/mongo"
+require "password_reuse_policy/ar"
+
+module PasswordReusePolicy
+
+end

data/lib/password_reuse_policy/ar.rb

@@ -0,0 +1,17 @@
+module PasswordReusePolicy::AR
+  module ClassMethods
+		def register!
+      raise PasswordReusePolicy::ActiveRecodNotFoundError, "Could not find actve record" unless defined? ActiveRecord
+			raise PasswordReusePolicy::ActiveRecodNotInherited, "Please inherit from active record class" unless ancestors.include? ActiveRecord::Base
+
+			serialize :last_used_passwords, Hash
+			before_save :set_last_used_passwords, :if => :password_present?
+		end
+  end
+
+  def self.included(receiver)
+    receiver.extend ClassMethods
+    receiver.register!
+    receiver.send :include, PasswordReusePolicy::InstanceMethods
+  end
+end

data/lib/password_reuse_policy/configuration.rb

@@ -0,0 +1,50 @@
+require 'digest'
+
+module PasswordReusePolicy
+
+  class Configuration
+
+    class << self
+
+      def default!
+        self.number_of_passwords_cannot_be_used = 3
+	      self.error_field_name = :password
+        self.password_field_name = :password
+      end
+
+      def config
+        yield self
+      end
+
+      def password_field_name
+        @password_field_name
+      end
+
+      def password_field_name=(name)
+	      @password_field_name = name.to_sym
+      end
+
+      def number_of_passwords_cannot_be_used
+        @number_of_passwords_cannot_be_used
+      end
+
+      def number_of_passwords_cannot_be_used=(number)
+        @number_of_passwords_cannot_be_used = number
+      end
+
+      def error_field_name
+        @error_field_name
+      end
+
+      def error_field_name=(name)
+        @error_field_name = name.to_sym
+      end
+
+      def encryption
+	      Digest::MD5
+      end
+    end
+
+  end
+
+end

data/lib/password_reuse_policy/errors.rb

@@ -0,0 +1,7 @@
+module NoMongoid
+  class DocumentError < StandardError
+  end
+end
+
+class PasswordReusePolicy::ActiveRecodNotFoundError < StandardError; end;
+class PasswordReusePolicy::ActiveRecodNotInherited < StandardError; end;

data/lib/password_reuse_policy/instance_methods.rb

@@ -0,0 +1,30 @@
+module PasswordReusePolicy::InstanceMethods
+  private
+
+  def password_present?
+    send(PasswordReusePolicy::Configuration.password_field_name).present?
+  end
+
+  def set_last_used_passwords
+    n = PasswordReusePolicy::Configuration.number_of_passwords_cannot_be_used
+    return false if n < 1
+
+    encryption = PasswordReusePolicy::Configuration.encryption
+    new_password = encryption.hexdigest public_send(PasswordReusePolicy::Configuration.password_field_name)
+
+    if self.last_used_passwords.values.include? new_password
+      self.errors.add(PasswordReusePolicy::Configuration.error_field_name, "Password can't be same as last #{n} passwords")
+      return false
+    else
+      set_new_password_hash_with new_password, n
+    end
+  end
+
+  def set_new_password_hash_with new_password, n
+    used_passwords = (self.last_used_passwords || {}).to_a
+    used_passwords.unshift ["1", new_password]
+    used_passwords[1..-1].each { |used_password| used_password[0] = used_password[0].to_i + 1 }
+    used_passwords = used_passwords.take n
+    self.last_used_passwords = used_passwords.to_h
+  end
+end

data/lib/password_reuse_policy/mongo.rb

@@ -0,0 +1,17 @@
+module PasswordReusePolicy::Mongo
+  module ClassMethods
+    def register!
+      raise NoMongoid::DocumentError, "Mongoid::Document is not defiend" unless defined? Mongoid::Document
+      raise NoMongoid::DocumentError, "Mongoid::Document is not inlcuded in the class" unless self.include? Mongoid::Document
+
+      field :last_used_passwords, type: Hash, default: {}
+      before_save :set_last_used_passwords,  :if => :password_present?
+    end
+  end
+
+  def self.included(receiver)
+    receiver.extend ClassMethods
+    receiver.register!
+    receiver.send :include, PasswordReusePolicy::InstanceMethods
+  end
+end

data/lib/password_reuse_policy/version.rb

@@ -0,0 +1,3 @@
+module PasswordReusePolicy
+  VERSION = "1.0.0"
+end

data/password_reuse_policy.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'password_reuse_policy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "password_reuse_policy"
+  spec.version       = PasswordReusePolicy::VERSION
+  spec.authors       = ["Naveen Agarwal"]
+  spec.email         = ["naveenagarwal287@gmail.com"]
+
+  spec.summary       = %q{Setup password resuse policy for your app.}
+  spec.description   = %q{You can setup the check when a password can be reused by a user. It lets you configure the last 'n' password can not be used by user when they change it.}
+  spec.homepage      = "https://github.com/naveenagarwal/password_reuse_policy"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mongoid", "~> 5.0.0"
+  spec.add_development_dependency 'activerecord', '~> 4.2'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.11'
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: password_reuse_policy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Naveen Agarwal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: You can setup the check when a password can be reused by a user. It lets
+  you configure the last 'n' password can not be used by user when they change it.
+email:
+- naveenagarwal287@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/password_reuse_policy.rb
+- lib/password_reuse_policy/ar.rb
+- lib/password_reuse_policy/configuration.rb
+- lib/password_reuse_policy/errors.rb
+- lib/password_reuse_policy/instance_methods.rb
+- lib/password_reuse_policy/mongo.rb
+- lib/password_reuse_policy/version.rb
+- password_reuse_policy.gemspec
+- password_reuse_policy_test.sqlite3
+homepage: https://github.com/naveenagarwal/password_reuse_policy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Setup password resuse policy for your app.
+test_files: []