pwnedkeys-filter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76391e2ba3bc336b7c1eae6034f034b3fce4bbf01094aa96c3bd76c71d5c9f0e
-  data.tar.gz: 1a84b07456594a252fd720c9a6152452a89403f5b54c337c4b768d44653b0961
+  metadata.gz: 9b916d185473c8a9bb1a2cc28036121d7c015af4abc287a4cc778f91d8184ea5
+  data.tar.gz: 3622ef85be404de370844c1fcede849a43e536d4c8261d43285ad45cc5d7ded4
 SHA512:
-  metadata.gz: 1e94333e88347be45babe142ceab68301c1897e7f998d0d1cbaa05a9cf9d93eac5cf3e51b363d089f894071793d8bf2309ee30c91d221991e04346a3906a882b
-  data.tar.gz: ff38e9a11c06de9cf9fb8aa5073010b03d986e33ec58e6d29d77677f3cb34015c386c175dc03f3f015cdeb331999dea42cb7c068184b39be47358b06bcdc3c7a
+  metadata.gz: e5a97277a35b9f2dd1901ab599bd3de39954c8bfceb868f3c33a3b275bc7390d2bb81a988d660d5f88d6cb5caf8043cacc830b02ebf14d4cb6d5d92094dce64a
+  data.tar.gz: 9d1ee32b9cec58d5d235aa569192ddbd7fecff7db735217d925d2b9ddbaf46d99e0766388300110227edb7e3f5c8dd25f575ccc20654615020cd8e534b783ab5

data/lib/pwnedkeys/filter.rb

@@ -117,6 +117,53 @@ module Pwnedkeys
       nil
     end
 
+    # Calculate count/length parameters for a given entry count and desired false-positive rate.
+    #
+    # @param entries [Integer] how many elements the bloom filter should
+    #    accommodate.
+    #
+    # @param fp_rate [Float] the maximum false-positive rate you wish to
+    #    accept.
+    #
+    # @return [Hash<Symbol, Integer>] the `:hash_count` and `:hash_length` which
+    #    will produce the desired false-positive rate if the filter is filled
+    #    with the specified number of entries.
+    #
+    def self.filter_parameters(entries:, fp_rate:)
+      # Blessings unto https://en.wikipedia.org/wiki/Bloom_filter#Optimal_number_of_hash_functions
+      optimal_filter_bits = (-1 * entries * Math.log(fp_rate) / Math.log(2) / Math.log(2))
+      hash_length = (Math.log2(optimal_filter_bits)).ceil
+      actual_filter_bits = 2 ** hash_length
+
+      # We could, in theory, just use the "optimal k" (hash count), which would
+      # often produce an actual false-positive rate much smaller than our
+      # target (because actual_filter_bits can be *significantly* larger than
+      # optimal_filter_bits).  Instead, to minimise the hashing required, we
+      # can use the extra filter length available to choose a smaller k that
+      # still satisfies the target false positive rate.
+      #
+      # Because my algebra isn't up to solving the FP rate equation for k, and
+      # because the search space of possible values of k is small and bounded
+      # (by 1, and by the "optimal k" on the upper bound), brute-forcing things
+      # seems the easiest option.
+
+      upper_bound = (Math.log(2) * actual_filter_bits / entries).ceil
+      hash_count = (1..upper_bound).find do |k|
+        (1 - (1 - 1.0 / actual_filter_bits) ** (k * entries)) ** k < fp_rate
+      end
+
+      if hash_count.nil?
+        #:nocov:
+        raise RuntimeError, "CAN'T HAPPEN: Could not determine hash_count for entries: #{entries}, fp_rate: #{fp_rate}.  Please report a violation of the laws of mathematics."
+        #:nocov:
+      end
+
+      {
+        hash_count:  hash_count,
+        hash_length: hash_length,
+      }
+    end
+
     # Open an existing pwnedkeys bloom filter data file.
     #
     # @param filename [String] the file to open.
@@ -245,7 +292,6 @@ module Pwnedkeys
       (1 - (1 - 1.0 / filter_bit_count) ** (hash_count * entry_count)) ** hash_count
     end
 
-
     private
 
     def hash_count

data/pwnedkeys-filter.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'github-release'
   s.add_development_dependency 'git-version-bump'
   s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rake', "~> 12.0"
   s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwnedkeys-filter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-21 00:00:00.000000000 Z
+date: 2020-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl-additions
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -209,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Library to query pwnedkeys.com bloom filters