pwn 0.5.708 → 0.5.709

data/lib/pwn/aws/waf_regional.rb

@@ -72,20 +72,23 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          waf_regional_obj = #{self}.connect(
+          # Run connect and return its result
+          #{self}.connect(
             region: 'required - region name to connect (eu-west-1, ap-southeast-1, ap-southeast-2, eu-central-1, ap-northeast-2, ap-northeast-1, us-east-1, sa-east-1, us-west-1, us-west-2)',
             access_key_id: 'required - Use AWS STS for best privacy (i.e. temporary access key id)',
             secret_access_key: 'required - Use AWS STS for best privacy (i.e. temporary secret access key',
             sts_session_token: 'optional - Temporary token returned by STS client for best privacy'
           )
-          puts waf_regional_obj.public_methods
 
+          # Run disconnect and return its result
           #{self}.disconnect(
             waf_regional_obj: 'required - waf_regional_obj returned from #connect method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/aws/workspaces.rb

@@ -72,20 +72,23 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          workspaces_obj = #{self}.connect(
+          # Run connect and return its result
+          #{self}.connect(
             region: 'required - region name to connect (eu-west-1, ap-southeast-1, ap-southeast-2, eu-central-1, ap-northeast-2, ap-northeast-1, us-east-1, sa-east-1, us-west-1, us-west-2)',
             access_key_id: 'required - Use AWS STS for best privacy (i.e. temporary access key id)',
             secret_access_key: 'required - Use AWS STS for best privacy (i.e. temporary secret access key',
             sts_session_token: 'optional - Temporary token returned by STS client for best privacy'
           )
-          puts workspaces_obj.public_methods
 
+          # Run disconnect and return its result
           #{self}.disconnect(
             workspaces_obj: 'required - workspaces_obj returned from #connect method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/aws/x_ray.rb

@@ -72,20 +72,23 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          x_ray_obj = #{self}.connect(
+          # Run connect and return its result
+          #{self}.connect(
             region: 'required - region name to connect (eu-west-1, ap-southeast-1, ap-southeast-2, eu-central-1, ap-northeast-2, ap-northeast-1, us-east-1, sa-east-1, us-west-1, us-west-2)',
             access_key_id: 'required - Use AWS STS for best privacy (i.e. temporary access key id)',
             secret_access_key: 'required - Use AWS STS for best privacy (i.e. temporary secret access key',
             sts_session_token: 'optional - Temporary token returned by STS client for best privacy'
           )
-          puts x_ray_obj.public_methods
 
+          # Run disconnect and return its result
           #{self}.disconnect(
             x_ray_obj: 'required - x_ray_obj returned from #connect method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/aws.rb

@@ -105,6 +105,10 @@ module PWN
     end
 
     public_class_method def self.help
+      puts "USAGE:
+        # Display a List of Every PWN::AWS Module
+        #{self}.authors
+      "
       constants.sort
     end
   end

data/lib/pwn/banner/anon.rb

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

data/lib/pwn/banner/bubble.rb

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

data/lib/pwn/banner/cheshire.rb

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

data/lib/pwn/banner/code_cave.rb

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

data/lib/pwn/banner/dont_panic.rb

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

data/lib/pwn/banner/f_society.rb

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

data/lib/pwn/banner/fork_bomb.rb

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

data/lib/pwn/banner/jmp_esp.rb

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

data/lib/pwn/banner/matrix.rb

@@ -194,12 +194,16 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run get and return its result
           #{self}.get
 
-          #{self}.has_you
+          # Run you and return its result
+          #{self}.you?
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/banner/ninja.rb

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

data/lib/pwn/banner/off_the_air.rb

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

data/lib/pwn/banner/pirate.rb

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

data/lib/pwn/banner/radare2.rb

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

data/lib/pwn/banner/radare2_ai.rb

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

data/lib/pwn/banner/white_rabbit.rb

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

data/lib/pwn/banner.rb

@@ -95,14 +95,18 @@ module PWN
 
     public_class_method def self.help
       puts "USAGE:
-        banner = #{self}.get(
+        # Run get and return its result
+        #{self}.get(
           index: 'optional - defaults to random banner index'
         )
 
-        banner = #{self}.welcome
+        # Run welcome and return its result
+        #{self}.welcome
 
+        # Print the AUTHOR(S) string for this module.
         #{self}.authors
       "
+      constants.sort
     end
   end
 end

data/lib/pwn/blockchain/btc.rb

@@ -261,19 +261,24 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          latest_block = #{self}.get_latest_block
+          # Run get latest block and return its result
+          #{self}.get_latest_block
 
