linzer 0.7.0.beta2 → 0.7.0.beta4

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "cgi"
+
+module Linzer
+  class Message
+    module Adapter
+      module NetHTTP
+        class Request < Abstract
+          def initialize(operation, **options)
+            @operation = operation
+            freeze
+          end
+
+          def headers
+            @operation.each_header.to_h
+          end
+
+          def attach!(signature)
+            signature.to_h.each { |h, v| @operation[h] = v }
+            @operation
+          end
+
+          private
+
+          def derived(name)
+            case name.value
+            when :method           then @operation.method
+            when :"target-uri"     then @operation.uri.to_s
+            when :authority        then @operation.uri.authority.downcase
+            when :scheme           then @operation.uri.scheme.downcase
+            when :"request-target" then @operation.uri.request_uri
+            when :path             then @operation.uri.path
+            when :query            then "?%s" % String(@operation.uri.query)
+            when :"query-param"    then query_param(name)
+            end
+          end
+
+          def query_param(name)
+            param_name = name.parameters["name"]
+            return nil if !param_name
+            decoded_param_name = URI.decode_uri_component(param_name)
+            params = CGI.parse(@operation.uri.query)
+            URI.encode_uri_component(params[decoded_param_name]&.first)
+          end
+
+          def field(name)
+            has_tr = name.parameters["tr"]
+            return nil if has_tr # HTTP requests don't have trailer fields
+            value = @operation[name.value.to_s]
+            value.dup&.strip
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Linzer
+  class Message
+    module Adapter
+      module NetHTTP
+        class Response < Abstract
+          def initialize(operation, **options)
+            @operation = operation
+            attached_request = options[:attached_request]
+            @attached_request = attached_request ? Message.new(attached_request) : nil
+            validate_attached_request @attached_request if @attached_request
+            freeze
+          end
+
+          def headers
+            @operation.each_header.to_h
+          end
+
+          # XXX: this implementation is incomplete, e.g.: ;tr parameter is not supported yet
+          def [](field_name)
+            return @operation.code.to_i if field_name == "@status"
+            @operation[field_name]
+          end
+
+          def attach!(signature)
+            signature.to_h.each { |h, v| @operation[h] = v }
+            @operation
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Linzer
+  class Message
+    module Adapter
+      module Rack
+        module Common
+          DERIVED_COMPONENT = {
+            method:           :request_method,
+            authority:        :authority,
+            path:             :path_info,
+            status:           :status,
+            "target-uri":     :url,
+            scheme:           :scheme,
+            "request-target": :fullpath,
+            query:            :query_string
+          }.freeze
+          private_constant :DERIVED_COMPONENT
+
+          private
+
+          def validate
+            msg = "Message instance must be an HTTP request or response"
+            raise Error.new msg if response? == request?
+          end
+
+          def validate_header_name(name)
+            raise ArgumentError.new, "Blank header name." if name.empty?
+            name.to_str
+          rescue => ex
+            err_msg = "Invalid header name: '#{name}'"
+            raise Linzer::Error.new, err_msg, cause: ex
+          end
+
+          def rack_header_name(field_name)
+            validate_header_name field_name
+
+            rack_name = field_name.upcase.tr("-", "_")
+            case field_name.downcase
+            when "content-type", "content-length"
+              rack_name
+            else
+              "HTTP_#{rack_name}"
+            end
+          end
+
+          def rack_request_headers(rack_request)
+            rack_request
+              .each_header
+              .to_h
+              .select do |k, _|
+                k.start_with?("HTTP_") || %w[CONTENT_TYPE CONTENT_LENGTH].include?(k)
+              end
+              .transform_keys { |k| k.downcase.tr("_", "-") }
+              .transform_keys do |k|
+                %w[content-type content-length].include?(k) ? k : k.gsub(/^http-/, "")
+              end
+          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 = 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
+            return value.downcase if %i[authority scheme].include?(method)
+            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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Linzer
+  class Message
+    module Adapter
+      module Rack
+        class Request < Abstract
+          include Common
+
+          def initialize(operation, **options)
+            @operation = operation
+            validate
+            freeze
+          end
+
+          def headers
+            rack_request_headers(@operation)
+          end
+
+          def attach!(signature)
+            signature.to_h.each do |h, v|
+              @operation.set_header(rack_header_name(h), v)
+            end
+            @operation
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Linzer
+  class Message
+    module Adapter
+      module Rack
+        class Response < Abstract
+          include Common
+
+          def initialize(operation, **options)
+            @operation = operation
+            validate
+            attached_request = options[:attached_request]
+            @attached_request = attached_request ? Message.new(attached_request) : nil
+            validate_attached_request @attached_request if @attached_request
+            freeze
+          end
+
+          def headers
+            @operation.headers
+          end
+
+          def attach!(signature)
+            signature.to_h.each { |h, v| @operation[h] = v }
+            @operation
+          end
+        end
+      end
+    end
+  end
+end

