linzer 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 026db131a5602b1f62b4f930086a0612b99f17a3aa6aa0eb649baa7bc8ba574b
-  data.tar.gz: 8f29e81e3083257c4731c9e408f4a66a95125fdb4d0678fd8d16cc410637d694
+  metadata.gz: 0befd6a2ae7ba008f6b2a343a24845be1941b6645615d8a029e698c083cd4481
+  data.tar.gz: ebd92e2c6b0991067753079c8b1bac87a6dfe644caa6380dedc63f88e74877e4
 SHA512:
-  metadata.gz: 6edb3a943f2bcf408ed865fe8bec013c3b13e609ea791981474a84bb21936b2e5fa61d86e64f9e9917c0a3e440e6246d443761c81cd94c094898c78423137789
-  data.tar.gz: 82074df18649f3f85af7c187762dbcf90b602c9748c9f6dba4695db42ee53ce24c5a546589f96011ab9d47564e1f9d2436a35616b54678e24f4222cd12f97837
+  metadata.gz: c7c5b9d9568402b2b4894ef8180c321281b420a156e7386abf12f069780a6ba7e2bc79d58bd0b7c97372058f974a25a1a138e9306434c28025e39f3267562b81
+  data.tar.gz: 7b997d06b2764171d5375baf1b889f4d98231961b86f89bea321155766932ffcd6913462df080f7edf09731d6d78332b474cda381ea4d0d8bdafba3dee76e6b3

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.5.2] - 2024-04-02
+
+- Make all unit tests pass on Ruby 3.0:
+  * Set minimum required version on openssl and uri gems.
+- Small refactor on ECDSA module.
+
+## [0.5.1] - 2024-04-01
+
+- Add support for additional derived components:
+  @target-uri, @scheme, @request-target, @query and @query-param.
+
 ## [0.5.0] - 2024-03-30
 
 - Build Linzer::Message instances from Rack request and response objects

data/README.md

