rodauth-pwned 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd0ad8ce7b86521b47c5d4ed6c1986210ba2962651ebf0689de230c2ce177e33
+  data.tar.gz: 4561058c9852a558be78f3c1584b72c96656925fcb91b7a8963d2282445a852b
+SHA512:
+  metadata.gz: b7d5a4f4a155fcd78871ea41851727b6243a4fd8d5b56453296ae724c150969363d0b20f9a01182541b317ef7cce3e9e5cb0d27879eb974910d5fea4ffb736a7
+  data.tar.gz: 207219558e027c559910cba8a662940eee39cbb8c6ce12e2a0d9f06c1c63cca4b9a2415c517f8faff2ea4bd702aedcacb881303371e90f4f33a1e7fd5d8d07c6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Janko Marohnić
+
+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,113 @@
+# rodauth-pwned
+
+[Rodauth] feature that checks user passwords against the [Pwned Passwords API].
+
+## Installation
+
+```rb
+gem "rodauth-pwned"
+```
+
+## Usage
+
+All you need to do is enable the `pwned_password` Rodauth feature provided by
+this gem, and new passwords will be automatically checked.
+
+```rb
+plugin :rodauth do
+  enable :pwned_password, ...
+  # ...
+end
+```
+
+### Allowed count
+
+You can still accept passwords that have only been exposed a small number of
+times:
+
+```rb
+plugin :rodauth do
+  # ...
+  password_allowed_pwned_count 5 # allow password to be pwned up to 5 times
+end
+```
+
+### Validation error message
+
+You can change the default validation error message:
+
+```rb
+plugin :rodauth do
+  # ...
+  password_pwned_message "has been pwned"
+end
+```
+
+### Request options
+
+You can pass additional request options to the [Pwned] gem:
+
+```rb
+plugin :rodauth do
+  # ...
+  pwned_request_options open_timeout: 1, read_timeout: 5, headers: { "User-Agent" => "MyApp" }
+end
+```
+
+### Handling network errors
+
+By default, any network errors to the Pwned Passwords API will be ignored, and
+the password will be considered not pwned. You can hook into these errors:
+
+```rb
+plugin :rodauth do
+  # ...
+  on_pwned_error { |error| Raven.capture_exception(error) }
+end
+```
+
+### API
+
+The feature exposes two public methods which you can use in your own code:
+
+* `password_pwned?(password)` – whether given password is considered pwned
+* `pwned_count(password)` – how many times has the given password been pwned
+
+```rb
+rodauth.password_pwned?("password123") #=> true
+rodauth.pwned_count("password123")     #=> 123063
+```
+
+You can also override these two methods:
+
+```rb
+plugin :rodauth do
+  # ...
+  password_pwned? { |password| ... }
+  pwned_count { |password| ... }
+end
+```
+
+## Development
+
+Run tests with Rake:
+
+```sh
+$ bundle exec rake test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/janko/rodauth-pwned. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/janko/rodauth-pwned/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rodauth::Pwned project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/janko/rodauth-pwned/blob/master/CODE_OF_CONDUCT.md).
+
+[Rodauth]: https://github.com/jeremyevans/rodauth
+[Pwned Passwords API]: https://haveibeenpwned.com/Passwords
+[Pwned]: https://github.com/philnash/pwned

data/lib/rodauth/features/pwned_password.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "pwned"
+
+module Rodauth
+  Feature.define(:pwned_password, :PwnedPassword) do
+    depends :login_password_requirements_base
+
+    auth_value_method :password_allowed_pwned_count, 0
+    translatable_method :password_pwned_message, "this password has previously appeared in a data breach and should never be used"
+    auth_value_method :pwned_request_options, {}
+
+    auth_methods(
+      :password_pwned?,
+      :pwned_count,
+      :on_pwned_error,
+    )
+
+    def password_meets_requirements?(password)
+      super && password_not_pwned?(password)
+    end
+
+    def password_pwned?(password)
+      pwned_count(password) > password_allowed_pwned_count
+    rescue Pwned::Error => error
+      on_pwned_error(error)
+      nil
+    end
+
+    def pwned_count(password)
+      Pwned.pwned_count(password, pwned_request_options)
+    end
+
+    private
+
+    def password_not_pwned?(password)
+      return true unless password_pwned?(password)
+      @password_requirement_message = password_pwned_message
+      false
+    end
+
+    def on_pwned_error(error)
+      # nothing by default
+    end
+  end
+end

data/rodauth-pwned.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |spec|
+  spec.name          = "rodauth-pwned"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Janko Marohnić"]
+  spec.email         = ["janko.marohnic@gmail.com"]
+
+  spec.summary       = "Rodauth extension for checking whether a password had been exposed in a database breach according to https://haveibeenpwned.com."
+  spec.description   = "Rodauth extension for checking whether a password had been exposed in a database breach according to https://haveibeenpwned.com."
+  spec.homepage      = "https://github.com/janko/rodauth-pwned"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files         = Dir["README.md", "LICENSE.txt", "*.gemspec", "lib/**/*"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rodauth", "~> 2.0"
+  spec.add_dependency "pwned", "~> 2.1"
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-hooks"
+  spec.add_development_dependency "tilt"
+  spec.add_development_dependency "bcrypt"
+  spec.add_development_dependency "capybara"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: rodauth-pwned
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rodauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pwned
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-hooks
+  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: tilt
+  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: bcrypt
+  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: capybara
+  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: Rodauth extension for checking whether a password had been exposed in
+  a database breach according to https://haveibeenpwned.com.
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/rodauth/features/pwned_password.rb
+- rodauth-pwned.gemspec
+homepage: https://github.com/janko/rodauth-pwned
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/janko/rodauth-pwned
+  source_code_uri: https://github.com/janko/rodauth-pwned
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.1
+signing_key: 
+specification_version: 4
+summary: Rodauth extension for checking whether a password had been exposed in a database
+  breach according to https://haveibeenpwned.com.
+test_files: []