Module: PWN::Engagement

Defined in:
lib/pwn/engagement.rb

Overview

Engagement scope, host state, and vault refs under ~/.pwn/engagements.

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



114
115
116
 
# File 'lib/pwn/engagement.rb', line 114

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

.close(opts = {}) ⇒ Object 



20
21
22
 
# File 'lib/pwn/engagement.rb', line 20

public_class_method def self.close(opts = {})
  PWN::AI::Agent::Engagement.close(opts)
end

.help ⇒ Object 



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/pwn/engagement.rb', line 118

public_class_method def self.help
  puts "USAGE:
    # Open an engagement and ensure its host/evidence directories exist.
    #{self}.open(
      name: 'optional - engagement identifier (defaults to default)',
      engagement: 'optional - alias for name',
      scope_cidrs: 'optional - Array of CIDR strings',
      scope_domains: 'optional - Array of DNS suffixes',
      excluded: 'optional - Array of excluded hosts',
      roe: 'optional - rules of engagement notes'
    )

    # Clear the active engagement pointer.
    #{self}.close(
      unused: 'optional - accepted so callers can pass a Hash'
    )

    # Return scope plus persisted host state.
    #{self}.status(
      name: 'optional - engagement identifier'
    )

    # True when a host or URL is inside the active scope.
    #{self}.in_scope?(
      host: 'optional - hostname or IP',
      ip: 'optional - alias for host',
      target: 'optional - alias for host',
      url: 'optional - URL whose host is checked'
    )

    # Warn on out-of-scope targets unless override is true.
    #{self}.warn_unless_in_scope(
      host: 'optional - hostname or IP',
      ip: 'optional - alias for host',
      target: 'optional - alias for host',
      override: 'optional - true continues despite a scope miss'
    )

    # Deep-merge ports, services, notes, and vault refs for a host.
    #{self}.record_host(
      host: 'required - hostname or IP',
      ip: 'optional - alias for host',
      ports: 'optional - Array of open ports',
      services: 'optional - Array of service labels',
      notes: 'optional - Array of freeform notes',
      creds: 'optional - Array of vault references',
      override: 'optional - true records an out-of-scope host'
    )

    # Return the host map for an engagement.
    #{self}.hosts(
      name: 'optional - engagement identifier'
    )

    # Merge structured scan rows into host state.
    #{self}.merge_scan(
      hosts: 'optional - Array of {host, port, service} hashes',
      results: 'optional - alias for hosts',
      override: 'optional - true records out-of-scope hosts',
      engagement: 'optional - engagement identifier (defaults to active)'
    )

    # Persist a timestamped nmap inventory snapshot under the engagement scans/ dir.
    #{self}.record_scan(
      hosts: 'required - inventory host array from NmapIt',
      ports: 'optional - flattened port rows',
      xml: 'optional - source nmap XML path',
      at: 'optional - Time or ISO8601 timestamp of the scan',
      kind: 'optional - scanner kind (defaults to nmap)',
      engagement: 'optional - engagement identifier',
      name: 'optional - alias for engagement'
    )

    # List persisted nmap snapshots oldest-first.
    #{self}.scans(
      name: 'optional - engagement identifier',
      engagement: 'optional - alias for name'
    )

    # Print the AUTHOR(S) string for this module.
    #{self}.authors
  "
end

.hosts(opts = {}) ⇒ Object 



67
68
69
70
71
72
73
 
# File 'lib/pwn/engagement.rb', line 67

public_class_method def self.hosts(opts = {})
  name = (opts[:name] || PWN::AI::Agent::Engagement.current_name || 'default').to_s
  path = File.join(PWN::AI::Agent::Engagement::ROOT, name, 'hosts.json')
  return {} unless File.file?(path)

  JSON.parse(File.read(path), symbolize_names: true)
end

.in_scope?(opts = {}) ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/pwn/engagement.rb', line 28

public_class_method def self.in_scope?(opts = {})
  PWN::AI::Agent::Engagement.in_scope?(opts)
end

.merge_scan(opts = {}) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/pwn/engagement.rb', line 75

public_class_method def self.merge_scan(opts = {})
  Array(opts[:hosts] || opts[:results]).each do |row|
    row = row.transform_keys(&:to_sym) if row.respond_to?(:transform_keys)
    record_host(
      host: row[:host] || row['host'],
      ports: [{ port: row[:port] || row['port'], proto: row[:proto], service: row[:service], version: row[:version], scripts: row[:scripts] }.compact],
      services: [row[:service] || row['service']].compact,
      override: opts[:override],
      engagement: opts[:engagement] || opts[:name]
    )
  end
  hosts(name: opts[:engagement] || opts[:name])
