Class: Nexpose::Site

Inherits:
APIObject show all
Includes:
JsonSerializer
Defined in:
lib/nexpose/site.rb

Overview

Configuration object representing a Nexpose site.

For a basic walk-through, see https://github.com/rapid7/nexpose-client/wiki/Using-Sites

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from JsonSerializer

#deserialize, #serialize, #to_hash

Methods inherited from APIObject

#object_from_hash

Constructor Details

#initialize(name = nil, scan_template_id = 'full-audit-without-web-spider') ⇒ Site

Site constructor. Both arguments are optional.

Parameters:

  • name (String) (defaults to: nil) —

    Unique name of the site.

  • scan_template_id (String) (defaults to: 'full-audit-without-web-spider') —

    ID of the scan template to use.



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/nexpose/site.rb', line 160

def initialize(name = nil, scan_template_id = 'full-audit-without-web-spider')
  @name = name
  @scan_template_id = scan_template_id
  @id = -1
  @risk_factor = 1.0
  @config_version = 3
  @schedules = []
  @blackouts = []
  @included_scan_targets = { addresses: [], asset_groups: [] }
  @excluded_scan_targets = { addresses: [], asset_groups: [] }
  @site_credentials = []
  @shared_credentials = []
  @web_credentials = []
  @alerts = []
  @users = []
  @tags = []
end

Instance Attribute Details

#alerts ⇒ Object

Array

Collection of real-time alerts.

See Also:



135
136
137
 
# File 'lib/nexpose/site.rb', line 135

def alerts
  @alerts
end

#auto_engine_selection_enabled ⇒ Object

Scan the assets with last scanned engine or not.



128
129
130
 
# File 'lib/nexpose/site.rb', line 128

def auto_engine_selection_enabled
  @auto_engine_selection_enabled
end

#blackouts ⇒ Object

Array

Blackout starting dates, times and duration for blackout periods.



112
113
114
 
# File 'lib/nexpose/site.rb', line 112

def blackouts
  @blackouts
end

#config_version ⇒ Object

Configuration version. Default: 3



145
146
147
 
# File 'lib/nexpose/site.rb', line 145

def config_version
  @config_version
end

#description ⇒ Object

Description of the site.



90
91
92
 
# File 'lib/nexpose/site.rb', line 90

def description
  @description
end

#discovery_config ⇒ Object

discovery config of the discovery connection associated with this site if it is dynamic.



151
152
153
 
# File 'lib/nexpose/site.rb', line 151

def discovery_config
  @discovery_config
end

#engine_id ⇒ Object

Scan Engine to use. Will use the default engine if nil or -1.



106
107
108
 
# File 'lib/nexpose/site.rb', line 106

def engine_id
  @engine_id
end

#excluded_scan_targets ⇒ Object

Excluded scan targets. May be IPv4, IPv6, DNS names, IPRanges or assetgroup ids.



96
97
98
 
# File 'lib/nexpose/site.rb', line 96

def excluded_scan_targets
  @excluded_scan_targets
end

#id ⇒ Object

The site ID. An ID of -1 is used to designate a site that has not been saved to a Nexpose console.



84
85
86
 
# File 'lib/nexpose/site.rb', line 84

def id
  @id
end

#included_scan_targets ⇒ Object

Included scan targets. May be IPv4, IPv6, DNS names, IPRanges or assetgroup ids.



93
94
95
 
# File 'lib/nexpose/site.rb', line 93

def included_scan_targets
  @included_scan_targets
end

#name ⇒ Object

Unique name of the site. Required.



87
88
89
 
# File 'lib/nexpose/site.rb', line 87

def name
  @name
end

#organization ⇒ Object

Information about the organization that this site belongs to. Used by some reports.



139
140
141
 
# File 'lib/nexpose/site.rb', line 139

def organization
  @organization
end

#risk_factor ⇒ Object

The risk factor associated with this site. Default: 1.0



115
116
117
 
# File 'lib/nexpose/site.rb', line 115

def risk_factor
  @risk_factor
end

#scan_template_id ⇒ Object

Scan template to use when starting a scan job. Default: full-audit-without-web-spider



99
100
101
 
# File 'lib/nexpose/site.rb', line 99

def scan_template_id
  @scan_template_id
end

#scan_template_name ⇒ Object

Friendly name of scan template to use when starting a scan job. Value is populated when a site is saved or loaded from a console.



103
104
105
 
# File 'lib/nexpose/site.rb', line 103

def scan_template_name
  @scan_template_name
end

