ronin-web 0.3.0.rc1 → 1.0.0.beta2

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

@@ -0,0 +1,106 @@
+#
+# 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/support/network/http'
+
+require 'command_kit/terminal'
+require 'nokogiri/diff'
+
+module Ronin
+  module Web
+    class CLI
+      module Commands
+        #
+        # Diffs two web pages.
+        #
+        # ## Usage
+        #
+        #     ronin-web diff [options] {URL | FILE} {URL | FILE}
+        #
+        # ## Arguments
+        #
+        #     URL | FILE                       The original URL or file
+        #     URL | FILE                       The modified URL or file
+        #
+        # ## Options
+        #
+        #     -h, --help                       Print help information
+        # 
+        class Diff < Command
+
+          include CommandKit::Terminal
+
+          usage '[options] {URL | FILE} {URL | FILE}'
+
+          argument :page1, required: true,
+                           usage:    'URL | FILE',
+                           desc:     'The original URL or file'
+
+          argument :page2, required: true,
+                           usage:    'URL | FILE',
+                           desc:     'The modified URL or file'
+
+          description 'Diffs two web pges'
+
+          man_page 'ronin-web-diff.1'
+
+          #
+          # Runs the `ronin-web diff` command.
+          #
+          # @param [String] page1
+          #   The URL or file path of the original page.
+          #
+          # @param [String] page2
+          #   The URL or file path of the modified page.
+          #
+          def run(page1,page2)
+            doc1 = Nokogiri::HTML(read(page1))
+            doc2 = Nokogiri::HTML(read(page2))
+
+            doc1.diff(doc2) do |change,node|
+              unless change == ' '
+                puts "#{change} #{node}"
+              end
+            end
+          end
+
+          #
+          # Reads a web page.
+          #
+          # @param [String] source
+          #   The URL or file path of the web page.
+          #
+          # @return [String, File]
+          #   The contents of the web page.
+          #
+          def read(source)
+            if source.start_with?('https://') ||
+               source.start_with?('http://')
+              Support::Network::HTTP.get_body(source)
+            else
+              File.new(source)
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,174 @@
+#
+# 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/support/network/http'
+
+require 'nokogiri'
+
+module Ronin
+  module Web
+    class CLI
+      module Commands
+        #
+        # Performs XPath/CSS-path queries on a URL or HTML file.
+        #
+        # ## Usage
+        #
+        #     ronin-web html [options] {URL | FILE} [XPATH | CSS-path]
+        #
+        # ## Options
+        #
+        #     -X, --xpath XPATH                XPath query
+        #     -C, --css-path CSSPath           CSS-path query
+        #     -M, --meta-tags                  Searches for all <meta ...> tags
+        #     -l, --links                      Searches for all <a href="..."> URLs
+        #     -S, --style                      Dumps all <style> tags
+        #     -s, --stylesheet-urls            Searches for all <link type="text/css" href="..."/> URLs
+        #     -J, --javascript                 Dumps all javascript source code
+        #     -j, --javascript-urls            Searches for all <script src="..."> URLs
+        #     -f, --form-urls                  Searches for all <form action="..."> URLS
+        #     -u, --urls                       Dumps all URLs in the page
+        #     -F, --first                      Only print the first match
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     URL | FILE                       The URL or FILE to search
+        #     [XPATH | CSS-path]               The XPath or CSS-path query
+        #
+        class Html < Command
+
+          usage '[options] {URL | FILE} [XPATH | CSS-path]'
+          
+          option :xpath, short: '-X',
+                         value: {type: String, usage: 'XPATH'},
+                         desc:  'XPath query' do |xpath|
+                           @query = xpath
+                         end
+
+          option :css_path, short: '-C',
+                            value: {type: String, usage: 'CSSPath'},
+                            desc:  'CSS-path query' do |css_path|
+                              @query = css_path
+                            end
+
+          option :meta_tags, short: '-M',
+                             desc: 'Searches for all <meta ...> tags' do
+                               @query = '//meta'
+                             end
+
+          option :links, short: '-l',
+                         desc: 'Searches for all <a href="..."> URLs' do
+                           @query = '//a/@href'
+                         end
+
+          option :style, short: '-S',
+                          desc: 'Dumps all <style> tags' do
+                            @query = '//style/text()'
+                          end
+
+          option :stylesheet_urls, short: '-s',
+                                   desc: 'Searches for all <link type="text/css" href="..."/> URLs' do
+                                     @query = '//link[@rel="stylesheet"]/@href'
+                                   end
+
+          option :javascript, short: '-J',
+                              desc: 'Dumps all javascript source code' do
+                                @query = '//script/text()'
+                              end
+
+          option :javascript_urls, short: '-j',
+                                   desc: 'Searches for all <script src="..."> URLs' do
+                                     @query = '//script/@src'
+                                   end
+
+          option :form_urls, short: '-f',
+                             desc: 'Searches for all <form action="..."> URLS' do
+                               @query = '//form/@action'
+                             end
+
+          option :urls, short: '-u',
+                        desc: 'Dumps all URLs in the page' do
+                          @query = '//a/@href | //link/@href | //script/@src | //form/@action'
+                        end
+
+          option :first, short: '-F',
+                         desc: 'Only print the first match'
+
+          argument :source, required: true,
+                            usage: 'URL | FILE',
+                            desc:  'The URL or FILE to search'
+
+          argument :query, required: false,
+                           usage: 'XPATH | CSS-path',
+                           desc: 'The XPath or CSS-path query'
+
+          description 'Performs XPath/CSS-path queries on a URL or HTML file'
+
+          man_page 'ronin-web-html.1'
+
+          #
+          # Runs the `ronin-web xpath` command.
+          #
+          # @param [String] source
+          #   The `URL` or `FILE` argument.
+          #
+          # @param [String, nil] query
+          #   The optional XPath or CSS-path argument.
+          #
+          def run(source,query=@query)
+            unless query
+              print_error "must specify --xpath, --css-path, or an XPath/CSS-path argument"
+              exit -1
+            end
+
+            doc   = Nokogiri::HTML(read(source))
+            nodes = if options[:first] then [doc.at(query)]
+                    else                    doc.search(query)
+                    end
+
+            nodes.each do |node|
+              puts node
+            end
+          end
+
+          #
+          # Reads a URI or file.
+          #
+          # @param [String] source
+          #   The URI or file path.
+          #
+          # @return [File, String]
+          #   The contents of the URI or file.
+          #
+          def read(source)
+            if source.start_with?('https://') ||
+               source.start_with?('http://')
+              Support::Network::HTTP.get_body(source)
+            else
+              File.new(source)
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+#
+# 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/web/cli/ruby_shell'
+
+module Ronin
+  module Web
+    class CLI
+      module Commands
+        #
+        # Starts an interactive Ruby shell with `ronin-web` loaded.
+        #
+        # ## Usage
+        #
+        #     ronin-web irb [options]
+        #
+        # ## Options
+        #
+        #     -h, --help                       Print help information
+        #
+        class Irb < Command
+
+          description "Starts an interactive Ruby shell with ronin-web loaded"
+
+          man_page 'ronin-web-irb.1'
+
+          #
+          # Runs the `ronin-web irb` command.
+          #
+          def run
+            require 'ronin/web'
+            CLI::RubyShell.start
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/web/cli/commands/new/nokogiri.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+#
+# 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/web/root'
+
+require 'ronin/core/cli/generator'
+
+module Ronin
+  module Web
+    class CLI
+      module Commands
+        class New < Command
+          #
+          # Generates a new nokogiri Ruby script.
+          #
+          # ## Usage
+          #
+          #     ronin-web new nokogiri [options] FILE
+          #
+          # ## Options
+          #
+          #     -U, --url URL                    Optional URL for the script
+          #     -h, --help                       Print help information
+          #
+          # ## Arguments
+          #
+          #     FILE                             The file to create
+          #
+          class Nokogiri < Command
+
+            include Core::CLI::Generator
+
+            template_dir File.join(ROOT,'data','new')
+
+            usage '[options] FILE'
+
+            option :url, short: '-U',
+                         value: {
+                           type:  String,
+                           usage: 'URL'
+                         },
+                         desc: 'Optional URL for the script'
+
+            argument :file, required: true,
+                            desc: 'The file to create'
+
+            description 'Generates a new nokogiri Ruby script'
+
+            man_page 'ronin-web-new-nokogiri.1'
+
+            #
+            # Runs the `ronin-web new nokogiri` command.
+            #
+            # @param [String] path
+            #   The path to the new script file to create.
+            #
+            def run(path)
+              @url = options[:url]
+
+              erb 'nokogiri.rb.erb', path
+              chmod '+x', path
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+#
+# 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/web/root'
+
+require 'ronin/core/cli/generator'
+
+module Ronin
+  module Web
+    class CLI
+      module Commands
+        class New < Command
+          #
+          # Creates a new [ronin-web-server] script.
+          #
+          # [ronin-web-server]: https://github.com/ronin-rb/ronin-web-server#readme
+          #
+          # ## Usage
+          #
+          #     ronin-web server [options]
+          #
+          # ## Options
+          #
+          #     -H, --host HOST|IP               Optional host or IP interface to listen on. Defaults to 0.0.0.0.
+          #     -p, --port PORT                  Optional port to listen on. Defaults to 8000.
+          #     -h, --help                       Print help information
+          #
+          # ## Arguments
+          #
+          #     FILE                             The file to create
+          #
+          class Server < Command
+
+            include Core::CLI::Generator
+
+            template_dir File.join(ROOT,'data','new')
+
+            usage '[options] FILE'
+
+            option :host, short: '-H',
+                          value: {
+                            type:  String,
+                            usage: 'HOST|IP'
+                          },
+                          desc: 'Optional host or IP interface to listen on. Defaults to 0.0.0.0.'
+
+            option :port, short: '-p',
+                          value: {
+                            type:  Integer,
+                            usage: 'PORT'
+                          },
+                          desc: 'Optional port to listen on. Defaults to 8000.'
+
+            argument :file, required: true,
+                            desc: 'The file to create'
+
+            description 'Creates a new web server script'
+
+            man_page 'ronin-web-new-server.1'
+
+            #
+            # Runs the `ronin-web new server` command.
+            #
+            # @param [String] path
+            #   The path to the new script file to create.
+            #
+            def run(path)
+              @host = options[:host]
+              @port = options[:port]
+
+              erb 'server.rb.erb', path
+              chmod '+x', path
+            end
+
+          end
+        end
+      end
+    end
+  end
+end