end

.open(opts = {}) ⇒ Object 



11
12
13
14
15
16
17
18
 
# File 'lib/pwn/engagement.rb', line 11

public_class_method def self.open(opts = {})
  row = PWN::AI::Agent::Engagement.open(opts)
  dir = File.join(PWN::AI::Agent::Engagement::ROOT, row[:name].to_s)
  FileUtils.mkdir_p(File.join(dir, 'evidence'))
  hosts = File.join(dir, 'hosts.json')
  File.write(hosts, JSON.generate({})) unless File.file?(hosts)
  row.merge(dir: dir, hosts: hosts)
end

.record_host(opts = {}) ⇒ Object 



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
 
# File 'lib/pwn/engagement.rb', line 38

public_class_method def self.record_host(opts = {})
  check = warn_unless_in_scope(opts)
  return check.merge(recorded: false) unless check[:ok]

  name = (opts[:engagement] || opts[:name] || PWN::AI::Agent::Engagement.current_name || 'default').to_s
  dir = File.join(PWN::AI::Agent::Engagement::ROOT, name)
  FileUtils.mkdir_p(dir)
  path = File.join(dir, 'hosts.json')
  store = File.file?(path) ? JSON.parse(File.read(path), symbolize_names: true) : {}
  host = (opts[:host] || opts[:ip]).to_s
  row = store[host.to_sym] || { host: host, ports: [], services: [], notes: [], creds: [] }
  incoming = Array(opts[:ports]).map do |port|
    port.is_a?(Hash) ? port.transform_keys(&:to_sym) : { port: port }
  end
  by_port = {}
  (Array(row[:ports]) + incoming).each do |item|
    item = item.is_a?(Hash) ? item.transform_keys(&:to_sym) : { port: item }
    key = item[:port]
    by_port[key] = (by_port[key] || {}).merge(item)
  end
  row[:ports] = by_port.values.map { |item| item.keys == [:port] ? item[:port] : item }
  row[:services] = (Array(row[:services]) + Array(opts[:services])).uniq
  row[:notes] = (Array(row[:notes]) + Array(opts[:notes])).uniq
  row[:creds] = (Array(row[:creds]) + Array(opts[:creds])).uniq
  store[host.to_sym] = row
  File.write(path, JSON.pretty_generate(store))
  row
end

.record_scan(opts = {}) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/pwn/engagement.rb', line 89

public_class_method def self.record_scan(opts = {})
  name = (opts[:engagement] || opts[:name] || PWN::AI::Agent::Engagement.current_name || 'default').to_s
  dir = File.join(PWN::AI::Agent::Engagement::ROOT, name, 'scans')
  FileUtils.mkdir_p(dir)
  at = opts[:at] || Time.now.utc
  at = Time.parse(at.to_s).utc unless at.is_a?(Time)
  path = File.join(dir, "nmap-#{at.utc.strftime('%Y%m%dT%H%M%SZ')}.json")
  body = {
    at: at.utc.iso8601,
    kind: opts[:kind] || 'nmap',
    xml: opts[:xml],
    hosts: opts[:hosts],
    ports: opts[:ports]
  }
  File.write(path, JSON.pretty_generate(body))
  body.merge(path: path)
end

.scans(opts = {}) ⇒ Object 



107
108
109
110
111
112
 
# File 'lib/pwn/engagement.rb', line 107

public_class_method def self.scans(opts = {})
  name = (opts[:name] || opts[:engagement] || PWN::AI::Agent::Engagement.current_name || 'default').to_s
  Dir[File.join(PWN::AI::Agent::Engagement::ROOT, name, 'scans', 'nmap-*.json')].map do |path|
    JSON.parse(File.read(path), symbolize_names: true).merge(path: path)
  end
end

.status(opts = {}) ⇒ Object 



24
25
26
 
# File 'lib/pwn/engagement.rb', line 24

public_class_method def self.status(opts = {})
  PWN::AI::Agent::Engagement.status(opts).merge(hosts: hosts(opts))
end

.warn_unless_in_scope(opts = {}) ⇒ Object 



32
33
34
35
36
 
# File 'lib/pwn/engagement.rb', line 32

public_class_method def self.warn_unless_in_scope(opts = {})
  return { ok: true } if in_scope?(opts) || opts[:override] == true

  { ok: false, warning: "out of scope: #{opts[:host] || opts[:ip] || opts[:target]}", override_required: true }
end