#schedules ⇒ Object

Array

Schedule starting dates and times for scans, and set their frequency.



109
110
111
 
# File 'lib/nexpose/site.rb', line 109

def schedules
  @schedules
end

#search_criteria ⇒ Object

Asset filter criteria if this site is dynamic.



148
149
150
 
# File 'lib/nexpose/site.rb', line 148

def search_criteria
  @search_criteria
end

#shared_credentials ⇒ Object

Array

Collection of shared credentials associated with this site.



122
123
124
 
# File 'lib/nexpose/site.rb', line 122

def shared_credentials
  @shared_credentials
end

#site_credentials ⇒ Object

Array

Collection of credentials associated with this site. Does not

include shared credentials.



119
120
121
 
# File 'lib/nexpose/site.rb', line 119

def site_credentials
  @site_credentials
end

#tags ⇒ Object

Array

Collection of TagSummary



154
155
156
 
# File 'lib/nexpose/site.rb', line 154

def tags
  @tags
end

#users ⇒ Object

Array

List of user IDs for users who have access to the site.



142
143
144
 
# File 'lib/nexpose/site.rb', line 142

def users
  @users
end

#web_credentials ⇒ Object

Array

Collection of web credentials associated with the site.



125
126
127
 
# File 'lib/nexpose/site.rb', line 125

def web_credentials
  @web_credentials
end

Class Method Details

.copy(connection, id) ⇒ Site

Copy an existing configuration from a Nexpose instance. Returned object will reset the site ID and append “Copy” to the existing name.

Parameters:

  • connection (Connection) —

    Connection to the security console.

  • id (Fixnum) —

    Site ID of an existing site.

Returns:

  • (Site) —

    Site configuration loaded from a Nexpose console.



548
549
550
551
552
553
 
# File 'lib/nexpose/site.rb', line 548

def self.copy(connection, id)
  site = self.load(connection, id)
  site.id = -1
  site.name = "#{site.name} Copy"
  site
end

.from_hash(hash) ⇒ Object 



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/nexpose/site.rb', line 435

def self.from_hash(hash)
  site = new(hash[:name], hash[:scan_template_id])
  hash.each do |k, v|
    site.instance_variable_set("@#{k}", v)
  end

  # Convert each string address to either a HostName or IPRange object
  included_scan_targets = { addresses: [], asset_groups: [] }
  site.included_scan_targets[:addresses].each { |asset| included_scan_targets[:addresses] << HostOrIP.convert(asset) }
  included_scan_targets[:asset_groups] = site.included_scan_targets[:asset_groups]
  site.included_scan_targets = included_scan_targets

  excluded_scan_targets = { addresses: [], asset_groups: [] }
  site.excluded_scan_targets[:addresses].each { |asset| excluded_scan_targets[:addresses] << HostOrIP.convert(asset) }
  excluded_scan_targets[:asset_groups] = site.excluded_scan_targets[:asset_groups]
  site.excluded_scan_targets = excluded_scan_targets

  site
end

.json_initializer(data) ⇒ Object 



536
537
538
 
# File 'lib/nexpose/site.rb', line 536

def self.json_initializer(data)
  new(data[:name], data[:scan_template_id])
end

.load(nsc, id) ⇒ Site

Load an site from the provided console.

Parameters:

  • nsc (Connection) —

    Active connection to a Nexpose console.

  • id (String) —

    Unique identifier of a site.

Returns:

  • (Site) —

    The requested site, if found.



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/nexpose/site.rb', line 504

