pwnedkeys-api-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5156705fc2f8ed04cc45a3076fb4728a092caddabbed5c4411c4d9272029d29f
-  data.tar.gz: d0b7445ecdceaed25f344ec9e67be817462585cd663132f452645c488900442c
+  metadata.gz: 166520b315e6b27d8737dca7c597ccbee2e7bad01f4fd75eaeef687bf55b7e8a
+  data.tar.gz: 9ae8086acce3d9a566b11df15c03810a1e5c7bfe34bac320ceeb0a400c329d3e
 SHA512:
-  metadata.gz: 428eb3e4d4f0112161cbf3ccd40db8ecb35a947d04a2bf2c9e50114e20a572ea46bccf0604414440cfa267468523614455cb7dab2a64c347cb00e5818360b428
-  data.tar.gz: cf51ff367ba37c9473b7fb3b023fe8900a25f6a9267c0c904a57e7f203dd37e01520736b18a77079d282c873d5e9d063a5a6b91d2eb8904704b7a4611860ecb5
+  metadata.gz: 53d3c4ddeb857f3face8c5e37d4ebac004a1791ffa608a0b20e36120840c2262f8921ff9427b747f26bb29ceff9dcdcb99380b1f520718c941f995ddaefafbb1
+  data.tar.gz: 48fe943209d7b284e36586b3398f1a12ad8f9761e9f7a93080d612998bd3877a44a5dc086817b8e304a93a30b3fa3365c57cc091426cc03e9eed2958bae991eb

data/lib/pwnedkeys/request.rb

@@ -2,8 +2,8 @@ require "base64"
 require "json"
 require "net/http"
 require "openssl"
-
 require "openssl/x509/spki"
+require "pwnedkeys/filter"
 
 # All the keys that are fit to be pwned.
 module Pwnedkeys
@@ -30,11 +30,16 @@ module Pwnedkeys
     #   ASN.1 structure.
     #
     #   If in doubt, just pass in a key and we'll take care of the rest.
+	 #
+	 # @param filter [#to_s] specify the location of a Pwnedkeys bloom filter.
+	 #   For more information on the format of a bloom filter file, see
+	 #   https://pwnedkeys.com/filter.html.
     #
     # @raise [Pwnedkeys::Request::Error] if the passed-in key representation
     #   can't be induced into something useable.
     #
-    def initialize(spki)
+    def initialize(spki, filter: nil)
+      @filter = filter
       @spki = if spki.is_a?(OpenSSL::X509::SPKI)
         spki
       elsif spki.is_a?(String)
@@ -67,6 +72,11 @@ module Pwnedkeys
     #   completed.
     #
     def pwned?
+      if @filter && !included_in_filter?
+        # Can't be pwned, the filter says so
+        return false
+      end
+
       retry_count = 10
       uri = URI(ENV["PWNEDKEYS_API_URL"] || "https://v1.pwnedkeys.com")
       uri.path += "/#{@spki.spki_fingerprint.hexdigest}"
@@ -204,5 +214,11 @@ module Pwnedkeys
         raise Error, "Unsupported key type #{@key.class}"
       end
     end
+
+    def included_in_filter?
+      Pwnedkeys::Filter.open(@filter) do |f|
+        f.probably_includes?(@spki)
+      end
+    end
   end
 end

data/pwnedkeys-api-client.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.5.0"
 
   s.add_runtime_dependency "openssl-additions"
+  s.add_runtime_dependency "pwnedkeys-filter"
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'github-release'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwnedkeys-api-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-25 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl-additions
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pwnedkeys-filter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -196,7 +210,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 the pwnedkeys.com API