pwn 0.5.434 → 0.5.436

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cdf2e676f8720fc916611068b8c6011fec4a8f655848ba3fe7eaba5370e4f75
-  data.tar.gz: 6f1505c1d3eb735da84c2033577638bc74aafd122d8909e817dd50313f83ebb2
+  metadata.gz: 9b0b70877101aefea31cdfd2b5eeb0ad3828273814199faf10e2c52fe35a6455
+  data.tar.gz: ad68a9d8e4a114096a062812cedf20813d34d6bc91f210884b54ac838ed6219b
 SHA512:
-  metadata.gz: db901c38eddb0daa14ba19a0a370dcd174a809112bf24d76396af1cfedccb36886961176b813f32b2dcf4d839b283828aa7e7ddc91423d47e456d059808b85a4
-  data.tar.gz: 3e97e046c79229ff21390c782a2a3f9387c91d29682b047d8aeb0d354824b7e6c9662bc1481c80f6eb0e58b6fed5af274d7ffdce1f1651d74e09483abee8c408
+  metadata.gz: 4b4721af1d836061595b1c295100927d2824c19e68ce0f17edec6dd07e707cbf5f01dcc7ca0d697803547b2ecc64a2b527936a7e5f86d7d4ba2f3d44e6ada0e3
+  data.tar.gz: f0eea79fb719f06556c8b6260181c5dd25067cba7c4e8d800bc3c543b61e05a45907a22add4e73d6b63b3db04771c31e90793344e8d9f3d1da49f0ce2bbd4ac8

data/README.md

@@ -37,7 +37,7 @@ $ cd /opt/pwn
 $ ./install.sh
 $ ./install.sh ruby-gem
 $ pwn
-pwn[v0.5.434]:001 >>> PWN.help
+pwn[v0.5.436]:001 >>> PWN.help
 ```
 
 [![Installing the pwn Security Automation Framework](https://raw.githubusercontent.com/0dayInc/pwn/master/documentation/pwn_install.png)](https://youtu.be/G7iLUY4FzsI)
@@ -52,7 +52,7 @@ $ rvm use ruby-3.4.4@pwn
 $ gem uninstall --all --executables pwn
 $ gem install --verbose pwn
 $ pwn
-pwn[v0.5.434]:001 >>> PWN.help
+pwn[v0.5.436]:001 >>> PWN.help
 ```
 
 If you're using a multi-user install of RVM do:
@@ -62,7 +62,7 @@ $ rvm use ruby-3.4.4@pwn
 $ rvmsudo gem uninstall --all --executables pwn
 $ rvmsudo gem install --verbose pwn
 $ pwn
