PenTest/nmap
1
0
Fork 0
mirror of https://github.com/nmap/nmap.git synced 2025-12-06 12:41:29 +00:00
Code Issues Projects Releases Wiki Activity

o The NSE datafiles library now has generic file parsing routines, and

Browse Source 
the parsing of the standard nmap data files (e.g. nmap-services,
  nmap-protocols, etc.) now uses those generic routines.  NSE scripts
  and libraries may find them useful for dealing with their own data
  files, such as password lists. [Jah]
This commit is contained in:
fyodor
2008-09-03 02:42:02 +00:00
parent a5de49445c
commit e30ba96035
2 changed files with 250 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG
View File

@@ -1,5 +1,11 @@
# Nmap Changelog ($Id$); -*-text-*- # Nmap Changelog ($Id$); -*-text-*-
o The NSE datafiles library now has generic file parsing routines, and
the parsing of the standard nmap data files (e.g. nmap-services,
nmap-protocols, etc.) now uses those generic routines. NSE scripts
and libraries may find them useful for dealing with their own data
files, such as password lists. [Jah]
o Fixed a Makefile problem (race condition) which could lead to build o Fixed a Makefile problem (race condition) which could lead to build
failures when launching make in parallel mode (e.g. -j4). [Michal failures when launching make in parallel mode (e.g. -j4). [Michal
Januszewski] Januszewski]

356
nselib/datafiles.lua
View File

