pwn 0.5.708 → 0.5.710

data/lib/pwn/plugins/log.rb

@@ -751,23 +751,123 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          logger = #{self}.append(
-            level: 'required - log verbosity :debug|:error|:fatal|:info|:learning|:unknown|:warn',
-            msg: 'required - message to log',
-            which_self: 'required - pass in self object from module calling #{self}'
+          # Run append and return its result
+          #{self}.append(
+            level: 'required - level value consumed by #append',
+            msg: 'optional - msg value consumed by #append',
+            which_self: 'optional - which self value consumed by #append'
           )
 
-          path = #{self}.start_debug(
-            tee: $stdout,
-            session_id: 'optional - pwn-ai session id'
+          # Run debug enabled and return its result
+          #{self}.debug_enabled?
+
+          # Run debug log path and return its result
+          #{self}.debug_log_path
+
+          # Open a debug session. Request traces go to
+          #{self}.start_debug(
+            trace: 'optional - trace value consumed by #start_debug',
+            path: 'required - filesystem path to read or write',
+            tee: 'optional - tee value consumed by #start_debug',
+            session_id: 'optional - session id value consumed by #start_debug',
+            step_io: 'optional - step io value consumed by #start_debug',
+            prefixes: 'optional - prefixes value consumed by #start_debug'
+          )
+
+          # Run trace enabled and return its result
+          #{self}.trace_enabled?
+
+          # Run next request log and return its result
+          #{self}.next_request_log!(
+            force: 'optional - force value consumed by #next_request_log!',
+            session_id: 'optional - session id value consumed by #next_request_log!'
+          )
+
+          # Run finish request log and return its result
+          #{self}.finish_request_log!(
+            force: 'optional - force value consumed by #finish_request_log!',
+            iter: 'optional - iter value consumed by #finish_request_log!',
+            tools_called: 'optional - tools called value consumed by #finish_request_log!',
+            engine_s: 'optional - engine s value consumed by #finish_request_log!',
+            final_chars: 'optional - final chars value consumed by #finish_request_log!',
+            nested: 'optional - nested value consumed by #finish_request_log!'
+          )
+
+          # Run stop debug and return its result
+          #{self}.stop_debug(
+            reason: 'required - reason value consumed by #stop_debug'
           )
-          #{self}.next_request_log!(session_id: 'optional')
-          #{self}.progress(msg: 'stage', which_self: self)
-          #{self}.finish_request_log!(iter: 1, tools_called: 0, engine_s: 0.2, final_chars: 12)
-          #{self}.stop_debug
-          # start_debug(trace: true) enables TracePoint + ENTER after each Loop step
-          # (toggle-trace). Stored on Pry.config.pwn_ai_trace, not Env.
+
+          # Run capture stderr and return its result
+          #{self}.capture_stderr!(
+            text: 'required - text value consumed by #capture_stderr!'
+          )
+
+          # Spinner frames stay on the TTY; never persist them in the RN log
+          #{self}.spinner_frame?(
+            text: 'optional - text value consumed by #spinner_frame?'
+          )
+
+          # Run raw stderr and return its result
+          #{self}.raw_stderr
+
+          # Run quiet tui and return its result
+          #{self}.quiet_tui!(
+            skip: 'optional - skip value consumed by #quiet_tui!'
+          )
+
+          # Run loud tui and return its result
+          #{self}.loud_tui!(
+            skip: 'optional - skip value consumed by #loud_tui!'
+          )
+
+          # One progress line to the debug file and the TUI tee (same payload)
+          #{self}.progress(
+            msg: 'optional - msg value consumed by #progress',
+            which_self: 'optional - which self value consumed by #progress (defaults to self)',
+            keep_newlines: 'optional - keep newlines value consumed by #progress',
+            cap: 'optional - cap value consumed by #progress',
+            tee: 'optional - tee value consumed by #progress'
+          )
+
+          # Run note interrupt and return its result
+          #{self}.note_interrupt!(
+            where: 'required - where value consumed by #note_interrupt!',
+            which_self: 'optional - which self value consumed by #note_interrupt! (defaults to self)'
+          )
+
+          # Run note exception and return its result
+          #{self}.note_exception!(
+            error: 'optional - error value consumed by #note_exception!',
+            where: 'required - where value consumed by #note_exception!',
+            which_self: 'optional - which self value consumed by #note_exception! (defaults to self)'
+          )
+
+          # Clone operator-visible TUI rows into the open RN request log (no ANSI)
+          #{self}.mirror_tui!(
+            msg: 'optional - msg value consumed by #mirror_tui!'
+          )
+
+          # Run start trace and return its result
+          #{self}.start_trace!(
+            prefixes: 'optional - prefixes value consumed by #start_trace!'
+          )
+
+          # Run stop trace and return its result
+          #{self}.stop_trace!(
+            skip: 'optional - skip value consumed by #stop_trace!'
+          )
+
+          # Run wait trace step and return its result
+          #{self}.wait_trace_step!(
+            nested: 'optional - nested value consumed by #wait_trace_step!',
+            label: 'required - label value consumed by #wait_trace_step!'
+          )
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/mail_agent.rb

