zyphr 0.1.50 → 0.1.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4fd52fa232b4a334d6ea406412fa92ee9d076583b6038b8e9d0231b5c77c016
-  data.tar.gz: 2f2e95c64d51dc3f4c48309a580d7e21960fc5a3665359b5986431e1f833c6b5
+  metadata.gz: f7ec40b14a9b8a2ce14cff88cdb6d2e4cdebd6b1c324a65a8f8c4f1b551f1688
+  data.tar.gz: dd884a0621a0a3243a6b1ffa98e6acc8821f1b4efaaf841f12df6307fba729cb
 SHA512:
-  metadata.gz: 48bdb019fd49d35023234cc46edb30ed3aa0716a267aefa6fbfb8c3147be8e3cde1bf60bd01f0c12e1e443111fd5bb58f49a853d2c09e1c28b91040103c1f0fe
-  data.tar.gz: fc7da20a4d8529d1a12e120bf0ffcf30588f26cc4abbfe8c0ea386c21d3435eac9aca82229a96f416d8d5826542881ec71c62f47c453b75179bdd9fd9f94e734
+  metadata.gz: 799f68978d7a8ea632126b16f2addb82b7e16f41e75c23f12abe809c5465ac74a7046276d371720f90472b4f0228353a3ccb9d48fbbf50ed443da2f9cf565a52
+  data.tar.gz: c17b1bdd2725d25d2c117ca6460e306ab1fe2cf96fddbcb43624f52f9dffa4546abd24ef2f13c66eb9c699e21ece24ef7e92f3d52f714ae712380fb09dcc21f6

data/docs/PasswordPolicy.md

@@ -11,6 +11,7 @@
 | **require_numbers** | **Boolean** | Whether at least one number (0-9) is required. |  |
 | **require_special** | **Boolean** | Whether at least one special character is required. |  |
 | **disallow_common** | **Boolean** | Whether commonly used passwords are rejected. |  |
