Ruby-Nmap 项目技术文档

1. 安装指南

1.1 系统要求

• Ruby：版本 >= 2.0.0
• Nmap：版本 >= 5.00
• Nokogiri：版本 ~> 1.3
• Command Mapper：版本 ~> 0.3

1.2 安装步骤

1.2.1 安装 Nmap

• Debian / Ubuntu:

  sudo apt install nmap
  

• Fedora / RedHat:

  sudo dnf install nmap
  

• Homebrew:

  brew install nmap
  

1.2.2 安装 Ruby-Nmap Gem

gem install ruby-nmap

2. 项目的使用说明

2.1 运行 Nmap 扫描

2.1.1 基本扫描

require 'nmap/command'

Nmap::Command.run do |nmap|
  nmap.connect_scan = true
  nmap.service_scan = true
  nmap.output_xml = 'scan.xml'
  nmap.verbose = true

  nmap.ports = [20, 21, 22, 23, 25, 80, 110, 443, 512, 522, 8080, 1080]
  nmap.targets = '192.168.1.*'
end

2.1.2 使用 sudo 运行扫描

require 'nmap/command'

Nmap::Command.sudo do |nmap|
  nmap.syn_scan = true
  nmap.os_fingerprint = true
  nmap.service_scan = true
  nmap.output_xml = 'scan.xml'
  nmap.verbose = true

  nmap.ports = [20, 21, 22, 23, 25, 80, 110, 443, 512, 522, 8080, 1080]
  nmap.targets = '192.168.1.*'
end

2.2 解析 Nmap XML 扫描文件

require 'nmap/xml'

Nmap::XML.open('scan.xml') do |xml|
  xml.each_host do |host|
    puts "[#{host.ip}]"

    host.each_port do |port|
      puts "  #{port.number}/#{port.protocol}\t#{port.state}\t#{port.service}"
    end
  end
end

2.3 打印 NSE 脚本输出

require 'nmap/xml'

Nmap::XML.open('nse.xml') do |xml|
  xml.each_host do |host|
    puts "[#{host.ip}]"

    host.scripts.each do |name, output|
      output.each_line { |line| puts "  #{line}" }
    end

    host.each_port do |port|
      puts "  [#{port.number}/#{port.protocol}]"

      port.scripts.each do |id, script|
        puts "    [#{id}]"

        script.output.each_line { |line| puts "      #{line}" }
      end
    end
  end
end

3. 项目API使用文档

3.1 Nmap::Command 类

• run: 运行 Nmap 扫描。
• sudo: 使用 sudo 权限运行 Nmap 扫描。

3.2 Nmap::XML 类

• open: 打开并解析 Nmap XML 文件。
• each_host: 遍历每个主机。
• each_port: 遍历每个端口。
• scripts: 获取 NSE 脚本输出。

4. 项目安装方式

4.1 安装 Nmap

• Debian / Ubuntu:

  sudo apt install nmap
  

• Fedora / RedHat:

  sudo dnf install nmap
  

• Homebrew:

  brew install nmap
  

4.2 安装 Ruby-Nmap Gem

gem install ruby-nmap

通过以上步骤，您可以成功安装并使用 ruby-nmap 项目进行自动化 Nmap 扫描和解析 Nmap XML 文件。