bayserver-docker-ajp 2.2.0

data/lib/baykit/bayserver/docker/ajp/command/cmd_forward_request.rb

@@ -0,0 +1,288 @@
+require 'baykit/bayserver/docker/ajp/ajp_command'
+require 'baykit/bayserver/docker/ajp/ajp_type'
+require 'baykit/bayserver/protocol/protocol_exception'
+require 'baykit/bayserver/util/headers'
+
+#
+#  AJP protocol
+#     https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html
+# 
+#  AJP13_FORWARD_REQUEST :=
+#      prefix_code      (byte) 0x02 = JK_AJP13_FORWARD_REQUEST
+#      method           (byte)
+#      protocol         (string)
+#      req_uri          (string)
+#      remote_addr      (string)
+#      remote_host      (string)
+#      server_name      (string)
+#      server_port      (integer)
+#      is_ssl           (boolean)
+#      num_headers      (integer)
+#      request_headers(req_header_name req_header_value)
+#      attributes     (attribut_name attribute_value)
+#      request_terminator (byte) OxFF
+#
+module Baykit
+  module BayServer
+    module Docker
+      module Ajp
+        module Command
+          class CmdForwardRequest < Baykit::BayServer::Docker::Ajp::AjpCommand
+            include Baykit::BayServer::Protocol
+            include Baykit::BayServer::Util
+
+            class << self
+              attr :method_map
+              attr :well_known_header_map
+              attr :attribute_name_map
+            end
+
+            @method_map = {
+              1 => "OPTIONS",
+              2 => "GET",
+              3 => "HEAD",
+              4 => "POST",
+              5 => "PUT",
+              6 => "DELETE",
+              7 => "TRACE",
+              8 => "PROPFIND",
+              9 => "PROPPATCH",
+              10 => "MKCOL",
+              11 => "COPY",
+              12 => "MOVE",
+              13 => "LOCK",
+              14 => "UNLOCK",
+              15 => "ACL",
+              16 => "REPORT",
+              17 => "VERSION_CONTROL",
+              18 => "CHECKIN",
+              19 => "CHECKOUT",
+              20 => "UNCHECKOUT",
+              21 => "SEARCH",
+              22 => "MKWORKSPACE",
+              23 => "UPDATE",
+              24 => "LABEL",
+              25 => "MERGE",
+              26 => "BASELINE_CONTROL",
+              27 => "MKACTIVITY",
+            }
+
+            def self.get_method_code(method)
+              @method_map.keys.each do |key|
+                if @method_map[key].casecmp? method
+                  return key
+                end
+              end
+              return -1
+            end
+
+
+            @well_known_header_map =  {
+              0xA001 => "Accept",
+              0xA002 => "Accept-Charset",
+              0xA003 => "Accept-Encoding",
+              0xA004 => "Accept-Language",
+              0xA005 => "Authorization",
+              0xA006 => "Connection",
+              0xA007 => "Content-Type",
+              0xA008 => "Content-Length",
+              0xA009 => "Cookie",
+              0xA00A => "Cookie2",
+              0xA00B => "Host",
+              0xA00C => "Pragma",
+              0xA00D => "Referer",
+              0xA00E => "User-Agent",
+            }
+
+            def self.get_well_known_header_code(name)
+              @well_known_header_map.keys.each do |key|
+                if @well_known_header_map[key].casecmp? name
+                  return key
+                end
+              end
+              return -1
+            end
+
+
+            @attribute_name_map = {
+              0x01 => "?context",
+              0x02 => "?servlet_path",
+              0x03 => "?remote_user",
+              0x04 => "?auth_type",
+              0x05 => "?query_string",
+              0x06 => "?route",
+              0x07 => "?ssl_cert",
+              0x08 => "?ssl_cipher",
+              0x09 => "?ssl_session",
+              0x0A => "?req_attribute",
+              0x0B => "?ssl_key_size",
+              0x0C => "?secret",
+              0x0D => "?stored_method",
+            }
+
+            def self.get_attribute_code(atr)
+              @attribute_name_map.keys.each do |key|
+                if @attribute_name_map[key].casecmp?(atr)
+                  return key
+                end
+              end
+              return -1
+            end
+
+            attr_accessor :method
+            attr_accessor :protocol
+            attr_accessor :req_uri
+            attr_accessor :remote_addr
+            attr_accessor :remote_host
+            attr_accessor :server_name
+            attr_accessor :server_port
+            attr_accessor :is_ssl
+            attr_accessor :headers
+            attr :attributes
+
+            def initialize
+              super(AjpType::FORWARD_REQUEST, true)
+              @headers = Headers.new()
+              @attributes = {}
+            end
+
+            def to_s()
+              return "ForwardRequest(m=#{self.method} p=#{self.protocol} u=#{self.req_uri} ra=#{self.remote_addr} rh=#{self.remote_host} sn=#{self.server_name} sp=#{self.server_port} ss=#{self.is_ssl} h=#{self.headers}"
+            end
+
+            def pack(pkt)
+              #BayLog.info("%s", self)
+              acc = pkt.new_ajp_data_accessor()
+              acc.put_byte(@type) # prefix code
+              acc.put_byte(CmdForwardRequest.get_method_code(@method))
+              acc.put_string(@protocol)
+              acc.put_string(@req_uri)
+              acc.put_string(@remote_addr)
+              acc.put_string(@remote_host)
+              acc.put_string(@server_name)
+              acc.put_short(@server_port)
+              acc.put_byte(@is_ssl ? 1 : 0)
+              write_request_headers(acc)
+              write_attributes(acc)
+
+              #  must be called from last line
+              super
+            end
+
+            def unpack(pkt) 
+              super
+              acc = pkt.new_ajp_data_accessor()
+              acc.get_byte() # prefix code
+              @method = CmdForwardRequest.method_map[acc.get_byte]
+              @protocol = acc.get_string
+              @req_uri = acc.get_string
+              @remote_addr = acc.get_string
+              @remote_host = acc.get_string
+              @server_name = acc.get_string
+              @server_port = acc.get_short
+              @is_ssl = acc.get_byte == 1
+
+              read_request_headers(acc)
+              read_attributes(acc)
+            end
+
+            def handle(handler)
+              return handler.handle_forward_request(self)
+            end
+
+
+            private
+            def read_request_headers(acc)
+              count = acc.get_short
+              count.times do |i|
+                code = acc.get_short
+
+                if code >= 0xA000
+                  name = CmdForwardRequest.well_known_header_map[code]
+
+                  if name == nil
+                    raise ProtocolException.new("Invalid header")
+                  end
+                else
+                  # code is length of header name
+                  name = acc.get_string_by_len(code)
+                end
+
+                value = acc.get_string
+                @headers.add(name, value)
+                #BayLog.trace "ForwardRequest header: #{name}=#{value}"
+              end
+            end
+
+            def read_attributes(acc)
+              while true
+                code = acc.get_byte()
+
+                if code == 0xFF
+                  break
+                elsif code == 0x0A
+                  name = acc.get_string()
+                else
+                  name = CmdForwardRequest.attribute_name_map[code]
+                  if name == nil
+                    raise ProtocolException.new "Invalid attribute: code=#{code}"
+                  end
+                end
+
+                if code == 0x0B # "?ssl_key_size"
+                  value = acc.get_short()
+                  @attributes[name] = value.to_s
+                else
+                  value = acc.get_string
+                  @attributes[name] = value
+                end
+
+                #BayLog.trace "ForwardRequest readAttributes:#{name}=#{value}"
+              end
+            end
+
+            def write_request_headers(acc)
+              h_list = []
+              @headers.names.each do |name|
+                @headers.values(name).each do |value|
+                  h_list << [name, value]
+                end
+              end
+              
+              acc.put_short(h_list.length)
+              h_list.each do |item|
+                code = CmdForwardRequest.get_well_known_header_code(item[0])
+                if code != -1
+                  acc.put_short(code)
+                else 
+                  acc.put_string(item[0])
+                end
+                
+                acc.put_string(item[1])
+              end
+
+            end
+
+            def write_attributes(acc)
+              @attributes.keys.each do |name|
+                value = @attributes[name]
+                code = CmdForwardRequest.get_attribute_code(name)
+                if code != -1
+                  acc.put_byte(code)
+                else
+                  acc.put_string(name)
+                end
+
+                acc.put_string(value)
+              end
+
+              acc.put_byte(0xFF) # terminator code
+            end
+          end
+
+        end
+      end
+    end
+  end
+end
+