+| **disallow_breached** | **Boolean** | Whether passwords found in the HaveIBeenPwned breach corpus are rejected at registration/reset. Checked via k-anonymity (only a 5-char SHA-1 prefix leaves our infrastructure) and fail-open: if the breach source is unavailable the password is allowed. Default false (advisory only — the breach signal is returned but does not gate acceptance unless enabled). |  |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = Zyphr::PasswordPolicy.new(
   require_lowercase: null,
   require_numbers: null,
   require_special: null,
-  disallow_common: null
+  disallow_common: null,
+  disallow_breached: null
 )
 ```
 

data/docs/PasswordStrength.md

@@ -4,8 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **valid** | **Boolean** | Whether the password would be accepted by the server's enforcement path. A password that is valid here is accepted by registration. |  |
-| **score** | **Integer** | Strength score, 0-100. |  |
+| **valid** | **Boolean** | Whether the password would be accepted by the server's enforcement path. A password that is valid here is accepted by registration. When the application enables `disallow_breached`, a breached password is `valid: false` here AND rejected by register/reset (no drift). |  |
+| **breached** | **Boolean** | Whether the password appears in the HaveIBeenPwned breach corpus. This is a distinct signal from `valid` and is always returned regardless of the app's `disallow_breached` setting. Fail-open: if the breach source is unavailable this is `false`. |  |
+| **breach_count** | **Integer** | HIBP occurrence count for the password (0 if not breached or if the breach lookup failed/was unavailable). |  |
+| **score** | **Integer** | Strength score, 0-100. A pure composition measure — independent of the breach signal. |  |
 | **label** | **String** | Strength label derived from the score. |  |
 | **feedback** | **Array<String>** | Actionable feedback — policy errors plus strength-improvement suggestions. |  |
 
@@ -16,6 +18,8 @@ require 'zyphr'
 
 instance = Zyphr::PasswordStrength.new(
   valid: null,
+  breached: null,
+  breach_count: null,
   score: null,
   label: null,
   feedback: null

data/lib/zyphr/models/password_policy.rb

@@ -37,6 +37,9 @@ module Zyphr
     # Whether commonly used passwords are rejected.
     attr_accessor :disallow_common
 
+    # Whether passwords found in the HaveIBeenPwned breach corpus are rejected at registration/reset. Checked via k-anonymity (only a 5-char SHA-1 prefix leaves our infrastructure) and fail-open: if the breach source is unavailable the password is allowed. Default false (advisory only — the breach signal is returned but does not gate acceptance unless enabled).
+    attr_accessor :disallow_breached
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,7 +49,8 @@ module Zyphr
         :'require_lowercase' => :'require_lowercase',
         :'require_numbers' => :'require_numbers',
         :'require_special' => :'require_special',
-        :'disallow_common' => :'disallow_common'
+        :'disallow_common' => :'disallow_common',
+        :'disallow_breached' => :'disallow_breached'
       }
     end
 
@@ -69,7 +73,8 @@ module Zyphr
         :'require_lowercase' => :'Boolean',
         :'require_numbers' => :'Boolean',
         :'require_special' => :'Boolean',
-        :'disallow_common' => :'Boolean'
+        :'disallow_common' => :'Boolean',
+        :'disallow_breached' => :'Boolean'
       }
     end
 
@@ -136,6 +141,12 @@ module Zyphr
       else
         self.disallow_common = nil
       end
+
+      if attributes.key?(:'disallow_breached')
+        self.disallow_breached = attributes[:'disallow_breached']
+      else
+        self.disallow_breached = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -171,6 +182,10 @@ module Zyphr
         invalid_properties.push('invalid value for "disallow_common", disallow_common cannot be nil.')
       end
 
+      if @disallow_breached.nil?
+        invalid_properties.push('invalid value for "disallow_breached", disallow_breached cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -185,6 +200,7 @@ module Zyphr
       return false if @require_numbers.nil?
       return false if @require_special.nil?
       return false if @disallow_common.nil?
+      return false if @disallow_breached.nil?
       true
     end
 
@@ -258,6 +274,16 @@ module Zyphr
       @disallow_common = disallow_common
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] disallow_breached Value to be assigned
+    def disallow_breached=(disallow_breached)
+      if disallow_breached.nil?
+        fail ArgumentError, 'disallow_breached cannot be nil'
+      end
+
+      @disallow_breached = disallow_breached
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -269,7 +295,8 @@ module Zyphr
           require_lowercase == o.require_lowercase &&
           require_numbers == o.require_numbers &&
           require_special == o.require_special &&
-          disallow_common == o.disallow_common
+          disallow_common == o.disallow_common &&
+          disallow_breached == o.disallow_breached
     end
 
     # @see the `==` method
@@ -281,7 +308,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [min_length, max_length, require_uppercase, require_lowercase, require_numbers, require_special, disallow_common].hash
+      [min_length, max_length, require_uppercase, require_lowercase, require_numbers, require_special, disallow_common, disallow_breached].hash
     end
 
     # Builds the object from hash

data/lib/zyphr/models/password_strength.rb

@@ -15,10 +15,16 @@ require 'time'
 
 module Zyphr
   class PasswordStrength
-    # Whether the password would be accepted by the server's enforcement path. A password that is valid here is accepted by registration.
+    # Whether the password would be accepted by the server's enforcement path. A password that is valid here is accepted by registration. When the application enables `disallow_breached`, a breached password is `valid: false` here AND rejected by register/reset (no drift).
     attr_accessor :valid
 
-    # Strength score, 0-100.
+    # Whether the password appears in the HaveIBeenPwned breach corpus. This is a distinct signal from `valid` and is always returned regardless of the app's `disallow_breached` setting. Fail-open: if the breach source is unavailable this is `false`.
+    attr_accessor :breached
+
+    # HIBP occurrence count for the password (0 if not breached or if the breach lookup failed/was unavailable).
+    attr_accessor :breach_count
+
+    # Strength score, 0-100. A pure composition measure — independent of the breach signal.
     attr_accessor :score
 
     # Strength label derived from the score.
@@ -53,6 +59,8 @@ module Zyphr
     def self.attribute_map
       {
         :'valid' => :'valid',
+        :'breached' => :'breached',
+        :'breach_count' => :'breach_count',
         :'score' => :'score',
         :'label' => :'label',
         :'feedback' => :'feedback'
@@ -73,6 +81,8 @@ module Zyphr
     def self.openapi_types
       {
         :'valid' => :'Boolean',
+        :'breached' => :'Boolean',
+        :'breach_count' => :'Integer',
         :'score' => :'Integer',
         :'label' => :'String',
         :'feedback' => :'Array<String>'
@@ -107,6 +117,18 @@ module Zyphr
         self.valid = nil
       end
 
+      if attributes.key?(:'breached')
+        self.breached = attributes[:'breached']
+      else
+        self.breached = nil
+      end
+
+      if attributes.key?(:'breach_count')
+        self.breach_count = attributes[:'breach_count']
+      else
+        self.breach_count = nil
+      end
+
       if attributes.key?(:'score')
         self.score = attributes[:'score']
       else
@@ -137,6 +159,18 @@ module Zyphr
         invalid_properties.push('invalid value for "valid", valid cannot be nil.')
       end
 
+      if @breached.nil?
+        invalid_properties.push('invalid value for "breached", breached cannot be nil.')
+      end
+
+      if @breach_count.nil?
+        invalid_properties.push('invalid value for "breach_count", breach_count cannot be nil.')
+      end
+
+      if @breach_count < 0
+        invalid_properties.push('invalid value for "breach_count", must be greater than or equal to 0.')
+      end
+
       if @score.nil?
         invalid_properties.push('invalid value for "score", score cannot be nil.')
       end
@@ -165,6 +199,9 @@ module Zyphr
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @valid.nil?
+      return false if @breached.nil?
+      return false if @breach_count.nil?
+      return false if @breach_count < 0
       return false if @score.nil?
       return false if @score > 100
       return false if @score < 0
@@ -185,6 +222,30 @@ module Zyphr
       @valid = valid
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] breached Value to be assigned
+    def breached=(breached)
+      if breached.nil?
+        fail ArgumentError, 'breached cannot be nil'
+      end
+
+      @breached = breached
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] breach_count Value to be assigned
+    def breach_count=(breach_count)
+      if breach_count.nil?
+        fail ArgumentError, 'breach_count cannot be nil'
+      end
+
+      if breach_count < 0
+        fail ArgumentError, 'invalid value for "breach_count", must be greater than or equal to 0.'
+      end
+
+      @breach_count = breach_count
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] score Value to be assigned
     def score=(score)
@@ -229,6 +290,8 @@ module Zyphr
       return true if self.equal?(o)
       self.class == o.class &&
           valid == o.valid &&
+          breached == o.breached &&
+          breach_count == o.breach_count &&
           score == o.score &&
           label == o.label &&
           feedback == o.feedback
@@ -243,7 +306,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [valid, score, label, feedback].hash
+      [valid, breached, breach_count, score, label, feedback].hash
     end
 
     # Builds the object from hash

data/spec/models/password_policy_spec.rb

@@ -69,4 +69,10 @@ describe Zyphr::PasswordPolicy do
     end
   end
 
+  describe 'test attribute "disallow_breached"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/password_strength_spec.rb

@@ -33,6 +33,18 @@ describe Zyphr::PasswordStrength do
     end
   end
 
+  describe 'test attribute "breached"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "breach_count"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "score"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/zyphr.gemspec

@@ -17,7 +17,7 @@ require "zyphr/version"
 
 Gem::Specification.new do |s|
   s.name        = "zyphr"
-  s.version = '0.1.50'
+  s.version = '0.1.51'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Zyphr"]
   s.email       = ["support@zyphr.dev"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zyphr
 version: !ruby/object:Gem::Version
-  version: 0.1.50
+  version: 0.1.51
 platform: ruby
 authors:
 - Zyphr