Class: NessusAPI::Template

Inherits:
Object
  • Object
show all
Defined in:
lib/nessus_api/template.rb

Instance Method Summary collapse

Constructor Details

#initialize(template_name, policy_id, target, startTime = nil, rRules = nil, session = Session.current) ⇒ Template

The class that handles the specific calls for templates.



8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/nessus_api/template.rb', line 8

def initialize(template_name, policy_id, target,
              startTime=nil, rRules=nil,
              session=Session.current)
  @name = template_name
  @policy = policy_id
  @target = target
  @session = session
  @time = startTime
  @rules = rRules
  params = optional({'template_name' => @name, 'policy_id' => @policy,
            'target' => @target}, @time, @rules)
  @uuid = @session.get('scan/template/new', params).at_css("name").text
end

Instance Method Details

#delete(uuid = @uuid) ⇒ Object 



39
40
41
42
43
44
45
46
 
# File 'lib/nessus_api/template.rb', line 39

def delete(uuid=@uuid)
  if @session.get('scan/template/delete',
                 {'template' => uuid}).css('status').text == 'OK'
    return true
  else
    return false
  end
end

#edit(old_name, new_name, policy_id, target, startTime = nil, rRules = nil) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/nessus_api/template.rb', line 22

def edit(old_name, new_name, policy_id, target,
         startTime=nil, rRules=nil)
  params = optional({'template' => old_name, 'template_name' => new_name,
            'policy_id' => policy_id, 'target' => target})
  if @session.get('scan/template/edit', params).css('status').text == 'OK'
    return true
  else
    return false
  end
end

#launch(uuid = @uuid) ⇒ Object 



33
34
35
36
37
 
# File 'lib/nessus_api/template.rb', line 33

def launch(uuid=@uuid)
  # Returns the uuid of a template scan.
  return @session.get('scan/template/launch',
                 {'template' => uuid}).at_css('uuid').text
end

#optional(params, startTime, rRules) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/nessus_api/template.rb', line 48

def optional(params, startTime, rRules)
  # Returns a hash given with a new hash
  # with the optional attributes added.
  if !startTime.nil?
    params['startTime'] = startTime
  end
  if !rRules.nil?
    params['rRules'] = rRules
  end
  return params
end