@@ -242,102 +242,110 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # attachment_name1.doc: attachment file path 1,
           #{self}.office365(
-            from: 'required',
-            to: 'required',
-            cc: 'optional',
-            bcc: 'optional',
-            reply_to: 'optional',
-            subject: 'optional',
-            html_body: 'optional',
-            txt_body: 'optional alternative to :html_body',
-            attachments_hash: {
-              'attachment_name1.doc': 'attachment file path 1',
-              'attachment_name2.xls': 'attachment file path 2'
-            },
-            username: 'required domain\\username',
-            password: 'optional (but will be prompted if not submitted)',
-            debug: true|false
+            from: 'required - sender account or address to bind as operator',
+            to: 'required - to value consumed by #office365',
+            cc: 'optional - cc value consumed by #office365',
+            bcc: 'optional - bcc value consumed by #office365',
+            reply_to: 'optional - reply to value consumed by #office365',
+            subject: 'optional - subject value consumed by #office365',
+            html_body: 'optional - html body value consumed by #office365',
+            txt_body: 'optional - optional alternative to :html_body',
+            attachments_hash: 'optional - attachments hash value consumed by #office365',
+            username: 'required - required username',
+            password: 'optional - optional (but will be prompted if not submitted)',
+            debug: 'optional - debug value consumed by #office365',
+            address: 'optional - address value consumed by #office365',
+            port: 'optional - TCP/UDP port number',
+            tls_auto: 'optional - tls auto value consumed by #office365',
+            authentication: 'optional - authentication value consumed by #office365'
           )
 
+          # attachment_name1.doc: attachment file path 1,
           #{self}.gmail(
-            from: 'required',
-            to: 'required',
-            cc: 'optional',
-            bcc: 'optional',
-            reply_to: 'optional',
-            subject: 'optional',
-            html_body: 'optional',
-            txt_body: 'optional alternative to :html_body',
-            attachments_hash: {
-              'attachment_name1.doc': 'attachment file path 1',
-              'attachment_name2.xls': 'attachment file path 2'
-            },
-            username: 'required',
-            password: 'optional (but will be prompted if not submitted)'
-            debug: true|false
+            from: 'required - sender account or address to bind as operator',
+            to: 'required - to value consumed by #gmail',
+            cc: 'optional - cc value consumed by #gmail',
+            bcc: 'optional - bcc value consumed by #gmail',
+            reply_to: 'optional - reply to value consumed by #gmail',
+            subject: 'optional - subject value consumed by #gmail',
+            html_body: 'optional - html body value consumed by #gmail',
+            txt_body: 'optional - optional alternative to :html_body',
+            attachments_hash: 'optional - attachments hash value consumed by #gmail',
+            username: 'required - username value consumed by #gmail',
+            password: 'optional - optional (but will be prompted if not submitted)',
+            debug: 'optional - debug value consumed by #gmail',
+            address: 'optional - address value consumed by #gmail',
+            port: 'optional - TCP/UDP port number',
+            tls_auto: 'optional - tls auto value consumed by #gmail',
+            authentication: 'optional - authentication value consumed by #gmail'
           )
 