data/lib/baykit/bayserver/docker/ajp/command/cmd_get_body_chunk.rb

@@ -0,0 +1,44 @@
+require 'baykit/bayserver/docker/ajp/ajp_command'
+require 'baykit/bayserver/docker/ajp/ajp_type'
+require 'baykit/bayserver/docker/ajp/ajp_packet'
+
+#
+# Get Body Chunk format
+#
+# AJP13_GET_BODY_CHUNK :=
+#   prefix_code       6
+#   requested_length  (integer)
+#
+module Baykit
+  module BayServer
+    module Docker
+      module Ajp
+        module Command
+          class CmdGetBodyChunk < Baykit::BayServer::Docker::Ajp::AjpCommand
+            attr_accessor :req_len
+
+            def initialize()
+              super AjpType::GET_BODY_CHUNK, false
+            end
+
+            def pack(pkt)
+              acc = pkt.new_ajp_data_accessor()
+              acc.put_byte(@type)
+              acc.put_short(@req_len)
+
+              # must be called from last line
+              super
+            end
+
+            def handle(handler)
+              return handler.handle_get_body_chunk(self)
+            end
+
+
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/baykit/bayserver/docker/ajp/command/cmd_send_body_chunk.rb

@@ -0,0 +1,71 @@
+require 'baykit/bayserver/docker/ajp/ajp_command'
+require 'baykit/bayserver/docker/ajp/ajp_type'
+require 'baykit/bayserver/docker/ajp/ajp_packet'
+require 'baykit/bayserver/util/string_util'
+#
+#  Send body chunk format
+#
+#  AJP13_SEND_BODY_CHUNK :=
+#    prefix_code   (byte) 0x03
+#    chunk_length  (integer)
+#    chunk         *(byte)
+#
+module Baykit
+  module BayServer
+    module Docker
+      module Ajp
+        module Command
+          class CmdSendBodyChunk < Baykit::BayServer::Docker::Ajp::AjpCommand
+            include Baykit::BayServer::Docker::Ajp
+            include Baykit::BayServer::Util
+
+            attr :chunk
+            attr :offset
+            attr :length
+
+            MAX_CHUNKLEN = AjpPacket::MAX_DATA_LEN - 4
+
+            def initialize(buf, ofs, len)
+              super(AjpType::SEND_BODY_CHUNK, false)
+              @chunk = buf
+              @offset = ofs
+              @length = len
+            end
+
+            def pack(pkt) 
+              if @length > MAX_CHUNKLEN
+                raise RuntimeError.new("IllegalArgument")
+              end 
+              
+              acc = pkt.new_ajp_data_accessor
+              acc.put_byte(@type)
+              acc.put_short(@length)
+              acc.put_bytes(@chunk, @offset, @length)
+              acc.put_byte(0)   # maybe document bug
+
+              #  must be called from last line
+              super
+            end
+
+            def unpack(pkt)
+              acc = pkt.new_ajp_data_accessor
+              acc.get_byte   # code
+              @length = acc.get_short
+              if @chunk == nil || @length > @chunk.length
+                @chunk = StringUtil.alloc(@length)
+              end
+
+              acc.get_bytes(@chunk, 0, @length)
+            end
+
+            def handle(handler)
+              return handler.handle_send_body_chunk(self)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/baykit/bayserver/docker/ajp/command/cmd_send_headers.rb

