ronin-web 0.3.0.rc1 → 1.0.0.beta2

data/lib/ronin/web/cli/commands/reverse_proxy.rb

@@ -0,0 +1,215 @@
+#
+# ronin-web - A collection of useful web helper methods and commands.
+#
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-web is free software: you can redistribute it and/or modify
+# it under the terms of the GNU 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 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with ronin-web.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/web/cli/command'
+require 'ronin/core/cli/logging'
+require 'ronin/web/server/reverse_proxy'
+
+module Ronin
+  module Web
+    class CLI
+      module Commands
+        #
+        # Starts a HTTP proxy server.
+        #
+        # ## Usage
+        #
+        #     ronin-web reverse-proxy [options] [--host HOST] [--port PORT]
+        #
+        # ## Options
+        #
+        #     -H, --host HOST                  Host to listen on (Default: localhost)
+        #     -p, --port PORT                  Port to listen on (Default: 8080)
+        #     -b, --show-body                  Print the request and response bodies
+        #         --rewrite-requests /REGEXP/:REPLACE
+        #                                      Rewrite request bodies
+        #         --rewrite-responses /REGEXP/:REPLACE
+        #                                      Rewrite response bodies
+        #     -h, --help                       Print help information
+        #
+        # @api private
+        #
+        class Proxy < Command
+
+          include Core::CLI::Logging
+
+          command_name 'reverse-proxy'
+
+          usage '[options] [--host HOST] [--port PORT]'
+
+          option :host, short: '-H',
+                        value: {
+                          type:    String,
+                          usage:   'HOST',
+                          default: 'localhost'
+                        },
+                        desc: 'Host to listen on'
+
+          option :port, short: '-p',
+                        value: {
+                          type:   Integer,
+                          usage:  'PORT',
+                          default: 8080
+                        },
+                        desc: 'Port to listen on'
+
+          option :show_body, short: '-b',
+                             desc: 'Print the request and response bodies'
+
+          option :rewrite_requests, value: {
+                                      type: String,
+                                      usage: '/REGEXP/:REPLACE'
+                                    },
+                                    desc: 'Rewrite request bodies' do |str|
+                                      @rewrite_requests << parse_rewrite_rule(str)
+                                    end
+
+          option :rewrite_responses, value: {
+                                       type: String,
+                                       usage: '/REGEXP/:REPLACE'
+                                     },
+                                     desc: 'Rewrite response bodies' do |str|
+                                       @rewrite_responses << parse_rewrite_rule(str)
+                                     end
+
+          description 'Starts a HTTP proxy server'
+
+          man_page 'ronin-web-reverse-proxy.1'
+
+          #
+          # Initializes the `reverse-proxy` command.
+          #
+          # @param [Hash{Symbol => Object}] kwargs
+          #   Additional keyword arguments.
+          #
+          def initialize(**kwargs)
+            super(**kwargs)
+
+            @rewrite_requests  = []
+            @rewrite_responses = []
+          end
+
+          #
+          # Runs the `ronin-web reverse-proxy` command.
+          #
+          def run
+            proxy = Ronin::Web::Server::ReverseProxy.new do |proxy|
+              proxy.on_request do |request|
+                puts "[#{request.ip} -> #{request.host_with_port}] #{request.request_method} #{request.url}"
+
+                request.headers.each do |name,value|
+                  puts "> #{name}: #{value}"
+                end
+                puts
+
+                unless @rewrite_requests.empty?
+                  request.body = rewrite_body(request.body,@rewrite_requests)
+                end
+
+                print_body(request.body) if options[:show_body]
+              end
+
+              proxy.on_response do |response|
+                puts "< HTTP/1.1 #{response.status}"
+
+                response.headers.each do |name,value|
+                  puts "< #{name}: #{value}"
+                end
+                puts
+
+                unless @rewrite_responses.empty?
+                  response.body = rewrite_body(response.body,@rewrite_responses)
+                end
+
+                print_body(response.body) if options[:show_body]
+              end
+            end
+
+            log_info "Starting proxy server on #{options[:host]}:#{options[:port]} ..."
+            proxy.run!(host: options[:host], port: options[:port])
+            log_info "shutting down ..."
+          end
+
+          #
+          # Prints a request or response body.
+          #
+          # @param [IO, StringIO, Array<String>, String] body
+          #   The request/response body to print. May be a IO/StringIO object,
+          #   an Array of Strings, or a String.
+          #
+          def print_body(body)
+            case body
+            when StringIO, IO
+              body.each_line do |line|
+                puts line
+              end
+
+              body.rewind
+            else
+              puts body
+            end
+          end
+
+          #
+          # Parses a rewrite rule.
+          #
+          # @param [String] value
+          #
+          # @return [(Regexp, String), (String, String)]
+          #
+          def parse_rewrite_rule(value)
+            if (index = value.rindex('/:'))
+              regexp  = Regexp.new(value[1...index])
+              replace = value[index+2..]
+
+              return [regexp, replace]
+            elsif (index = value.rindex(':'))
+              string  = value[0...index]
+              replace = value[(index+1)..]
+
+              return [string, replace]
+            end
+          end
+          
+          #
+          # Rewrites a request or response body.
+          #
+          # @param [IO, StringIO, Array<String>, String] body
+          #
+          # @return [String]
+          #
+          def rewrite_body(body,rules)
+            body = case body
+                   when StringIO, IO then body.read
+                   when Array        then body.join
+                   else                   body.to_s
+                   end
+
+            rules.each do |(pattern,replace)|
+              body.gsub!(pattern,replace)
+            end
+
+            return body
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/web/cli/commands/server.rb