@@ -1,4 +1,11 @@
-# Linzer
+# Linzer [![Latest Version][gem-badge]][gem-link] [![License: MIT][license-image]][license-link] [![CI Status][ci-image]][ci-link]
+
+[gem-badge]: https://badge.fury.io/rb/linzer.svg
+[gem-link]: https://rubygems.org/gems/linzer
+[license-image]: https://img.shields.io/badge/license-MIT-blue.svg
+[license-link]: https://github.com/nomadium/linzer/blob/master/LICENSE.txt
+[ci-image]: https://github.com/nomadium/linzer/actions/workflows/main.yml/badge.svg?branch=master
+[ci-link]: https://github.com/nomadium/linzer/actions/workflows/main.yml
 
 Linzer is a Ruby library for [HTTP Message Signatures (RFC 9421)](https://www.rfc-editor.org/rfc/rfc9421.html).
 
@@ -93,7 +100,10 @@ response = http.post("/some_uri", "data", headers.merge(signature.to_h))
 test_ed25519_key_pub = Base64.strict_encode64(key.material.verify_key.to_bytes)
 # => "EUra7KsJ8B/lSZJVhDaopMycmZ6T7KtJqKVNJTHKIw0="
 
-pubkey = Linzer.new_ed25519_public_key(test_ed25519_key_pub, "some-key-ed25519")
+raw_pubkey = Base64.strict_decode64(test_ed25519_key_pub)
+# => "\xB1rM\xFFR\x1F\xDDw\x00\x89\..."
+
+pubkey = Linzer.new_ed25519_public_key(raw_pubkey, "some-key-ed25519")
 # => #<Linzer::Ed25519::Key:0x00000fe19b9384b0
 
 # if you have to, there is a helper method to build a request object on the server side

data/lib/linzer/ecdsa.rb

@@ -18,23 +18,25 @@ module Linzer
 
       private
 
+      DIGEST_PARAMS = {
+        "SHA256" => {hex_format: "%.64x", hex_length: 64},
+        "SHA384" => {hex_format: "%.96x", hex_length: 96}
+      }
+      private_constant :DIGEST_PARAMS
+
       def der_signature(sig)
         digest = @params[:digest]
         msg = "Cannot verify invalid signature."
+        raise Linzer::Error.new(msg) unless DIGEST_PARAMS.key?(digest)
+        digest_params = DIGEST_PARAMS[digest]
+
+        l   = digest_params[:hex_length]
+        raise Linzer::Error.new(msg) if sig.length != l
+        h   = l / 2
+        fmt = "H#{l}"
 
-        case digest
-        when "SHA256"
-          raise Linzer::Error.new(msg) if sig.length != 64
-          r_bn = OpenSSL::BN.new(sig[0..31].unpack1("H64").to_i(16))
-          s_bn = OpenSSL::BN.new(sig[32..63].unpack1("H64").to_i(16))
-        when "SHA384"
-          raise Linzer::Error.new(msg) if sig.length != 96
-          r_bn = OpenSSL::BN.new(sig[0..47].unpack1("H96").to_i(16))
-          s_bn = OpenSSL::BN.new(sig[48..95].unpack1("H96").to_i(16))
-        else
-          msg = "Cannot verify signature, unsupported digest algorithm: '%s'" % digest
-          raise Linzer::Error.new(msg)
-        end
+        r_bn = OpenSSL::BN.new(sig[0..(h - 1)].unpack1(fmt).to_i(16))
+        s_bn = OpenSSL::BN.new(sig[h..(l - 1)].unpack1(fmt).to_i(16))
 
         r = OpenSSL::ASN1::Integer(r_bn)
         s = OpenSSL::ASN1::Integer(s_bn)
@@ -46,17 +48,15 @@ module Linzer
       def decode_der_signature(der_sig)
         digest = @params[:digest]
         msg = "Unsupported digest algorithm: '%s'" % digest
+        raise Linzer::Error.new(msg) unless DIGEST_PARAMS.key?(digest)
+        digest_params = DIGEST_PARAMS[digest]
+        fmt = "H#{digest_params[:hex_length]}"
+
         OpenSSL::ASN1
           .decode(der_sig)
           .value
-          .map do |n|
-            case digest
-            when "SHA256" then "%.64x" % n.value
-            when "SHA384" then "%.96x" % n.value
-            else raise Linzer::Error.new(msg)
-            end
-          end
-          .map { |s| [s].pack("H#{s.length}") }
+          .map { |bn| digest_params[:hex_format] % bn.value }
+          .map { |hex| [hex].pack(fmt) }
           .reduce(:<<)
           .encode(Encoding::ASCII_8BIT)
       end

data/lib/linzer/message.rb

@@ -25,20 +25,33 @@ module Linzer
       !!self[f]
     end
 
+    DERIVED_COMPONENT = {
+      "@method"         => :request_method,
+      "@authority"      => :authority,
+      "@path"           => :path_info,
+      "@status"         => :status,
+      "@target-uri"     => :url,
+      "@scheme"         => :scheme,
+      "@request-target" => :fullpath,
+      "@query"          => :query_string
+    }.freeze
+
     def [](field_name)
       if !field_name.start_with?("@")
         return @operation.env[Request.rack_header_name(field_name)] if request?
         return @operation.headers[field_name]                     # if response?
       end
 
+      method = DERIVED_COMPONENT[field_name]
+
       case field_name
-      when "@method"    then @operation.request_method
-      when "@authority" then @operation.authority
-      when "@path"      then @operation.path_info
-      when "@status"    then @operation.status
-      else # XXX: improve this and add support for all fields in the RFC
-        raise Error.new "Unknown/unsupported field: \"#{field_name}\""
+      when "@query"
+        return "?#{@operation.public_send(method)}"
+      when /\A(?<field>(?<prefix>@query-param)(?<rest>;name=.+)\Z)/
+        return parse_query_param Regexp.last_match
       end
+
+      method ? @operation.public_send(method) : nil
     end
 
     class << self
@@ -48,5 +61,17 @@ module Linzer
         raise Error.new "Cannot parse \"#{field_name}\" field. Bailing out!"
       end
     end
+
+    private
+
+    def parse_query_param(match_data)
+      raw_item    = '"%s"%s' % [match_data[:prefix], match_data[:rest]]
+      parsed_item = Starry.parse_item(raw_item)
+      fail unless parsed_item.value == "@query-param"
+      param_name  = URI.decode_uri_component(parsed_item.parameters["name"])
+      URI.encode_uri_component(@operation.params.fetch(param_name))
+    rescue => _
+      nil
+    end
   end
 end

data/lib/linzer/version.rb

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

data/lib/linzer.rb

@@ -3,6 +3,7 @@
 require "starry"
 require "openssl"
 require "rack"
+require "uri"
 
 require_relative "linzer/version"
 require_relative "linzer/common"

data/linzer.gemspec

@@ -29,7 +29,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "openssl", ">= 3.0.0"
   spec.add_runtime_dependency "ed25519", "~> 1.3", ">= 1.3.0"
   spec.add_runtime_dependency "starry", "~> 0.1"
   spec.add_runtime_dependency "rack", "~> 3.0"
+  spec.add_runtime_dependency "uri", ">= 0.12.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: linzer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Miguel Landaeta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-30 00:00:00.000000000 Z
+date: 2024-04-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: ed25519
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 description:
 email:
 - miguel@miguel.cc