@@ -0,0 +1,153 @@
+require 'baykit/bayserver/docker/ajp/ajp_command'
+require 'baykit/bayserver/docker/ajp/ajp_type'
+require 'baykit/bayserver/util/http_status'
+
+#
+#  Send headers format
+#
+#  AJP13_SEND_HEADERS :=
+#    prefix_code       4
+#    http_status_code  (integer)
+#    http_status_msg   (string)
+#    num_headers       (integer)
+#    response_headers *(res_header_name header_value)
+#
+#  res_header_name :=
+#      sc_res_header_name | (string)   [see below for how this is parsed]
+#
+#  sc_res_header_name := 0xA0 (byte)
+#
+#  header_value := (string)
+#
+module Baykit
+  module BayServer
+    module Docker
+      module Ajp
+        module Command
+          class CmdSendHeaders < Baykit::BayServer::Docker::Ajp::AjpCommand
+            include Baykit::BayServer::Util
+
+            class << self 
+              attr :well_known_header_map
+            end
+            
+            @well_known_header_map = {
+              "content-type" => 0xA001,
+              "content-language" => 0xA002,
+              "content-length" => 0xA003,
+              "date" => 0xA004,
+              "last-modified" => 0xA005,
+              "location" => 0xA006,
+              "set-cookie" => 0xA007,
+              "set-cookie2" => 0xA008,
+              "servlet-engine" => 0xA009,
+              "status" => 0xA00A,
+              "www-authenticate" => 0xA00B,
+            }
+
+            def self.get_well_known_header_name(code)
+              @well_known_header_map.keys.each do |name|
+                if @well_known_header_map[name] == code
+                  return name
+                end
+              end
+              return nil
+            end
+
+            attr :headers
+            attr_accessor :status
+            attr :desc
+
+            def initialize
+              super(AjpType::SEND_HEADERS, false)
+              @headers = {}
+              @status = HttpStatus::OK
+              @desc = nil
+            end
+
+            def to_s()
+              return "SendHeaders(s=#{@status} d=#{@desc} h=#{@headers}"
+            end
+
+            def pack(pkt) 
+              acc = pkt.new_ajp_data_accessor
+              acc.put_byte(@type)
+              acc.put_short(@status)
+              acc.put_string(HttpStatus.description(@status))
+
+              count = 0
+              @headers.keys.each do |key|
+                count += @headers[key].length
+              end
+              acc.put_short(count)
+
+              @headers.keys.each do |name|
+                code = CmdSendHeaders.well_known_header_map[name]
+
+                @headers[name].each do |value|
+                  if code != nil
+                    acc.put_short(code)
+                  else
+                    acc.put_string(name)
+                  end
+                  acc.put_string(value)
+                end
+              end
+
+              #  must be called from last line
+              super
+            end
+
+            def unpack(pkt) 
+              acc = pkt.new_ajp_data_accessor
+              prefix_code = acc.get_byte
+              if prefix_code != AjpType::SEND_HEADERS
+                raise ProtocolException.new "Expected SEND_HEADERS"
+              end
+
+              @status = acc.get_short
+              @desc = acc.get_string
+              count = acc.get_short
+              count.times do |i|
+                code = acc.get_short
+                name = CmdSendHeaders.get_well_known_header_name(code)
+                if name == nil
+                  name = acc.get_string_by_len(code)
+                end
+
+                value = acc.get_string
+                add_header(name, value)
+              end
+              #BayLog.info("%s", self)
+            end
+
+            def handle(handler)
+              return handler.handle_send_headers(self)
+            end
+
+
+            def get_header(name)
+              values = @headers[name.downcase]
+              if values == nil || values.empty?
+                nil
+              else
+                values[0]
+              end
+            end
+
+            def add_header(name, value)
+              values = @headers[name]
+              if values == nil
+                values = []
+                @headers[name] = values
+              end
+              values.append(value)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/baykit/bayserver/docker/ajp/command/cmd_shutdown.rb