+          # attachment_name1.doc: attachment file path 1,
           #{self}.hotmail_n_live(
-            from: 'required',
-            to: 'required',
-            cc: 'optional',
-            bcc: 'optional',
-            reply_to: 'optional',
-            subject: 'optional',
-            html_body: 'optional',
-            txt_body: 'optional alternative to :html_body',
-            attachments_hash: {
-              'attachment_name1.doc': 'attachment file path 1',
-              'attachment_name2.xls': 'attachment file path 2'
-            },
-            username: 'required',
-            password: 'optional (but will be prompted if not submitted)'
-            debug: true|false
+            from: 'required - sender account or address to bind as operator',
+            to: 'required - to value consumed by #hotmail_n_live',
+            cc: 'optional - cc value consumed by #hotmail_n_live',
+            bcc: 'optional - bcc value consumed by #hotmail_n_live',
+            reply_to: 'optional - reply to value consumed by #hotmail_n_live',
+            subject: 'optional - subject value consumed by #hotmail_n_live',
+            html_body: 'optional - html body value consumed by #hotmail_n_live',
+            txt_body: 'optional - optional alternative to :html_body',
+            attachments_hash: 'optional - attachments hash value consumed by #hotmail_n_live',
+            username: 'required - username value consumed by #hotmail_n_live',
+            password: 'optional - optional (but will be prompted if not submitted)',
+            debug: 'optional - debug value consumed by #hotmail_n_live',
+            address: 'optional - address value consumed by #hotmail_n_live',
+            port: 'optional - TCP/UDP port number',
+            tls_auto: 'optional - tls auto value consumed by #hotmail_n_live',
+            authentication: 'optional - authentication value consumed by #hotmail_n_live'
           )
 
+          # attachment_name1.doc: attachment file path 1,
           #{self}.yahoo(
-            from: 'required',
-            to: 'required',
-            cc: 'optional',
-            bcc: 'optional',
-            reply_to: 'optional',
-            subject: 'optional',
-            html_body: 'optional',
-            txt_body: 'optional alternative to :html_body',
-            attachments_hash: {
-              'attachment_name1.doc': 'attachment file path 1',
-              'attachment_name2.xls': 'attachment file path 2'
-            },
-            username: 'required',
-            password: 'optional (but will be prompted if not submitted)'
-            debug: true|false
+            from: 'required - sender account or address to bind as operator',
+            to: 'required - to value consumed by #yahoo',
+            cc: 'optional - cc value consumed by #yahoo',
+            bcc: 'optional - bcc value consumed by #yahoo',
+            reply_to: 'optional - reply to value consumed by #yahoo',
+            subject: 'optional - subject value consumed by #yahoo',
+            html_body: 'optional - html body value consumed by #yahoo',
+            txt_body: 'optional - optional alternative to :html_body',
+            attachments_hash: 'optional - attachments hash value consumed by #yahoo',
+            username: 'required - username value consumed by #yahoo',
+            password: 'optional - optional (but will be prompted if not submitted)',
+            debug: 'optional - debug value consumed by #yahoo',
+            address: 'optional - address value consumed by #yahoo',
+            port: 'optional - TCP/UDP port number',
+            tls_auto: 'optional - tls auto value consumed by #yahoo',
+            authentication: 'optional - authentication value consumed by #yahoo'
           )
 
+          # attachment_name1.doc: attachment file path 1,
           #{self}.manual(