@@ -2,152 +2,284 @@
-- data files. For example nmap-protocol, nmap-rpc, etc. These functions' -- data files. For example nmap-protocol, nmap-rpc, etc. These functions'
-- return values are setup for use with exception handling via nmap.new_try(). -- return values are setup for use with exception handling via nmap.new_try().
-- @author Kris Katterjohn 03/2008 -- @author Kris Katterjohn 03/2008
-- @author jah 08/2008
module(... or "datafiles", package.seeall) module(... or "datafiles", package.seeall)
require 'stdnse' local stdnse = require "stdnse"
-- These tables are filled by the following fill* functions
local protocols_table = {}
local rpc_table = {}
local services_table = {tcp={}, udp={}}
-- Fills protocols or rpc table with values read from the nmap-* files ---
local filltable = function(filename, table) -- Holds tables containing captures for common data files, indexed by filename.
if #table ~= 0 then -- @type table
return true -- @name common_files
end local common_files = {
["nmap-rpc"] = { [function(ln) return tonumber( ln:match( "^%s*[^%s#]+%s+(%d+)" ) ) end] = "^%s*([^%s#]+)%s+%d+" },
["nmap-protocols"] = { [function(ln) return tonumber( ln:match( "^%s*[^%s#]+%s+(%d+)" ) ) end] = "^%s*([^%s#]+)%s+%d+" },
["nmap-services"] = { ["tcp"] = { [function(ln) return tonumber( ln:match( "^%s*[^%s#]+%s+(%d+)/tcp" ) ) end] = "^%s*([^%s#]+)%s+%d+/tcp" },
["udp"] = { [function(ln) return tonumber( ln:match( "^%s*[^%s#]+%s+(%d+)/udp" ) ) end] = "^%s*([^%s#]+)%s+%d+/udp" }
}
local path = nmap.fetchfile(filename) }
if path == nil then
return false
end
local file = io.open(path, "r") ---
-- This function reads and parses Nmap's nmap-protocols file.
-- Loops through file line-by-line
while true do
local l = file:read()
if not l then
break
end
l = l:gsub("%s*#.*", "")
if l:len() ~= 0 then
local m = l:gsub("^([%a%d_-]+)%s+(%d+).*", "%2=%1")
if m:match("=") then
local t = stdnse.strsplit("=", m)
table[tonumber(t[1])] = t[2]
end
end
end
file:close()
return true
end
-- Fills services_table{} with values read from nmap-services
local fillservices = function()
if #services_table["tcp"] ~= 0 or
#services_table["udp"] ~= 0 then
return true
end
local path = nmap.fetchfile("nmap-services")
if path == nil then
return false
end
local file = io.open(path, "r")
-- Loops through nmap-services line-by-line
while true do
local l = file:read()
if not l then
break
end
l = l:gsub("%s*#.*", "")
if l:len() ~= 0 then
local m = l:gsub("^([%a%d_-]+)%s+([%a%d/]+).*", "%2=%1")
if m:match("=") and m:match("/") then
local t = stdnse.strsplit("=", m)
local s = stdnse.strsplit("/", t[1])
if s[2] ~= "tcp" and s[2] ~= "udp" then
services_table = {tcp={}, udp={}}
return false
end
services_table[s[2]][tonumber(s[1])] = t[2]
end
end
end
file:close()
return true
end
--- This function reads and parses Nmap's nmap-protocols file.
-- bool is a Boolean value indicating success. If bool is true, then the -- bool is a Boolean value indicating success. If bool is true, then the
-- second returned value is a table with protocol numbers indexing the -- second returned value is a table with protocol numbers indexing the
-- protocol names. If bool is false, an error message is returned as the -- protocol names. If bool is false, an error message is returned as the
-- second value instead of the table. -- second value instead of the table.
-- @return bool, table|err -- @return bool, table|err
-- @see parse_file
parse_protocols = function() parse_protocols = function()
if not filltable("nmap-protocols", protocols_table) then local status, protocols_table = parse_file("nmap-protocols")
return false, "Error parsing nmap-protocols" if not status then
end return false, "Error parsing nmap-protocols"
end
return true, protocols_table return true, protocols_table
end end
--- This function reads and parses Nmap's nmap-rpc file. bool is a
---
-- This function reads and parses Nmap's nmap-rpc file. bool is a
-- Boolean value indicating success. If bool is true, then the second -- Boolean value indicating success. If bool is true, then the second
-- returned value is a table with RPC numbers indexing the RPC names. -- returned value is a table with RPC numbers indexing the RPC names.
-- If bool is false, an error message is returned as the second value -- If bool is false, an error message is returned as the second value
-- instead of the table. -- instead of the table.
-- @return bool, table|err -- @return bool, table|err
-- @see parse_file
parse_rpc = function() parse_rpc = function()
if not filltable("nmap-rpc", rpc_table) then local status, rpc_table = parse_file("nmap-rpc")
return false, "Error parsing nmap-rpc" if not status then
end return false, "Error parsing nmap-rpc"
end
return true, rpc_table return true, rpc_table
end end
--- This function reads and parses Nmap's nmap-services file.
---
-- This function reads and parses Nmap's nmap-services file.
-- bool is a Boolean value indicating success. If bool is true, -- bool is a Boolean value indicating success. If bool is true,
-- then the second returned value is a table containing two other -- then the second returned value is a table containing two other
-- tables: tcp{} and udp{}. tcp{} contains services indexed by TCP port -- tables: tcp{} and udp{}. tcp{} contains services indexed by TCP port
-- numbers. udp{} is the same, but for UDP. You can pass "tcp" or "udp" -- numbers. udp{} is the same, but for UDP. You can pass "tcp" or "udp"
-- as an argument to parse_services() to only get the corresponding table. -- as an argument to parse_services() to only get the corresponding table.
-- If bool is false, an error message is returned as the second value instead -- If bool is false, an error message is returned as the second value instead
-- of the table. -- of the table.
-- @param protocol The protocol table to return. -- @param protocol The protocol table to return.
-- @return bool, table|err -- @return bool, table|err
-- @see parse_file
parse_services = function(protocol) parse_services = function(protocol)
if protocol and protocol ~= "tcp" and protocol ~= "udp" then if protocol and protocol ~= "tcp" and protocol ~= "udp" then
return false, "Bad protocol for nmap-services: use tcp or udp" return false, "Bad protocol for nmap-services: use tcp or udp"
end end
if not fillservices() then local status, services_table = parse_file("nmap-services", protocol)
return false, "Error parsing nmap-services" if not status then
end return false, "Error parsing nmap-services"
end
if protocol then return true, services_table
return true, services_table[protocol]
end
return true, services_table
end end
---
-- Generic parsing of datafiles. By supplying this function with a table containing captures to be applied to each line
-- of a datafile a table will be returned which mirrors the structure of the supplied table and which contains any captured
-- values. A capture will be applied to each line using string.match() and may also be enclosed within a table or a function.
-- A function must accept a line as its paramater and should return one value derived from that line.
function parse_file( filename, ... )
local data_struct
-- must have a filename
if type( filename ) ~= "string" or filename == "" then
return false, "Error in datafiles.parse_file: No file to parse."
end
-- is filename a member of common_files? is second parameter a key in common_files or is it a table?
if common_files[filename] then
if type( arg[1] ) == "string" and common_files[filename][arg[1]] then
data_struct = {{ [arg[1]] = common_files[filename][arg[1]] }}
elseif type( arg[1] ) == "table" then
data_struct = { arg[1] }
else
data_struct = { common_files[filename] }
end
end
if type( data_struct ) ~= "table" then
local t = {}
for _, a in ipairs( arg ) do
if type( a ) == "table" then
if not next( a ) then a = { "^(.+)$" } end -- empty table? no problem, you'll get the whole line
t[#t+1] = a
end
end
if #t == 0 then
return false, "Error in datafiles.parse_file: I've no idea how you want your data."
end
data_struct = t
end
-- get path to file - no checking done here
local status, filepath = get_filepath( filename )
if not status then
return false, ( "Error in datafiles.parse_file: %s." ):format( filepath ) -- error from get_filepath
end
-- get a table of lines
local status, lines = read_from_file( filepath )
if not status then
return false, ( "Error in datafiles.parse_file: %s could not be read: %s." ):format( filepath, lines )
end
-- do the actual parsing
local ret = {}
for _, ds in ipairs( data_struct ) do
status, ret[#ret+1] = parse_lines( lines, ds )
-- hmmm should we fail all if there are any failures? yes? ok
if not status then return false, ret[#ret] end
end
return true, unpack( ret )
end
---
-- Generic parsing of an array of strings. By supplying this function with a table containing captures to be applied to each value
-- of a array-like table of strings a table will be returned which mirrors the structure of the supplied table and which contains any captured
-- values. A capture will be applied to each array member using string.match() and may also be enclosed within a table or a function.
-- A function must accept an array member as its paramater and should return one value derived from that member.
function parse_lines( lines, data_struct )
if type( lines ) ~= "table" or #lines < 1 then
return false, "Error in datafiles.parse_lines: No lines to parse."
end
if type( data_struct ) ~= "table" or not next( data_struct ) then
return false, "Error in datafiles.parse_lines: No patterns for data capture."
end
local ret = {}
-- return an array-like table of values captured from each line
function get_array( v_pattern )
local ret = {}
for _, line in ipairs( lines ) do
-- only process strings
if type( line ) == "string" then
local captured
if type( v_pattern ) == "function" then
captured = v_pattern( line )
else
captured = line:match( v_pattern )
end
ret[#ret+1] = captured
end
end
return ret
end
-- return an associative array table of index-value pairs captured from each line
function get_assoc_array( i_pattern, v_pattern )
local ret = {}
for _, line in ipairs(lines) do
-- only process strings
if type( line ) == "string" then
if type(i_pattern) == "function" then
index = i_pattern(line)
else
index = line:match(i_pattern)
end
if index and type(v_pattern) == "function" then
ret[index] = v_pattern(line)
elseif index then
ret[index] = line:match(v_pattern)
end
end
end
return ret
end
-- traverse data_struct and enforce sensible index-value pairs. Call functions to process the members of lines.
for index, value in pairs( data_struct ) do
if type(index) == nil then return false, "Error in datafiles.parse_lines: Invalid index." end
if type(index) == "number" or ( type(index) == "string" and not index:match("%(") ) then
if type(value) == "number" or ( type(value) == "string" and not value:match("%(") ) then
return false, "Error in datafiles.parse_lines: No patterns for data capture."
elseif type(value) == "string" or type(value) == "function" then
ret = get_array( value )
elseif type(value) == "table" then
_, ret[index] = parse_lines( lines, value )
else
-- TEMP
print(type(index), "unexpected value", type(value))
end
elseif type(index) == "string" or type(index) == "function" then
if type( value ) == "string" or type( value ) == "function" then
ret = get_assoc_array( index, value )
else
return false, ( "Error in datafiles.parse_lines: Invalid value for index %s." ):format( index )
end
else
-- TEMP
print("unexpexted index", type(index), type(value))
end
end
return true, ret
end
---
-- Reads a file, line by line, into a table.
-- @param file String representing a filepath.
-- @return Boolean True on success, False on error
-- @return Table (array-style) of lines read from the file or error message in case of an error.
function read_from_file( file )
if type( file ) ~= "string" or file == "" then
return false, "Error in datafiles.read_from_file: Expected file as a string."
end
local f, err, _ = io.open( file, "r" )
if not f then
return false, ( "Error in datafiles.read_from_file: Cannot open %s for reading: %s" ):format( file, err )
end
local line, ret = nil, {}
while true do
line = f:read()
if not line then break end
ret[#ret+1] = line
end
f:close()
return true, ret
end
---
-- Gets the path to filename.
function get_filepath( filename )
local ff = { "nmap-rpc", "nmap-services", "nmap-protocols" }
for _, f in pairs( ff ) do
local path = nmap.fetchfile( f )
if path then
return true, ( path:sub( 1, #path - #f ) .. filename )
end
end
return false, "Error in datafiles.get_filepath: Can't find nmap datafiles" -- ?
end