Class: Nmap::Program

Inherits:

RProgram::Program

• Object
• RProgram::Program
• Nmap::Program

Defined in:

lib/nmap/program.rb

Class Method Summary

• .scan(options = {}) {|task| ... } ⇒ Boolean

  Finds the nmap program and performs a scan.

Instance Method Summary

• #scan(options = {}) {|task| ... } ⇒ Boolean

  Performs a scan.

Class Method Details

.scan(options = {}) {|task| ... } ⇒ Boolean

Finds the nmap program and performs a scan.

Examples:

Specifying Nmap options via a Hash.

Nmap::Program.scan(
  :targets => '192.168.1.1',
  :ports => [22,80,443],
  :verbose => true
)

Specifying Nmap options via a Task object.

Nmap::Program.scan do |nmap|
  nmap.targets = '192.168.1.1'
  nmap.ports = [22,80,443]
  nmap.verbose = true
end

Parameters:

• options (Hash{Symbol => Object}) (defaults to: {}) —

  Additional options for nmap.

Yields:

• (task) —

  If a block is given, it will be passed a task object used to specify options for nmap.

Yield Parameters:

• task (Task) —

  The nmap task object.

Returns:

• (Boolean) —

  Specifies whether the command exited normally.

# File 'lib/nmap/program.rb', line 40

def self.scan(options={},&block)
  self.find.scan(options,&block)
end

Instance Method Details

#scan(options = {}) {|task| ... } ⇒ Boolean

Performs a scan.

Parameters:

• options (Hash{Symbol => Object}) (defaults to: {}) —

  Additional options for nmap.

Yields:

• (task) —

  If a block is given, it will be passed a task object used to specify options for nmap.

Yield Parameters:

• task (Task) —

  The nmap task object.

Returns:

• (Boolean) —

  Specifies whether the command exited normally.

# File 'lib/nmap/program.rb', line 60

def scan(options={},&block)
  run_task(Task.new(options,&block))
end