-            from: 'required',
-            to: 'required',
-            cc: 'optional',
-            bcc: 'optional',
-            reply_to: 'optional',
-            subject: 'optional',
-            html_body: 'optional',
-            txt_body: 'optional alternative to :html_body',
-            attachments_hash: {
-              'attachment_name1.doc': 'attachment file path 1',
-              'attachment_name2.xls': 'attachment file path 2'
-            },
-            address: 'smtp server ip or domain',
-            port: 'smtp port',
-            tls_auto: true|false,
-            authentication: 'optional defaults to :plain - available :login, :plain, or :cram_md5',
-            username: 'optional',
-            password: 'optional',
-            debug: true|false
+            from: 'required - sender account or address to bind as operator',
+            to: 'required - to value consumed by #manual',
+            cc: 'optional - cc value consumed by #manual',
+            bcc: 'optional - bcc value consumed by #manual',
+            reply_to: 'optional - reply to value consumed by #manual',
+            subject: 'optional - subject value consumed by #manual',
+            html_body: 'optional - html body value consumed by #manual',
+            txt_body: 'optional - optional alternative to :html_body',
+            attachments_hash: 'optional - attachments hash value consumed by #manual',
+            address: 'optional - smtp server ip or domain',
+            port: 'optional - smtp port',
+            tls_auto: 'optional - tls auto value consumed by #manual',
+            username: 'optional - username value consumed by #manual',
+            password: 'optional - password value consumed by #manual',
+            debug: 'optional - debug value consumed by #manual',
+            authentication: 'optional - authentication value consumed by #manual'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/metasploit.rb

@@ -130,21 +130,26 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          console_obj = #{self}.connect(
-            yaml_conf: 'optional -  path to userland yaml (defaults to $PWN_ROOT/etc/userland/$PWN_PROVIDER/metasploit/vagrant.yaml)'
+          # Run connect and return its result
+          #{self}.connect(
+            yaml_conf: 'optional - path to userland yaml (defaults to /pwn/etc/userland/PWN_PROVIDEDR/metasploit/vagrant.yaml)'
           )
 
-          console_obj = #{self}.console_exec(
-            console_obj: 'required - msfrpcd_conn object returned from #connect method',
+          # Run console exec and return its result
+          #{self}.console_exec(
+            console_obj: 'required - console_obj object returned from #connect method',
             cmd: 'required - msfconsole command string or array of strings'
           )
 
-          console_obj = #{self}.disconnect(
-            console_obj: 'required - msfrpcd_conn object returned from #connect method'
+          # Run disconnect and return its result
+          #{self}.disconnect(
+            console_obj: 'required - console_obj returned from #console_exec method to terminate'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/monkey_patch.rb

@@ -172,10 +172,13 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run pry and return its result
           #{self}.pry
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/msr206.rb

@@ -1193,64 +1193,78 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          msr206_obj = #{self}.connect(
-            block_dev: 'optional serial block device path (defaults to /dev/ttyUSB0)',
-            baud: 'optional (defaults to 19200)',
-            data_bits: 'optional (defaults to 8)',
-            stop_bits: 'optional (defaults to 1)',
-            parity: 'optional - :even||:odd|:none (defaults to :none)',
-            flow_control: 'optional - :none||:hard||:soft (defaults to :soft)'
+          # Run connect and return its result
+          #{self}.connect(
+            block_dev: 'optional - serial block device path (defaults to /dev/ttyUSB0)',
+            baud: 'optional - (defaults to 19200)',
+            data_bits: 'optional - (defaults to 8)',
+            stop_bits: 'optional - (defaults to 1)',
+            parity: 'optional - :even|:mark|:odd|:space|:none (defaults to :none),',
+            flow_control: 'optional - :none|:hard|:soft (defaults to :soft)'
           )
 
+          # Run list cmds and return its result
+          #{self}.list_cmds
+
+          # Run set protocol and return its result
           #{self}.set_protocol(
             msr206_obj: 'required - msr206_obj returned from #connect method',
             protocol: 'optional - :usi0 or :usi1 (defaults to :usi0)'
           )
 
