pwn 0.4.333

data/lib/pwn/plugins/nmap_it.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'nmap'
+
+module PWN
+  module Plugins
+    # This plugin is used as an  interface to nmap, the exploration tool and security / port scanner.
+    module NmapIt
+      # Supported Method Parameters::
+      # PWN::Plugins::NmapIt.port_scan do |nmap|
+      #   puts nmap.public_methods
+      # end
+
+      public_class_method def self.port_scan
+        Nmap::Program.scan do |nmap|
+          yield(nmap)
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # PWN::Plugins::NmapIt.parse_xml_results(:xml_file => 'required - path to nmap xml results') do |xml|
+      #   puts xml.public_methods
+      #   xml.each_host do |host|
+      #     puts "[#{host.ip}]"
+      #
+      #     host.scripts.each do |name,output|
+      #       output.each_line { |line| puts "  #{line}" }
+      #     end
+      #
+      #     host.each_port do |port|
+      #       puts "  [#{port.number}/#{port.protocol}]"
+      #
+      #       port.scripts.each do |name,output|
+      #         puts "    [#{name}]"
+      #         output.each_line { |line| puts "      #{line}" }
+      #       end
+      #     end
+      #   end
+      # end
+
+      public_class_method def self.parse_xml_results(opts = {})
+        xml_file = opts[:xml_file].to_s.scrub.strip.chomp if File.exist?(opts[:xml_file].to_s.scrub.strip.chomp)
+
+        Nmap::XML.new(xml_file) do |xml|
+          yield(xml)
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Author(s):: Jacob Hoopes <jake.hoopes@gmail.com>
+
+      public_class_method def self.authors
+        "AUTHOR(S):
+          Jacob Hoopes <jake.hoopes@gmail.com>
+        "
+      end
+
+      # Display Usage for this Module
+
+      public_class_method def self.help
+        puts "USAGE:
+          #{self}.port_scan do |nmap|
+            puts nmap.public_methods
+            nmap.connect_scan = true
+            nmap.service_scan = true
+            nmap.verbose = true
+            nmap.ports = [1..1024,1337]
+            nmap.targets = '127.0.0.1'
+            nmap.xml = '/tmp/nmap_port_scan_res.xml'
+          end
+
+          #{self}.parse_xml_results(:xml_file => 'required - path to nmap xml results') do |xml|
+            xml.each_host do |host|
+              puts host.ip
+
+              host.scripts.each do |name,output|
+                output.each_line { |line| puts line }
+              end
+
+              host.each_port do |port|
+                puts port
+
+                port.scripts.each do |name,output|
+                  puts name
+                  output.each_line { |line| puts line }
+                end
+              end
+            end
+          end
+
+          #{self}.authors
+        "
+      end
+    end
+  end
+end

data/lib/pwn/plugins/oauth2.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+
+module PWN
+  module Plugins
+    # This plugin is somewhat of a hack used for extracting OAuth2 tokens
+    # from HTTP responses to be used for subsequent HTTP requests.
+    module OAuth2
+      # Supported Method Parameters::
+      # PWN::Plugins::OAuth2.decode(
+      #   oauth2_token: 'required oauth2 token'
+      # )
+
+      public_class_method def self.decode(opts)
+        oauth2_token = opts[:oauth2_token]
+        Base64.decode64(oauth2_token)
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # PWN::Plugins::OAuth2.get_value_by_key(
+      #   oauth2_token: 'required oauth2 token',
+      #   key: 'required oauth2 token key name located within the Base64 encoded token as symbol, e.g. :company_id'
+      # )
+
+      public_class_method def self.get_value_by_key(opts)
+        oauth2_token = opts[:oauth2_token]
+        # Make sure we're receiving a symbol.  Convert to string first in case an int is passed.
+        key = opts[:key].to_s.to_sym
+
+        # Holy omg...strip out the ugly tail of this stuff.
+        readable_oauth2_token = Base64.decode64(oauth2_token).match(/^(.*?)\]\}/).to_s
+
+        json_oauth2_token_body = JSON.parse(readable_oauth2_token.split(/^\{(.*?)\}/)[-1], symbolize_names: true)
+        json_oauth2_token_body[key]
+      rescue StandardError => e
+        raise e
+      end
+
+      # Author(s):: Jacob Hoopes <jake.hoopes@gmail.com>
+
+      public_class_method def self.authors
+        "AUTHOR(S):
+          Jacob Hoopes <jake.hoopes@gmail.com>
+        "
+      end
+
+      # Display Usage for this Module
+
+      public_class_method def self.help
+        puts %{USAGE:
+          #{self}.decode(oauth2_token: 'required oauth2 token')"
+
+          #{self}.get_value_by_key(
+            oauth2_token: 'required oauth2 token',
+            key: 'required oauth2 token key name located within the Base64 encoded token as symbol, e.g. :company_id'
+          )
+
+          #{self}.authors
+        }
+      end
+    end
+  end
+end

