linzer 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1955734eb1a8115753448b579b0cbe84f7d1ad247677ae20dd49495841b4aef3
-  data.tar.gz: abf9b2fbc465f10210c77f3d29e10c7e15af26a5badba90516f0b96050e3a548
+  metadata.gz: c09a63a7eae654921b40e0462b463b3e70867522fcedaf42f03373dd72ef55a5
+  data.tar.gz: b5fea79104954db4289fbf7e4df9f8e589827943cb62eb2836bd0b970611263a
 SHA512:
-  metadata.gz: 5263ec042dd91dc5bc434f4bbccc8f17d0ec52c751b7b9adec613c87efa180175cc7e5b4f47da007e6e61298a2b153f9ca05250ba3d55786c2d5609725233903
-  data.tar.gz: 45ad9720b910f441bf36f9766ec10eaaab64fb7a36f420b947a5170d9cae0d18d540f380996eba2265b6faa0df0b9537fb1c8b2b2e58c94bab45abcaccb19112
+  metadata.gz: 89572382dde42b597eeafecceca1572222cff5d20bba50345b0e3849f47d510cdbcfbc0988295e16b783aa9d28235a95e56b49302a53577e744dc8575253a419
+  data.tar.gz: bc8c2850994c211b4549dcd07d64ddb14fd54d948a05153d8011042eb4cd2b4adca4d8f80ab983a8c8c71deefc2473994fa479ec8b7ec00063dfa86ead7be7a4

data/.standard.yml

@@ -3,9 +3,7 @@
 ruby_version: 2.6
 
 ignore:
-  - 'lib/**/*':
-    - Layout/ExtraSpacing
-    - Layout/HashAlignment
-  - 'spec/**/*':
+  - '**/*':
     - Layout/ExtraSpacing
     - Layout/HashAlignment
+    - Layout/ArgumentAlignment

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.6.0] - 2024-04-06
+
+- Support parameters on HTTP field component identifiers.
+
+- Add a work-around for failed unit-tests in ruby HEAD CI jobs.
+
+- Set up simplecov and improve unit-tests coverage.
+
+## [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:

data/README.md

@@ -159,6 +159,9 @@ Please note that is still early days and extensive testing is still ongoing. For
 I'll be expanding the library to cover more functionality specified in the RFC
 in subsequent releases.
 
+## Ruby version compatibility
+
+linzer is built in [Continuous Integration](https://github.com/nomadium/linzer/actions/workflows/main.yml) on Ruby 3.0+.
 
 ## Development
 

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

@@ -2,8 +2,10 @@
 
 module Linzer
   class Message
-    def initialize(operation)
+    def initialize(operation, attached_request: nil)
       @operation = operation
+      validate
+      @attached_request = attached_request ? Message.new(attached_request) : nil
       freeze
     end
 
@@ -15,6 +17,10 @@ module Linzer
       @operation.is_a?(Rack::Response) || @operation.respond_to?(:status)
     end
 
+    def attached_request?
+      !!@attached_request
+    end
+
     def headers
       return @operation.headers if response? || @operation.respond_to?(:headers)
 
@@ -26,32 +32,26 @@ module Linzer
     end
 
     DERIVED_COMPONENT = {
-      "@method"         => :request_method,
-      "@authority"      => :authority,
-      "@path"           => :path_info,
-      "@status"         => :status,
-      "@target-uri"     => :url,
-      "@scheme"         => :scheme,
-      "@request-target" => :fullpath,
-      "@query"          => :query_string
+      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
+      name = parse_field_name(field_name)
+      return nil if name.nil?
 
-      method = DERIVED_COMPONENT[field_name]
-
-      case 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
+      if field_name.start_with?("@")
+        return nil if name.parameters["tr"]
+        retrieve(name, :derived)
+      else
+        retrieve(name, :field)
       end
-
-      method ? @operation.public_send(method) : nil
     end
 
     class << self
@@ -64,14 +64,105 @@ module Linzer
 
     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))
