pwn 0.5.708 → 0.5.710

data/lib/pwn/plugins/dao_ldap.rb

@@ -105,26 +105,32 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          ldap_obj = #{self}.connect(
-            host: 'required host or IP',
-            port: 'required port',
-            base: 'required ldap base to search from (e.g. dc=domain,dc=com)',
-            encryption: 'optional parameter to protect communication in transit, :simple_tls OR :start_tls',
-            auth_method: 'required ldap auth bind method, :simple, :sasl, OR :gss_spnego'
-            username: 'required username',
-            password: 'optional (prompts if left blank)',
+          # Run connect and return its result
+          #{self}.connect(
+            host: 'required - required host or IP',
+            port: 'optional - optional port (defaults to 636)',
+            base: 'required - required ldap base to search from (e.g. dc=domain,dc=com)',
+            encryption: 'optional - optional parameter to protect communication in transit, :simple_tls OR :start_tls',
+            auth_method: 'required - required ldap auth bind method, :simple, :sasl, OR :gss_spnego',
+            username: 'required - required username (e.g. support@0dayinc.com)',
+            password: 'optional - optional (prompts if left blank)'
           )
 
-          employee = #{self}.get_employee_by_username(
-            ldap_obj: 'required ldap_obj returned from #connect method',
-            username: 'required username of employee to retrieve from LDAP server'
+          # Run get employee by username and return its result
+          #{self}.get_employee_by_username(
+            ldap_obj: 'required - required ldap_obj returned from #connect method',
+            username: 'required - required username of employee to retrieve from LDAP server'
           )
-          puts employee[0][:dn]
 
-          #{self}.disconnect(:ldap_obj => ldap_obj)
+          # Run disconnect and return its result
+          #{self}.disconnect(
+            ldap_obj: 'optional - ldap obj value consumed by #disconnect'
+          )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/dao_mongo.rb

@@ -80,16 +80,22 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          mongo_conn = #{self}.connect(
-            host: 'optional host or IP defaults to 127.0.0.1',
-            port: 'optional port defaults to 27017',
-            database: 'optional database name'
+          # Run connect and return its result
+          #{self}.connect(
+            host: 'optional - optional host or IP defaults to 127.0.0.1',
+            port: 'optional - optional port defaults to 27017',
+            database: 'optional - optional database name'
           )
 
-          #{self}.disconnect(mongo_conn: mongo_conn)
+          # Run disconnect and return its result
+          #{self}.disconnect(
+            mongo_conn: 'optional - mongo conn value consumed by #disconnect'
+          )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/dao_postgres.rb

@@ -190,34 +190,43 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          pg_conn = #{self}.connect(
-            host: 'required host or IP',
-            port: 'optional port (defaults to 5432)',
-            dbname: 'required database name',
-            user: 'required username',
-            password: 'optional (prompts if left blank)',
-            connect_timeout: 'optional (defaults to 60 seconds)',
-            options: 'optional postgres options',
-            tty: 'optional tty',
-            sslmode: :disable|:allow|:prefer|:require
+          # Run connect and return its result
+          #{self}.connect(
+            host: 'required - required host or IP',
+            port: 'optional - optional port (defaults to 5432)',
+            dbname: 'required - required database name',
+            user: 'required - required username',
+            password: 'optional - optional (prompts if left blank)',
+            connect_timeout: 'optional - optional (defaults to 60 seconds)',
+            options: 'optional - optional postgres options',
+            tty: 'optional - optional tty',
+            sslmode: 'required - :disable|:allow|:prefer|:require'
           )
 
-          res = #{self}.sql_statement(
-            pg_conn: pg_conn,
-            prepared_statement: 'SELECT * FROM tn_users WHERE state = $1',
-            statement_params: ['Active']
+          # Run sql statement and return its result
+          #{self}.sql_statement(
+            pg_conn: 'optional - pg conn value consumed by #sql_statement',
+            prepared_statement: 'optional - SELECT * FROM tn_users WHERE state = $1',
+            statement_params: 'required - statement params value consumed by #sql_statement'
           )
 
-          res = #{self}.list_all_columns_by_table(
-            pg_conn: pg_conn,
-            schema: 'required schema name',
-            table_name: 'required table name'
+          # Method Parameters Not Implemented
+          #{self}.list_all_columns_by_table(
+            pg_conn: 'optional - pg conn value consumed by #list_all_columns_by_table',
+            schema: 'required - required schema name',
+            table_name: 'required - required table name',
+            table_schema: 'optional - table schema value consumed by #list_all_columns_by_table'
           )
 