-          cmds = #{self}.list_cmds
-
-          parsed_cmd_resp_arr = #{self}.exec(
-            msr206_obj: 'required msr206_obj returned from #connect method',
+          # Run exec and return its result
+          #{self}.exec(
+            msr206_obj: 'required - msr206_obj returned from #connect method',
             cmd: 'required - cmd returned from #list_cmds method',
-            params: 'optional - parameters for specific command'
+            params: 'optional - parameters for specific command returned from #list_params method'
           )
 
-          track_data = #{self}.read_card(
-            msr206_obj: 'required msr206_obj returned from #connect method'
+          # Run read card and return its result
+          #{self}.read_card(
+            msr206_obj: 'required - msr206_obj returned from #connect method'
           )
 
-          track_data = #{self}.backup_card(
-            msr206_obj: 'required msr206_obj returned from #connect method'
+          # Run backup card and return its result
+          #{self}.backup_card(
+            msr206_obj: 'required - msr206_obj returned from #connect method'
           )
 
-          track_data = #{self}.write_card(
-            msr206_obj: 'required msr206_obj returned from #connect method',
+          # Run write card and return its result
+          #{self}.write_card(
+            msr206_obj: 'required - msr206_obj returned from #connect method',
             encoding: 'required - :iso || :iso_alt || :raw',
-            track_data: 'required - track data to write'
+            track_data: 'required - track data to write (see #backup_card for structure)'
           )
 
-          track_data = #{self}.clone_card(
-            msr206_obj: 'required msr206_obj returned from #connect method'
+          # Run clone card and return its result
+          #{self}.clone_card(
+            msr206_obj: 'required - msr206_obj returned from #connect method'
           )
 
-          track_data = #{self}.load_card_from_file(
-            msr206_obj: 'required msr206_obj returned from #connect method'
+          # Run load card from file and return its result
+          #{self}.load_card_from_file(
+            msr206_obj: 'required - msr206_obj returned from #connect method'
           )
 
-          track_data = #{self}.update_card(
-            msr206_obj: 'required msr206_obj returned from #connect method'
+          # Run update card and return its result
+          #{self}.update_card(
+            msr206_obj: 'required - msr206_obj returned from #connect method'
           )
 
-          config = #{self}.get_config(
-            msr206_obj: 'required msr206_obj returned from #connect method'
+          # Run get config and return its result
+          #{self}.get_config(
+            msr206_obj: 'required - msr206_obj returned from #connect method'
           )
 
+          # Run disconnect and return its result
           #{self}.disconnect(
-            msr206_obj: 'required msr206_obj returned from #connect method'
+            msr206_obj: 'required - msr206_obj returned from #connect method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/plugins/nessus_cloud.rb

@@ -743,55 +743,87 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          nessus_obj = #{self}.login(
+          # Run login and return its result
+          #{self}.login(
             access_key: 'required - API access key (will prompt if blank)',
             secret_key: 'required - API secret key (will prompt if blank)'
           )
 
+          # Run get canned scan templates and return its result
           #{self}.get_canned_scan_templates(
             nessus_obj: 'required - nessus_obj returned from #login method',
             name: 'optional - name of scan template'
           )
 
+          # Run get policies and return its result
           #{self}.get_policies(
             nessus_obj: 'required - nessus_obj returned from #login method',
             name: 'optional - name of policy (i.e. user-defined template)'
           )
 
+          # Run get folders and return its result
           #{self}.get_folders(
             nessus_obj: 'required - nessus_obj returned from #login method',
             name: 'optional - name of folder'
           )
 
+          # Run get scanners and return its result
           #{self}.get_scanners(
             nessus_obj: 'required - nessus_obj returned from #login method',
             name: 'optional - name of scanner'
           )
 
+          # Run get target networks and return its result
           #{self}.get_target_networks(
             nessus_obj: 'required - nessus_obj returned from #login method',
             name: 'optional - name of target network'
           )
 