def self.load(nsc, id)
  uri = "/api/2.1/site_configurations/#{id}"
  resp = AJAX.get(nsc, uri, AJAX::CONTENT_TYPE::JSON)
  hash = JSON.parse(resp, symbolize_names: true)
  site = self.json_initializer(hash).deserialize(hash)

  # Convert each string address to either a HostName or IPRange object
  included_addresses = hash[:included_scan_targets][:addresses]
  site.included_scan_targets[:addresses] = []
  included_addresses.each { |asset| site.include_asset(asset) }

  excluded_addresses = hash[:excluded_scan_targets][:addresses]
  site.excluded_scan_targets[:addresses] = []
  excluded_addresses.each { |asset| site.exclude_asset(asset) }

  site.organization = Organization.create(site.organization)
  site.schedules = (hash[:schedules] || []).map {|schedule| Nexpose::Schedule.from_hash(schedule) }
  site.blackouts = (hash[:blackouts] || []).map {|blackout| Nexpose::Blackout.from_hash(blackout) }
  site.site_credentials = hash[:site_credentials].map {|cred| Nexpose::SiteCredentials.new.object_from_hash(nsc,cred)}
  site.shared_credentials = hash[:shared_credentials].map {|cred| Nexpose::SiteCredentials.new.object_from_hash(nsc,cred)}
  site.discovery_config = Nexpose::DiscoveryConnection.new.object_from_hash(nsc, hash[:discovery_config]) unless hash[:discovery_config].nil?
  site.search_criteria = Nexpose::DiscoveryConnection::Criteria.parseHash(hash[:search_criteria]) unless hash[:search_criteria].nil?
  site.alerts = Alert.load_alerts(hash[:alerts])
  site.tags = Tag.load_tags(hash[:tags])
  site.web_credentials = hash[:web_credentials].map {|webCred| (
  webCred[:service] == Nexpose::WebCredentials::WebAppAuthType::HTTP_HEADER ?
      Nexpose::WebCredentials::Headers.new(webCred[:name], webCred[:baseURL], webCred[:soft403Pattern], webCred[:id]).object_from_hash(nsc,webCred) :
      Nexpose::WebCredentials::HTMLForms.new(webCred[:name], webCred[:baseURL], webCred[:loginURL], webCred[:soft403Pattern], webCred[:id]).object_from_hash(nsc,webCred))}

  site
end

Instance Method Details

#add_asset(asset) ⇒ Object Also known as: add_host, add_ip

Deprecated.

Use #include_asset instead.



293
294
295
296
 
# File 'lib/nexpose/site.rb', line 293

def add_asset(asset)
  warn "[DEPRECATED] Use #{self.class}#include_asset instead of #{self.class}#add_asset."
  include_asset(asset)
end

#add_ip_range(from, to) ⇒ Object

Deprecated.

Use #include_ip_range instead.



254
255
256
257
 
# File 'lib/nexpose/site.rb', line 254

def add_ip_range(from, to)
  warn "[DEPRECATED] Use #{self.class}#include_ip_range instead of #{self.class}#add_ip_range."
  include_ip_range(from, to)
end

#add_user(user_id) ⇒ Object 



419
420
421
422
423
424
425
 
# File 'lib/nexpose/site.rb', line 419

def add_user(user_id)
  unless user_id.is_a?(Numeric) && user_id > 0
    raise 'Invalid user id. A user id must be a positive number and refer to an existing system user.'
  end

  @users << { id: user_id}
end

#delete(connection) ⇒ Boolean

Delete this site from a Nexpose console.

Parameters:

  • connection (Connection) —

    Connection to console where this site will be saved.

Returns:

  • (Boolean) —

    Whether or not the site was successfully deleted.



586
587
588
589
 
# File 'lib/nexpose/site.rb', line 586

def delete(connection)
  r = connection.execute(%(<SiteDeleteRequest session-id="#{connection.session_id}" site-id="#{@id}"/>))
  r.success
end

#exclude_asset(asset) ⇒ Object

Adds an asset to this site excluded scan targets, resolving whether an IP or hostname is provided.

Parameters:

  • asset (String) —

    Identifier of an asset, either IP or host name.



360
361
362
 
# File 'lib/nexpose/site.rb', line 360

def exclude_asset(asset)
  @excluded_scan_targets[:addresses] << HostOrIP.convert(asset)
end

#exclude_asset_group(asset_group_id) ⇒ Object

Adds an asset group ID to this site excluded scan targets.

Parameters:

  • asset_group_id (Integer) —

    Identifier of an assetGroupID.



395
396
397
398
 
# File 'lib/nexpose/site.rb', line 395

def exclude_asset_group(asset_group_id)
  validate_asset_group(asset_group_id)
  @excluded_scan_targets[:asset_groups] << asset_group_id.to_i
end

#exclude_ip_range(from, to) ⇒ Object

Adds assets to this site excluded scan targets by IP address range.

Parameters:

  • from (String) —

    Beginning IP address of a range.

  • to (String) —

    Ending IP address of a range.



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/nexpose/site.rb', line 323

def exclude_ip_range(from, to)
  begin
    from_ip = IPAddr.new(from)
    to_ip = IPAddr.new(to)
    (from_ip..to_ip)
    if (from_ip..to_ip).to_a.size == 0
      raise 'Invalid IP range specified'
    end
    @excluded_scan_targets[:addresses] << IPRange.new(from, to)
  rescue ArgumentError => e
    raise "#{e.message} in given IP range"
  end
end