@@ -0,0 +1,37 @@
+require 'baykit/bayserver/docker/ajp/ajp_command'
+require 'baykit/bayserver/docker/ajp/ajp_type'
+
+#
+#  Shutdown command format
+# 
+#    none
+#
+module Baykit
+  module BayServer
+    module Docker
+      module Ajp
+        module Command
+          class CmdShutdown < Baykit::BayServer::Docker::Ajp::AjpCommand
+
+            def initialize
+              super(AjpType::SHUTDOWN, true)
+            end
+
+            def unpack(pkt)
+              super
+            end
+
+            def pack(pkt)
+              super
+            end
+
+            def handle(handler)
+              return handler.handle_shutdown(self)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/baykit/bayserver/docker/ajp/command/package.rb

@@ -0,0 +1,7 @@
+require 'baykit/bayserver/docker/ajp/command/cmd_data'
+require 'baykit/bayserver/docker/ajp/command/cmd_end_response'
+require 'baykit/bayserver/docker/ajp/command/cmd_forward_request'
+require 'baykit/bayserver/docker/ajp/command/cmd_get_body_chunk'
+require 'baykit/bayserver/docker/ajp/command/cmd_send_body_chunk'
+require 'baykit/bayserver/docker/ajp/command/cmd_send_headers'
+require 'baykit/bayserver/docker/ajp/command/cmd_shutdown'