-          #{self}.disconnect(pg_conn: pg_conn)
+          # Run disconnect and return its result
+          #{self}.disconnect(
+            pg_conn: 'optional - pg conn value consumed by #disconnect'
+          )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/dao_sqlite3.rb

@@ -107,18 +107,27 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          sqlite3_conn = #{self}.connect(db_path: 'Required - Path of SQLite3 DB File')
+          # Run connect and return its result
+          #{self}.connect(
+            db_path: 'required - Path of SQLite3 DB File'
+          )
 
-          res = #{self}.sql_statement(
-            sqlite3_conn: sqlite3_conn,
-            prepared_statement: 'SELECT * FROM tn_users WHERE state = ?;',
-            statement_params: ['Active']
+          # Run sql statement and return its result
+          #{self}.sql_statement(
+            sqlite3_conn: 'optional - sqlite3 conn value consumed by #sql_statement',
+            prepared_statement: 'optional - SELECT * FROM tn_users WHERE state = ?;',
+            statement_params: 'required - statement params value consumed by #sql_statement'
           )
 
-          #{self}.disconnect(:sqlite3_conn => sqlite3_conn)
+          # Run disconnect and return its result
+          #{self}.disconnect(
+            sqlite3_conn: 'optional - sqlite3 conn value consumed by #disconnect'
+          )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/defect_dojo.rb

@@ -738,7 +738,8 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          dd_obj = #{self}.login(
+          # Run login and return its result
+          #{self}.login(
             url: 'required - url of DefectDojo Server',
             api_version: 'required - api version to use v1 || v2',
             username: 'required - username to AuthN w/ api v1)',
@@ -746,18 +747,21 @@ module PWN
             proxy: 'optional - proxy all traffic through MITM proxy (defaults to nil)'
           )
 
-          product_list = #{self}.product_list(
-            dd_obj: 'required dd_obj returned from #login_v1 method',
+          # Run product list and return its result
+          #{self}.product_list(
+            dd_obj: 'required - required dd_obj returned from #login method',
             id: 'optional - retrieve single product by id, otherwise return all'
           )
 
-          engagement_list = #{self}.engagement_list(
-            dd_obj: 'required dd_obj returned from #login_v1 method',
+          # Run engagement list and return its result
+          #{self}.engagement_list(
+            dd_obj: 'required - required dd_obj returned from #login method',
             id: 'optional - retrieve single engagement by id, otherwise return all'
           )
 
-          engagement_create_response = #{self}.engagement_create(
-            dd_obj: 'required - dd_obj returned from #login_v1 method',
+          # Run engagement create and return its result
+          #{self}.engagement_create(
+            dd_obj: 'required - dd_obj returned from #login method',
             name: 'required - name of the engagement',
             description: 'optional - description of engagement',
             engagement_type: 'optional - type of engagement Interactive||CI/CD (defaults to CI/CD)',
@@ -774,16 +778,19 @@ module PWN
             check_list: 'optional - boolean to set an engagement as a checkbox assessment (defaults to false)',
             first_contacted: 'optional - date of engagement request e.g. 2018-06-18 (Defaults to current day)',
             target_start: 'optional - date to start enagement e.g. 2018-06-19 (Defaults to current day)',
-            target_end: 'optional - date of engagement completion e.g. 2018-06-20 (Defaults to current day)'
+            target_end: 'optional - date of engagement completion e.g. 2018-06-20 (Defaults to current day)',
+            engagment_type: 'optional - engagment type value consumed by #engagement_create'
           )
 
-          test_list = #{self}.test_list(
-            dd_obj: 'required dd_obj returned from #login_v1 method',
+          # Run test list and return its result
+          #{self}.test_list(
+            dd_obj: 'required - required dd_obj returned from #login method',
             id: 'optional - retrieve single test by id, otherwise return all'
           )
 
-          importscan_response = #{self}.importscan(
-            dd_obj: 'required - dd_obj returned from #login_v1 method',
+          # Run importscan and return its result
+          #{self}.importscan(
+            dd_obj: 'required - dd_obj returned from #login method',
             engagement_name: 'required - name of engagement to associate w/ scan',
             scan_type: 'required - type of scan importing (see <DEFECTDOJO_URL>/admin/dojo/test_type/ for listing)',
             file: 'required - path of scan results file',
@@ -795,11 +802,14 @@ module PWN
             create_finding_groups: 'optional - flag to create finding groups (defaults to false)',
             close_old_findings_product_scope: 'optional - flag to close old findings from engagement (defaults to false)',
             close_old_findings: 'optional - flag to close old findings, regardless of engagement (defaults to false)',