-          block_details = #{self}.get_block_details(
+          # Run get block details and return its result
+          #{self}.get_block_details(
             height: 'required - block height as an integer (0 for genesis block / Defaults to latest block)'
           )
 
-          transactions = #{self}.get_transactions(
+          # Run get transactions and return its result
+          #{self}.get_transactions(
             from: 'required - start date in YYYY-MM-DD format',
             to: 'required - end date in YYYY-MM-DD format'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/blockchain/eth.rb

@@ -142,14 +142,21 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          latest_block = #{self}.get_latest_block
+          # Run get latest block and return its result
+          #{self}.get_latest_block(
+            token: 'optional - API token for higher rate limits'
+          )
 
-          block_details = #{self}.get_block_details(
-            height: 'required - block height number'
+          # Run get block details and return its result
+          #{self}.get_block_details(
+            height: 'required - block height number',
+            token: 'optional - API token for higher rate limits'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/blockchain.rb

@@ -17,6 +17,10 @@ module PWN
     end
 
     public_class_method def self.help
+      puts "USAGE:
+        # Display a List of Every PWN::Blockchain Module
+        #{self}.authors
+      "
       constants.sort
     end
   end

data/lib/pwn/bounty/lifecycle_authz_replay.rb

@@ -248,33 +248,52 @@ module PWN
       # Display Usage Information
 
       public_class_method def self.help
-        <<~HELP
-          Usage:
-            plan = PWN::Bounty::LifecycleAuthzReplay.load_plan(
-              yaml_path: '/path/to/lifecycle_authz_replay.yaml'
-            )
-
-            run_obj = PWN::Bounty::LifecycleAuthzReplay.start_run(
-              plan: plan,
-              output_dir: '/tmp/evidence-bundles'
-            )
-
-            PWN::Bounty::LifecycleAuthzReplay.record_observation(
-              run_obj: run_obj,
-              checkpoint: 'post_change_t0',
-              actor: 'revoked_user',
-              surface: 'repo_settings_page',
-              status: :accessible,
-              request: { method: 'GET', path: '/org/repo/settings' },
-              response: { http_status: 200 },
-              notes: 'Still reachable after remove action',
-              artifact_paths: ['/tmp/screenshot.png']
-            )
-
-            summary = PWN::Bounty::LifecycleAuthzReplay.finalize_run(
-              run_obj: run_obj
-            )
-        HELP
+        puts "USAGE:
+          # Run load plan and return its result
+          #{self}.load_plan(
+            yaml_path: 'required - /path/to/lifecycle_authz_replay.yaml'
+          )
+
+          # Run start run and return its result
+          #{self}.start_run(
+            yaml_path: 'optional - /path/to/lifecycle_authz_replay.yaml',
+            output_dir: 'required - /tmp/evidence_bundle',
+            plan: 'required - normalized_plan_hash',
+            run_id: 'required - run id value consumed by #start_run'
+          )
+
+          # Run record observation and return its result
+          #{self}.record_observation(
+            run_obj: 'required - run obj value consumed by #record_observation',
+            checkpoint: 'required - checkpoint value consumed by #record_observation',
+            actor: 'required - actor value consumed by #record_observation',
+            surface: 'required - repo_settings_page',
+            status: 'required - status value consumed by #record_observation',
+            request: 'optional - { method: GET, path: /org/repo/settings }',
+            response: 'optional - { http_status: 200 }',
+            notes: 'optional - Still reachable after collaborator removal',
+            artifact_paths: 'optional - Array [/tmp/screen.png]'
+          )
+
+          # Run finalize run and return its result
+          #{self}.finalize_run(
+            run_obj: 'required - run obj value consumed by #finalize_run'
+          )
+
+          # Run normalize plan and return its result
+          #{self}.normalize_plan(
+            plan: 'optional - plan value consumed by #normalize_plan',
+            campaign: 'required - { id: acme-revoke }',
+            actors: 'optional - [owner, revoked_user]',
+            surfaces: 'optional - surfaces value consumed by #normalize_plan',
+            checkpoints: 'required - [pre_change, post_change_t0]',
+            plan_id_hint: 'required - plan id hint value consumed by #normalize_plan'
+          )
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
+        constants.sort
       end
 
       private_class_method def self.find_stale_access_findings(opts = {})

data/lib/pwn/bounty.rb

@@ -16,6 +16,10 @@ module PWN
     end
 
     public_class_method def self.help
+      puts "USAGE:
+        # Display a List of Every PWN::Bounty Module
+        #{self}.authors
+      "
       constants.sort
     end
   end

data/lib/pwn/config.rb

@@ -1050,39 +1050,105 @@ module PWN
 
     public_class_method def self.help
       puts "USAGE:
