ronin-rb/ronin-web-server

# frozen_string_literal: true
#
# ronin-web-server - A custom Ruby web server based on Sinatra.
#
# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# ronin-web-server is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# ronin-web-server is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with ronin-web-server.  If not, see <https://www.gnu.org/licenses/>.
#

require_relative '../request'

module Ronin
  module Web
    module Server
      class ReverseProxy
        #
        # Class that represents a reverse proxied request.
        #
        class Request < Server::Request

          #
          # Changes the HTTP Host header of the request.
          #
          # @param [String] new_host
          #   The new value of the HTTP Host header.
          #
          # @return [String]
          #   The new HTTP Host header.
          #
          # @api public
          #
          def host=(new_host)
            @env['HTTP_HOST'] = new_host
          end

          #
          # Changes the port the request is being sent to.
          #
          # @param [Integer] new_port
          #   The new port the request will be sent to.
          #
          # @return [Integer]
          #   The new port the request will be sent to.
          #
          # @api public
          #
          def port=(new_port)
            @env['SERVER_PORT'] = new_port
          end

          #
          # Changes the URI scheme of the request.
          #
          # @param [String] new_scheme
          #   The new URI scheme for the request.
          #
          # @return [String]
          #   The new URI scheme of the request.
          #
          # @api public
          #
          def scheme=(new_scheme)
            @env['rack.url_scheme'] = new_scheme
          end

          #
          # Toggles whether the request to be proxied over SSL.
          #
          # @param [Boolean] ssl
          #   Specifies whether to enable or disable SSL.
          #
          # @return [Boolean]
          #   Whether SSL is enabled or disabled.
          #
          # @api public
          #
          def ssl=(ssl)
            if ssl
              self.port   = 443
              self.scheme = 'https'
            else
              self.port   = 80
              self.scheme = 'http'
            end

            return ssl
          end

          #
          # Changes the HTTP Request Method of the request.
          #
          # @param [String] new_method
          #   The new HTTP Request Method.
          #
          # @return [String]
          #   The new HTTP Request Method.
          #
          # @api public
          #
          def request_method=(new_method)
            @env['REQUEST_METHOD'] = new_method
          end

          #
          # Changes the HTTP Query String of the request.
          #
          # @param [String] new_query
          #   The new HTTP Query String for the request.
          #
          # @return [String]
          #   The new HTTP Query String of the request.
          #
          # @api public
          #
          def query_string=(new_query)
            @env['QUERY_STRING'] = new_query
          end

          #
          # Toggles whether the request is a XML HTTP Request.
          #
          # @param [Boolean] xhr
          #   Specifies whether the request is an XML HTTP Request.
          #
          # @return [Boolean]
          #   Specifies whether the request is an XML HTTP Request.
          #
          # @api public
          #
          def xhr=(xhr)
            if xhr then @env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
            else        @env.delete('HTTP_X_REQUESTED_WITH')
            end

            return xhr
          end

          #
          # Changes the HTTP Content-Type header of the request.
          #
          # @param [String] new_content_type
          #   The new HTTP Content-Type for the request.
          #
          # @return [String]
          #   The new HTTP Content-Type of the request.
          #
          # @api public
          #
          def content_type=(new_content_type)
            @env['CONTENT_TYPE'] = new_content_type
          end

          #
          # Changes the HTTP Accept-Encoding header of the request.
          #
          # @param [String] new_encoding
          #   The new HTTP Accept-Encoding for the request.
          #
          # @return [String]
          #   The new HTTP Accept-Encoding of the request.
          #
          # @api public
          #
          def accept_encoding=(new_encoding)
            @env['HTTP_ACCEPT_ENCODING'] = new_encoding
          end

          #
          # Sets the HTTP User-Agent header of the request.
          #
          # @param [String] new_user_agent
          #   The new User-Agent header to use.
          #
          # @return [String]
          #   The new User-Agent header.
          #
          # @api public
          #
          def user_agent=(new_user_agent)
            @env['HTTP_USER_AGENT'] = new_user_agent
          end

          #
          # Changes the HTTP `Referer` header of the request.
          #
          # @param [String] new_referer
          #   The new HTTP `Referer` header for the request.
          #
          # @return [String]
          #   The new HTTP `Referer` header of the request.
          #
          # @api public
          #
          def referer=(new_referer)
            @env['HTTP_REFERER'] = new_referer
          end

          alias referrer= referer=

          #
          # Changes the body of the request.
          #
          # @param [String] new_body
          #   The new body for the request.
          #
          # @return [String]
          #   The new body of the request.
          #
          # @api public
          #
          def body=(new_body)
            @env['rack.input'] = new_body
          end

        end
      end
    end
  end
end