Module: PWN::Config

Defined in:
lib/pwn/config.rb

Overview

Used to manage PWN configuration settings within PWN drivers.

Class Method Summary collapse

Class Method Details

.authors ⇒ Object

Author(s)

0day Inc. <[email protected]>



277
278
279
280
281
 
# File 'lib/pwn/config.rb', line 277

public_class_method def self.authors
  "AUTHOR(S):
    0day Inc. <[email protected]>
  "
end

.default_env(opts = {}) ⇒ Object

Supported Method Parameters

env = PWN::Config.default_env(

pwn_env_path: 'optional - Path to pwn.yaml file.  Defaults to ~/.pwn/pwn.yaml'

)



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/pwn/config.rb', line 13

public_class_method def self.default_env(opts = {})
  pwn_env_path = opts[:pwn_env_path]
  pwn_dec_path = "#{pwn_env_path}.decryptor"

  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',
        max_prompt_length: 256_000
      },
      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',
        max_prompt_length: 128_000
      },
      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',
        max_prompt_length: 32_000
      }
    },
    plugins: {
      asm: { arch: PWN::Plugins::DetectOS.arch, endian: PWN::Plugins::DetectOS.endian.to_s },
      blockchain: {
        bitcoin: {
          rpc_host: 'localhost',
          rpc_port: 8332,
          rpc_user: 'bitcoin RPC Username',
          rpc_pass: 'bitcoin RPC Password'
        }
      },
      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' },
      jira_data_center: {
        base_uri: 'Jira Server Base API URI (e.g. https://jira.company.com/rest/api/latest)',
        token: 'Jira Server API Token'
      },
      meshtastic: {
        admin_key: 'Public key authorized to send admin messages to nodes',
        serial: {
          port: '/dev/ttyUSB0',
          baud: 115_200,
          bits: 8,
          stop: 1,
          parity: :none
        },
        mqtt: {
          host: 'mqtt.meshtastic.org',
          port: 1883,
          tls: false,
          user: 'meshdev',
          pass: 'large4cats'
        },
        channel: {
          active: 'LongFast',
          LongFast: {
            psk: 'AQ==',
            region: 'US/<STATE>',
            topic: '2/e/#',
            channel_num: 8
          },
          PWN: {
            psk: 'required - PSK for pwn channel',
            region: 'US/<STATE>',
            topic: '2/e/PWN/#',
            channel_num: 99
          }
        }
      },
      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)
  # Change file permission to 600
  File.chmod(0o600, pwn_env_path)

  env[:driver_opts] = {
    pwn_env_path: pwn_env_path,
    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

.help ⇒ Object

Display Usage for this Module



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/pwn/config.rb', line 285

public_class_method def self.help
  puts "USAGE:
    #{self}.default_env(
      pwn_env_path: 'optional - Path to pwn.yaml file.  Defaults to ~/.pwn/pwn.yaml'
    )

    #{self}.redact_sensitive_artifacts(
      config: 'optional - Hash to redact sensitive artifacts from.  Defaults to PWN::Env'
    )

    #{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.decryrptor'
    )

    #{self}.authors
  "
end

.init_driver_options ⇒ Object

Supported Method Parameters

env = PWN::Config.init_driver_options



177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/pwn/config.rb', line 177

public_class_method def self.init_driver_options
  env = {
    driver_opts: {
      pwn_env_path: nil,
      pwn_dec_path: nil
    }
  }
  PWN.const_set(:Env, env)
  # puts '[*] Loaded driver options.'
rescue StandardError => e
  raise e
end

.redact_sensitive_artifacts(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Config.redact_sensitive_artifacts(

config: 'optional - Hash to redact sensitive artifacts from.  Defaults to PWN::Env'

)



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/pwn/config.rb', line 158

public_class_method def self.redact_sensitive_artifacts(opts = {})
  config = opts[:config] ||= PWN::Env

  sensitive_keys = %i[api_key key pass password psk token]

  # Transform values at the current level: redact sensitive keys
  config.transform_values.with_index do |v, k|
    if sensitive_keys.include?(config.keys[k])
      '>>> REDACTED >>> USE `pwn-vault` FOR ADMINISTRATION <<< REDACTED <<<'
    else
      v.is_a?(Hash) ? redact_sensitive_artifacts(config: v) : v
    end
  end
rescue StandardError => e
  raise e
end

.refresh_env(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Config.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'

)



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/pwn/config.rb', line 196

public_class_method def self.refresh_env(opts = {})
  pwn_env_root = "#{Dir.home}/.pwn"
  FileUtils.mkdir_p(pwn_env_root)

  pwn_env_path = opts[:pwn_env_path] ||= "#{pwn_env_root}/pwn.yaml"
  return default_env(pwn_env_path: pwn_env_path) unless File.exist?(pwn_env_path)

  is_encrypted = PWN::Plugins::Vault.file_encrypted?(file: pwn_env_path)
  raise "PWN Environment (#{pwn_env_path}) is not encrypted!  Use PWN::Vault.create(file: '#{pwn_env_path}', decryptor_file: '#{pwn_env_path}.decryptor') to encrypt it." unless is_encrypted

  pwn_dec_path = opts[:pwn_dec_path] ||= "#{pwn_env_path}.decryptor"
  raise "PWN Decryptor (#{pwn_dec_path}) does not exist!" unless File.exist?(pwn_dec_path)

  pwn_decryptor = YAML.load_file(pwn_dec_path, symbolize_names: true)

  key = opts[:key] ||= pwn_decryptor[:key] ||= ENV.fetch('PWN_DECRYPTOR_KEY')
  key = PWN::Plugins::AuthenticationHelper.mask_password(prompt: 'Decryption Key') if key.nil?

  iv = opts[:iv] ||= pwn_decryptor[:iv] ||= ENV.fetch('PWN_DECRYPTOR_IV')
  iv = PWN::Plugins::AuthenticationHelper.mask_password(prompt: 'Decryption IV') if iv.nil?

  env = PWN::Plugins::Vault.dump(
    file: pwn_env_path,
    key: key,
    iv: iv
  )

  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)

  key = env[:ai][engine][:key]
  if key.nil?
    key = PWN::Plugins::AuthenticationHelper.mask_password(
      prompt: "#{engine} API Key"
    )
    env[:ai][engine][:key] = key
  end

  model = env[:ai][engine][:model]
  system_role_content = env[:ai][engine][:system_role_content]

  # Reset the ai response history on env refresh
  env[:ai][engine][:response_history] = {
    id: '',
    object: '',
    model: model,
    usage: {},
    choices: [
      {
        role: 'system',
        content: system_role_content
      }
    ]
  }

  # These two lines should be immutable for the session
  env[:driver_opts] = {
    pwn_env_path: pwn_env_path,
    pwn_dec_path: pwn_dec_path
  }

  # Assign the refreshed env to PWN::Env
  PWN.send(:remove_const, :Env) if PWN.const_defined?(:Env)
  PWN.const_set(:Env, env.freeze)

  # Redact sensitive artifacts from PWN::Env and store in PWN::EnvRedacted
  env_redacted = redact_sensitive_artifacts(config: env)
  PWN.send(:remove_const, :EnvRedacted) if PWN.const_defined?(:EnvRedacted)
  PWN.const_set(:EnvRedacted, env_redacted.freeze)

  Pry.config.refresh_pwn_env = false if defined?(Pry)

  puts "[*] PWN::Env loaded via: #{pwn_env_path}\n"
rescue StandardError => e
  raise e
end