-            push_to_jira: 'optional - flag to push findings to JIRA (defaults to false)'
+            push_to_jira: 'optional - flag to push findings to JIRA (defaults to false)',
+            test_title: 'optional - test title value consumed by #importscan',
+            group_by: 'required - group by value consumed by #importscan'
           )
 
-          reimportscan_response = #{self}.reimportscan(
-            dd_obj: 'required - dd_obj returned from #login_v1 method',
+          # Run reimportscan and return its result
+          #{self}.reimportscan(
+            dd_obj: 'required - dd_obj returned from #login method',
             engagement_name: 'required - name of engagement to associate w/ scan',
             scan_type: 'required - type of scan importing (see <DEFECTDOJO_URL>/admin/dojo/test_type/ for listing)',
             file: 'required - path of scan results file',
@@ -814,27 +824,33 @@ module PWN
             push_to_jira: 'optional - flag to push findings to JIRA (defaults to false)'
           )
 
-          finding_list = #{self}.finding_list(
-            dd_obj: 'required dd_obj returned from #login_v1 method',
+          # Run finding list and return its result
+          #{self}.finding_list(
+            dd_obj: 'required - required dd_obj returned from #login method',
             id: 'optional - retrieve single finding by id, otherwise return all'
           )
 
-          user_list = #{self}.user_list(
-            dd_obj: 'required dd_obj returned from #login_v1 method',
+          # Run user list and return its result
+          #{self}.user_list(
+            dd_obj: 'required - required dd_obj returned from #login method',
             id: 'optional - retrieve single user by id, otherwise return all'
           )
 
-          tool_configuration_list = #{self}.tool_configuration_list(
-            dd_obj: 'required dd_obj returned from #login_v1 method',
+          # Run tool configuration list and return its result
+          #{self}.tool_configuration_list(
+            dd_obj: 'required - required dd_obj returned from #login method',
             id: 'optional - retrieve single test by id, otherwise return all'
           )
 
+          # Run logout and return its result
           #{self}.logout(
-            dd_obj: 'required dd_obj returned from #login_v1 or #login_v2 method'
+            dd_obj: 'required - required dd_obj returned from #login method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/detect_os.rb

@@ -57,14 +57,19 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run type and return its result
           #{self}.type
 
+          # Run arch and return its result
           #{self}.arch
 
+          # Run endian and return its result
           #{self}.endian
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/ein.rb

@@ -129,12 +129,15 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run generate and return its result
           #{self}.generate(
             count: 'required - number of EIN numbers to generate'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/exploit_db.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'open3'
+
+module PWN
+  module Plugins
+    # searchsploit / ExploitDB plus a CPE string builder for nmap versions.
+    module ExploitDB
+      public_class_method def self.required_bins
+        %w[searchsploit]
+      end
+
+      public_class_method def self.search(opts = {})
+        q = (opts[:query] || opts[:q]).to_s
+        raise 'ERROR: query is required' if q.empty?
+
+        return { error: 'searchsploit missing', query: q } unless PWN::Plugins::PreflightChecker.bin?(name: 'searchsploit')
+
+        stdout, stderr, status = Open3.capture3('searchsploit', '--json', q)
+        parsed = begin
+          JSON.parse(stdout)
+        rescue JSON::ParserError
+          {}
+        end
+        { query: q, results: parsed['RESULTS_EXPLOIT'] || parsed['results'] || [], stderr: stderr, exit: status.exitstatus }
+      end
+
+      public_class_method def self.cve_for_cpe(opts = {})
+        cpe = opts[:cpe].to_s
+        product = opts[:product].to_s
+        version = opts[:version].to_s
+        q = cpe
+        q = "#{product} #{version}".strip if q.empty?
+        raise 'ERROR: cpe or product is required' if q.empty?
+
+        search(query: q).merge(cpe: cpe, product: product, version: version)
+      end
+
+      public_class_method def self.authors
+        "AUTHOR(S):\n  0day Inc. <support@0dayinc.com>\n"
+      end
+
+      public_class_method def self.help
+        puts "USAGE:
+          # List host binaries this module expects to be installed.
+          #{self}.required_bins
+
+          # Search local ExploitDB via searchsploit --json.
+          #{self}.search(
+            query: 'required - product, CVE, or keyword',
+            q: 'optional - alias for query'
+          )
+
+          # Build a search from an nmap CPE/product/version tuple.
+          #{self}.cve_for_cpe(
+            cpe: 'optional - CPE string (e.g. cpe:/a:apache:http_server:2.4.49)',
+            product: 'optional - product name when no CPE',
+            version: 'optional - version string from nmap_it'
+          )
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+        constants.sort
+      end
+    end
+  end
+end