#excluded_addresses ⇒ Array[IPRange|HostName]

Returns the array of excluded scan target addresses.

Returns:



206
207
208
 
# File 'lib/nexpose/site.rb', line 206

def excluded_addresses
  @excluded_scan_targets[:addresses]
end

#excluded_addresses=(new_addresses) ⇒ Array[IPRange|HostName]

Sets the array of excluded scan target addresses.

Parameters:

  • new_addresses (Array[IPRange|HostName]) —

    The new array of scan target addresses.

Returns:



213
214
215
 
# File 'lib/nexpose/site.rb', line 213

def excluded_addresses=(new_addresses)
  @excluded_scan_targets[:addresses] = new_addresses
end

#excluded_asset_groups ⇒ Array[Fixnum]

Returns the array of IDs for excluded scan target asset groups.

Returns:

  • (Array[Fixnum]) —

    Array of IDs for excluded asset groups.



219
220
221
 
# File 'lib/nexpose/site.rb', line 219

def excluded_asset_groups
  @excluded_scan_targets[:asset_groups]
end

#excluded_asset_groups=(new_asset_groups) ⇒ Array[Fixnum]

Sets the array IDs for excluded scan target asset groups.

Parameters:

  • new_asset_groups (Array[Fixnum]) —

    The new array of IDs for scan target asset groups.

Returns:

  • (Array[Fixnum]) —

    Array of IDs of the updated scan target asset groups.



226
227
228
 
# File 'lib/nexpose/site.rb', line 226

def excluded_asset_groups=(new_asset_groups)
  @excluded_scan_targets[:asset_groups] = new_asset_groups
end

#include_asset(asset) ⇒ Object

Adds an asset to this site included scan targets, resolving whether an IP or hostname is provided.

Parameters:

  • asset (String) —

    Identifier of an asset, either IP or host name.



288
289
290
 
# File 'lib/nexpose/site.rb', line 288

def include_asset(asset)
  @included_scan_targets[:addresses] << HostOrIP.convert(asset)
end

#include_asset_group(asset_group_id) ⇒ Object

Adds an asset group ID to this site included scan targets.

Parameters:

  • asset_group_id (Integer) —

    Identifier of an assetGroupID.



377
378
379
380
 
# File 'lib/nexpose/site.rb', line 377

def include_asset_group(asset_group_id)
  validate_asset_group(asset_group_id)
  @included_scan_targets[:asset_groups] << asset_group_id.to_i
end

#include_ip_range(from, to) ⇒ Object

Adds assets to this site by IP address range.

Parameters:

  • from (String) —

    Beginning IP address of a range.

  • to (String) —

    Ending IP address of a range.



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/nexpose/site.rb', line 239

def include_ip_range(from, to)
  begin
    from_ip = IPAddr.new(from)
    to_ip = IPAddr.new(to)
    (from_ip..to_ip)
    if (from_ip..to_ip).to_a.size == 0
      raise 'Invalid IP range specified'
    end
    @included_scan_targets[:addresses] << IPRange.new(from, to)
  rescue ArgumentError => e
    raise "#{e.message} in given IP range"
  end
end

#included_addresses ⇒ Array[IPRange|HostName]

Returns the array of included scan target addresses.

Returns:



180
181
182
 
# File 'lib/nexpose/site.rb', line 180

def included_addresses
  @included_scan_targets[:addresses]
end

#included_addresses=(new_addresses) ⇒ Array[IPRange|HostName]

Sets the array of included scan target addresses.

Parameters:

  • new_addresses (Array[IPRange|HostName]) —

    The new array of scan target addresses.

Returns:



187
188
189
 
# File 'lib/nexpose/site.rb', line 187

def included_addresses=(new_addresses)
  @included_scan_targets[:addresses] = new_addresses
end

#included_asset_groups ⇒ Array[Fixnum]

Returns the array of IDs for included scan target asset groups.

Returns:

  • (Array[Fixnum]) —

    Array of included asset groups.



193
194
195
 
# File 'lib/nexpose/site.rb', line 193

def included_asset_groups
  @included_scan_targets[:asset_groups]
end

#included_asset_groups=(new_asset_groups) ⇒ Array[Fixnum] Array of IDs of the updated scan target asset groups.

Sets the array of IDs for included scan target asset groups.

Parameters:

  • Array[Fixnum] (Array[Fixnum] new_asset_groups The new array of IDs for scan target asset groups.) —

    new_asset_groups The new array of IDs for scan target asset groups.