data/lib/linzer/message/adapter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "adapter/abstract"
+require_relative "adapter/rack/common"
+require_relative "adapter/rack/request"
+require_relative "adapter/rack/response"
+require_relative "adapter/net_http/request"
+require_relative "adapter/net_http/response"

data/lib/linzer/message/wrapper.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Linzer
+  class Message
+    module Wrapper
+      @adapters = {
+        Rack::Request     => Linzer::Message::Adapter::Rack::Request,
+        Rack::Response    => Linzer::Message::Adapter::Rack::Response,
+        Net::HTTPRequest  => Linzer::Message::Adapter::NetHTTP::Request,
+        Net::HTTPResponse => Linzer::Message::Adapter::NetHTTP::Response
+      }
+
+      class << self
+        def wrap(operation, **options)
+          adapter_class = adapters[operation.class]
+
+          if !adapter_class
+            ancestor = find_ancestor(operation)
+            fail_with_unsupported(operation) unless ancestor
+          end
+
+          (adapter_class || ancestor).new(operation, **options)
+        end
+
+        def register_adapter(operation_class, adapter_class)
+          adapters[operation_class] = adapter_class
+        end
+
+        private
+
+        attr_reader :adapters
+
+        def find_ancestor(operation)
+          adapters
+            .select { |klz, adpt| operation.is_a? klz }
+            .values
+            .first
+        end
+
+        def fail_with_unsupported(operation)
+          err_msg = <<~EOM
+            Unknown/unsupported HTTP message class: '#{operation.class}'!
+
+            Linzer supports custom HTTP messages implementation by register them first
+            with `Linzer::Message.register_adapter` method.
+          EOM
+          raise Linzer::Error, err_msg
+        end
+      end
+    end
+  end
+end

data/lib/linzer/message.rb

@@ -1,207 +1,28 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module Linzer
   class Message
+    extend Forwardable
+
     def initialize(operation, attached_request: nil)
-      @operation = operation
-      validate
-      @attached_request = attached_request ? Message.new(attached_request) : nil
+      @adapter = Wrapper.wrap(operation, attached_request: attached_request)
       freeze
     end
 
-    def request?
-      @operation.is_a?(Rack::Request) || @operation.respond_to?(:request_method)
-    end
-
-    def response?
-      @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)
+    # common predicates
+    def_delegators :@adapter, :request?, :response?, :attached_request?
 
-      Request.headers(@operation)
-    end
-
-    def field?(f)
-      !!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
+    # fields look up
+    def_delegators :@adapter, :headers, :field?, :[]
 
-    def [](field_name)
-      name = parse_field_name(field_name)
-      return nil if name.nil?
-
-      if field_name.start_with?("@")
-        retrieve(name, :derived)
-      else
-        retrieve(name, :field)
-      end
-    end
+    # to attach a signature to the underlying HTTP message
+    def_delegators :@adapter, :attach!
 
     class << self
-      def parse_structured_dictionary(str, field_name = nil)
-        Starry.parse_dictionary(str)
-      rescue Starry::ParseError => _
-        raise Error.new "Cannot parse \"#{field_name}\" field. Bailing out!"
-      end
-    end
-
-    private
-
-    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 validate_parameters(name, method)
-      has_unknown = name.parameters.any? { |p, _| !KNOWN_PARAMETERS.include?(p) }
-      return nil if has_unknown
-
-      has_name = name.parameters["name"]
-      has_req  = name.parameters["req"]
-      has_sf   = name.parameters["sf"] || name.parameters.key?("key")
-      has_bs   = name.parameters["bs"]
-      value    = name.value
-
-      # Section 2.2.8 of RFC 9421
-      return nil if has_name && value != :"query-param"
-
-      # No derived values come from trailers section
-      return nil if method == :derived && name.parameters["tr"]
-
-      # From: 2.1. HTTP Fields:
-      # The bs parameter, which requires the raw bytes of the field values
-      # from the message, is not compatible with the use of the sf or key
-      # parameters, which require the parsed data structures of the field
-      # values after combination
-      return nil if has_sf && has_bs
-
-      # req param only makes sense on responses with an associated request
-      return nil if has_req && (!response? || !attached_request?)
-
-      name
-    end
-
-    KNOWN_PARAMETERS = %w[sf key bs req tr name]
-    private_constant :KNOWN_PARAMETERS
-
-    def retrieve(name, method)
-      if !name.parameters.empty?
-        valid_params = validate_parameters(name, method)
-        return nil if !valid_params
-      end
-
-      has_req = name.parameters["req"]
-      has_sf  = name.parameters["sf"] || name.parameters.key?("key")
-      has_bs  = name.parameters["bs"]
-
-      if has_req
-        name.parameters.delete("req")
-        return req(name, method)
-      end
-
-      value = send(method, name)
-
-      case
-      when has_sf
-        key = name.parameters["key"]
-        sf(value, key)
-      when has_bs then bs(value)
-      else value
-      end
-    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
-      return value.downcase if %i[authority scheme].include?(method)
-      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)
-
-      if key
-        obj = dict[key]
-        Starry.serialize(obj.is_a?(Starry::InnerList) ? [obj] : obj)
-      else
-        Starry.serialize(dict)
-      end
-    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]
+      def register_adapter(operation_class, adapter_class)
+        Wrapper.register_adapter(operation_class, adapter_class)
       end
     end
   end