+          # Run get timezones and return its result
           #{self}.get_timezones(
             nessus_obj: 'required - nessus_obj returned from #login method',
             name: 'optional - name of timezone'
           )
 
+          # Run get target groups and return its result
           #{self}.get_target_groups(
             nessus_obj: 'required - nessus_obj returned from #login method',
             name: 'optional - name of target group'
           )
 
+          # Run get tag values and return its result
           #{self}.get_tag_values(
             nessus_obj: 'required - nessus_obj returned from #login method',
             name: 'optional - name of tag value'
           )
 
+          # Run get assets and return its result
+          #{self}.get_assets(
+            nessus_obj: 'required - nessus_obj returned from #login method',
+            name: 'optional - name of asset'
+          )
+
+          # Run add tag to assets and return its result
+          #{self}.add_tag_to_assets(
+            nessus_obj: 'required - nessus_obj returned from #login method',
+            targets: 'required - comma-delimited list of targets to tag',
+            tag_uuids: 'required - array of tag UUIDS to tag against targets'
+          )
+
+          # Run get credential types and return its result
+          #{self}.get_credential_types(
+            nessus_obj: 'required - nessus_obj returned from #login method',
+            category: 'optional - category of credential type (Defaults to Host)',
+            name: 'optional - name of credential type (Defaults to SSH)'
+          )
+
+          # Run get scans and return its result
           #{self}.get_scans(
-            nessus_obj: 'required - nessus_obj returned from #login method'
+            nessus_obj: 'required - nessus_obj returned from #login method',
+            name: 'optional - binary or identifier name'
           )
 
+          # Run create scan and return its result
           #{self}.create_scan(
             nessus_obj: 'required - nessus_obj returned from #login method',
             scan_template_uuid: 'required - the UUID for the Tenable-provided scan template to use.  Run #get_canned_scan_templates for a list of UUIDs',
@@ -800,6 +832,7 @@ module PWN
             plugins: 'optional - plugins object as defined by https://developer.tenable.com/reference/scans-create (Defaults to {})'
           )
 
+          # Run update scan and return its result
           #{self}.update_scan(
             nessus_obj: 'required - nessus_obj returned from #login method',
             scan_id: 'required - the scan id to update.  Run #get_scans for a list',
@@ -809,16 +842,19 @@ module PWN
             plugins: 'optional - plugins object as defined by https://developer.tenable.com/reference/scans-create (Defaults to {})'
           )
 
+          # Run launch scan and return its result
           #{self}.launch_scan(
             nessus_obj: 'required - nessus_obj returned from #login method',
             scan_id: 'required - scan uuid to launch'
           )
 
+          # Run get scan status and return its result
           #{self}.get_scan_status(
             nessus_obj: 'required - nessus_obj returned from #login method',
             scan_id: 'required - scan uuid to retrieve status'
           )
 
+          # Run create tag and return its result
           #{self}.create_tag(
             nessus_obj: 'required - nessus_obj returned from #login method',
             category: 'required - category name to create or use',
@@ -826,21 +862,25 @@ module PWN
             desc: 'optional - tag value description'
           )
 
+          # Run get scan history and return its result
           #{self}.get_scan_history(
-            nessus_obj: 'required - nessus_obj returned from #login method'
+            nessus_obj: 'required - nessus_obj returned from #login method',
             scan_id: 'required - scan uuid to launch'
           )
 
+          # Run export scan results and return its result
           #{self}.export_scan_results(
             nessus_obj: 'required - nessus_obj returned from #login method',
             scan_id: 'required - scan uuid to export',
             path_to_export: 'required - filename to export results',
             history_id: 'optional - defaults to last scan',
-            format: 'optional - :csv|:db|:html|:nessus|:pdf (defaults to :csv')
+            format: 'optional - :csv|:db|:html|:nessus|:pdf (defaults to :csv'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end