PenTest/nmap
1
0
Fork 0
mirror of https://github.com/nmap/nmap.git synced 2026-02-16 02:16:34 +00:00
Code Issues Projects Releases Wiki Activity

Fix an inaccuracy in the documentation for the nmap.receive_lines and

Browse Source 
nmap.receive_bytes functions. It claimed that if you don't get all the
lines/bytes you request before a timeout, then a "TIMEOUT" error happens. In
reality you get back data as long as at least one byte was received before the
timeout. From nsock_readlines:

/* Read up to nlines lines (terminated with \n, which of course
   inclues \r\n), or until EOF, or until the timeout, whichever comes
   first.  Note that NSE_STATUS_SUCCESS will be returned in the case
   of EOF or tiemout if at least 1 char has been read.  Also note that
   you may get more than 'nlines' back -- we just stop once "at least"
   'nlines' is read */
This commit is contained in:
david
2008-11-04 22:39:07 +00:00
parent 00b8d455c3
commit 854b3460b5
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
nselib/nmap.luadoc
View File

@@ -279,12 +279,12 @@ function receive()
--- Receives lines from an open connection.
--
-- Tries to receive at least <code>n</code> lines from an open connection. A
-- line is a string delimited with <code>\n</code> characters. If it was not
-- possible to receive at least <code>n</code> lines before the operation times
-- out a <code>"TIMEOUT"</code> error occurs. On the other hand, if more than
-- <code>n</code> lines were received, all are returned, not just
-- <code>n</code>. Use <code>stdnse.make_buffer</code> to guarantee only one
-- line is returned per call.
-- line is a string delimited with <code>\n</code> characters. If no data was
-- was received before the operation times out a <code>"TIMEOUT"</code> error
-- occurs. If even one character was received then it is returned with success.
-- On the other hand, if more than <code>n</code> lines were received, all are
-- returned, not just <code>n</code>. Use <code>stdnse.make_buffer</code> to
-- guarantee only one line is returned per call.
--
-- On success the function returns true along with the received data. If
-- receiving data has failed, the function returns false along with an error
@@ -301,8 +301,8 @@ function receive_lines(n)
-- Tries to receive at least <code>n</code> bytes from an open connection. Like
-- in <code>receive_lines</code>, <code>n</code> is the minimum amount of
-- characters we would like to receive. If more arrive, we get all of them. If
-- fewer than <code>n</code> characters arrive before the operation times out,
-- a <code>"TIMEOUT"</code> error occurs.
-- even one is received then it is returned. If no characters arrive before the
-- operation times out, a <code>"TIMEOUT"</code> error occurs.
--
-- On success the function returns true along with the received data. If
-- receiving data has failed, the function returns false along with an error