data/lib/pwn/plugins/ocr.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'rtesseract'
+
+module PWN
+  module Plugins
+    # This plugin processes images into readable text
+    module OCR
+      # Supported Method Parameters::
+      # PWN::Plugins::OCR.process(
+      #   file: 'required - path to image file',
+      # )
+
+      public_class_method def self.process(opts = {})
+        file = opts[:file].to_s.scrub.strip.chomp if File.exist?(opts[:file].to_s.scrub.strip.chomp)
+        image = RTesseract.new(file)
+        image.to_s
+      rescue StandardError => e
+        raise e
+      end
+
+      # Author(s):: Jacob Hoopes <jake.hoopes@gmail.com>
+
+      public_class_method def self.authors
+        "AUTHOR(S):
+          Jacob Hoopes <jake.hoopes@gmail.com>
+        "
+      end
+
+      # Display Usage for this Module
+
+      public_class_method def self.help
+        puts "USAGE:
+          #{self}.process(
+            file: 'required - path to image file'
+          )
+
+          #{self}.authors
+        "
+      end
+    end
+  end
+end

data/lib/pwn/plugins/openvas.rb

@@ -0,0 +1,308 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'time'
+require 'base64'
+
+module PWN
+  module Plugins
+    # This plugin is used for interacting w/ OpenVAS using OMP (OpenVAS Management Protocol).
+    module OpenVAS
+      # Supported Method Parameters::
+      # task_xml_resp = PWN::Plugins::OpenVAS.get_task_id(
+      #   task_name: 'required task name to start',
+      #   username: 'required username',
+      #   password: 'optional password (will prompt if nil)'
+      # )
+
+      public_class_method def self.get_task_id(opts = {})
+        task_name = opts[:task_name].to_s.scrub
+        username = opts[:username].to_s.scrub
+
+        password = if opts[:password].nil?
+                     PWN::Plugins::AuthenticationHelper.mask_password
+                   else
+                     opts[:password].to_s.scrub
+                   end
+
+        get_tasks_xml_resp = Nokogiri::XML(
+          `sudo runuser -u _gvm -- /usr/bin/gvm-cli \
+            --gmp-username '#{username}' \
+            --gmp-password '#{password}' \
+            socket \
+            --xml="<get_tasks/>"
+          `
+        )
+
+        get_tasks_xml_resp.xpath(
+          "/get_tasks_response/task[name/text()='#{task_name}']"
+        )
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # start_task_xml_resp = PWN::Plugins::OpenVAS.start_task(
+      #   task_name: 'required task name to start',
+      #   username: 'required username',
+      #   password: 'optional password (will prompt if nil)'
+      # )
+
+      public_class_method def self.start_task(opts = {})
+        task_name = opts[:task_name].to_s.scrub
+        username = opts[:username].to_s.scrub
+
+        password = if opts[:password].nil?
+                     PWN::Plugins::AuthenticationHelper.mask_password
+                   else
+                     opts[:password].to_s.scrub
+                   end
+
+        task_id = get_task_id(
+          task_name: task_name,
+          username: username,
+          password: password
+        ).xpath('@id').text
+
+        Nokogiri::XML(
+          `sudo runuser -u _gvm -- /usr/bin/gvm-cli \
+            --gmp-username '#{username}' \
+            --gmp-password '#{password}' \
+            socket \
+            --xml="<start_task task_id='#{task_id}'/>"
+          `
+        )
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # task_status = PWN::Plugins::OpenVAS.get_task_status(
+      #   task_name: 'required task name to start',
+      #   username: 'required username',
+      #   password: 'optional password (will prompt if nil)'
+      # )
+
+      public_class_method def self.get_task_status(opts = {})
+        task_name = opts[:task_name].to_s.scrub
+        username = opts[:username].to_s.scrub
+
+        password = if opts[:password].nil?
+                     PWN::Plugins::AuthenticationHelper.mask_password
+                   else
+                     opts[:password].to_s.scrub
+                   end
+
+        get_task_id(
+          task_name: task_name,
+          username: username,
+          password: password
+        ).xpath('status').text
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # last_report_id = PWN::Plugins::OpenVAS.last_report_id(
+      #   task_name: 'required task name to start',
+      #   username: 'required username',
+      #   password: 'optional password (will prompt if nil)'
+      # )
+
+      public_class_method def self.last_report_id(opts = {})
+        task_name = opts[:task_name].to_s.scrub
+        username = opts[:username].to_s.scrub
+
+        password = if opts[:password].nil?
+                     PWN::Plugins::AuthenticationHelper.mask_password
+                   else
+                     opts[:password].to_s.scrub
+                   end
+
+        task_id = get_task_id(
+          task_name: task_name,
+          username: username,
+          password: password
+        ).xpath('@id').text
+
+        report_xml_resp = Nokogiri::XML(
+          `sudo runuser -u _gvm -- /usr/bin/gvm-cli \
+            --gmp-username '#{username}' \
+            --gmp-password '#{password}' \
+            socket \
+            --xml="<get_reports/>"
+          `
+        )
+
+        report_xml_resp.xpath(
+          "/get_reports_response/report/task[@id='#{task_id}']"
+        ).last.parent.xpath(
+          '@id'
+        ).text
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # PWN::Plugins::OpenVAS.save_report(
+      #   report_type: 'required report type (csv|itg|pdf|txt|xml)',
+      #   report_id: 'required report id to save',
+      #   username: 'required username',
+      #   password: 'optional password (will prompt if nil)'
+      # )
+
+      public_class_method def self.save_report(opts = {})
+        report_type = opts[:report_type].to_s.scrub
+        report_id = opts[:report_id].to_s.scrub
+        report_dir = opts[:report_dir].to_s.scrub
+        raise "#{report_dir} Does Not Exist." unless Dir.exist?(
+          report_dir
+        )
+
+        username = opts[:username].to_s.scrub
+
+        password = if opts[:password].nil?
+                     PWN::Plugins::AuthenticationHelper.mask_password
+                   else
+                     opts[:password].to_s.scrub
+                   end
+
+        case report_type.to_sym
+        when :csv
+          report_type_name = 'CSV Results'
+        when :itg
+          report_type_name = 'ITG'
+        when :pdf
+          report_type_name = 'PDF'
+        when :txt
+          report_type_name = 'TXT'
+        when :xml
+          report_type_name = 'XML'
+        else
+          raise "Report Type: \"#{report_type}\" not supported."
+        end
+
+        report_formats_xml_resp = Nokogiri::XML(
+          `sudo runuser -u _gvm -- /usr/bin/gvm-cli \
+            --gmp-username '#{username}' \
+            --gmp-password '#{password}' \
+            socket \
+            --xml="<get_report_formats/>"
+          `
+        )
+
+        rpt_fmt_xml_resp_by_name = report_formats_xml_resp.xpath(
+          "/get_report_formats_response/report_format[name/text()='#{report_type_name}']"
+        )
+
+        format_id = rpt_fmt_xml_resp_by_name.xpath('@id').text
+
+        # Generate Report
+        report_xml_resp = Nokogiri::XML(
+          `sudo runuser -u _gvm -- /usr/bin/gvm-cli \
+            --gmp-username '#{username}' \
+            --gmp-password '#{password}' \
+            socket \
+            --xml="<get_reports report_id='#{report_id}' format_id='#{format_id}'/>"
+          `
+        )
+
+        # timestamp = Time.parse(
+        #   report_xml_resp.xpath('//modification_time')
+        # ).localtime.strftime(
+        #   '%Y-%m-%d-%H-%M-%S%z'
+        # )
+
+        base64_report = report_xml_resp.xpath(
+          '//report/text()'
+        ).text
+
+        # File.open("#{report_dir}/openvas_results-#{timestamp}.#{report_type}", 'w') do |f|
+        File.open("#{report_dir}/openvas_results.#{report_type}", 'w') do |f|
+          f.puts Base64.strict_decode64(base64_report)
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # report_types = PWN::Plugins::OpenVAS.get_report_types(
+      #   username: 'required username',
+      #   password: 'optional password (will prompt if nil)'
+      # )
+
+      public_class_method def self.get_report_types(opts = {})
+        username = opts[:username].to_s.scrub
+
+        password = if opts[:password].nil?
+                     PWN::Plugins::AuthenticationHelper.mask_password
+                   else
+                     opts[:password].to_s.scrub
+                   end
+
+        report_types = %i[
+          csv
+          itg
+          pdf
+          txt
+          xml
+        ]
+      rescue StandardError => e
+        raise e
+      end
+
+      # Author(s):: Jacob Hoopes <jake.hoopes@gmail.com>
+
+      public_class_method def self.authors
+        "AUTHOR(S):
+          Jacob Hoopes <jake.hoopes@gmail.com>
+        "
+      end
+
+      # Display Usage for this Module
+
+      public_class_method def self.help
+        puts "USAGE:
+          task_xml_resp = #{self}.get_task_id(
+            task_name: 'required task name to start',
+            username: 'required username',
+            password: 'optional password (will prompt if nil)'
+          )
+
+          start_task_xml_resp = #{self}.start_task(
+            task_name: 'required task name to start',
+            username: 'required username',
+            password: 'optional password (will prompt if nil)'
+          )
+
+          task_status = #{self}.get_task_status(
+            task_name: 'required task name to start',
+            username: 'required username',
+            password: 'optional password (will prompt if nil)'
+          )
+
+          last_report_id = #{self}.last_report_id(
+            task_name: 'required task name to start',
+            username: 'required username',
+            password: 'optional password (will prompt if nil)'
+          )
+
+          #{self}.save_report(
+            report_type: 'required report type (csv|itg|pdf|txt|xml)',
+            report_id: 'required report id to save',
+            report_dir: 'required directory to save report',
+            username: 'required username',
+            password: 'optional password (will prompt if nil)'
+          )
+
+          report_types = #{self}.get_report_types(
+            username: 'required username',
+            password: 'optional password (will prompt if nil)'
+          )
+
+          #{self}.authors
+        "
+      end
+    end
+  end
+end