Returns:

  • (Array[Fixnum] Array of IDs of the updated scan target asset groups.) —

    Array Array of IDs of the updated scan target asset groups.



200
201
202
 
# File 'lib/nexpose/site.rb', line 200

def included_asset_groups=(new_asset_groups)
  @included_scan_targets[:asset_groups] = new_asset_groups
end

#is_dynamic? ⇒ Boolean

Returns true when the site is dynamic.

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/nexpose/site.rb', line 231

def is_dynamic?
  !@discovery_config.nil?
end

#remove_asset(asset) ⇒ Object Also known as: remove_host, remove_ip

Deprecated.

Use #remove_included_asset instead.



311
312
313
314
 
# File 'lib/nexpose/site.rb', line 311

def remove_asset(asset)
  warn "[DEPRECATED] Use #{self.class}#remove_included_asset instead of #{self.class}#remove_asset."
  remove_included_asset(asset)
end

#remove_excluded_asset(asset) ⇒ Object

Removes an asset to this site excluded scan targets, resolving whether an IP or hostname is provided.

Parameters:

  • asset (String) —

    Identifier of an asset, either IP or host name.



369
370
371
 
# File 'lib/nexpose/site.rb', line 369

def remove_excluded_asset(asset)
  @excluded_scan_targets[:addresses].reject! { |existing_asset| existing_asset == HostOrIP.convert(asset) }
end

#remove_excluded_asset_group(asset_group_id) ⇒ Object

Adds an asset group ID to this site excluded scan targets.

Parameters:

  • asset_group_id (Integer) —

    Identifier of an assetGroupID.



404
405
406
407
 
# File 'lib/nexpose/site.rb', line 404

def remove_excluded_asset_group(asset_group_id)
  validate_asset_group(asset_group_id)
  @excluded_scan_targets[:asset_groups].reject! { |t| t.eql? asset_group_id.to_i }
end

#remove_excluded_ip_range(from, to) ⇒ Object

Remove assets from this site excluded scan targets by IP address range.

Parameters:

  • from (String) —

    Beginning IP address of a range.

  • to (String) —

    Ending IP address of a range.



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/nexpose/site.rb', line 341

def remove_excluded_ip_range(from, to)
  begin
    from_ip = IPAddr.new(from)
    to_ip = IPAddr.new(to)
    (from_ip..to_ip)
    if (from_ip..to_ip).to_a.size == 0
      raise 'Invalid IP range specified'
    end
    @excluded_scan_targets[:addresses].reject! { |t| t.eql? IPRange.new(from, to) }
  rescue ArgumentError => e
    raise "#{e.message} in given IP range"
  end
end

#remove_included_asset(asset) ⇒ Object

Remove an asset to this site included scan targets, resolving whether an IP or hostname is provided.

Parameters:

  • asset (String) —

    Identifier of an asset, either IP or host name.



306
307
308
 
# File 'lib/nexpose/site.rb', line 306

def remove_included_asset(asset)
  @included_scan_targets[:addresses].reject! { |existing_asset| existing_asset == HostOrIP.convert(asset) }
end

#remove_included_asset_group(asset_group_id) ⇒ Object

Adds an asset group ID to this site included scan targets.

Parameters:

  • asset_group_id (Integer) —

    Identifier of an assetGroupID.



386
387
388
389
 
# File 'lib/nexpose/site.rb', line 386

def remove_included_asset_group(asset_group_id)
  validate_asset_group(asset_group_id)
  @included_scan_targets[:asset_groups].reject! { |t| t.eql? asset_group_id.to_i }
end

#remove_included_ip_range(from, to) ⇒ Object

Remove assets to this site by IP address range.

Parameters:

  • from (String) —

    Beginning IP address of a range.

  • to (String) —

    Ending IP address of a range.



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/nexpose/site.rb', line 263

def remove_included_ip_range(from, to)
  begin
    from_ip = IPAddr.new(from)
    to_ip = IPAddr.new(to)
    (from_ip..to_ip)
    if (from_ip..to_ip).to_a.size == 0
      raise 'Invalid IP range specified'
    end
    @included_scan_targets[:addresses].reject! { |t| t.eql? IPRange.new(from, to) }
  rescue ArgumentError => e
    raise "#{e.message} in given IP range"
  end
end

#remove_ip_range(from, to) ⇒ Object

Deprecated.

Use #remove_included_ip_range instead.



278
279
280
281
 
# File 'lib/nexpose/site.rb', line 278

