From 5fffad15ebe6358a779c2bef3a8fbb46eb9ab477 Mon Sep 17 00:00:00 2001
From: david <david@e0a8ed71-7df4-0310-8962-fdc924857419>
Date: Mon, 3 Nov 2008 23:47:22 +0000
Subject: [PATCH] Canonicalize script args in smb.lua. Canonicalize @copyright
 lines in netbios.lua, smb.lua, and msrpc.lua.

---
 nselib/msrpc.lua   |  2 +-
 nselib/netbios.lua |  2 +-
 nselib/smb.lua     | 56 +++++++++++++++++++++++-----------------------
 3 files changed, 30 insertions(+), 30 deletions(-)

diff --git a/nselib/msrpc.lua b/nselib/msrpc.lua
index b39a711b4..0da4973a6 100644
--- a/nselib/msrpc.lua
+++ b/nselib/msrpc.lua
@@ -32,7 +32,7 @@
 -- remove references to Samba. 
 --
 --@author Ron Bowes <ron@skullsecurity.net>
---@copyright See nmap's COPYING for licence
+--@copyright Same as Nmap--See http://nmap.org/book/man-legal.html
 -----------------------------------------------------------------------
 module(... or "msrpc", package.seeall)
 
diff --git a/nselib/netbios.lua b/nselib/netbios.lua
index 785cd254b..3d0e18b73 100644
--- a/nselib/netbios.lua
+++ b/nselib/netbios.lua
@@ -2,7 +2,7 @@
 --  NetBIOS name requests. 
 --
 --@author Ron Bowes <ron@skullsecurity.net>
---@copyright See nmaps COPYING for licence
+--@copyright Same as Nmap--See http://nmap.org/book/man-legal.html
 -----------------------------------------------------------------------
 
 module(... or "netbios", package.seeall)
diff --git a/nselib/smb.lua b/nselib/smb.lua
index 926ba42d3..ac1bd9d76 100644
--- a/nselib/smb.lua
+++ b/nselib/smb.lua
@@ -99,49 +99,49 @@
 -- or calling RPC functions. Calling RPC functions is the interesting part, and it's done through
 -- the <code>SMB_TRANS</code> packet. The actual RPC protocol is built on top of the SMB protocol. 
 --
--- Thanks go to Christopher R. Hertel and his book <i>Implementing CIFS</i>, which 
+-- Thanks go to Christopher R. Hertel and his book Implementing CIFS, which 
 -- taught me everything I know about Microsoft's protocols. Additionally, I used Samba's
 -- list of error codes for my constants, although I don't believe they would be covered
 -- by GPL, since they're public now anyways, but I'm not a lawyer and, if somebody feels
 -- differently, let me know and we can sort this out. 
 --
--- The following arguments are understood by this script. I don't know if putting them in the nselib file
--- is the right thing to do, but they're here for now anyways. 
---
--- Here's an example of a script with parameters:
--- <code>nmap --script=smb-<script>.nse --script=args=smbuser=ron,smbpass=iagotest2k3 <host></code>
---
---@args  smbusername The SMB username to log in with. The form DOMAIN\username and username@DOMAIN
---                   are NOT understood. To set a domain, use the smbdomain argument. 
+-- Scripts that use this module can use the script arguments
+-- <code>smbusername</code>, <code>smbpassword</code>, <code>smbhash</code>,
+-- <code>smbguest</code>, and <code>smbtype</code>, described below. Here's an
+-- example of using these script arguments:
+-- <code>
+-- nmap --script=smb-<script>.nse --script-args=smbuser=ron,smbpass=iagotest2k3 <host>
+-- </code>
+-- 
+--@args  smbusername The SMB username to log in with. The forms "DOMAIN\username" and "username@DOMAIN"
+--                   are not understood. To set a domain, use the <code>smbdomain</code> argument. 
 --@args  smbdomain   The domain to log in with. If you aren't in a domained environment, then anything
 --                   will (should?) be accepted by the server. 
 --@args  smbpassword The password to connect with. Be cautious with this, since some servers will lock
---                   accounts if the incorrect password is given (although it's rare for the 
---                   'administrator' account to be lockoutable, in the off chance that it is, you could
---                   get yourself in trouble). 
+--                   accounts if the incorrect password is given. Although it's rare that the
+--                   Administrator account can be locked out, in the off chance that it can, you could
+--                   get yourself in trouble. 
 --@args  smbhash     A password hash to use when logging in. This is given as a single hex string (32
---                   characters) or a pair of hex strings (2 x 32 characters, optionally separated by a 
---                   single character). These hashes are the Lanman or NTLM hash of the user's password,
---                   and are stored by systems, on the harddrive or memory. They can be retrived from memory
+--                   characters) or a pair of hex strings (both 32 characters, optionally separated by a 
+--                   single character). These hashes are the LanMan or NTLM hash of the user's password,
+--                   and are stored on disk or in memory. They can be retrieved from memory
 --                   using the fgdump or pwdump tools. 
---@args  smbguest    If this is set to 'true' or '1', a 'guest' login will be attempted if the normal one 
+--@args  smbguest    If this is set to <code>true</code> or <code>1</code>, a guest login will be attempted if the normal one 
 --                   fails. This should be harmless, but I thought I would disable it by default anyway
 --                   because I'm not entirely sure of any possible consequences. 
---@args  smbtype     The type of SMB authentication to use. By default, NTLMv1 is used, which is a pretty
+--@args  smbtype     The type of SMB authentication to use. These are the possible options:
+-- * <code>v1</code>: Sends LMv1 and NTLMv1.
+-- * <code>LMv1</code>: Sends LMv1 only.
+-- * <code>NTLMv1</code>: Sends NTLMv1 only (default).
+-- * <code>v2</code>: Sends LMv2 and NTLMv2.
+-- * <code>LMv2</code>: Sends LMv2 only.
+--                   The default, <code>NTLMv1</code>, is a pretty
 --                   decent compromise between security and compatibility. If you are paranoid, you might 
---                   want to use 'v2' or 'lmv2' for this (actually, if you're paranoid, you should be 
+--                   want to use <code>v2</code> or <code>lmv2</code> for this. (Actually, if you're paranoid, you should be 
 --                   avoiding this protocol altogether :P). If you're using an extremely old system, you 
---                   might need to set this to 'v1' or 'lm', which are less secure but more compatible. 
---
---                   If you want finer grained control, these are the possible options:
---                       * v1 -- Sends LMv1 and NTLMv1
---                       * LMv1 -- Sends LMv1 only
---                       * NTLMv1 -- Sends NTLMv1 only (default)
---                       * v2 -- Sends LMv2 and NTLMv2
---                       * LMv2 -- Sends LMv2 only
---
+--                   might need to set this to <code>v1</code> or <code>lm</code>, which are less secure but more compatible. 
 --@author Ron Bowes <ron@skullsecurity.net>
---@copyright See nmaps COPYING for licence
+--@copyright Same as Nmap--See http://nmap.org/book/man-legal.html
 -----------------------------------------------------------------------
 module(... or "smb", package.seeall)