+    def validate
+      msg = "Message instance must be an HTTP request or response"
+      raise Error.new msg if response? == request?
+    end
+
+    def parse_field_name(field_name)
+      if field_name&.start_with?("@")
+        Starry.parse_item(field_name[1..])
+      else
+        Starry.parse_item(field_name)
+      end
+    rescue => _
+      nil
+    end
+
+    def retrieve(name, method)
+      has_req = name.parameters["req"]
+      has_sf  = name.parameters["sf"] || name.parameters.key?("key")
+      has_bs  = name.parameters["bs"]
+
+      return nil if has_req && (!response? || !attached_request?)
+
+      if has_req
+        name.parameters.delete("req")
+        return req(name, method)
+      end
+
+      value = send(method, name)
+
+      key = name.parameters["key"]
+      value = sf(value, key) if has_sf
+      value = bs(value)      if has_bs
+      value
+    end
+
+    def derived(name)
+      method = DERIVED_COMPONENT[name.value]
+
+      value = case name.value
+      when :query         then derive(@operation, method)
+      when :"query-param" then query_param(name)
+      end
+
+      return nil if !method && !value
+      value || derive(@operation, method)
+    end
+
+    def field(name)
+      has_tr = name.parameters["tr"]
+      if has_tr
+        value = tr(name)
+      else
+        if request?
+          rack_header_name = Request.rack_header_name(name.value.to_s)
+          value = @operation.env[rack_header_name]
+        end
+        value = @operation.headers[name.value.to_s] if response?
+      end
+      value.dup&.strip
+    end
+
+    def derive(operation, method)
+      return nil unless operation.respond_to?(method)
+      value = operation.public_send(method)
+      return "?" + value if method == :query_string
+      value
+    end
+
+    def query_param(name)
+      param_name = name.parameters["name"]
+      return nil if !param_name
+      decoded_param_name = URI.decode_uri_component(param_name)
+      URI.encode_uri_component(@operation.params.fetch(decoded_param_name))
     rescue => _
       nil
     end
+
+    def sf(value, key = nil)
+      dict = Starry.parse_dictionary(value)
+
+      obj = dict[key] if key
+      return Starry.serialize(obj.is_a?(Starry::InnerList) ? [obj] : obj) if key
+
+      Starry.serialize(dict)
+    end
+
+    def bs(value)
+      Starry.serialize(value.encode(Encoding::ASCII_8BIT))
+    end
+
+    def tr(trailer)
+      @operation.body.trailers[trailer.value.to_s]
+    end
+
+    def req(field, method)
+      case method
+      when :derived then @attached_request["@#{field}"]
+      when :field   then @attached_request[field.to_s]
+      end
+    end
   end
 end

data/lib/linzer/request.rb

@@ -84,6 +84,7 @@ module Linzer
     def build_rack_env(headers)
       headers
         .to_hash
+        .transform_values(&:to_s)
         .transform_keys { |k| k.upcase.tr("-", "_") }
         .transform_keys do |k|
           %w[CONTENT_TYPE CONTENT_LENGTH].include?(k) ? k : "HTTP_#{k}"

data/lib/linzer/response.rb

@@ -3,7 +3,7 @@
 module Linzer
   module Response
     def new_response(body = nil, status = 200, headers = {})
-      Rack::Response.new(body, status, headers)
+      Rack::Response.new(body, status, headers.transform_values(&:to_s))
     end
   end
 end

data/lib/linzer/version.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
 module Linzer
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
+
+  def self.ruby_dev?
+    RUBY_ENGINE == "ruby" && RUBY_PATCHLEVEL == -1 && /\Aruby 3.[0-9].0dev/ =~ RUBY_DESCRIPTION
+  end
 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", ">= 3.0.0"
   spec.add_runtime_dependency "ed25519", "~> 1.3", ">= 1.3.0"
-  spec.add_runtime_dependency "starry", "~> 0.1"
+  spec.add_runtime_dependency "starry", "~> 0.1" unless Linzer.ruby_dev?
   spec.add_runtime_dependency "rack", "~> 3.0"
+  spec.add_runtime_dependency "uri", "~> 0.12", ">= 0.12.0"
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: linzer
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Miguel Landaeta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-01 00:00:00.000000000 Z
+date: 2024-04-06 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'
+    - - ">="
+      - !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: ed25519
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +78,26 @@ 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'
+    - - ">="
+      - !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 description:
 email:
 - miguel@miguel.cc