linzer 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5767ac6b96b624e2098faa01e7cda512ca5f1530d6331c0a95c8f57a262da3d
-  data.tar.gz: 0ec39dbe4697fd2617770be2937ec062d5a9336ef5365dd3c3b028e541670903
+  metadata.gz: 760341bd66c313c36150f7cb31d741c84252ffe726ecd5bc838928b5f656832f
+  data.tar.gz: 6df1c1af21e5fbadc3eb242dc84973251ddc8dd6849606a2bd213ea57ffd9d89
 SHA512:
-  metadata.gz: c471b814bc6310ca41f60947df7a5097c738bb79e89720c3e7da0b7e331949b244bb0e030162363eb00bce411d3b2d6735615f3b529cd7e42815a4cee769b828
-  data.tar.gz: 3beaf6ab15820fb61473811d63da3f0bbd58653d62e58f193dd5709dd8e5e7b54914f420dbec61af557dcb9afd8da571ae0ab007ba39f7b19d48324084f30df7
+  metadata.gz: 899a41a945b59b368110befe463d300445d605483ef64020e1e35c12e71e0945f3b6aeb1774155cbc4919246f88fc0b77175fe16d2f4270e4bc57f861983f145
+  data.tar.gz: 8af02940869d0e451a8c45738f943cb32bdc515347d325121cafbb9c49e6e1e601d897749e2a5f9453f7c1f6a98acff59e778a5489ed70a60476f0086ab4bace

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [0.7.2] - 2025-05-21
+
+- Add a few integration tests against CloudFlare test server.
+
+- Fix bug when accessing headers in http adapter classes.
+  Pull request [#14](https://github.com/nomadium/linzer/pull/14)
+  by [oneiros](https://github.com/oneiros).
+
+## [0.7.1] - 2025-05-18
+
+- Introduce specific exception classes for message signing errors
+  and signature verification exceptions (i.e. Linzer::SigningError
+  and Linzer::VerifyError)
+
+- Fix bug in Linzer::HTTP client that prevented it from working with https URLs.
+
 ## [0.7.0] - 2025-05-17
 
 (No changes since the last beta release, this new stable release just

data/Rakefile

@@ -7,4 +7,10 @@ RSpec::Core::RakeTask.new(:spec)
 
 require "standard/rake"
 
+desc "Run RSpec integration examples"
+task :integration do
+  sh "bundle exec rspec -t integration spec/integration/**"
+end
+
 task default: %i[spec standard]
+task all: %i[integration default]

data/lib/linzer/http.rb

@@ -33,6 +33,8 @@ module Linzer
 
       req_uri = URI(uri)
       http = Net::HTTP.new(req_uri.host, req_uri.port)
+
+      http.use_ssl = req_uri.scheme == "https"
       http.set_debug_output($stderr) if options[:debug]
 
       headers    = build_headers(options[:headers] || {})
@@ -63,6 +65,7 @@ module Linzer
     end
 
     def build_headers(headers)
+      return headers if headers.transform_keys(&:downcase).key?("user-agent")
       headers.merge({"user-agent" => "Linzer/#{Linzer::VERSION}"})
     end
 

data/lib/linzer/message/adapter/abstract.rb

@@ -37,7 +37,7 @@ module Linzer
           end
         end
 
-        def headers
+        def header(name)
           raise Linzer::Error, "Sub-classes are required to implement this method!"
         end
 

data/lib/linzer/message/adapter/http_gem/request.rb

@@ -5,8 +5,8 @@ module Linzer
     module Adapter
       module HTTPGem
         class Request < Linzer::Message::Adapter::NetHTTP::Request
-          def headers
-            @operation.headers.to_h
+          def header(name)
+            @operation[name]
           end
 
           private

data/lib/linzer/message/adapter/http_gem/response.rb

@@ -14,8 +14,8 @@ module Linzer
             freeze
           end
 
-          def headers
-            @operation.headers
+          def header(name)
+            @operation[name]
           end
 
           # XXX: this implementation is incomplete, e.g.: ;tr parameter is not supported yet

data/lib/linzer/message/adapter/net_http/request.rb

@@ -12,8 +12,8 @@ module Linzer
             freeze
           end
 
-          def headers
-            @operation.each_header.to_h
+          def header(name)
+            @operation[name]
           end
 
           def attach!(signature)

data/lib/linzer/message/adapter/net_http/response.rb

@@ -13,8 +13,8 @@ module Linzer
             freeze
           end
 
-          def headers
-            @operation.each_header.to_h
+          def header(name)
+            @operation[name]
           end
 
           # XXX: this implementation is incomplete, e.g.: ;tr parameter is not supported yet

data/lib/linzer/message/adapter/rack/common.rb

@@ -74,11 +74,9 @@ module Linzer
             if has_tr
               value = tr(name)
             else
-              if request?
-                rack_header_name = rack_header_name(name.value.to_s)
-                value = @operation.env[rack_header_name]
-              end
-              value = @operation.headers[name.value.to_s] if response?
+              rack_header_name = rack_header_name(name.value.to_s)
+              value = @operation.env[rack_header_name] if request?
+              value = @operation.get_header(rack_header_name) if response?
             end
             value.dup&.strip
           end

data/lib/linzer/message/adapter/rack/request.rb

@@ -13,8 +13,8 @@ module Linzer
             freeze
           end
 
-          def headers
-            rack_request_headers(@operation)
+          def header(name)
+            @operation.get_header(rack_header_name(name))
           end
 
           def attach!(signature)

data/lib/linzer/message/adapter/rack/response.rb

@@ -16,12 +16,14 @@ module Linzer
             freeze
           end
 
-          def headers
-            @operation.headers
+          def header(name)
+            @operation.get_header(rack_header_name(name))
           end
 
           def attach!(signature)
-            signature.to_h.each { |h, v| @operation[h] = v }
+            signature.to_h.each do |h, v|
+              @operation.set_header(rack_header_name(h), v)
+            end
             @operation
           end
         end

data/lib/linzer/message.rb

@@ -15,7 +15,7 @@ module Linzer
     def_delegators :@adapter, :request?, :response?, :attached_request?
 
     # fields look up
-    def_delegators :@adapter, :headers, :field?, :[]
+    def_delegators :@adapter, :header, :field?, :[]
 
     # to attach a signature to the underlying HTTP message
     def_delegators :@adapter, :attach!

data/lib/linzer/signer.rb

@@ -27,11 +27,15 @@ module Linzer
 
       def validate(key, message, components)
         msg = "Message cannot be signed with null %s"
-        raise Error.new msg % "value"     if message.nil?
-        raise Error.new msg % "key"       if key.nil?
-        raise Error.new msg % "component" if components.nil?
-
-        validate_components message, components
+        raise SigningError, msg % "value"     if message.nil?
+        raise SigningError, msg % "key"       if key.nil?
+        raise SigningError, msg % "component" if components.nil?
+
+        begin
+          validate_components message, components
+        rescue Error => ex
+          raise SigningError, ex.message, cause: ex
+        end
       end
 
       def populate_parameters(key, options)

data/lib/linzer/verifier.rb

@@ -19,26 +19,35 @@ module Linzer
       private
 
       def validate(message, key, signature, no_older_than: nil)
-        raise Error.new "Message to verify cannot be null"       if message.nil?
-        raise Error.new "Key to verify signature cannot be null" if key.nil?
-        raise Error.new "Signature to verify cannot be null"     if signature.nil?
+        raise VerifyError, "Message to verify cannot be null"       if message.nil?
+        raise VerifyError, "Key to verify signature cannot be null" if key.nil?
+        raise VerifyError, "Signature to verify cannot be null"     if signature.nil?
 
         if !signature.respond_to?(:value) || !signature.respond_to?(:components)
-          raise Error.new "Signature is invalid"
+          raise VerifyError, "Signature is invalid"
         end
 
-        raise Error.new "Signature raw value to cannot be null" if signature.value.nil?
-        raise Error.new "Components cannot be null"             if signature.components.nil?
+        raise VerifyError, "Signature raw value to cannot be null" if signature.value.nil?
+        raise VerifyError, "Components cannot be null"             if signature.components.nil?
 
-        validate_components message, signature.components
+        begin
+          validate_components message, signature.components
+        rescue Error => ex
+          raise VerifyError, ex.message, cause: ex
+        end
 
         return unless no_older_than
-        raise Error.new "Signature created more than #{no_older_than} seconds ago" if signature.older_than?(no_older_than.to_i)
+        old_sig_msg = "Signature created more than #{no_older_than} seconds ago"
+        begin
+          raise VerifyError, old_sig_msg if signature.older_than?(no_older_than.to_i)
+        rescue Error => ex
+          raise VerifyError, ex.message, cause: ex
+        end
       end
 
       def verify_or_fail(key, signature, data)
         return true if key.verify(signature, data)
-        raise Error.new "Failed to verify message: Invalid signature."
+        raise VerifyError, "Failed to verify message: Invalid signature."
       end
     end
   end

data/lib/linzer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Linzer
-  VERSION = "0.7.0"
+  VERSION = "0.7.2"
 end

data/lib/linzer.rb

@@ -29,6 +29,10 @@ require_relative "rack/auth/signature"
 module Linzer
   class Error < StandardError; end
 
+  class VerifyError < Error; end
+
+  class SigningError < Error; end
+
   class << self
     include Key::Helper
 
@@ -55,7 +59,12 @@ module Linzer
 
     def verify!(request_or_response, key: nil, no_older_than: 900)
       message = Message.new(request_or_response)
-      signature = Signature.build(message.headers.slice("signature", "signature-input"))
+      signature_headers = {}
+      %w[signature-input signature].each do |name|
+        value = message.header(name)
+        signature_headers[name] = value if value
+      end
+      signature = Signature.build(signature_headers)
       keyid = signature.parameters["keyid"]
       raise Linzer::Error, "key not found" if !key && !keyid
       verify_key = block_given? ? (yield keyid) : key

data/lib/rack/auth/signature.rb

@@ -67,7 +67,12 @@ module Rack
         signature_opts[:label] = label if label
 
         @message = Linzer::Message.new(request)
-        signature = Linzer::Signature.build(@message.headers, **signature_opts)
+        signature_headers = {}
+        %w[signature-input signature].each do |name|
+          value = @message.header(name)
+          signature_headers[name] = value if value
+        end
+        signature = Linzer::Signature.build(signature_headers, **signature_opts)
         request.env["rack.signature"] = signature
         signature
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: linzer
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Miguel Landaeta