LANGuard 9 - Scripting Guide
LANGuard 9 - Scripting Guide
Scripting manual
By GFI Software
http://www.gfi.com
Email: info@gfi.com
2 Python Scripting 17
2.1 What is the Python programming language? .................................................... 17
2.2 Creating a new vulnerability check of type Python Script Test.......................... 18
2.3 Application Programming Interfaces (APIs) available in Python Scripts ........... 19
2.4 Debugging Python scripts .................................................................................. 20
3 Functions List 21
5 Object Documentation 27
5.1 Socket Object: ................................................................................................... 27
5.2 SNMP Object: .................................................................................................... 34
5.3 File Object: ......................................................................................................... 37
5.4 Registry Object: ................................................................................................. 45
5.5 HTTP Object ...................................................................................................... 50
5.6 HTTP Headers Object ....................................................................................... 61
5.7 FTP Object ......................................................................................................... 64
5.8 Encode Object: .................................................................................................. 79
6 General Functions 81
6.1 List of functions .................................................................................................. 81
GFI LANguard allows the user to write custom scripts that check for
vulnerabilities. The scripts can be platform dependent or platform
independent.
Platform dependent: Unix scripts run through SSH: The remote machine
must be a Unix machine and allow remote connections via SSH. These
scripts are run on the scanned machine.
Platform independent:
Visual Basic scripts: This manual provides extensive information on how to
write, debug and setup Visual Basic custom vulnerability checks.
Python scripts: More details are available in the Python Scripting chapter in
this manual.
Screenshot 5 Watches
8. In the Value edit box specify the value returned by the Python script when
the vulnerability is discovered. Click Finish button.
The vulnerability check is added and will be included in the list of
vulnerabilities checked for on the next scan of a computer.
To test it out, simply scan your localhost machine (127.0.0.1) and you should
see the vulnerability warning under the miscellaneous section of the
vulnerabilities node of the scan results.
Starting with version 9.0, GFI LANguard supports a new type of vulnerability
checks: Python Script Test. This type of check is available under the
Independent Checks type.
8. In the Value edit box specify the value returned by the Python script when
the vulnerability is discovered. Click Finish button.
9.The vulnerability check is added and will be included in the list of
vulnerabilities checked for on the next scan of a computer.
List of functions which were available in version 3.X of GFI LANguard and
their equivalents in this version.
NOTE: Some functions are still standalone functions (marked with <Global>)
and others are accessed via dedicated objects.
*1 Function is no longer applicable in GFI LANguard 8.X since it was replaced by another
function or equivalent member of the parent Object. For e.g., (RecvFrom functionality is
available by the Recv function of the Socket Object)
*2 Function is no longer standalone but part of a parent Object. For e.g. SnmpGet,
snmpGetNext, and snmpSet are now named Get, GetNext, and set respectively in GFI
LANguard 8.X . This is because they are no longer separate standalone functions but part
of the SNMP Object.
*3 These functions are now available via their VB native functions equivalents
*4 Global functions are not part of an Object. Use these functions directly as normal native VB
functions in scripts
4. Old -> New Function Mapping
With the extended VBScript language based scripting engine some of the
functions available in previous versions of GFI LANguard are now available
under different function names / object locations.
This section describes the equivalent function in GFI LANguard 9.X of a
particular function available in GFI LANguard 3.X
*1 Delete is not implemented but it can be achieved by using left and right in
conjunction.
Example:
In order to convert x = Delete(x, 5, 4) to the new system use the following
system:
x = Left(x,4)+Right(x, 5)
*2 In GFI LANguard 3.X, Dup was used to create multiple copies of a string. This
functionality is now achieved using a loop:
Example:
LongString=”Create Multiple Copies Of This String”
For Copies = 1 to 5
LongString = LongString + LongString
Next Copies
*3 These functions are now available via their VB native functions equivalents
*4 Regular expression functionality can be used using the Microsoft regular
expression activeX component.
Example:
Dim regexp As Object
Set regexp = CreateObject("VBScript.regexp")
regexp.pattern = "[A-Za-z]:(\\[A-Za-z0-9_.-])*"
If regexp.test(string_to_Check) Then
„ Function to execute if regular expression returns
true go here
End If
5. Object Documentation
5.1.1 OpenTcp
OpenTcp is used to establish a connection with a remote server using TCP.
Syntax
OpenTcp(ip, port)
Returns
Socket Object
Example
'This Script displays the banner of an ftp server that is running locally
'It can be made to work with any ftp server simply by changing the value of
the variable IP
Function Main
Dim SocketObject As Object
Dim ip As String
Dim port As String
Dim strResponse As String
Ip = "127.0.0.1"
Port = "21"
Socket.SetTimeout 5000,5000
Set SocketObject = Socket.OpenTcp(Ip,Port)
If Not SocketObject is Nothing Then
'check to see that the Object returned successfully
strResponse = SocketObject.Recv(1024)
echo(strResponse)
SocketObject.Close
End If
End Function
5.1.2 OpenUdp
OpenUdp is used to establish a connection with a remote server using UDP.
Syntax
OpenUdp()
Returns
Socket Object
Example
'This script connects with a DNS server, specified by
the IP variable and runs a query for www.gfi.com and
„then displays the result
Function Main
Dim SocketObject As Object
Dim ip As String
Dim port As String
Dim rawdata As Variant
Dim Response As Variant
Ip = "172.16.130.40"
Port = "53"
strRequest="www.gfi.com"
rawdata = Array(0,3,1,0,0,1,0,0,0,0,0,0,3,&H77,
&H77, &H77, &H03, &H67, &H66, &H69, &H03, &H63,
&H6F,&H6D, 0,0,1,0,1)
'^^^^^^^^^^
'This part is the packet header of our request, it
includes informations such as flags
'^^^^^^^^^^
'This is the request itself, www.gfi.com, note that
'.' are 'represented as &H03 instead of &H2E
'^^^^^^^^^^
'This is the End header of our packet
Set SocketObject = Socket.OpenUdp()
If Not SocketObject is Nothing Then
'check to see that the Object returned
successfully
SocketObject.SendTo IP,port,rawdata
Response = SocketObject.Recv(1024)
For a = UBound(response)-3 To
UBound(response)
echo(Response(a))
If a <> UBound(response) Then
echo(".")
End If
Next a
SocketObject.Close
End If
End Function
5.1.3 Close
Close is used to free a previously assigned socket object.
Syntax
Close
Returns
No data returned.
Example
'This Script Displays the banner of an ftp server that is running locally
'it can be made to work with any ftp server simply by changing the value of
the variable IP
Function Main
Dim SocketObject As Object
Dim ip As String
Dim port As String
Dim strResponse As String
Ip = "127.0.0.1"
Port = "21"
Socket.SetTimeout 5000,5000
Set SocketObject = Socket.OpenTcp(Ip,Port)
If Not SocketObject is Nothing Then
'check to see that the Object returned
successfully
strResponse = SocketObject.Recv(1024)
echo(strResponse)
SocketObject.Close
End If
End Function
5.1.4 Recv
Recv is used to retrieve data from a socket (used for both TCP and UDP
transmissions).
Syntax
Recv(SizeInBytes, [DataType])
More Information
The SizeInBytes parameter specifies how much of the buffer will be
returned. The optional parameter “DataType” can be used to specify in what
format the buffer should be returned. If nothing is specified the buffer is
analyzed, and the appropriate DataType will be set accordingly.
Possible options for the DataType parameter are as follow:
0 – Return buffer as an array of bytes (ideal for raw data).
1 – Return Buffer as a string (ideal if you know that the buffer consists of raw
text)
2 – Return buffer as string, convert non printable characters into “.” Ideal
when you know that the buffer is
mixed between plain text and special characters but when you‟re just
interested in the plain text part.
Returns
String or an array of bytes.
Example
'This Script displays the banner of an ftp server that is running locally
'it can be made to work with any ftp server simply by changing the value of
the variable IP
Function Main
Dim SocketObject As Object
Dim ip As String
Dim port As String
Dim strResponse As String
Ip = "127.0.0.1"
Port = "21"
Socket.SetTimeout 5000,5000
Set SocketObject = Socket.OpenTcp(Ip,Port)
If Not SocketObject is Nothing Then
'check to see that the Object returned
successfully
strResponse = SocketObject.Recv(1024,1)
echo(strResponse)
SocketObject.Close
End If
End Function
5.1.5 Send
Send is used to send data to the current open socket over a TCP
connection.
Syntax
Send (data, [SizeInBytes])
Returns
The actual amount of sent bytes.
More Information
The Send function can only be used with an open Socket Object that was
opened on a TCP connect. To Send data over a UDP Connection see the
SendTo function further on in the document.
The Send function accepts an optional parameter (SizeInBytes) which
specifies how much of the buffer which was passed to the data field will
actually be sent. If this optional parameter is omitted, then the size is
automatically calculated.
Example
'This Script displays the default page in raw html of a web server running
locally
'the script can be made to work with any web server simply by changing the
value of the variable IP
Function Main
Dim SocketObject As Object
Dim ip As String
Dim port As String
Dim req As String
Dim strResponse As String
Ip = "172.16.130.112"
Port = "80"
req = "GET / HTTP/1.0"
cr = Chr(13) + Chr(10)'carriage return and line
feed
req = CStr(req +cr +cr)
Socket.SetTimeout 5000,5000
Set SocketObject = Socket.OpenTcp(Ip,Port)
If Not SocketObject is Nothing Then 'check to see
that the Object returned successfully
SocketObject.Send(CStr(req))
strResponse = SocketObject.Recv(1024)
While Len(CStr(strResponse)) <> 0
echo(strResponse)
StrResponse = SocketObject.Recv(1024)
Wend
echo(strResponse)
End If
End Function
5.1.6 SendTo
SendTo is used to send data to the current open socket over a UDP
Connection.
Syntax
SendTo (ip, port, data, [SizeInBytes])
Returns
The actual amount of bytes sent.
More Information
The SendTo function can only be used with an open Socket object that was
opened on a UDP connect, in order to send data over a TCP Connection
please check the Send function described earlier on in the document.
The SendTo function accepts an optional parameter (SizeInBytes) which
specifies how much of the buffer which was passed to data field will actually
be sent. If this optional parameter is omitted, then the size is automatically
calculated.
Example
'This script connects with a DNS server, specified by
the IP variable and runs a query for www.gfi.com and
„than displays the result
Function Main
Dim SocketObject As Object
Dim ip As String
Dim port As String
Dim rawdata As Variant
Dim Response As Variant
Ip = "172.16.130.40"
Port = "53"
strRequest="www.gfi.com"
rawdata = Array(0,3,1,0,0,1,0,0,0,0,0,0,3, &H77,
&H77, &H77, &H03, &H67, &H66, &H69, &H03, &H63,
&H6F,&H6D, 0,0,1,0,1)
Set SocketObject = Socket.OpenUdp()
If Not SocketObject is Nothing Then
'check to see that the Object returned
successfully
SocketObject.SendTo IP,port,rawdata
Response = SocketObject.Recv(1024)
For a = UBound(response)-3 To
UBound(response)
echo(Response(a))
If a <> UBound(response) Then
echo(".")
End If
Next a
SocketObject.Close
End If
End Function
5.1.7 SetTimeout
The default timeout for sending / receiving data is 2 seconds. SetTimeout is
used to set a different timeout both for sending and receiving data.
Syntax
SetTimeout(SendTimeout, RecieveTimeout)
Returns
No data returned.
More Information
SetTimeout needs to be set before setting the object which will be used for
sending and receiving. Passed parameters for timeouts are in milliseconds.
If -1 is passed as one of the value, the currently set value will be used.
Example
'This Script displays the banner of an ftp server that is running locally
'it can be made to work with any ftp server simply by changing the value of
the variable IP
Function Main
Dim SocketObject As Object
Dim ip As String
Dim port As String
Dim strResponse As String
Ip = "127.0.0.1"
Port = "21"
Socket.SetTimeout -1,5000
Set SocketObject = Socket.OpenTcp(Ip,Port)
If Not SocketObject is Nothing Then
'check to see that the Object returned successfully
strResponse = SocketObject.Recv(1024)
echo(strResponse)
SocketObject.Close
End If
End Function
5.1.8 DnsLookup
DnsLookup is used to resolve host names into IP addresses. This function is
mostly used when you wish to connect to servers and you do not know their
IP.
Syntax
DnsLookup(hostname)
Returns
String (IP Address)
Example
„very simple dns lookup and reverse lookup
Function Main
Dim SocketObject As Object
Dim ServerName As String
Dim IP As String
Dim ResolvedName As String
cr = Chr(13) + Chr(10)'Carriage return and line
feed
ServerName = "whois.networksolutions.com"
echo("Resolving"+cr)
Socket.SetTimeout 5000,5000
ip = socket.DnsLookup(ServerName)
echo(ServerName + " resolves to the IP Address:"+cr
)
echo(ip +cr)
ResolvedName = Socket.ReverseDnsLookup(ip)
echo(cr)
echo("IP Address "+ip+ " resolves to "+cr)
echo(ResolvedName+cr)
End Function
5.1.9 ReverseDnsLookup
ReverseDnsLookup is used to resolve IP addresses into host names.
Syntax
ReverseDnsLookup(IP)
Returns
String : Containing the returned hostname.
Example
„Very simple dns lookup and reverse lookup
Function Main
Dim SocketObject As Object
Dim ServerName As String
Dim IP As String
Dim ResolvedName As String
cr = Chr(13) + Chr(10)
'Carriage return and line feed
ServerName = "whois.networksolutions.com"
echo("Resolving"+cr)
Socket.SetTimeout 5000,5000
ip = socket.DnsLookup(ServerName)
echo(ServerName + " resolves to the IP Address:"+cr
)
echo(ip +cr)
ResolvedName = Socket.ReverseDnsLookup(ip)
echo(cr)
echo("IP Address "+ip+ " resolves to "+cr)
echo(ResolvedName+cr)
End Function
5.2.1 Connect
Connect is used to establish a connection with a remote server and return
an SNMP object to it.
Syntax
Connect(ip, community_string)
Returns
SNMP Object
Example
'Very Simple SNMP Client that retrieves the SysName from a computer
which has an SNMP server installed
Function Main
Dim snmp1 As Object
cr = Chr(13) + Chr(10)'Carriage return and line
feed
Set snmp1 = SNMP.Connect("127.0.0.1", "public")
Val1 = "1.3.6.1.2.1.1.5.0"'OID of the sysName
root = "1.3.6.1.2.1.1."'OID of the systems Object
snmp1.Get Val1
echo "Oid: '"+Val1 + "'"+cr
echo "Value: '"+snmp1.Get(Val1)+"'"+cr
snmp1.Close
End Function
5.2.2 Get
Get is used to retrieve the corresponding string to the specified OID.
Syntax
Get (oid)
Returns
String
Example
'Very Simple SNMP Client that retrieves the SysName from
a computer which has an SNMP server installed
Function Main
Dim snmp1 As Object
cr = Chr(13) + Chr(10)'Carriage return and line
feed
Set snmp1 = SNMP.Connect("127.0.0.1", "public")
Val1 = "1.3.6.1.2.1.1.5.0"'OID of the sysName
root = "1.3.6.1.2.1.1."'OID of the systems Object
snmp1.Get Val1
echo "Oid: '"+Val1 + "'"+cr
echo "Value: '"+snmp1.Get(Val1)+"'"+cr
snmp1.Close
End Function
5.2.3 GetNext
GetNext is used to retrieve the next corresponding string to the specified
OID.
Syntax
GetNext (oid)
Returns
String
Example
'Very Simple SNMP Client that retrieves all the strings pertaining to the
system Object from a computer which has an SNMP server installed
NOTE: that this is raw information, for example the uptime (OID
1.3.5.1.2.1.1.3.0) is displayed as hundreds of a second.
Function Main
Dim snmp1 As Object
cr = Chr(13) + Chr(10)'Carriage return and line
feed
Set snmp1 = SNMP.Connect("127.0.0.1", "public")
Val1 = "1.3.6.1.2.1.1.1.0"'OID of the sysName
root = "1.3.6.1.2.1.1."'OID of the systems Object
'snmp1.Get Val1
While Val1 <> ""'
echo "Oid: '"+Val1 + "'"+cr
echo "Value: '"+snmp1.Get(Val1)+"'"+cr
Val1 = snmp1.GetNext(Val1)
If InStr(Val1, root) <> 1 Then Val1 =""
Wend
snmp1.Close
End Function
5.2.4 Set
Set is used to set a value to a specified OID.
Syntax
Set (oid, String)
Returns
True if successful, false otherwise.
Example
'Very Simple SNMP Client that sets the sysLocation of a
computer which has an SNMP server installed on it to
“Malta”
'Please note that by default this script will always
fail because generally, the public community would be
set to read only
Function Main
Dim snmp1 As Object
cr = Chr(13) + Chr(10)'Carriage return and line
feed
Set snmp1 = SNMP.Connect("127.0.0.1", "public")
Val1 = "1.3.6.1.2.1.1.6.0"'OID of the sysName
root = "1.3.6.1.2.1.1."'OID of the systems Object
If snmp1.Set(Val1, "Malta") = true Then
echo("Value Set successfully")
Else
echo("Failed to Set value")
End If
snmp1.Close
End Function
5.2.5 Close
Close is used to close an open SNMP session.
Syntax
Close
Returns
No data returned.
Example
'Very Simple SNMP Client that retrieves the sysName from
a computer which has an SNMP server installed
Function Main
Dim snmp1 As Object
cr = Chr(13) + Chr(10)'Carriage return and line
feed
Set snmp1 = SNMP.Connect("127.0.0.1", "public")
Val1 = "1.3.6.1.2.1.1.5.0"'OID of the sysName
root = "1.3.6.1.2.1.1."'OID of the systems Object
snmp1.Get Val1
echo "Oid: '"+Val1 + "'"+cr
echo "Value: '"+snmp1.Get(Val1)+"'"+cr
snmp1.Close
End Function
5.3.1 Connect
Connect is used to connect to a machine (either local or remote) on which
you want to open files.
Syntax
Connect (IP or NetBIOS name)
Returns
File Object
Example
'This script opens a file (test.txt) on the local C drive and writes 2 lines to it
Function Main
Dim textfile As Object
Set textfile = File.Connect("127.0.0.1")
If textfile.Open("c:\test.txt", GENERIC_WRITE,
CREATE_ALWAYS) Then
textfile.WriteLine("Hi, This is a test file")
textfile.WriteLine("It was created using GFI
LANguard scripting")
textfile.Close
End If
End Function
5.3.2 Open
Opens a file for read or write.
Syntax
Open (Filename, mode, disposition)
Returns
True if the open operation succeeds, False otherwise.
More Information
Mode:
0 - Open file in query access mode, attributes maybe queried but the file
may not be accessed
GENERIC_READ- Opens file for reading
GENERIC_WRITE- Open File for writing
Disposition:
CREATE_NEW- Creates a new file. The function fails if the specified file
already exists.
CREATE_ALWAYS - Creates a new file. The function overwrites the file if it
exists.
OPEN_EXISTING - Opens the file. The function fails if the file does not exist.
OPEN_ALWAYS - Opens the file, if it exists. If the file does not exist, the
function creates the file.
TRUNCATE_EXISTING - Opens the file. Once opened, the file is truncated
so that its size is zero bytes.
Example
'This script opens a file (test.txt) on the local C drive and writes 2 lines to it
Function Main
Dim textfile As Object
Set textfile = File.Connect("127.0.0.1")
If textfile.Open("c:\test.txt", GENERIC_WRITE,
CREATE_ALWAYS) Then
textfile.WriteLine("Hi, This is a test file")
textfile.WriteLine("It was created using GFI
LANguard scripting")
textfile.Close
End If
End Function
5.3.3 Close
Close is used to close an instance of an open file.
Syntax
Close
Returns
No data returned.
Example
'This script opens a file (test.txt) on the local C drive and writes 2 lines to it
Function Main
Dim textfile As Object
Set textfile = File.Connect("127.0.0.1")
If textfile.Open("c:\test.txt", GENERIC_WRITE,
CREATE_ALWAYS) Then
textfile.WriteLine("Hi, This is a test file")
textfile.WriteLine("It was created using GFI
LANguard scripting")
textfile.Close
End If
End Function
5.3.4 Read
Read is used to read a string of (x) length from a text file.
Syntax
Read(number_of_bytes, [DataType])
Returns
String
More Information
DataType is an optional parameter. If omitted the correct data type will be
auto detected by the system.
Possible options for the DataType parameter are as follow:
0 – Return buffer as an array of bytes (ideal for raw data).
1 – Return Buffer as a string (ideal if you know that the buffer consists of raw
text)
2 – Return buffer as string, non printable characters are ignored. This is
Ideal when you know that the buffer is mixed between plain text and special
characters but when you‟re just interested in the plain text part.
Example
'This script displays the contents of the hosts file
Function Main
Dim textfile As Object
Set textfile = File.Connect("127.0.0.1")
If
textfile.Open("c:\windows\system32\drivers\etc\host
s", GENERIC_READ, Open_Existing) Then
echo(textfile.read(1024,1))
textfile.Close
End If
End Function
5.3.5 Write
Write is used to write a string to a file without appending a CRLF (Carriage
Return Line Feed) at the end of the provided string.
Syntax
Write(string, [number_of_bytes])
Returns
No data returned.
More Information
Number_of_bytes is an optional parameter, if omitted its value will be
automatically calculated according to the size of the string passed.
Example
'This script opens a file (test.txt) on the local C drive and writes a couple of
lines to it.
'The first line is composed by a write and WriteLine function
Function Main
Dim textfile As Object
Set textfile = File.Connect("127.0.0.1")
If textfile.Open("c:\test.txt", GENERIC_WRITE,
CREATE_ALWAYS) Then
textfile.Write("Hi,")
textfile.WriteLine(" This is a test file")
textfile.WriteLine("It was created using GFI
LANguard scripting engine")
textfile.Close
End If
End Function
5.3.6 WriteLine
WriteLine is used to write a string to a file and append a CRLF (Carriage
Return Line Feed) at the end of the provided string
Syntax
WriteLine(string)
Returns
Boolean: True (non-zero) if write succeeded and False (zero) otherwise
Example
'This script opens a file (test.txt) on the local C drive and writes 2 lines to it
Function Main
Dim textfile As Object
Set textfile = File.Connect("127.0.0.1")
If textfile.Open("c:\test.txt", GENERIC_WRITE,
CREATE_ALWAYS) Then
textfile.WriteLine("Hi, This is a test file")
textfile.WriteLine("It was created using GFI
LANguard scripting")
textfile.Close
End If
End Function
5.3.7 Seek
Seek is used to move to an alternative position in the file (from where to read
or write)
Syntax
Seek(Distance, Method)
Returns
Current position in the file
More Information
Distance is a measurement of how many bytes to move the cursor.
Method can be one of the following:
0 -Move cursor specified distance starting from the beginning of the file
1 -Move cursor specified distance starting from current position in the file
2 -Move cursor specified distance starting from the end of the file
Example
'This script displays the contents of the hosts file after moving the cursor 50
characters into the file
Function Main
Dim textfile As Object
Set textfile = File.Connect("127.0.0.1")
If
textfile.Open("c:\windows\system32\drivers\etc\host
s", GENERIC_READ, Open_Existing) Then
Textfile.Seek 50,0
echo(textfile.read(1024))
textfile.Close
End If
End Function
5.3.8 Delete
Delete is used to delete files on the hard disk
Syntax
Delete (path to file)
More Information
You must be connected to the machine before you can delete the file.
NOTE: Do not open the file you are currently running delete on, or else the
file would be locked and the delete operation will fail.
Returns
True if the delete operation succeeds, False otherwise.
Example
'This script deletes the file (test.txt) on the local C drive if it exists.
Function Main
Dim textfile As Object
Set textfile = File.Connect("127.0.0.1")
If textfile.Delete("c:\test.txt") = true Then
echo("File Deleted Successfully")
else
echo(“Delete Failed”)
End If
End Function
5.3.9 Size
Size returns the size of a file.
Syntax
Size ([highpart])
Returns
Size of the file (the lowpart property of the size of the file)
More Information
A file size has two parts. A highpart and a low part. What is returned by the
function is the lowpart. The highpart is an optional parameter in which you
can Get the highpart size property of a file should you need it.
Example
'Displays the size of the hosts file
Function Main
Dim textfile As Object
Dim size As Integer
Set textfile = File.Connect("127.0.0.1")
If
textfile.Open("c:\windows\system32\drivers\etc\host
s", GENERIC_READ, Open_Existing) Then
size = Textfile.Size
echo("your host file has a file size of : " &
size & “ bytes”)
textfile.Close
End If
End Function
5.3.10 FileVersion
FileVersion returns the version of a file if it has the necessary properties
assigned.
Syntax
FileVersion (String)
Returns
Version of the file if file version information exists (returns a string).
Example
'Displays the file version of the calc.exe
Function Main
Dim textfile As Object
Dim ver As String
Set textfile = File.Connect("127.0.0.1")
If textfile.Open("c:\windows\system32\calc.exe",
GENERIC_READ, Open_Existing) Then
ver = Textfile.FileVersion
echo("Your Calc.exe file version is : " &
ver)
textfile.Close
End If
End Function
5.3.11 ProductVersion
ProductVersion returns the product version property of a file if this
information exists.
Syntax
ProductVersion
Returns
String
Example
'Displays the product version of the calc.exe
Function Main
Dim textfile As Object
Dim ver As String
Set textfile = File.Connect("127.0.0.1")
If textfile.Open("c:\windows\system32\calc.exe",
GENERIC_READ, Open_Existing) Then
ver = Textfile.ProductVersion
echo("Your Calc.exe Product version is : " &
ver)
textfile.Close
End If
End Function
5.3.12 Attributes
Returns the attributes of a file.
Syntax
Attributes
Returns
Integer : containing encoded in it the attributes of the file.
More Information
Attributes values:
1- Read Only – File is set as read only.
2- Hidden – The file or directory is hidden.
4- System – The file or directory is an operation system file or directory.
16- Directory – This item is a directory.
32- Archive – The file or directory is an archive file or directory.
64- Device – Reserved, not to be used.
128- Normal – The File has no attributes.
256- Temporary File – This file is marked as being temporary.
512- Sparse File – This file has the sparse attribute assigned to it.
1024- Reparse point – the file or directory has an associated reparse point.
2048- Compressed - The file or directory is compressed.
4096- Offline – The file has been moved into offline storage and data is not
currently available.
8192 - No Index – This file will not be indexed.
16384- Encrypted – This file is encrypted.
NOTE: If the file has a mixture of these attributes, the value will add to each
other. Example an archive which is also read only and hidden, would return
a value of 35 (32 for archive, 1 for read only and 2 for hidden)
Example
'Displays the attributes of the calc.exe
Function Main
Dim textfile As Object
Dim att As Integer
Set textfile = File.Connect("127.0.0.1")
If textfile.Open("c:\windows\system32\calc.exe",
GENERIC_READ, Open_Existing) Then
att = Textfile.Attributes
echo("Your Calc.exe attribute value is : " & att)
textfile.Close
End If
End Function
5.4.1 Connect
Used to create a Connection to the registry of the specified machine.
Syntax
Connect (IP or Netbios name)
Returns
Registry Object
Example
'This script Gets the version of Internet Explorer by
reading it directly from the registry.
Function Main
Dim Ro As Object
Dim ie_version as string
Set Ro = Registry.Connect("127.0.0.1")
ie_version = ro.Read("SOFTWARE\Microsoft\Internet
Explorer\Version Vector", "IE")
echo "IE Version is " + ie_version
End Function
5.4.2 Read
Read is a function used to read values of registry keys
Syntax
Read(Path, ValueName)
Returns
Long - if registry value is REG_DWORD
String - if registry value is REG_SZ
Array of Strings- If registry value is REG_MULTI_SZ
Array of bytes - if registry value is REG_BINARY
Example
'This script gets the version of Internet Explorer by
reading it directly from the registry.
Function Main
Dim Ro As Object
Dim ie_version as string
Set Ro = Registry.Connect("127.0.0.1")
ie_version = ro.Read("SOFTWARE\Microsoft\Internet
Explorer\Version Vector", "IE")
echo "IE Version is " + ie_version
End Function
5.4.3 Write
Write is a function used to write values to registry keys
Syntax
Write(Path, ValueName, Value)
Returns
No data returned.
More Information
Use the following declaration to achieve the correct value type
Long -if registry value is REG_DWORD
String -if registry value is REG_SZ
Array of Strings- if registry value is REG_MULTI_SZ
(arrays need to be declared as variants and then value assigned to them
using the array() function)
Example: Dim test as variant
Test = array(10,2,10)
NOTE : If the key does not exist, it will be created.
Example
'This script writes the value “test” to a particular Key
„SOFTWARE\Microsoft\testkey\testsubkey.
Function Main
Dim Ro As Object
Dim test As String
test = "testvalue"
Set Ro = Registry.Connect("127.0.0.1")
ro.write "SOFTWARE\Microsoft\testkey",
"testsubkey",test
End Function
5.4.4 GetFirstValue
GetFirstValue is a function whose purpose is to initiate the enumeration of a
registry path.
Syntax
GetFirstValue(Path, ValueName)
Returns
Long - if registry value is REG_DWORD
String - if registry value is REG_SZ
Array of Strings- If registry value is REG_MULTI_SZ
Array of bytes - if registry value is REG_BINARY
More Information
ValueName must be a variable of type variant. GetFirstValue will return the
name of the attribute which contains the value returned inside the variable
ValueName.
Example
'This scripts lists all of the programs that run on startup
Function Main
Dim Ro As Object
Dim valueName as variant
cr = Chr(13) + Chr(10)
Set Ro = Registry.Connect("127.0.0.1")
Value =
ro.GetFirstValue("SOFTWARE\Microsoft\Windows\Curren
tVersion\Run", valueName)
While Value <> ""
Echo "ValueName: " & valueName & " = " &
value & cr
Value = ro.GetNextValue(valueName)
Wend
End Function
5.4.5 GetNextValue
GetNextValue is a function used in the enumeration process of registry
paths. It will return subsequent values, on the sequence started by
GetFirstValue.
Syntax
GetNextValue(ValueName)
Returns
Long - if registry value is REG_DWORD
String - if registry value is REG_SZ
Array of Strings- If registry value is REG_MULTI_SZ
Array of bytes - if registry value is REG_BINARY
More Information
ValueName must be a variable of type variant. GetNextValue will return the
name of the attribute which contained the value returned inside the variable
ValueName.
Example
'This scripts lists all of the programs that run on startup
Function Main
Dim Ro As Object
Dim valueName as variant
cr = Chr(13) + Chr(10)
Set Ro = Registry.Connect("127.0.0.1")
Value =
ro.GetFirstValue("SOFTWARE\Microsoft\Windows\Curren
tVersion\Run", valueName)
While Value <> ""
Echo "ValueName: " & valueName & " = " &
value & cr
Value = ro.GetNextValue(valueName)
Wend
End Function
5.4.6 GetFirstKey
Used to start the enumeration of keys residing in a registry path.
Syntax
GetFirstKey(Path)
Returns
String – name of the first key
Example
'This scripts lists all of keys under Microsoft
Function Main
Dim Ro As Object
cr = Chr(13) + Chr(10)
Set Ro = Registry.Connect("127.0.0.1")
Value = ro.GetFirstKey("SOFTWARE\Microsoft")
While Value <> ""
Echo "Keyname = " & value & cr
Value = ro.GetNextKey
Wend
End Function
5.4.7 GetNextKey
GetNextKey is used to continue the enumeration of keys which was started
by the GetFirstKey function.
Syntax
GetNextKey
Returns
String : containing name of key
Example
'This scripts lists all of keys under Microsoft
Function Main
Dim Ro As Object
cr = Chr(13) + Chr(10)
Set Ro = Registry.Connect("127.0.0.1")
Value = ro.GetFirstKey("SOFTWARE\Microsoft")
While Value <> ""
Echo "Keyname = " & value & cr
Value = ro.GetNextKey
Wend
End Function
5.4.8 DeleteValue
DeleteValue is a function used to delete values from the registry keys.
Syntax
DeleteValue(Path, ValueName)
Returns
0 – on deletion success, error number on failure.
Example
'This script deletes the registry key created in the
write example above
Function Main
Dim Ro As Object
Dim result As Integer
Set Ro = Registry.Connect("127.0.0.1")
result =
ro.DeleteValue("SOFTWARE\Microsoft\testkey",
"testsubkey")
If result = 0 Then
Echo "Value Deleted Successfully"
Else
Echo "Failed to Delete Value, Error code: " &
result
End If
End Function
5.4.9 DeleteKey
DeleteKey is a function used to delete registry keys.
Syntax
DeleteKey(Path)
Returns
0 – on deletion success, error number on failure.
Example
'This script deletes the registry key created in the
write example above
Function Main
Dim Ro As Object
Dim result As Integer
Set Ro = Registry.Connect("127.0.0.1")
result = ro.DeleteKey("SOFTWARE\Microsoft\testkey")
If result = 0 Then
Echo "Value Deleted Successfully"
Else
Echo "Failed to Delete Value, Error code: " &
result
End If
End Function
5.5.1 Connect
Connect is used to set the hostname or IP address and the port of the HTTP
server in the Object.
Syntax
HTTP.Connect (STRING "hostname", LONG port)
Hostname can be the IP address or the hostname (eg. www.gfi.com)
Port is the port number – an Integer between 1 and 65535
Returns
HTTP Object
Example
' This script will do a GET request and print out the
return code
Function Main
Dim HTTPObj as Object
ip = "www.gfi.com"
port = 80
Set HTTPobj = HTTP.Connect (ip,port)
' set up the request type
HTTPobj.GetURL("/")
' to pass through the proxy with automatic
authentication
' Authentication needs to be set to 1
HTTPobj.Authentication = 1
' Send the GET request
HTTPResponse = HTTPobj.SendRequest ()
echo "Result: " + cstr(HTTPResponse)
End Function
5.5.2 GetURL
GetUrl is used to initiate a GET request to an HTTP server. GET requests
are used to retrieve documents on the HTTP server.
Syntax
GetUrl (STRING document)
Document is a string (eg. "/index.html")
Returns
No data returned.
Example
' This script will do a GET request and print out the
return code
Function Main
Dim HTTPObj as Object
ip = "www.gfi.com"
port = 80
Set HTTPobj = HTTP.Connect (ip,port)
' Set up the request type
HTTPobj.GetURL("/")
' to pass through the proxy with automatic
authentication
' Authentication needs to be Set to 1
HTTPobj.Authentication = 1
' Send the GET request
HTTPResponse = HTTPobj.SendRequest ()
echo "Result: " + cstr(HTTPResponse)
End Function
5.5.3 PostURL
PostUrl is used to initiate a POST request to an HTTP server. POST
requests are used to send data to an HTTP server.
Syntax
PostUrl (STRING document, STRING data)
Document is a string (eg. "/index.html")
Data is a string (eg. "value1=data1")
Returns
No data returned.
Example
' This script will do a POST request and print out the
return code
Function Main
Dim HTTPObj as Object
ip = "www.gfi.com"
port = 80
Set HTTPobj = HTTP.Connect (ip,port)
' Set up the request type
HTTPobj.PostURL "/", "test"
' to pass through the proxy with automatic
authentication
' Authentication needs to be set to 1
HTTPobj.Authentication = 1
' Send the POST request
HTTPResponse = HTTPobj.SendRequest ()
echo "Result: " + cstr(HTTPResponse)
End Function
5.5.4 SendRequest
SendRequest is used to Send the initiated HTTP request. For example, if
previously the GetURL method was used a GET request will be sent.
Syntax
SendRequest ()
Return value
HTTP Reponse code.
Example
' This script will do a GET request and print out the
return code
Function Main
Dim HTTPObj as Object
ip = "www.gfi.com"
port = 80
Set HTTPobj = HTTP.Connect (ip,port)
' Set up the request type
HTTPobj.GetURL("/")
' to pass through the proxy with automatic
authentication
' Authentication needs to be set to 1
HTTPobj.Authentication = 1
' Send the GET request
HTTPResponse = HTTPobj.SendRequest ()
echo "Result: " + cstr(HTTPResponse)
End Function
5.5.5 AddHeader
AddHeader modifies an initiated request to add, delete or modify an existing
header.
Syntax
AddHeader (STRING name, STRING value)
Name is a string (eg. "Content-Type"). If the name already exists, the value
of that name will be overwritten with the value specified.
Value is a string (eg. "text/html"). If the value is empty the header will be
deleted if it exists.
Return Value
No data returned.
Example
' This script will modify some headers in an attempt to
launch
' a Cross Site Scripting attack on log file parsers
Function Main
Dim HTTPObj As Object
Dim headers As Variant
ip = "www.gfi.com"
port = 80
cr = Chr(13) + Chr(10)
XSSTest = "<script>alert('The new GFI LANguard
features detection of Cross Site Scripting
Detection')</script>"
Set HTTPobj = HTTP.Connect (ip,port)
' headers to try
headers = Array ( "Host", "User-Agent", "Accept",
"X-Header1" , "X-Proxy", "Cookie" )
HTTPobj.GetURL("/")
HTTPobj.Authentication = 1
' a loop for each header which might be used to
' inject XSS signature. Send a request every time
For a = LBound(headers) To UBound(headers)
HTTPobj.ClearRequestHeaders
HTTPobj.AddHeader headers(a), XSSTest
' Send the GET request with our custom
headers
HTTPResponse = HTTPobj.SendRequest ()
echo CStr(a) + " result: " +
CStr(HTTPResponse)+cr
Next
End Function
ClearRequestHeaders
Clears all headers which were previously set with the AddHeader method.
Syntax
ClearRequestHeaders
Return Value
No data returned.
Example
' This script will modify some headers in an attempt to
launch
' a Cross Site Scripting attack on log file parsers
Function Main
Dim HTTPObj As Object
Dim headers As Variant
ip = "www.gfi.com"
port = 80
cr = Chr(13) + Chr(10)
XSSTest = "<script>alert('The new GFI LANGUARD
features detection of Cross Site Scripting
Detection')</script>"
Set HTTPobj = HTTP.Connect (ip,port)
' headers to try
headers = Array ( "Host", "User-Agent", "Accept",
"X-Header1" , "X-Proxy", "Cookie" )
HTTPobj.GetURL("/")
HTTPobj.Authentication = 1
' a loop for each header which might be used to
' inject XSS signiture. Send a request every time
For a = LBound(headers) To UBound(headers)
HTTPobj.ClearRequestHeaders
HTTPobj.AddHeader headers(a), XSSTest
' Send the GET request with our custom
headers
HTTPResponse = HTTPobj.SendRequest ()
echo CStr(a) + " result: " +
CStr(HTTPResponse)+cr
Next
End Function
5.5.8 IP Property
Used to set or retrieve the IP address or host name.
Syntax
HTTPObject.IP
IP: String (read/write)
Example
' This script will re-use the same Object to connect to
a different host and Send the same request
Function Main
Dim HTTPObj As Object
ip1 = "www.gfi.com"
ip2 = "127.0.0.1"
port = 80
cr = Chr(13) + Chr(10)
Set HTTPobj = HTTP.Connect (ip1,port)
' Set up the request type
HTTPobj.GetURL("/")
' to pass through the proxy with automatic
authentication
' Authentication needs to be set to 1
HTTPobj.Authentication = 1
' Send the GET request
HTTPResponse1 = HTTPobj.SendRequest ()
HTTPobj.IP = ip2
HTTPResponse2 = HTTPobj.SendRequest ()
echo "Result: " + CStr(HTTPResponse1)+cr
echo "Result: " + CStr(HTTPResponse2)+cr
End Function
5.6.2 HeaderName
HeaderName retrieves the name of the header from the HTTPHeader
Object.
Syntax
HeaderName (LONG index)
The valid range for index between 0 and the number of headers.
Returns
String : The name of the header.
Example
' This script will print the headers
Function Main
Dim HTTPObj as Object
Dim headers as Object
ip = "www.gfi.com"
port = 80
cr = Chr(13) + Chr(10)
Set HTTPobj = HTTP.Connect (ip,port)
' Set up the request type
HTTPobj.GetURL("/")
HTTPobj.verb = "HEAD"
' Send the HEAD request
HTTPResponse = HTTPobj.SendRequest ()
' Set new Object called headers
Set headers = HTTPobj.ResponseHeaders
' headers.count contains the number of headers
(long)
echo "header count: " & CStr(headers.Count) & cr
upbound = headers.Count - 1
' for each header, echo back the HeaderName and
Header value
For hn=0 To upbound
echo headers.HeaderName(hn) & vbTab & "-->" &
vbtab & headers.HeaderValue(hn) & cr
Next
End Function
5.7.1 Connect
Connect is used to determine the hostname or IP address and the port of the
FTP server.
Syntax
FTPObject connect (STRING hostname, LONG port, BOOL PassiveMode
STRING user, STRING password)
Hostname can be the IP address or the hostname (eg. www.gfi.com)
Port is the port number – an Integer between 1 and 65535
PassiveMode is either TRUE or FALSE. False Sets the mode to Active.
User is the ftp username. For anonymous logon specify username as
“anonymous”.
Password is the ftp password. For anonymous logon use an e-mail address
such as (lnss@gfi.com) as password.
Returns
FTP Object
Example
' an example which echoes the current ftp working
directory
Function Main
Dim FTPobj as Object
ip = "127.0.0.1"
port = 21
mode = FALSE
username = "anonymous"
password = "test@lnss.com"
Set FTPobj=FTP.Connect
(ip,21,mode,username,password)
cdir = FTPobj.GetCurrentDirectory
echo cdir
End Function
5.7.2 GetCurrentDirectory
GetCurrentDirectory retrieves current directory on the ftp server. Any file
functions (eg. Upload or download) are relative to this directory.
Syntax
STRING GetCurrentDirectory()
Returns
The current working directory on the ftp server as a string.
Example
' an example which echoes the current ftp working
directory
Function Main
Dim FTPobj as Object
ip = "127.0.0.1"
port = 21
mode = FALSE
username = "anonymous"
password = “test@lnss.com”
' create a new ftp Connection
Set FTPobj=FTP.Connect
(ip,21,mode,username,password)
cdir = FTPobj.GetCurrentDirectory
echo cdir
End Function
5.7.3 SetCurrentDirectory
SetCurrentDirectory sets the directory location on the remote ftp server. Any
file functions (eg. Upload or download) are relative to this directory.
Syntax
SetCurrentDirectory(STRING directory)
Directory is a string.
Returns
Boolean. If it returns TRUE, the function has succeeded, otherwise it means
that and error was returned. When FALSE is returned, FTPObject.LastError
will return the WIN32 error code.
Example
' an example which Sets the current working directory
Function Main
Dim FTPobj as Object
' configure as needed
ip = "127.0.0.1"
port = 21
mode = FALSE
username = "anonymous"
password = "test@lnss.com"
directory = "/pub/"
' create a new ftp Connection
Set FTPobj=FTP.Connect
(ip,21,mode,username,password)
' Set the current working directory to /pub/
RET = FTPobj.SetCurrentDirectory (directory)
if RET Then
echo "Set current directory to " + directory
+ " succeeded"
else
echo "failed to Set current dir: " +
CStr(FTPobj.LastError)
End If
End Function
5.7.4 CreateDirectory
CreateDirectory creates a new directory on the remote ftp server.
Syntax
CreateDirectory(STRING directory)
Directory is a string.
Returns
Boolean. If it returns TRUE, the function has succeeded, otherwise it means
that and error was returned. When FALSE is returned, FTPObject.LastError
will return the WIN32 error code.
Example
'an example which echoes the current ftp working
directory
Function Random(N)
Random = Int(N*Rnd)
End Function
Function Main
Dim FTPobj as Object
' configure as needed
ip = "127.0.0.1"
port = 21
mode = FALSE
username = "anonymous"
password = “test@lnss.com”
cr = Chr(13) + Chr(10)
' initialise randomization
Randomize
„ now generate a random number to be added to the
filenames
for K = 1 to 10
randomnumber = randomnumber +
cstr(Random(10))
next
tempDir = "lnssDir" & randomnumber
' create a new ftp Connection
Set FTPobj=FTP.Connect
(ip,21,mode,username,password)
' attempt to create a new directory after an
anonymous ftp Connection
if FTPobj.CreateDirectory ( tempDir ) = TRUE then
echo "Directory create access is available to
anonymous ftp at " + ip & cr
' now attempt to Delete the directory
if FTPobj.RemoveDirectory ( tempDir ) = TRUE
then
echo "Directory Delete access is
available to anonymous ftp at " + ip &
cr
else
echo "Directory Delete access is not
available. You might need to Delete
directories created by GFI LANguard" &
cr
End If
End If
End Function
5.7.5 RemoveDirectory
RemoveDirectory creates a new directory on the remote ftp server.
Syntax
RemoveDirectory(STRING directory)
Directory is a string.
Returns
Boolean. If it returns TRUE, the function has succeeded, otherwise it means
that and error was returned. When FALSE is returned, FTPObject.LastError
will return the WIN32 error code.
Example
' an example which echoes the current ftp working
directory
Function Random(N)
Random = Int(N*Rnd)
End Function
Function Main
Dim FTPobj as Object
' configure as needed
ip = "127.0.0.1"
port = 21
mode = FALSE
username = "anonymous"
password = “test@lnss.com”
cr = Chr(13) + Chr(10)
' initialise randomization
Randomize
' now generate a random number to be added to the
filenames
for K = 1 to 10
randomnumber = randomnumber + cstr(Random(10))
next
tempDir = "lnssDir" & randomnumber
' create a new ftp Connection
Set FTPobj=FTP.Connect
(ip,21,mode,username,password)
' attempt to create a new directory after an
anonymous ftp Connection
if FTPobj.CreateDirectory ( tempDir ) = TRUE then
echo "Directory create access is available to
anonymous ftp at " + ip & cr
' now attempt to Delete the directory
if FTPobj.RemoveDirectory ( tempDir ) =
TRUE then
echo "Directory Delete access is
available to anonymous ftp at " + ip &
cr
else
echo "Directory Delete access is not
available. You might need to Delete
directories created by GFI LANguard" &
cr
End If
End If
End Function
5.7.6 DeleteFile
Delete file on the remote ftp server.
Syntax
DeleteFile(STRING file)
File is a string (eg. “readme.txt”)
Returns
Boolean. If it returns TRUE, the function has succeeded, otherwise it means
that and error was returned. When FALSE is returned, FTPObject.LastError
will return the WIN32 error code.
Example
' an example which uploads a file and deletes it on a
remote ftp server
Function Random(N)
Random = Int(N*Rnd)
End Function
Function Main
Dim FTPobj As Object
Dim fl As Object
' configure as needed
ip = "127.0.0.1"
port = 21
mode = FALSE
username = "anonymous"
password = "test@lnss.com"
cr = Chr(13) + Chr(10)
Set fl = file.Connect("127.0.0.1")
fl.Open "testfile.txt", GENERIC_WRITE,
CREATE_ALWAYS
fl.writeline("This is a testfile")
' initialise randomization
Randomize
fl.Close
' now generate a random number to be added to the
filenames
For K = 1 To 10
randomnumber = randomnumber &
CStr(Random(10))
Next
tempFile = "lnssFile" + randomnumber
' create a new ftp Connection
Set FTPobj=FTP.Connect
(ip,21,mode,username,password)
If FTPobj.PutFile ( "testfile.txt", tempFile
) = TRUE Then
echo "File write access is available to
anonymous ftp at " + ip & cr
If FTPobj.DeleteFile ( tempFile ) = TRUE
Then
echo "File Delete access is available to
anonymous ftp at " + ip& cr
Else
echo "File Delete access is not
available. You might need to Delete
files created by GFI LANguard" & cr
End If
End If
fl.Delete("testfile.txt")
End Function
5.7.7 GetFile
GetFile retrieves a file from the remote machine. The file is then stored
locally.
Syntax
GetFile(STRING remotefile, String localfile)
RemoteFile is a string (eg. “readme.txt”)
LocalFile is a string (eg. “readmecopy.txt”)
Returns
Boolean. If it returns TRUE, the function has succeeded, otherwise it means
that and error was returned. When FALSE is returned, FTPObject.LastError
will return the WIN32 error code.
Example
' an example of GetFile function in the FTP Object
' retrieves all files found in the root of the ftp
server.
Function Main
Dim FTPobj as Object
Const DIRECTORYMASK=&H10
ip = "127.0.0.1"
port = 21
cr = Chr(13) + Chr(10)
Set FTPobj = FTP.Connect
(ip,port,TRUE,"anonymous","lnss@gfi.com")
Found=FTPobj.FindFirstFile("*")
While Found
If (FTPobj.GetFindFileAttributes And
DIRECTORYMASK) = DIRECTORYMASK Then
FileType="directory"
Else
FileType="file"
ret = FTPobj.GetFile
(FTPobj.GetFindFileName,
FTPobj.GetFindFileName)
End If
echo "File: " + FTPobj.GetFindFileName + "
size: " + CStr(FTPobj.GetFindFileSize) + "
bytes type: " + FileType & cr
Found=FTPobj.FindNextFile
Wend
End Function
5.7.8 PutFile
PutFile uploads a file from the local disk to the remote ftp server.
Syntax
PutFile(STRING localfile, STRING remotefile)
Localfile is a string (eg. “readme.txt”)
Remotefile is a string (eg. “readme.txt”)
Returns
Boolean. If it returns TRUE, the function has succeeded, otherwise it means
that and error was returned. When FALSE is returned, FTPObject.LastError
will return the WIN32 error code.
Example
' an example which uploads a file and deletes it on a
remote ftp server
Function Random(N)
Random = Int(N*Rnd)
End Function
Function Main
Dim FTPobj As Object
Dim fl As Object
' configure as needed
ip = "127.0.0.1"
port = 21
mode = FALSE
username = "anonymous"
password = "test@lnss.com"
cr = Chr(13) + Chr(10)
Set fl = file.Connect("127.0.0.1")
fl.Open "testfile.txt", GENERIC_WRITE,
CREATE_ALWAYS
fl.writeline("This is a testfile")
' initialise randomization
Randomize
fl.Close
' now generate a random number to be added to the
filenames
For K = 1 To 10
randomnumber = randomnumber & CStr(Random(10))
Next
tempFile = "lnssFile" + randomnumber
' create a new ftp Connection
Set FTPobj=FTP.Connect
(ip,21,mode,username,password)
If FTPobj.PutFile ( "testfile.txt", tempFile ) =
TRUE Then
echo "File write access is available to
anonymous ftp at " + ip & cr
If FTPobj.DeleteFile ( tempFile ) = TRUE Then
echo "File Delete access is available to
anonymous ftp at " + ip& cr
Else
echo "File Delete access is not
available. You might need to Delete
files created by GFI LANguard" & cr
End If
End If
fl.Delete("testfile.txt")
End Function
5.7.9 RenameFile
RenameFile renames files on the remote ftp server.
Syntax
RenameFile(STRING originalFileName, STRING renamedFileName)
originalFileName is a string.
renamedFileName is a string.
Returns
Boolean. If it returns TRUE, the function has succeeded, otherwise it means
that and error was returned. When FALSE is returned, FTPObject.LastError
will return the WIN32 error code.
Example
' an example of RenameFile function in the FTP Object
' renames all files found in the root of the ftp server.
Function Main
Dim FTPobj as Object
Const DIRECTORYMASK=&H10
ip = "127.0.0.1"
port = 21
cr = Chr(13) + Chr(10)
Set FTPobj = FTP.Connect
(ip,port,TRUE,"anonymous","lnss@gfi.com")
Found=FTPobj.FindFirstFile("*")
While Found
If (FTPobj.GetFindFileAttributes And
DIRECTORYMASK) = DIRECTORYMASK Then
FileType="directory"
Else
FileType="file"
FileName = FTPobj.GetFindFileName
RenameFileName = "renamed_" +
FTPobj.GetFindFileName
ret = FTPobj.RenameFile (FileName,
RenameFileName)
End If
echo "File: " + FTPobj.GetFindFileName + "
size: " + CStr(FTPobj.GetFindFileSize) + "
bytes type: " + FileType & cr
Found=FTPobj.FindNextFile
Wend
End Function
5.7.10 FindFirstFile
FindFirstFile initiates and enumeration of files and directories in the current
directory on the remote ftp server.
Syntax
FindFirstFile(STRING filemask)
Filemask is a string. Usually this would be “*” to enumerate all files.
Returns
Boolean. If it returns TRUE, that means that at least one file on the remote
ftp server matched.
File name and file size for the first matching file can be retrieved using
GetFindFileName()/GetFindFileSize() methods. FindNextFile() method is
used to move to next matching file.
FindFirstFile will returns FALSE in case no matching files were found.
FindFirstFile will also returns FALSE on subsequent calls to FindFirstFile() if
current search operation has not been Closed with FindFileClose() method.
When FALSE is returned, FTPObject.LastError will return the WIN32 error
code.
Example
' an example of RenameFile function in the FTP Object
' renames all files found in the root of the ftp server.
Function Main
Dim FTPobj as Object
Const DIRECTORYMASK=&H10
ip = "127.0.0.1"
port = 21
cr = Chr(13) + Chr(10)
Set FTPobj = FTP.Connect
(ip,port,TRUE,"anonymous","lnss@gfi.com")
Found=FTPobj.FindFirstFile("*")
While Found
If (FTPobj.GetFindFileAttributes And
DIRECTORYMASK) = DIRECTORYMASK Then
FileType="directory"
Else
FileType="file"
FileName = FTPobj.GetFindFileName
RenameFileName = "renamed_" +
FTPobj.GetFindFileName
ret = FTPobj.RenameFile (FileName,
RenameFileName)
End If
echo "File: " + FTPobj.GetFindFileName + "
size: " + CStr(FTPobj.GetFindFileSize) + "
bytes type: " + FileType & cr
Found=FTPobj.FindNextFile
Wend
End Function
5.7.11 FindNextFile
Searches for the next file matching the filemask specified by the
FindFirstFile method.
Syntax
FindNextFile
Returns
Boolean. If it returns TRUE, that means that more files were found which
match the filemask specified by the FindFirstFile method. File name and file
size for the first matching file can be retrieved using
GetFindFileName()/GetFindFileSize() methods. FindNextFile will returns
FALSE in case no matching files were found.FindNextFile must be called in-
between a successful call to FindFirstFile() and a call to FindFileClose(). The
method will return FALSE if called outside this scope.
When FALSE is returned, FTPObject.LastError will return the WIN32 error
code.
Example
' an example of RenameFile function in the FTP Object
' renames all files found in the root of the ftp server.
Function Main
Dim FTPobj as Object
Const DIRECTORYMASK=&H10
ip = "127.0.0.1"
port = 21
cr = Chr(13) + Chr(10)
Set FTPobj = FTP.Connect
(ip,port,TRUE,"anonymous","lnss@gfi.com")
Found=FTPobj.FindFirstFile("*")
While Found
If (FTPobj.GetFindFileAttributes And
DIRECTORYMASK) = DIRECTORYMASK Then
FileType="directory"
Else
FileType="file"
FileName = FTPobj.GetFindFileName
RenameFileName = "renamed_" +
FTPobj.GetFindFileName
ret = FTPobj.RenameFile (FileName,
RenameFileName)
End If
echo "File: " + FTPobj.GetFindFileName + "
size: " + CStr(FTPobj.GetFindFileSize) + "
bytes type: " + FileType & cr
Found=FTPobj.FindNextFile
Wend
End Function
5.7.12 FindFileClose
Searches for the next file matching the filemask specified by the
FindFirstFile method. There is no need to call this if call to FindFirstFile()
failed.
Syntax
FindFileClose
Returns
No data returned.
Example
' an example of FindFileClose function in the FTP Object
' searches for a certain file until found in the root.
Function Main
Dim FTPobj as Object
Const DIRECTORYMASK=&H10
ip = "127.0.0.1"
port = 21
cr = Chr(13) + Chr(10)
Set FTPobj = FTP.Connect
(ip,port,TRUE,"anonymous","lnss@gfi.com")
Found=FTPobj.FindFirstFile("*")
While Found
If (FTPobj.GetFindFileAttributes And
DIRECTORYMASK) = DIRECTORYMASK Then
FileType="directory"
Found=FTPobj.FindNextFile
Else
FileType="file"
if FTPobj.GetFindFileName = "test.zip"
then
echo "test.zip exists" & cr
FTPobj.FindFileClose
Found = false
else
echo "test.zip does not exist" & cr
Found=FTPobj.FindNextFile
End If
End If
Wend
End Function
5.7.13 GetFindFileName
GetFindFileName retrieves the filename of the currently matched file after a
successful call to either FindFirstFile or FindNextFile methods.
When FindFileClose is called, GetFindFileName, GetFindFileSize and
GetFindFileAttributes should not be used since this will make the Scripting
engine fail.
Syntax
GetFindFileName
Returns
The name of the file. This is a string.
Example
' an example of RenameFile function in the FTP Object
' renames all files found in the root of the ftp server.
Function Main
Dim FTPobj as Object
Const DIRECTORYMASK=&H10
ip = "127.0.0.1"
port = 21
Set FTPobj = FTP.Connect
(ip,port,TRUE,"anonymous","lnss@gfi.com")
Found=FTPobj.FindFirstFile("*")
While Found
If (FTPobj.GetFindFileAttributes And
DIRECTORYMASK) = DIRECTORYMASK Then
FileType="directory"
Else
FileType="file"
FileName = FTPobj.GetFindFileName
RenameFileName = "renamed_" +
FTPobj.GetFindFileName
ret = FTPobj.RenameFile (FileName,
RenameFileName)
End If
Wend
End Function
5.7.14 GetFindFileSize
GetFindFileSize retrieves the file size of the currently matched file after a
successful call to either FindFirstFile or FindNextFile methods.
When FindFileClose is called, GetFindFileName, GetFindFileSize and
GetFindFileAttributes should not be used since this will make the Scripting
engine fail.
Syntax
GetFileSize
Returns
File size of the currently matched file. Long Integer.
Example
' an example of RenameFile function in the FTP Object
' renames all files found in the root of the ftp server.
Function Main
Dim FTPobj as Object
Const DIRECTORYMASK=&H10
ip = "127.0.0.1"
port = 21
cr = Chr(13) + Chr(10)
Set FTPobj = FTP.Connect
(ip,port,TRUE,"anonymous","lnss@gfi.com")
Found=FTPobj.FindFirstFile("*")
While Found
If (FTPobj.GetFindFileAttributes And
DIRECTORYMASK) = DIRECTORYMASK Then
FileType="directory"
Else
FileType="file"
End If
echo "File: " + FTPobj.GetFindFileName + "
size: " + CStr(FTPobj.GetFindFileSize) + "
bytes type: " + FileType & cr
Found=FTPobj.FindNextFile
Wend
End Function
5.7.15 GetFindFileAttributes
GetFindFileAttributes retrieves the file Attributes of the currently matched file
after a successful call to either FindFirstFile or FindNextFile methods.
When FindFileClose is called, GetFindFileName, GetFindFileSize and
GetFindFileAttributes should not be used since this will make the Scripting
engine fail.
Syntax
GetFindFileAttributes
Returns
File attributes of currently matched file. These are the attributes from
dwFileAttributes member in WIN32 defined structure WIN32_FIND_DATA.
Bit masks are defined as FILE_ATTRUTE_* constants. I.e.
FILE_ATTRUTE_DIRECTORY is defined as 0x10.
FILE_ATTRIBUTE_READONLY &H1
FILE_ATTRIBUTE_HIDDEN &H2
FILE_ATTRIBUTE_SYSTEM &H4
FILE_ATTRIBUTE_DIRECTORY &H10
FILE_ATTRIBUTE_ARCHIVE &H20
FILE_ATTRIBUTE_DEVICE &H40
FILE_ATTRIBUTE_NORMAL &H80
FILE_ATTRIBUTE_TEMPORARY &H100
FILE_ATTRIBUTE_SPARSE_FILE &H200
FILE_ATTRIBUTE_REPARSE_POINT &H400
FILE_ATTRIBUTE_COMPRESSED &H800
FILE_ATTRIBUTE_OFFLINE &H1000
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED &H2000
FILE_ATTRIBUTE_ENCRYPTED &H4000
Example
' an example of RenameFile function in the FTP Object
' renames all files found in the root of the ftp server.
Function Main
Dim FTPobj as Object
Const DIRECTORYMASK=&H10
ip = "127.0.0.1"
port = 21
Set FTPobj = FTP.Connect
(ip,port,TRUE,"anonymous","lnss@gfi.com")
Found=FTPobj.FindFirstFile("*")
While Found
If (FTPobj.GetFindFileAttributes And
DIRECTORYMASK) = DIRECTORYMASK Then
FileType="directory"
Else
FileType="file"
End If
echo "File: " + FTPobj.GetFindFileName + "
size: " + CStr(FTPobj.GetFindFileSize) + "
bytes type: " + FileType
Found=FTPobj.FindNextFile
Wend
End Function
5.8.2 Base64Decode
Base64Decode is used to decode a Base64 Representation string into its
original format
Syntax
Base64Decode(String)
Returns
String
Example
Function Main
Dim message As String
Dim encoded As String
Dim decoded As String
cr = Chr(13) + Chr(10)'Carriage return and line
feed
message = "String to be encoded"
encoded = Encode.Base64Encode(message)
echo "Encoded Text : "
echo encoded
echo cr
decoded = Encode.Base64Decode(encoded)
echo "Decoded Text :"+decoded+cr
End Function
6. General Functions
6.1.2 WriteToLog
Writetolog will write any string passed to it, in the scripting engine log file
Syntax
WriteToLog(String)
Returns
No data returned.
Example
Function Main
WritetoLog "test"
End Function
6.1.3 StatusBar
StatusBar is used to display a string in the status bar of the current active
component
Syntax
StatusBar(String)
Returns
No data returned.
Example:
Function Main
StatusBar "test"
End Function
6.1.4 AddListItem
AddListItem is a function which allows scripts to return feedback to the user.
This function will add any string passed to it as a sub node of the triggered
vulnerability. The AddListItem function takes 2 different parameters. The first
parameter specifies the parent node and the second parameter, the string to
be added to the tree. If the parent node is left empty, the function will add the
specified string to the top available node (the vulnerability parent node). The
tree can only have 1 level though even though it can have as many siblings
as required.
Syntax
AddListItem(String,String)
Returns
N/A
Example
Function MAIN
Dim wmi As Object
Dim objset As Object
Dim obj As Object
Dim monitor As Object
Dim prop As Object
Set wmi =
GetObject("winmgmts:\\127.0.0.1\root\cimv2")
Set objset = wmi.instancesof("Win32_service")
For Each obj In objset
Set monitor = obj
For Each prop In monitor.properties_
If VarType(prop.value) = 8 Then
If Not (IsNull(prop.value)) Then
If prop.name = "Name" Then
If left(prop.value,1) = "a" then
AddListItem("A",prop.value)
End If
If left(prop.value,1) = "b" then
AddListItem("B",prop.value)
End If
If left(prop.value,1) = "c" Then
AddListItem("C",prop.value)
End if
End If
End If
End If
Next
Next
main = true
End Function
6.1.5 SetDescription
SetDescription is used to return simple feedback to the user by means of
programmatically changing the vulnerability description to indicate a more
detailed reason for the vulnerability trigger. SetDescription takes only one
parameter. The string passed to the function will be set as the new
description for the vulnerability once it is triggered.
Syntax
SetDescription(String)
Returns
N/A
Example
Function Main
SetDescription (“This New description will be set
in place of the one specified in the
vulnerability")
Main=true
End Function
7. Using ActiveX, COM and OLE
Automation components
Another advantage of the new scripting language is its ability to use libraries
in scripts. This allows you to create libraries with their most used function
and than simply import the library in all the scripts you wish to use the
functions in.
Platform dependent, 5
Platform independent, 5
B Python, 3, 5, 11, 13, 14, 15
Boolean, 6, 37, 61, 62, 63, 65, 66, 67, PythonWin, 15
68, 69, 70
Breakpoint, 6 S
breakpoints, 5, 6, 9
Scanner, 8, 10
scripts, 3, 5, 6, 10, 14, 15, 19, 43, 44,
D 78, 81, 83
debugging, 5, 6, 15 SNMP, 3, 17, 19, 21, 30, 31, 32, 33
DnsLookup, 17, 29, 30 String, 7, 8, 10, 17, 21, 23, 24, 25,
26, 27, 28, 29, 30, 31, 32, 35,
39, 40, 41, 42, 43, 44, 50, 51,
F 52, 53, 54, 55, 56, 58, 66, 76,
Files, 33 77, 78, 79, 81, 84
FTP, 3, 18, 19, 60, 61, 62, 63, 64, 65, Syntax, 6, 23, 24, 25, 26, 27, 28, 29,
66, 68, 69, 70, 71, 72, 73, 74, 30, 31, 32, 33, 34, 35, 36, 37,
75 38, 39, 40, 41, 42, 43, 44, 45,
46, 47, 48, 49, 50, 51, 52, 53,
54, 55, 56, 57, 58, 59, 60, 61,
H 62, 63, 64, 66, 67, 68, 69, 70,
71, 72, 73, 74, 75, 76, 77, 78,
HTTP, 3, 18, 27, 46, 47, 48, 49, 50,
79
51, 52, 53, 54, 55, 56, 57, 58,
59
V
I variables, 5, 6, 7, 8, 9, 10, 23
VBScript, 3, 6, 21, 22, 81
IDLE, 15
Integer, 39, 40, 41, 45, 46, 60, 73
W
L watches, 5
Winpdb, 15
Libraries, 3, 83
wmi, 7, 8, 10, 78, 82
P
parameters, 5, 10, 29, 78