data/lib/linzer/options.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Linzer
+  module Options
+    DEFAULT = {
+      covered_components: %w[@method @request-target @authority date]
+    }.freeze
+  end
+end

data/lib/linzer/signature.rb

@@ -86,11 +86,17 @@ module Linzer
         raise Error.new "Unexpected value for covered components."
       end
 
+      def parse_structured_dictionary(str, field_name = nil)
+        Starry.parse_dictionary(str)
+      rescue Starry::ParseError => _
+        raise Error.new "Cannot parse \"#{field_name}\" field. Bailing out!"
+      end
+
       def parse_structured_field(hsh, field_name)
         # Serialized Structured Field values for HTTP are ASCII strings.
         # See: RFC 8941 (https://datatracker.ietf.org/doc/html/rfc8941)
         value = hsh[field_name].encode(Encoding::US_ASCII)
-        Message.parse_structured_dictionary(value, field_name)
+        parse_structured_dictionary(value, field_name)
       end
     end
   end

data/lib/linzer/version.rb

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

data/lib/linzer.rb

@@ -5,12 +5,14 @@ require "openssl"
 require "rack"
 require "uri"
 require "stringio"
+require "net/http"
 
 require_relative "linzer/version"
 require_relative "linzer/common"
-require_relative "linzer/request"
-require_relative "linzer/response"
+require_relative "linzer/options"
 require_relative "linzer/message"
+require_relative "linzer/message/adapter"
+require_relative "linzer/message/wrapper"
 require_relative "linzer/signature"
 require_relative "linzer/key"
 require_relative "linzer/rsa"
@@ -21,6 +23,7 @@ require_relative "linzer/ecdsa"
 require_relative "linzer/key/helper"
 require_relative "linzer/signer"
 require_relative "linzer/verifier"
+require_relative "linzer/http"
 require_relative "rack/auth/signature"
 
 module Linzer
@@ -28,11 +31,6 @@ module Linzer
 
   class << self
     include Key::Helper
-    include Response
-
-    def new_request(verb, uri = "/", params = {}, headers = {})
-      Linzer::Request.build(verb, uri, params, headers)
-    end
 
     def verify(pubkey, message, signature, no_older_than: nil)
       Linzer::Verifier.verify(pubkey, message, signature, no_older_than: no_older_than)
@@ -41,5 +39,27 @@ module Linzer
     def sign(key, message, components, options = {})
       Linzer::Signer.sign(key, message, components, options)
     end
+
+    def sign!(request_or_response, **args)
+      message = Message.new(request_or_response)
+      options = {}
+
+      label = args[:label]
+      options[:label] = label if label
+      options.merge!(args.fetch(:params, {}))
+
+      key = args.fetch(:key)
+      signature = Linzer::Signer.sign(key, message, args.fetch(:components), options)
+      message.attach!(signature)
+    end
+
+    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"))
+      keyid = signature.parameters["keyid"]
+      raise Linzer::Error, "key not found" if !key && !keyid
+      verify_key = block_given? ? (yield keyid) : key
+      Linzer.verify(verify_key, message, signature, no_older_than: no_older_than)
+    end
   end
 end

data/lib/rack/auth/signature/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 
 module Rack

data/lib/rack/auth/signature.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "linzer"
 require "logger"
 require_relative "signature/helpers"