data/lib/baykit/bayserver/docker/ajp/package.rb

@@ -0,0 +1,12 @@
+require 'baykit/bayserver/docker/ajp/ajp_command'
+require 'baykit/bayserver/docker/ajp/ajp_command_handler'
+require 'baykit/bayserver/docker/ajp/ajp_command_unpacker'
+require 'baykit/bayserver/docker/ajp/ajp_inbound_handler'
+require 'baykit/bayserver/docker/ajp/ajp_docker'
+require 'baykit/bayserver/docker/ajp/ajp_packet'
+require 'baykit/bayserver/docker/ajp/ajp_packet_factory'
+require 'baykit/bayserver/docker/ajp/ajp_packet_unpacker'
+require 'baykit/bayserver/docker/ajp/ajp_port_docker'
+require 'baykit/bayserver/docker/ajp/ajp_protocol_handler'
+require 'baykit/bayserver/docker/ajp/ajp_type'
+require 'baykit/bayserver/docker/ajp/ajp_warp_handler'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: bayserver-docker-ajp
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+platform: ruby
+authors:
+- Michisuke-P
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bayserver-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: AJP docker of BayServer
+email: michisukep@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/baykit/bayserver/docker/ajp/ajp_command.rb
+- lib/baykit/bayserver/docker/ajp/ajp_command_handler.rb
+- lib/baykit/bayserver/docker/ajp/ajp_command_unpacker.rb
+- lib/baykit/bayserver/docker/ajp/ajp_docker.rb
+- lib/baykit/bayserver/docker/ajp/ajp_inbound_handler.rb
+- lib/baykit/bayserver/docker/ajp/ajp_packet.rb
+- lib/baykit/bayserver/docker/ajp/ajp_packet_factory.rb
+- lib/baykit/bayserver/docker/ajp/ajp_packet_unpacker.rb
+- lib/baykit/bayserver/docker/ajp/ajp_port_docker.rb
+- lib/baykit/bayserver/docker/ajp/ajp_protocol_handler.rb
+- lib/baykit/bayserver/docker/ajp/ajp_type.rb
+- lib/baykit/bayserver/docker/ajp/ajp_warp_docker.rb
+- lib/baykit/bayserver/docker/ajp/ajp_warp_handler.rb
+- lib/baykit/bayserver/docker/ajp/command/cmd_data.rb
+- lib/baykit/bayserver/docker/ajp/command/cmd_end_response.rb
+- lib/baykit/bayserver/docker/ajp/command/cmd_forward_request.rb
+- lib/baykit/bayserver/docker/ajp/command/cmd_get_body_chunk.rb
+- lib/baykit/bayserver/docker/ajp/command/cmd_send_body_chunk.rb
+- lib/baykit/bayserver/docker/ajp/command/cmd_send_headers.rb
+- lib/baykit/bayserver/docker/ajp/command/cmd_shutdown.rb
+- lib/baykit/bayserver/docker/ajp/command/package.rb
+- lib/baykit/bayserver/docker/ajp/package.rb
+homepage: https://baykit.yokohama
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: AJP docker of BayServer
+test_files: []