-pwn[v0.5.434]:001 >>> PWN.help
+pwn[v0.5.436]:001 >>> PWN.help
 ```
 
 PWN periodically upgrades to the latest version of Ruby which is reflected in `/opt/pwn/.ruby-version`.  The easiest way to upgrade to the latest version of Ruby from a previous PWN installation is to run the following script:

data/lib/pwn/ai/introspection.rb

@@ -10,10 +10,20 @@ module PWN
     # when `PWN::Env[:ai][:introspection]` is set to `true`.
     module Introspection
       # Supported Method Parameters::
-      # response = PWN::AI::Introspection.reflect
+      # response = PWN::AI::Introspection.reflect(
+      #   request: 'required - String - What you want the AI to reflect on'
+      # )
 
-      public_class_method def self.reflect
+      public_class_method def self.reflect(opts = {})
+        request = opts[:request]
+        raise 'ERROR: request must be provided' if request.nil?
+
+        response = nil
+
+        valid_ai_engines = PWN::AI.help.reject { |e| e.downcase == :introspection }.map(&:downcase)
         engine = PWN::Env[:ai][:active].to_s.downcase.to_sym
+        raise "ERROR: Unsupported AI engine. Supported engines are: #{valid_ai_engines}" unless valid_ai_engines.include?(engine)
+
         base_uri = PWN::Env[:ai][engine][:base_uri]
         model = PWN::Env[:ai][engine][:model]
         key = PWN::Env[:ai][engine][:key]
@@ -70,7 +80,9 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          #{self}.reflect
+          #{self}.reflect(
+            request: 'required - String - What you want the AI to reflect on'
+          )
 
           #{self}.authors
         "

data/lib/pwn/config.rb

@@ -6,6 +6,101 @@ require 'yaml'
 module PWN
   # Used to manage PWN configuration settings within PWN drivers.
   module Config
+    # Supported Method Parameters::
+    # env = PWN::Config.minimal_env
+    public_class_method def self.minimal_env(opts = {})
+      pwn_env_path = opts[:pwn_env_path]
+      pwn_dec_path = "#{File.dirname(pwn_env_path)}/pwn.decryptor.yaml"
+
+      puts "
+        [*] NOTICE:
+        1. Writing minimal PWN::Env to:
+           #{pwn_env_path}
+        2. Your decryptor file will be written to:
+           #{pwn_dec_path}
+        3. Use the pwn-vault command in the pwn prototyping driver to update:
+           #{pwn_env_path}
+        4. For optimal security, it's recommended to move:
+           #{pwn_dec_path}
+           to a secure location and use the --pwn-dec parameter for PWN drivers.
+      "
+      env = {
+        ai: {
+          active: 'grok',
+          introspection: false,
+          grok: {
+            base_uri: 'optional - Base URI for Grok - Use private base OR defaults to https://api.x.ai/v1',
+            key: 'required - OpenAI API Key',
+            model: 'optional - Grok model to use',
+            system_role_content: 'You are an ethically hacking OpenAI agent.',
+            temp: 'optional - OpenAI temperature'
+          },
+          openai: {
+            base_uri: 'optional - Base URI for OpenAI - Use private base OR defaults to https://api.openai.com/v1',
+            key: 'required - OpenAI API Key',
+            model: 'optional - OpenAI model to use',
+            system_role_content: 'You are an ethically hacking OpenAI agent.',
+            temp: 'optional - OpenAI temperature'
+          },
+          ollama: {
+            base_uri: 'required - Base URI for Open WebUI - e.g. https://ollama.local',
+            key: 'required - Open WebUI API Key Under Settings  >> Account >> JWT Token',
+            model: 'required - Ollama model to use',
+            system_role_content: 'You are an ethically hacking Ollama agent.',
+            temp: 'optional - Ollama temperature'
+          }
+        },
+        asm: { arch: PWN::Plugins::DetectOS.arch, endian: PWN::Plugins::DetectOS.endian },
+        irc: {
+          ui_nick: '_human_',
+          shared_chan: '#pwn',
+          ai_agent_nicks: {
+            browser: {
+              pwn_rb: '/opt/pwn/lib/pwn/plugins/transparent_browser.rb',
+              system_role_content: 'You are a browser.  You are a web browser that can be controlled by a human or AI agent'
+            },
+            nimjeh: {
+              pwn_rb: '',
+              system_role_content: 'You are a sarcastic hacker.  You find software zero day vulnerabilities. This involves analyzing source code, race conditions, application binaries, and network protocols from an offensive security perspective.'
+            },
+            nmap: {
+              pwn_rb: '/opt/pwn/lib/pwn/plugins/nmap_it.rb',
+              system_role_content: 'You are a network scanner.  You are a network scanner that can be controlled by a human or AI agent'
+            },
+            shodan: {
+              pwn_rb: '/opt/pwn/lib/pwn/plugins/shodan.rb',
+              system_role_content: 'You are a passive reconnaissance agent.  You are a passive reconnaissance agent that can be controlled by a human or AI agent'
+            }
+          }
+        },
+        hunter: { api_key: 'hunter.how API Key' },
+        meshtastic: {
+          psks: {
+            LongFast: 'AQ==',
+            PWN: 'required - PSK for pwn channel'
+          }
+        },
+        shodan: { api_key: 'SHODAN API Key' }
+      }
+      # Remove beginning colon from key names
+      yaml_env = YAML.dump(env).gsub(/^(\s*):/, '\1')
+      File.write(pwn_env_path, yaml_env)
+
+      env[:pwn_env_path] = pwn_env_path
+      env[:pwn_dec_path] = pwn_dec_path
+
+      PWN::Plugins::Vault.create(
+        file: pwn_env_path,
+        decryptor_file: pwn_dec_path
+      )
+
+      Pry.config.refresh_pwn_env = false if defined?(Pry)
+      PWN.send(:remove_const, :Env) if PWN.const_defined?(:Env)
+      PWN.const_set(:Env, env.freeze)
+    rescue StandardError => e
+      raise e
+    end
+
     # Supported Method Parameters::
     # PWN::Config.refresh_env(
     #   pwn_env_path: 'optional - Path to pwn.yaml file.  Defaults to ~/.pwn/pwn.yaml',
@@ -17,7 +112,7 @@ module PWN
       FileUtils.mkdir_p(pwn_env_root)
 
       pwn_env_path = opts[:pwn_env_path] ||= "#{pwn_env_root}/pwn.yaml"
-      return {} unless File.exist?(pwn_env_path)
+      return minimal_env(pwn_env_path: pwn_env_path) unless File.exist?(pwn_env_path)
 
       is_encrypted = PWN::Plugins::Vault.file_encrypted?(file: pwn_env_path)
 
@@ -42,11 +137,7 @@ module PWN
         env = YAML.load_file(pwn_env_path, symbolize_names: true)
       end
 
-      valid_ai_engines = %i[
-        grok
-        openai
-        ollama
-      ]
+      valid_ai_engines = PWN::AI.help.reject { |e| e.downcase == :introspection }.map(&:downcase)
 
       engine = env[:ai][:active].to_s.downcase.to_sym
       raise "ERROR: Unsupported AI Engine: #{engine} in #{pwn_env_path}.  Supported AI Engines:\n#{valid_ai_engines.inspect}" unless valid_ai_engines.include?(engine)
@@ -80,8 +171,7 @@ module PWN
       env[:pwn_env_path] = pwn_env_path
       env[:pwn_dec_path] = pwn_dec_path if is_encrypted
 
-      Pry.config.refresh = false if defined?(Pry)
-
+      Pry.config.refresh_pwn_env = false if defined?(Pry)
       PWN.send(:remove_const, :Env) if PWN.const_defined?(:Env)
       PWN.const_set(:Env, env.freeze)
     rescue StandardError => e
@@ -100,6 +190,10 @@ module PWN
 
     public_class_method def self.help
       puts "USAGE:
+        #{self}.minimal_env(
+          pwn_env_path: 'optional - Path to pwn.yaml file.  Defaults to ~/.pwn/pwn.yaml'
+        )
+
         #{self}.refresh_env(
           pwn_env_path: 'optional - Path to pwn.yaml file.  Defaults to ~/.pwn/pwn.yaml',
           pwn_dec_path: 'optional - Path to pwn.decryptor.yaml file.  Defaults to ~/.pwn/pwn.decryptor.yaml'

data/lib/pwn/plugins/repl.rb

@@ -18,7 +18,7 @@ module PWN
         mode = opts[:mode]
 
         proc do |_target_self, _nest_level, pi|
-          PWN::Config.refresh_env(opts) if Pry.config.refresh
+          PWN::Config.refresh_env(opts) if Pry.config.refresh_pwn_env
 
           pi.config.pwn_repl_line += 1
           line_pad = format(
@@ -530,8 +530,8 @@ module PWN
         # Define REPL Hooks
         # Welcome Banner Hook
         Pry.config.hooks.add_hook(:before_session, :welcome) do |output, _binding, _pi|
-          PWN::Config.refresh_env(opts)
           output.puts PWN::Banner.welcome
+          PWN::Config.refresh_env(opts)
         end
 
         Pry.config.hooks.add_hook(:after_read, :pwn_asm_hook) do |request, pi|

data/lib/pwn/plugins/vault.rb

@@ -37,19 +37,27 @@ module PWN
 
       # Supported Method Parameters::
       # PWN::Plugins::Vault.create(
-      #   file: 'required - encrypted file to create'
+      #   file: 'required - encrypted file to create',
+      #   decryptor_file: 'optional - file to save the key && iv values'
       # )
 
       public_class_method def self.create(opts = {})
         file = opts[:file].to_s.scrub if File.exist?(opts[:file].to_s.scrub)
+        decryptor_file = opts[:decryptor_file]
 
         cipher = OpenSSL::Cipher.new('aes-256-cbc')
         key = Base64.strict_encode64(cipher.random_key)
         iv = Base64.strict_encode64(cipher.random_iv)
 
-        puts 'Please store the Key && IV in a secure location as they are required for decryption.'
-        puts "Key: #{key}"
-        puts "IV: #{iv}"
+        if decryptor_file
+          decryptor_hash = { key: key, iv: iv }
+          yaml_decryptor = YAML.dump(decryptor_hash).gsub(/^(\s*):/, '\1')
+          File.write(decryptor_file, yaml_decryptor)
+        else
+          puts 'Please store the Key && IV in a secure location as they are required for decryption.'
+          puts "Key: #{key}"
+          puts "IV: #{iv}"
+        end
 
         encrypt(
           file: file,
@@ -173,7 +181,7 @@ module PWN
         system(relative_editor, file)
 
         # If the Pry object exists, set refresh_config to true
-        Pry.config.refresh = true if defined?(Pry)
+        Pry.config.refresh_pwn_env = true if defined?(Pry)
 
         encrypt(
           file: file,
@@ -253,7 +261,8 @@ module PWN
           )
 
           #{self}.create(
-            file: 'required - file to encrypt'
+            file: 'required - file to encrypt',
+            decryptor_file: 'optional - file to save the key && iv values'
           )
 
           #{self}.decrypt(

data/lib/pwn/reports/sast.rb

@@ -49,16 +49,22 @@ module PWN
             percent_complete = (entry_count.to_f / total_entries * 100).round(2)
             line_no = src_detail[:line_no]
             source_code_snippet = src_detail[:contents]
-            request = {
-              scm_uri: "#{git_repo_root_uri}/#{filename}",
-              line: line_no,
-              source_code_snippet: source_code_snippet
-            }.to_json
             author = src_detail[:author].to_s.scrub.chomp.strip
 
-            # TODO: move PWN::AI::Introspection.reflect into each PWN::SAST::* module
-            # This will drastically speed up the overall SAST analysis process
-            response = PWN::AI::Introspection.reflect if ai_instrospection
+            # TODO: >>>
+            # 1. Move PWN::AI::Introspection.reflect into each PWN::SAST::* module
+            #    This will drastically speed up the overall SAST analysis process
+            # 2. Have PWN::AI::Introspection.reflect assess test case effectiveness
+            response = nil
+            if ai_instrospection
+              request = {
+                scm_uri: "#{git_repo_root_uri}/#{filename}",
+                line: line_no,
+                source_code_snippet: source_code_snippet
+              }.to_json
+              response = PWN::AI::Introspection.reflect(request: request)
+            end
+
             ai_analysis = nil
             if response.is_a?(Hash)
               ai_analysis = response[:choices].last[:text] if response[:choices].last.keys.include?(:text)

data/lib/pwn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PWN
-  VERSION = '0.5.434'
+  VERSION = '0.5.436'
 end

data/lib/pwn.rb

@@ -27,7 +27,9 @@ module PWN
 
   # Initialize PWN configuration file
   # PWN::Env is the constant that stores the configuration data
-  PWN::Config.refresh_env
+  # Only call this if the program name is not pwn
+  driver = File.basename($PROGRAM_NAME)
+  PWN::Config.refresh_env unless driver == 'pwn'
 rescue StandardError => e
   puts e.backtrace
   raise e

data/spec/lib/pwn/config_spec.rb

@@ -3,11 +3,6 @@
 require 'spec_helper'
 
 describe PWN::Config do
-  it 'should return data for refresh method' do
-    config_response = PWN::Config.refresh_env
-    expect(config_response).not_to be_nil
-  end
-
   it 'should display information for authors' do
     authors_response = PWN::Config
     expect(authors_response).to respond_to :authors

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwn
 version: !ruby/object:Gem::Version
-  version: 0.5.434
+  version: 0.5.436
 platform: ruby
 authors:
 - 0day Inc.