def remove_ip_range(from, to)
  warn "[DEPRECATED] Use #{self.class}#remove_included_ip_range instead of #{self.class}#remove_ip_range."
  remove_included_ip_range(from, to)
end

#remove_user(user_id) ⇒ Object 



427
428
429
430
431
432
433
 
# File 'lib/nexpose/site.rb', line 427

def remove_user(user_id)
  unless user_id.is_a?(Numeric) && user_id > 0
    raise 'Invalid user id. A user id must be a positive number and refer to an existing system user.'
  end

  @users.delete_if { |h| h[:id] == user_id }
end

#save(connection) ⇒ Fixnum

Saves this site to a Nexpose console. If the site is dynamic, connection and asset filter changes must be saved through the DiscoveryConnection#update_site call.

Parameters:

  • connection (Connection) —

    Connection to console where this site will be saved.

Returns:

  • (Fixnum) —

    Site ID assigned to this configuration, if successful.



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/nexpose/site.rb', line 562

def save(connection)
  new_site = @id == -1

  if new_site
    resp = AJAX.post(connection, '/api/2.1/site_configurations/', to_json, AJAX::CONTENT_TYPE::JSON)
    @id = resp.to_i
  else
    resp = AJAX.put(connection, "/api/2.1/site_configurations/#{@id}", to_json, AJAX::CONTENT_TYPE::JSON)
  end

  # Retrieve the scan engine and shared credentials and add them to the site configuration
  site_config = Site.load(connection, @id)
  @engine_id = site_config.engine_id
  @shared_credentials = site_config.shared_credentials
  @alerts = site_config.alerts

  @id
end

#scan(connection, sync_id = nil) ⇒ Scan

Scan this site.

Parameters:

  • connection (Connection) —

    Connection to console where scan will be launched.

  • sync_id (String) (defaults to: nil) —

    Optional synchronization token.

Returns:

  • (Scan) —

    Scan launch information.



597
598
599
600
601
602
603
604
605
 
# File 'lib/nexpose/site.rb', line 597

def scan(connection, sync_id = nil)
  xml = REXML::Element.new('SiteScanRequest')
  xml.add_attributes({ 'session-id' => connection.session_id,
                       'site-id' => @id,
                       'sync-id' => sync_id })

  response = connection.execute(xml, '1.1', timeout: 60)
  Scan.parse(response.res) if response.success
end

#to_h ⇒ Object 



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/nexpose/site.rb', line 459

def to_h
  included_scan_targets = {
      addresses: @included_scan_targets[:addresses].compact,
      asset_groups: @included_scan_targets[:asset_groups].compact
  }
  excluded_scan_targets = {
      addresses: @excluded_scan_targets[:addresses].compact,
      asset_groups: @excluded_scan_targets[:asset_groups].compact
  }

  hash = {
      id: @id,
      name: @name,
      description: @description,
      auto_engine_selection_enabled: @auto_engine_selection_enabled,
      included_scan_targets: included_scan_targets,
      excluded_scan_targets: excluded_scan_targets,
      engine_id: @engine_id,
      scan_template_id: @scan_template_id,
      risk_factor: @risk_factor,
      schedules: (@schedules || []).map {|schedule| schedule.to_h},
      shared_credentials: (@shared_credentials || []).map {|cred| cred.to_h},
      site_credentials: (@site_credentials || []).map {|cred| cred.to_h},
      web_credentials: (@web_credentials || []).map {|webCred| webCred.to_h},
      discovery_config: @discovery_config.to_h,
      search_criteria: @search_criteria.to_h,
      tags: (@tags || []).map{|tag| tag.to_h},
      alerts: (@alerts || []).map {|alert| alert.to_h },
      organization: @organization.to_h,
      users: users
  }
  # @TODO: Revisit this for 2.0.0 update
  # Only pass in blackouts if they were actually specified (for backwards compatibility)
  hash[:blackouts] = @blackouts.map(&:to_h) if @blackouts && @blackouts.any?

  hash
end

#to_json ⇒ Object 



455
456
457
 
# File 'lib/nexpose/site.rb', line 455

def to_json
  JSON.generate(to_h)
end

#validate_asset_group(asset_group_id) ⇒ Object 



409
410
411
412
413
414
415
416
417
 
# File 'lib/nexpose/site.rb', line 409

def validate_asset_group(asset_group_id)
  begin
    Integer(asset_group_id)
  rescue ArgumentError => e
    raise "Invalid asset_group id. #{e.message}"
  end

  raise 'Invalid asset_group id. Must be positive number.' if asset_group_id.to_i < 1
end