ey-hmac 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0395ec2d5516cbf5d39c1490f0f84c9674da117158e4af1de439b98e3a60b03e'
-  data.tar.gz: d58723b34816d4555610989bfe9e6e0a93f75e735b82ca0853966cc9e0b171fc
+  metadata.gz: 1ea57d603aa108a1bf510fcf6e61aa45b1d1d0fca0ba7aa1b97681396fae9a7c
+  data.tar.gz: 7ad6caf49126be2b2a4b75acbc97ecf9d1898307a896f909493850be26d8261e
 SHA512:
-  metadata.gz: eae3a563262f394b556c11833269dc222018d54218378911cc6009dc185790cbc658ceb7350be3a89e667e580e28c3b6a0838393768bf5db9d576e55da5103ce
-  data.tar.gz: 2a720b806b64471333982dd534687f242f306d3276f653317e049a778b0e1a8830b0f37aabca8f0c260244c52bea6c2354e60ddb1279973404125dae93466d7a
+  metadata.gz: 6c790db93637c36fe752759cdb1aac1a70d3f1378ca5c2ae6b4132b8115d97b5e75b15e75de7dc069800980846d83524dbbe58903d9fd4b2006499e0ff8f9826
+  data.tar.gz: 6d8745e27b9c8d01d01d9f6bc608eba2f6fd6f8476a28eba9097dda9765944b8d5ba535be0901f151e69f4b66b9e1a2d022bdd29cbc38fc68a3ec9cacfaf2500

data/.rubocop.yml

@@ -23,6 +23,8 @@ Style/ClassAndModuleChildren:
   EnforcedStyle: compact
 Metrics/MethodLength:
   Enabled: false
+Metrics/ClassLength:
+  Enabled: false
 RSpec/ExampleLength:
   Enabled: false
 RSpec/MultipleExpectations:

data/lib/ey-hmac/adapter.rb

@@ -4,11 +4,19 @@
 # @abstract override methods {#method}, {#path}, {#body}, {#content_type} and {#content_digest}
 class Ey::Hmac::Adapter
   AUTHORIZATION_REGEXP = /\w+ ([^:]+):(.+)$/.freeze
+  DEFAULT_CANONICALIZE_WITH = %i[method content_type content_digest date path].freeze
 
   autoload :Rack, 'ey-hmac/adapter/rack'
   autoload :Faraday, 'ey-hmac/adapter/faraday'
 
-  attr_reader :request, :options, :authorization_header, :service, :sign_with, :accept_digests
+  attr_reader :request,
+              :options,
+              :authorization_header,
+              :service,
+              :sign_with,
+              :accept_digests,
+              :include_query_string,
+              :canonicalize_with
 
   # @param [Object] request signer-specific request implementation
   # @option options [Integer] :version signature version
@@ -16,6 +24,7 @@ class Ey::Hmac::Adapter
   # @option options [String] :authorization_header ('Authorization') Authorization header key.
   # @option options [String] :server ('EyHmac') service name prefixed to {#authorization}. set to {#service}
   # @option options [Symbol] :sign_with (:sha_256) outgoing signature digest algorithm. See {OpenSSL::Digest#new}
+  # @option options [Symbol] :include_query_string (false) canonicalize with the request query string.
   # @option options [Array] :accepted_digests ([:sha_256]) accepted incoming signature digest algorithm. See {OpenSSL::Digest#new}
   def initialize(request, options = {})
     @request = request
@@ -25,7 +34,11 @@ class Ey::Hmac::Adapter
     @authorization_header = options[:authorization_header] || 'Authorization'
     @service              = options[:service] || 'EyHmac'
     @sign_with            = options[:sign_with] || :sha256
-    @accept_digests       = Array(options[:accept_digests] || :sha256)
+    @include_query_string = options.fetch(:include_query_string, false)
+    @accept_digests = Array(options[:accept_digests] || :sha256)
+
+    @canonicalize_with = DEFAULT_CANONICALIZE_WITH
+    @canonicalize_with += :query_string if include_query_string
   end
 
   # In order for the server to correctly authorize the request, the client and server MUST AGREE on this format
@@ -33,7 +46,7 @@ class Ey::Hmac::Adapter
   # default canonical string formation is '{#method}\\n{#content_type}\\n{#content_digest}\\n{#date}\\n{#path}'
   # @return [String] canonical string used to form the {#signature}
   def canonicalize
-    [method, content_type, content_digest, date, path].join("\n")
+    canonicalize_with.map { |message| public_send(message) }.join("\n")
   end
 
   # @param [String] key_secret private HMAC key
@@ -129,8 +142,11 @@ class Ey::Hmac::Adapter
 
     check_ttl!
 
-    calculated_signatures = accept_digests.map { |ad| signature(key_secret, ad) }
-    matching_signature = calculated_signatures.any? { |cs| secure_compare(signature_value, cs) }
+    matching_signature =
+      accept_digests
+      .lazy
+      .map { |ad| signature(key_secret, ad) }
+      .any? { |cs| secure_compare(signature_value, cs) }
 
     raise Ey::Hmac::SignatureMismatch unless matching_signature
 

data/lib/ey-hmac/version.rb

@@ -2,6 +2,6 @@
 
 module Ey # rubocop:disable Style/ClassAndModuleChildren
   module Hmac
-    VERSION = '2.3.1'
+    VERSION = '2.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ey-hmac
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Josh Lane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-08 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler