  The following information is an alphabetical listing of Internet Services script global constants along with a brief description of their syntax and function. For an introduction to functions, see About Internet Services script library.
AUTH_TYPE
Displays the authentication method used to encode the user ID and password required to access the current page.
Note
This script global variable is either 'basic' or no value (for non-authenticated users).
CONTENT_TYPE
Returns the value of the COMSPEC environment variable. Windows sets this to the complete path of the command interpreter, for example C:\Windows\system32\cmd.exe.
Syntax
CONTENT_TYPE
where Internet Services outputs the value of the COMSPEC environment variable.
Value type
string
CONTENT_LENGTH
Returns the number of bytes of data contained in the request from the browser. This is typically zero, except when the request is the result of a FORM post.
Syntax
CONTENT_LENGTH (number)
where Internet Services outputs the value of the CONTENT_LENGTH header variable.
Value type
number
COMSPEC (Windows only)
Returns the value of the COMSPEC environment variable. Windows sets this to the complete path of the command interpreter, for example, C:\Windows\system32\cmd.exe.
Syntax
COMSPEC
where Internet Services outputs the value of the COMSPEC environment variable.
Value type
string
DATE_GMT
Displays the server's date and time, according to GMT.
Note
The format for this global constant can be controlled using the #config timefmt script command.
DATE_LOCAL
Displays the server's date and time, according its local time zone.
DOCUMENT_NAME
Displays the file name of the current document.
DOCUMENT_URI
Displays the URL for the current document.
FTP_DOMAIN
Returns the value of the FTP domain name field as set in the Basic Internet Setup form.
Syntax
FTP_DOMAIN
Outputs the value as a string and used in the banner string presented when FTP clients connect.
GATEWAY_INTERFACE
Returns the current CGI interface version.
Syntax
GATEWAY_INTERFACE
returns the value CGI/1.1 in string format.
HTTP_ACCEPT
Displays the file formats supported by the user agent (browser).
The output depends on the browser.
HTTP_DOMAIN
Returns the fully qualified domain name to which this connection resolved.
Syntax
HTTP_DOMAIN
Returns the value from the "Domain names" field on the Multiple Sites & Languages form or the HTTP server domain name on the Basic Internet Setup form.
Value type
string
HTTP_PORT
Returns the numeric value of the TCP/IP port on which the current connection was accepted.
Syntax
HTTP_PORT
The default value is 80, but may be overridden in the Multiple Sites & Languages form.
HTTP_REFERER
Displays the URL of the HTML page that links to the current page.
HTTP_USER_AGENT
Displays information about the browser and the operating system it is running on.
Typical values
Netscape
Mozilla 4.08 {en}(Win98;1)
Microsoft Internet Explorer:
Mozilla 4.0 (compatible;MSIE4.0;Windows 98)
HTTPS
Displays that HTTPS is being used.
Note
If the HTTPS script global variable is being used, Internet Services sets the value to 'on'.
Value type
flag
HTTPS_CIPHER
Shows the Cipher specification name (SSL/TLS cipherspec).
Note
The term Cipher means encryption algorithm.
Syntax
HTTPS_CIPHER
where Internet Services outputs different values depending on the connection that's negotiated between Internet Services and browser.
Value type
string
HTTPS_KEYSIZE
Sets the number of bits in the session key.
Syntax
HTTPS_KEYSIZE
where Internet Services outputs a value negotiated between Internet Services and the browser.
This is dependant on an encryption algorithm.
Value type
number
HTTPS_PORT
Returns the numeric value of the TCP/IP port on which the current connection is accepted.
Syntax
HTTPS_PORT
The default value for this is 443, but may be overridden in the Multiple Sites & Languages form.
Value type
number
HTTPS_SECRETKEYSIZE
Sets the number of bits in the secret key.
Syntax
HTTPS_SECRETKEYSIZE
where Internet Services outputs a value that is negotiated between Internet Services and the browser.
This is dependant on an encryption algorithm.
Value type
number
LAST_MODIFIED
Displays the date on which the current document was last modified.
Note
The format can be controlled with the #config timefmt script command.
LDAP_DOMAIN
Returns the value of the primary domain name field.
Syntax
LDAP_DOMAIN
This string is currently unused.
Value type
number
NNTP_DOMAIN
Returns the value of the NNTP server domain name field as set in the Basic Internet Setup form - News tab.
Syntax
NNTP_DOMAIN
Outputs the value that is used in the banner string presented when NNTP clients connect.
Value type
string
PATH_INFO
Displays the path of the current document, relative to the site root.
PRIMARY_DOMAIN
Returns the value of the Primary domain name field as set in the Basic Internet Setup form.
Syntax
PRIMARY_DOMAIN
Outputs the value that is used in the banner string presented when POP3 clients connect, as well as other uses in various places.
Value type
string
QUERY_STRING
Returns the query part of the request URL.
Syntax
QUERY_STRING
Outputs the query part of a URL that follows the first question mark as a string.
QUERY_STRING_UNESCAPED
Displays the unescaped list of the URI parameters for this document.
REMOTE_ADDR
Displays the TCP/IP address of the client end of the current connection, in dotted-quad format.
Syntax
REMOTE_ADDR
Value type
string
Example
127.0.0.1
REMOTE_HOST
Displays the DNS host name of the machine the browser is running on.
Note
If there is no host name defined for the computer or the reverse DNS lookup fails, it displays the IP address.
REMOTE_USER
Displays the remote user log in name, if the user is logged into your system.
REQUEST_METHOD
The HTTP request keyword.
Syntax
REQUEST_METHOD
Outputs typically either GET or POST.
Value type
string
SERVER_ADDR
The server's TCP/IP address for the current connection, in dotted-quad format.
Syntax
SERVER_ADDR
Value type
string
Example
127.0.0.1
SERVER_DOMAIN
Returns the domain name as specified in the Domain name field on the System Profile form.
Syntax
SERVER_DOMAIN
Ouputs the value, as a string, that is used to create FCP URLs.
SERVER_NAME
Displays the name of the machine on which Internet Services is installed.
SERVER_PORT
Displays the HTTP port number as set in the HTTP port field.
Typical values
80
SERVER_PROTOCOL
Displays the version of the protocol implemented on your server.
Typical values
HTTP/1.1
Value type
string
SERVER_SOFTWARE
Displays the text FirstClass/(version #)
Typical values
FirstClass/8.0
SMTP_DOMAIN
Returns the value of the SMTP server domain name field as set in the Basic Internet Setup form - Mail tab.
Syntax
SMTP_DOMAIN
Outputs the value, as a string, used in the banner string presented when SMTP clients connect.
SSL_CIPHER
See HTTPS_CIPHER.
Syntax
SSL_CIPHER
Outputs the value as a string.
Value type
string
SSL_CIPHER_ALGKEYSIZE
Returns the number of (possible) cipher bits.
Syntax
SSL_CIPHER_ALGKEYSIZE
Outputs the value as a number.
The more bits, the stronger the encryption, for example, 128 bits.
SSL_CIPHER_EXPORT
Returns true if the cipher is an export cipher.
Syntax
SSL_CIPHER_EXPORT
Returns a boolean value either 'true' or 'false'.
SSL_CIPHER_USEKEYSIZE
Returns the algorithm used for the signature of the client's certificate.
Syntax
SSL_CLIENT_A_SIG
Outputs the value as a string.
Currently returns nothing, this is reserved for future use.
SSL_CLIENT_A_SIG
Returns the algorithm used for the public key of the client's certificate.
Syntax
SSL_CLIENT_A_KEY
Outputs the value as a string.
Currently returns nothing, this is reserved for future use.
SSL_CLIENT_A_KEY
Returns the algorithm used for the public key of the client's certificate.
Syntax
SSL_CLIENT_A_KEY
Outputs the value as a string.
Currently returns nothing, this is reserved for future use.
SSL_CLIENT_CERT
Sets the Base64-encoded client certificate.
Syntax
SSL_CLIENT_CERT
Outputs the value as a string.
SSL_CLIENT_DN
Sets the Distinguished Name (DN) in the client's security certificate.
Note
Distinguished Name refers to the most legal name of the site, for example, company or organizational unit name.
Syntax
SSL_CLIENT_DN
Outputs the value as a string.
SSL_CLIENT_I_CERT
Returns the issuer's PEM encoded certificate for the client's certificate, for example, browser.
SSL_CLIENT_I_DN
Returns the issuer DN of the client's certificate.
Syntax
SSL_CLIENT_I_DN
Outputs the value as a string.
Value type
string
SSL_CLIENT_I_DN_CERT
Invalid
SSL_CLIENT_I_DN_DN
Invalid
SSL_CLIENT_V_END
Returns the date the the client's certificate is valid until.
Syntax
SSL_CLIENT_V_END
The date is returned in the format of YYMMDDHHMMSSZ where Z indicates GMT.
Value type
string
SSL_CLIENT_V_START
Returns the date the the client's certificate is valid from.
Syntax
SSL_CLIENT_V_STAR
The date is returned in the format of YYMMDDHHMMSSZ where Z indicates GMT.
Value type
string
SSL_CLIENT_VERIFY
Returns the result of client certificate verification.
Syntax
SSL_CLIENT_VERIFY
Returns 'NONE', as Internet Services currently does not support configuring SSL to request or require that clients supply valid certificates when negotiating SSL connections.
Value type
string
SSL_EXPORT
SSL_KEYSIZE
SSL_PROTOCOL
Returns the negotiated protocol that the client and server will use for this connection.
Syntax
SSL_PROTOCOL
Returns one of SSLv2, SSLv3, or TLSv1.
Value type
string
SSL_PROTOCOL_VERSION
Returns the SSL version number.
The two possible version numbers are version 2 or version 3.
Syntax
SSL_PROTOCOL_VERSION
Value type
string
SSL_SECKEYSIZE
SSL_SERVER_A_KEY
The algorithm used for the public key of the server's certificate.
Syntax
SSL_SERVER_A_KEY
Value type
string
Example
rsaEncryption, or UNKNOWN if not known.
SSL_SERVER_A_SIG
The algorithm used for the signature of the server's certificate.
Syntax
SSL_SERVER_A_SIG
Value type
string
Example
md5WithRSAEncryption, or UNKNOWN if not known.
SSL_SERVER_CERT
Returns the PEM encoded value of the SSL certificate the server is using for this connection.
Syntax
SSL_SERVER_S_CERT
The contents of the certificate from -----BEGIN CERTIFICATE----- to -----END CERTIFICATE-----, inclusive. Does not contain the password or the private key.
Value type
string
SSL_SERVER_DN
Displays the DN of the server's certificate.
Syntax
SSL_SERVER_DN
Value type
string
SSL_SERVER_I_CERT
Returns the issuer's PEM encoded certificate for the server's certificate, for example, the certificate VeriSign used to sign the server's certificate.
SSL_SERVER_I_DN
Displays the DN of the issuer of the server's certificate.
Syntax
SSL_SERVER_I_DN
Value type
string
SSL_SERVER_I_DN_CERT
Invalid
SSL_SERVER_I_DN_DN
Invalid
See SSL_SERVER_CERT
SSL_SERVER_S_DN
The value of the server's Distinguished Name in the SSL certificate used to negotiate the current connection.
Syntax
SSL_SERVER_S_DN
The PEM encoded DN is a string that contains a list of attribute/value pairs, separated by forward slashes (/). The attributes are taken from the list of: C, CN, ST, L, O, OU, Email, T, I, G, S, D, UID.
Value type
string
Example
SSL_SERVER_S_DN="/C=XY/ST=Snake Desert/L=Snake Town/O=Snake Oil, Ltd/OU=Webserver Team/CN=www.snakeoil.dom/Email=www@snakeoil.dom"
SSL_SERVER_S_DN_CERT
Invalid
SSL_SERVER_S_DN_DN
Invalid
SSL_SERVER_V_END
Returns the date the the server's certificate is valid until.
Syntax
SSL_SERVER_V_END
The date is returned in the format of YYMMDDHHMMSSZ where Z(ulu) indicates GMT.
Value type
string
SSL_SERVER_V_START
Returns the date the the server's certificate is valid from.
Syntax
SSL_SERVER_V_START
The date is returned in the format of YYMMDDHHMMSSZ where Z(ulu) indicates GMT.
Value type
string
SSL_SESSION_ID
Returns the hex encoded number or string for CGIs to use that do not or cannot generate one.
Syntax
SSL_SESSION_ID
The string returned is 64 ASCII characters from the set of 0-9 and A-F.
Value type
string
number
SSL_SSLEAY_VERSION
Returns which version of the SSL library is used in Internet Services.
Note
Internet Services uses the 'OpenSSL 0.9.6 24 Sep 2000' SSL library version.
Syntax
SSL_SSLEAY_VERSION
SSL_VERSION_LIBRARY
Returns a string that identifies the version of the library used to provide SSL functionality.
Syntax
SSL_VERSION_LIBRARY
The current library version is OpenSSL/0.9.6.
Value type
string
SSLEAY_VERSION
Returns the same information as SSL_VERSION_LIBRARY. Provided for backward compatibility.
SystemRoot (Windows only)
The value of the SystemRoot environment variable, which is the location of top level folder containing the active Windows installation.
Syntax
SystemRoot
Typically the same value as WINDIR.
Value type
string
WINDIR (Windows only)
The value of the WINDIR environment variable, which is the location of the top level folder containing the active Windows installation.
Syntax
SystemRoot
This value is used to locate Windows specific information.
Value type
string
|