+        # Run env template and return its result
+        #{self}.env_template
+
+        # Run default env and return its result
         #{self}.default_env(
           pwn_env_path: 'optional - Path to pwn.yaml file.  Defaults to ~/.pwn/pwn.yaml'
         )
 
+        # Run redact sensitive artifacts and return its result
         #{self}.redact_sensitive_artifacts(
           config: 'optional - Hash to redact sensitive artifacts from.  Defaults to PWN::Env'
         )
 
-        #{self}.pwn_skills_path
+        # Run init driver options and return its result
+        #{self}.init_driver_options
+
+        # Run refresh env and return its result
+        #{self}.refresh_env(
+          pwn_env_path: 'required - pwn env path value consumed by #refresh_env',
+          pwn_dec_path: 'required - pwn dec path value consumed by #refresh_env',
+          key: 'optional - key value consumed by #refresh_env',
+          iv: 'optional - iv value consumed by #refresh_env'
+        )
 
-        #{self}.sanitize_skill_name(name: '...')
+        # Run pwn skills path and return its result
+        #{self}.pwn_skills_path(
+          pwn_env_path: 'optional - Path to pwn.yaml file.  Defaults to ~/.pwn/pwn.yaml'
+        )
 
+        # Run sanitize skill name and return its result
+        #{self}.sanitize_skill_name(
+          name: 'required - binary or identifier name'
+        )
+
+        # Run parse skill frontmatter and return its result
+        #{self}.parse_skill_frontmatter(
+          content: 'optional - content value consumed by #parse_skill_frontmatter'
+        )
+
+        # Run parse skill references and return its result
+        #{self}.parse_skill_references(
+          content: 'optional - content value consumed by #parse_skill_references'
+        )
+
+        # Run write skill and return its result
         #{self}.write_skill(
-          name: 'required', content: 'required',
-          description: 'optional', references: 'optional Array',
-          license: 'optional', metadata: 'optional Hash',
-          allowed_tools: 'optional Array', pwn_skills_path: 'optional'
+          name: 'required - free-form; sanitised to [a-z0-9-]',
+          content: 'required - markdown body (WITHOUT frontmatter)',
+          description: 'optional - 1..1024 chars; derived from body when omitted',
+          references: 'optional - Array of URLs / CWE / CVE / ATT&CK / NIST ids',
+          license: 'optional - SPDX id or free text',
+          metadata: 'optional - Hash of arbitrary metadata',
+          allowed_tools: 'optional - Array of toolset names',
+          pwn_skills_path: 'optional - override skills root (defaults to pwn_skills_path)'
         )
 
-        #{self}.load_skills(pwn_skills_path: 'optional')
+        # Run migrate legacy skills and return its result
+        #{self}.migrate_legacy_skills(
+          pwn_skills_path: 'optional - override skills root (defaults to pwn_skills_path)',
+          delete_legacy: 'optional - remove flat file after migration (default true)'
+        )
 
-        #{self}.migrate_legacy_skills(pwn_skills_path: 'optional', delete_legacy: true)
+        # Run default skill names and return its result
+        #{self}.default_skill_names(
+          source: 'optional - source value consumed by #default_skill_names',
+          root: 'optional - root value consumed by #default_skill_names'
+        )
 
-        #{self}.install_default_skills(pwn_skills_path: 'optional')
-        #{self}.default_skill_names
+        # Run default skills dir and return its result
+        #{self}.default_skills_dir
 
-        #{self}.refresh_env(
-          pwn_env_path: 'optional - Path to pwn.yaml file.  Defaults to ~/.pwn/pwn.yaml',
-        pwn_dec_path: 'optional - Path to pwn.yaml.decryptor file.  Defaults to ~/.pwn/pwn.yaml.decryptor'
+        # Seed bundled skills into ~/.pwn/skills (or pwn_skills_path:)
+        #{self}.install_default_skills(
+          pwn_skills_path: 'optional - pwn skills path value consumed by #install_default_skills',
+          source: 'optional - source value consumed by #install_default_skills'
+        )
+
+        # Run load skills and return its result
+        #{self}.load_skills(
+          pwn_skills_path: 'optional - Path to skills folder.  Defaults to ~/.pwn/skills',
+          references: 'optional - frontmatter:, loaded:?, error:? }'
         )
 
+        # Run pwn memory path and return its result
+        #{self}.pwn_memory_path
+
+        # Run load memory and return its result
+        #{self}.load_memory
+
+        # Run pwn sessions path and return its result
+        #{self}.pwn_sessions_path
+
+        # Run pwn cron path and return its result
+        #{self}.pwn_cron_path
+
+        # Print the AUTHOR(S) string for this module.
         #{self}.authors
       "
+      constants.sort
     end
   end
 end