hmac 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b341ba62c9eaddb7ec4b369cdfb13557a4b5ff7aac0e3c5c4d1c6f99fc60bfd4
-  data.tar.gz: 9e6d858c85ff46d7ed1678db9d3d4a97307d7b52a56ecb18f9dc12974e0b1588
+  metadata.gz: 7888837728c6bb09e5e14affacdb43a21f11da744c0764bb4ef5a9b57ed0a62b
+  data.tar.gz: 05ecca95e1798456adb1e5b81201ac8bafdbe981b897a688ebd7bf7a29d270f0
 SHA512:
-  metadata.gz: 7a82f8525db4569fb753d198d0ab90c4c9f117f071792938a0927e5613377e84521753a4c25c6931a2941a67621687ebc2e3a30a70115b3901c7105f8663f196
-  data.tar.gz: 7b59569d8bd181c819ee8661a549177b66710454ae22bf366df3117bcafe3e9871a2d1590e831d4e3ef0671bed5f71847d78332f65e22ef23d7537f909cf202a
+  metadata.gz: 4112f07d1dee0c90e7e5f2a878998401cb1fa8b6b7989a7e5693e8ecfa78acb03ced551a070091a9e2539aa30295c029023a72b1ed3462aaf3665a6c63860ba8
+  data.tar.gz: d9256aa9cb5973a34f2a0dfc045f6a24b60603574077d259d9d89a399793c7128dfa770039417f63440c28298e6aa8e6140f65250437b4a1da76f87b6556b114

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [2.1.0] - 2022-04-16
+
+- Allow calling code to override the HMAC secret at runtime
+- Allow the encoding of extra fields into the HMAC (e.g. email address)
+
 ## [2.0.0] - 2022-04-13
 
 - Add a configuration class and remove direct env var access

data/bin/release

@@ -0,0 +1,4 @@
+gem build
+gem push hmac-$1.gem
+git tag $1
+git push --tags

data/lib/hmac/generator.rb

@@ -1,19 +1,23 @@
 module HMAC
   class Generator
-    def initialize(context:, public: false)
+    def initialize(context:, public: false, secret: nil)
       @context = context
       @public = public
       @digest = OpenSSL::Digest.new("SHA256")
-      @hmac_key = HMAC.configuration.secret
+      @hmac_key = secret || HMAC.configuration.secret
+
+      raise ConfigurationError, "HMAC secret is not configured" if @hmac_key.nil?
     end
 
-    def generate(id:)
-      OpenSSL::HMAC
-        .new(hmac_key, digest)
-        .update(id.to_s)
-        .update(context)
-        .tap { |hmac| hmac.update("public") if public? }
-        .hexdigest
+    def generate(id:, extra_fields: {})
+      OpenSSL::HMAC.new(hmac_key, digest).tap do |hmac|
+        hmac.update(id.to_s)
+        hmac.update(context.to_s)
+        hmac.update("public") if public?
+        extra_fields.sort.each do |_, value|
+          hmac.update(value.to_s)
+        end
+      end.hexdigest
     end
 
   private

data/lib/hmac/validator.rb

@@ -1,11 +1,13 @@
+require_relative "generator"
+
 module HMAC
   class Validator
     def initialize(...)
-      @generator = HMAC::Generator.new(...)
+      @generator = Generator.new(...)
     end
 
-    def validate(hmac, against_id:)
-      present?(hmac) && hmac == @generator.generate(id: against_id)
+    def validate(hmac, against_id:, extra_fields: {})
+      present?(hmac) && hmac == @generator.generate(id: against_id, extra_fields:)
     end
 
   private

data/lib/hmac/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HMAC
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/hmac.rb

@@ -14,6 +14,7 @@ module HMAC
   end
 
   HMACConfiguration = Struct.new("HMACConfiguration", :secret)
+  class ConfigurationError < StandardError; end
 end
 
 require_relative "hmac/generator"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hmac
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Elliot Crosby-McCullough
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-13 00:00:00.000000000 Z
+date: 2022-04-16 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -29,6 +29,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/release
 - bin/setup
 - hmac.gemspec
 - lib/hmac.rb
@@ -41,7 +42,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/SmartCasual/hmac
   source_code_uri: https://github.com/SmartCasual/hmac
-  changelog_uri: https://github.com/SmartCasual/hmac/blob/2.0.0/CHANGELOG.md
+  changelog_uri: https://github.com/SmartCasual/hmac/blob/2.1.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []