From 3dcf997d603dc209d56ccbd994bb9ece4f2856e9 Mon Sep 17 00:00:00 2001 From: dmiller Date: Sat, 8 Mar 2014 14:02:06 +0000 Subject: [PATCH] Fix NSEdoc errors 1. All @table blocks must have an explicit @name 2. All @field blocks must have both a name and description Also added some more information to the creds.States table description --- nselib/creds.lua | 15 +++++++++++++++ nselib/ldap.lua | 1 + nselib/smbauth.lua | 14 +++++++------- 3 files changed, 23 insertions(+), 7 deletions(-) diff --git a/nselib/creds.lua b/nselib/creds.lua index 6fac4a136..03f724ba4 100644 --- a/nselib/creds.lua +++ b/nselib/creds.lua @@ -105,7 +105,22 @@ _ENV = stdnse.module("creds", stdnse.seeall) --- Table mapping the different account states to their number +-- +-- Also available is the StateMsg table, used to map these numbers +-- to a description. -- @class table +-- @name State +-- @field LOCKED Account is locked +-- @field VALID Valid credentials +-- @field DISABLED Account is disabled +-- @field CHANGEPW Valid credentials, password must be changed at next logon +-- @field PARAM Credentials passed to script during Nmap execution +-- @field EXPIRED Valid credentials, account expired +-- @field TIME_RESTRICTED Valid credentials, account cannot log in at current time +-- @field HOST_RESTRICTED Valid credentials, account cannot log in from current host +-- @field LOCKED_VALID Valid credentials, account locked +-- @field DISABLED_VALID Valid credentials, account disabled +-- @field HASHED Hashed valid or invalid credentials State = { LOCKED = 1, VALID = 2, diff --git a/nselib/ldap.lua b/nselib/ldap.lua index 465824f34..e0c5feb3c 100644 --- a/nselib/ldap.lua +++ b/nselib/ldap.lua @@ -43,6 +43,7 @@ ERRORS = { --- Application constants -- @class table +-- @name APPNO APPNO = { BindRequest = 0, BindResponse = 1, diff --git a/nselib/smbauth.lua b/nselib/smbauth.lua index 78b6283a1..059030b90 100644 --- a/nselib/smbauth.lua +++ b/nselib/smbauth.lua @@ -810,13 +810,13 @@ end -- Host information for NTLM security -- @class table -- @name host_info --- @field target_realm --- @field netbios_computer_name --- @field netbios_domain_name --- @field fqdn --- @field dns_domain_name --- @field dns_forest_name --- @field timestamp +-- @field target_realm Target Name Data +-- @field netbios_computer_name Server name +-- @field netbios_domain_name Domain name +-- @field fqdn DNS server name +-- @field dns_domain_name DNS domain name +-- @field dns_forest_name DNS tree name +-- @field timestamp Timestamp --- -- Gets host info from a security blob