@@ -0,0 +1,155 @@
+#
+# ronin-web - A collection of useful web helper methods and commands.
+#
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-web is free software: you can redistribute it and/or modify
+# it under the terms of the GNU 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 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with ronin-web.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/web/cli/command'
+require 'ronin/core/cli/logging'
+require 'ronin/web/server'
+
+module Ronin
+  module Web
+    class CLI
+      module Commands
+        #
+        # Starts a web server.
+        #
+        # ## Usage
+        #
+        #     ronin-web server [options]
+        #
+        # ## Options
+        #
+        #    -H, --host HOST                  Host name or IP to bind to (Default: localhost)
+        #    -p, --port PORT                  Port number to listen on (Default: 8000)
+        #    -A, --basic-auth USER:PASSWORD   Sets up Basic-Authentication
+        #    -d, --dir /PATH:DIR              Mounts a directory to the given PATH
+        #    -f, --file /PATH:FILE            Mounts a file to the given PATH
+        #    -r, --root DIR                   Root directory to serve
+        #    -R, --redirect /PATH:URL         Registers a 302 Found redirect at the given PATH
+        #    -h, --help                       Print help information
+        # 
+        class Server < Command
+
+          include Core::CLI::Logging
+
+          class App < Ronin::Web::Server::Base
+          end
+
+          option :host, short: '-H',
+                        value: {
+                          type:    String,
+                          usage:   'HOST',
+                          default: 'localhost'
+                        },
+                        desc: 'Host name or IP to bind to' do |host|
+                          App.host = host
+                        end
+
+          option :port, short: '-p',
+                        value: {
+                          type:    Integer,
+                          usage:   'PORT',
+                          default: App.port
+                        },
+                        desc: 'Port number to listen on' do |port|
+                          App.port = port
+                        end
+
+          option :basic_auth, short: '-A',
+                              value: {
+                                type: String,
+                                usage: 'USER:PASSWORD'
+                              },
+                              desc: 'Sets up Basic-Authentication' do |str|
+                                auth_user, auth_password = str.split(':',2)
+
+                                App.basic_auth(auth_user,auth_password)
+                              end
+
+          option :dir, short: '-d',
+                       value: {
+                         type:  String,
+                         usage: '/PATH:DIR'
+                       },
+                       desc: 'Mounts a directory to the given PATH' do |str|
+                         url_path, dir = str.split(':',2)
+
+                         App.directory(url_path,dir)
+                       end
+
+          option :file, short: '-f',
+                        value: {
+                          type: String,
+                          usage: '/PATH:FILE'
+                        },
+                        desc: 'Mounts a file to the given PATH' do |str|
+                          url_path, file = str.split(':',2)
+
+                          App.file(url_path,file)
+                        end
+
+          option :root, short: '-r',
+                        value: {
+                          type: String,
+                          usage: 'DIR'
+                        },
+                        desc: 'Root directory to serve'
+
+          option :redirect, short: '-R',
+                            value: {
+                              type:  String,
+                              usage: '/PATH:URL'
+                            },
+                            desc: 'Registers a 302 Found redirect at the given PATH' do |str|
+                              route, url = str.split(':',2)
+
+                              App.redirect(route,url)
+                            end
+
+          description 'Starts a web server'
+
+          man_page 'ronin-web-server.1'
+
+          #
+          # Runs the `ronin-web server` command.
+          #
+          def run
+            if options[:root]
+              App.public_dir = options[:root]
+            else
+              App.any('*') do
+                puts "#{request.request_method} #{request.path}"
+
+                request.headers.each do |name,value|
+                  puts "#{name}: #{value}"
+                end
+
+                puts request.body.read
+              end
+            end
+
+            log_info "Starting web server listening on #{App.host}:#{App.port} ..."
+            App.run!
+            log_info "Shutting down ..."
+          end
+
+        end
+      end
+    end
+  end
+end