978 lines
51 KiB
HTML
978 lines
51 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
<!DOCTYPE html
|
||
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
<html lang="en-us" xml:lang="en-us">
|
||
|
<head>
|
||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
<meta name="security" content="public" />
|
||
|
<meta name="Robots" content="index,follow" />
|
||
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
<meta name="DC.Type" content="topic" />
|
||
|
<meta name="DC.Title" content="Environment variables on HTTP Server" />
|
||
|
<meta name="abstract" content="This topic provides information about environment variables." />
|
||
|
<meta name="description" content="This topic provides information about environment variables." />
|
||
|
<meta name="DC.Relation" scheme="URI" content="rzaiereference.htm" />
|
||
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
|
||
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
|
||
|
<meta name="DC.Format" content="XHTML" />
|
||
|
<meta name="DC.Identifier" content="rzaieenvvar" />
|
||
|
<meta name="DC.Language" content="en-us" />
|
||
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
<!-- US Government Users Restricted Rights -->
|
||
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
<title>Environment variables on HTTP Server</title>
|
||
|
</head>
|
||
|
<body id="rzaieenvvar"><a name="rzaieenvvar"><!-- --></a>
|
||
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
<h1 class="topictitle1">Environment variables on HTTP Server</h1>
|
||
|
<div><p>This topic provides information about environment variables.</p>
|
||
|
<div class="important"><span class="importanttitle">Important:</span> Information
|
||
|
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
|
||
|
It is recommended that you install the latest PTFs to upgrade to the latest
|
||
|
level of the HTTP Server for i5/OS. Some of the topics documented here are
|
||
|
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
|
||
|
<p>The supported environment variables for HTTP Server are listed here. The
|
||
|
environment variables have been divided into two groups: Non-SSL and SSL.</p>
|
||
|
<p>You can provide secure Web serving when you run HTTP traffic over the SSL
|
||
|
protocol. To use SSL, your server must have a <a href="../rzahu/rzahurzahu4abunderstanddc.htm">digital certificate</a>. This is how a retail
|
||
|
company on the Internet allows users to look through the merchandise without
|
||
|
security. These same users then fill out order forms and send their credit
|
||
|
card numbers by using SSL. A browser that does not support HTTPS cannot request
|
||
|
URLs by using HTTP over SSL. The Non-SSL browsers will not allow the submission
|
||
|
of forms that need secure submission.</p>
|
||
|
<p>Not all environment variables are supported by both HTTP Server types.
|
||
|
Make sure to check that the environment variable is supported by your HTTP
|
||
|
Server type.</p>
|
||
|
<div class="note"><span class="notetitle">Note:</span> All headers sent by the client (such as Set-Cookie) are prefixed by
|
||
|
"HTTP_", and their value can be extracted. To access variables that are headers,
|
||
|
prefix the variable name with "HTTP_". You can also create new variables using
|
||
|
the HTTP_set() predefined function. </div>
|
||
|
|
||
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" width="26.031746031746035%" id="d0e40">Variable Name</th>
|
||
|
<th valign="top" width="11.11111111111111%" id="d0e42">Type</th>
|
||
|
<th valign="top" width="62.857142857142854%" id="d0e44">Description</th>
|
||
|
</tr>
|
||
|
</thead>
|
||
|
<tbody><tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">AUTH_TYPE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>If the server supports client authentication and
|
||
|
the script is a protected script, this environment variable contains the method
|
||
|
that is used to authenticate the client. </p>
|
||
|
<p>Example: Cert_Or_Basic </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">CGI_ASCII_CCSID </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the ASCII CCSID the server used when converting
|
||
|
CGI input data. If the server did not perform any conversion, (for Example,
|
||
|
in %%BINARY%% mode), the server sets this value to the DefaultNetCCSID configuration
|
||
|
directive value. </p>
|
||
|
<p>Example: 819 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">CGI_EBCDIC_CCSID</td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the EBCDIC CCSID under which the current
|
||
|
CGI job is running (DefaultFsCCSID or CGIJobCCSID configuration directive).
|
||
|
It also represents the job CCSID that is used during server conversion (if
|
||
|
any) of CGI input data. </p>
|
||
|
<p>Example: 37 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">CGI_JOB_LOCALE</td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 ">Allows a locale to be set globally or for a specific
|
||
|
CGI job. After the locale is set, country specific information such as date
|
||
|
or time format can be accessed. Some ILE C/C++ run-time functions such as
|
||
|
ctime() and localtime() are locale sensitive. <p>Example: CGIJobLocale /QSYS.LIB/LOCALELIB.LIB/EN_US.LOCALE </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">CGI_MODE</td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL </td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the CGI conversion mode the server is using
|
||
|
for this request. The program can use this information to determine what conversion,
|
||
|
if any, was performed by the server on CGI input data and what format that
|
||
|
data is currently in. </p>
|
||
|
<p>Example: EBCDIC </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">CGI_OUTPUT_MODE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL </td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Determines which output conversion mode the server
|
||
|
is using. </p>
|
||
|
<p>Example: EBCDIC </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">CONTENT_LENGTH </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL </td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>When the method of POST is used to send information,
|
||
|
this variable contains the number of characters. Servers typically do not
|
||
|
send an end-of-file flag when they forward the information by using stdin.
|
||
|
If needed, you can use the CONTENT_LENGTH value to determine the end of the
|
||
|
input string. </p>
|
||
|
<p>Example: 7034</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">CONTENT_TYPE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>When information is sent with the method of POST,
|
||
|
this variable contains the type of data included. You can create your own
|
||
|
content type in the server configuration file and map it to a viewer. </p>
|
||
|
<p>Example:
|
||
|
Application/x-www-form-urlencoded </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">DATE_GMT </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The current date and time in Greenwich Mean Time.
|
||
|
</p>
|
||
|
<p>Example: 2000/12/31:03:15:20 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">DATE_LOCAL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The current date and time in the local time zone.
|
||
|
</p>
|
||
|
<p>Example: 2000/08/14:15:40:10 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">DOCUMENT_NAME </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The file name of the document requested by the user.
|
||
|
</p>
|
||
|
<p>Example: /www/myserver/htdocs/html/hello.html </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">DOCUMENT_PATH_ INFO </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the additional path information as sent
|
||
|
by the Web browser for SSI. </p>
|
||
|
<p>Example: /wizard </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">DOCUMENT_ROOT </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Sets the directory from which the HTTP Server will
|
||
|
serve files. The server appends the path from the requested URL to the document
|
||
|
root and makes the path to the document. </p>
|
||
|
<p>Example: /www/myserver/htdocs
|
||
|
</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">DOCUMENT_URI </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The URI of the document requested by the user. </p>
|
||
|
<p>Example:
|
||
|
/html/hello.html</p>
|
||
|
<div class="note"><span class="notetitle">Note:</span> The DOCUMENT_URI and DOCUMENT_URL environment variables
|
||
|
are identical</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">DOCUMENT_URL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The URL of the document requested by the user. </p>
|
||
|
<p>Example:
|
||
|
/html/hello.html</p>
|
||
|
<div class="note"><span class="notetitle">Note:</span> The DOCUMENT_URI and DOCUMENT_URL environment variables
|
||
|
are identical. </div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">FSCP </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The EBCDIC CCSID used to translate the data. </p>
|
||
|
<p>Example:
|
||
|
37 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">GATEWAY_ INTERFACE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the version of CGI that the server is using.
|
||
|
</p>
|
||
|
<p>Example: CGI/1.1 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTP_ACCEPT_ LANGUAGE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the list of languages the browser accepts.
|
||
|
</p>
|
||
|
<p>Example: de,fr,en</p>
|
||
|
<div class="note"><span class="notetitle">Note:</span> The header lines received from the client,
|
||
|
if any, are placed into the environment variable with the prefix HTTP_* followed
|
||
|
by the header name. The header will return the environment variable. </div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">IBM_CCSID_VALUE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The CCSID under which the current server job is running.
|
||
|
</p>
|
||
|
<p>Example: 37 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">NETCP </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The default ASCII CCSID used to translate the data.
|
||
|
</p>
|
||
|
<p>Example: 819 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">PATH_INFO </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the additional path information as sent
|
||
|
by the web browser. </p>
|
||
|
<p>Example: /wizard </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">PATH_TRANSLATED </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the decoded or translated version of the
|
||
|
path information that is contained in PATH_INFO, which takes the path and
|
||
|
does any virtual-to-physical mapping to it. </p>
|
||
|
<p>Example: /wwwhome/wizard
|
||
|
</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">QIBM_CGI_ LIBRARY_LIST</td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>This variable is used to set the CGI jobs' library
|
||
|
list. The variable can be set using the SetEnv directive. See the <a href="rzaiemod_env.htm#setenv">SetEnv</a> directive
|
||
|
for more information.</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">QUERY_STRING </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>When information is sent using a method of GET, this
|
||
|
variable contains the information in a query that follows the "?". The string
|
||
|
is coded in the standard URL format of changing spaces to "+" and encoding
|
||
|
special characters with "%xx" hexadecimal encoding. The CGI program must decode
|
||
|
this information. </p>
|
||
|
<p>Example: NAME=Eugene+T%2E+Fox=etfox%7Cibm.net=xyz</p>
|
||
|
<div class="note"><span class="notetitle">Note:</span> The
|
||
|
supported maximum size of QUERY_STRING is 8K for HTTP Server (powered by Apache). </div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">QZHBHA_MODEL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Model of the highly available Web server. </p>
|
||
|
<p>Example:
|
||
|
PRIMARYBACKUP </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">QZHBIS_FIRST_REQUEST </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>This environment variable indicates to a CGI program
|
||
|
if this is a subsequent request of some session. The Web server sets this
|
||
|
variable to 1 if this is not a subsequent request of any session (this is
|
||
|
potentially the first request of a new session). The Web server sets this
|
||
|
variable to 0 if this is a subsequent request of some session. </p>
|
||
|
<p>Example:
|
||
|
0 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">QZHBIS_CLUSTER_ENABLED </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>This environment variable indicates to the CGI program
|
||
|
that the CGI program is allowed to be cluster-enabled if the request does
|
||
|
not belong to any existing session (QZHBIS_FIRST_REQUEST is set to 1). This
|
||
|
environment variable indicates to the CGI program that the CGI program is
|
||
|
cluster-enabled (QZHBIS_FIRST_REQUEST set to "0"). When the Web server receives
|
||
|
a first request to a CGI, it decides if the CGI program is allowed to be cluster-enabled.
|
||
|
If the CGI program is allowed to be cluster-enabled, the Web server sets the
|
||
|
QZHBIS_CLUSTER_ENABLED environment variable to 1; otherwise the Web server
|
||
|
does not define the QZHBIS_CLUSTER_ENABLED environment variable. When the
|
||
|
Web server receives a subsequent request to a CGI, it looks to see if the
|
||
|
session is cluster-enabled. If the session is cluster-enabled, the Web server
|
||
|
sets the QZHBIS_CLUSTER_ENABLED environment variable to 1; otherwise the Web
|
||
|
server does not define the QZHBIS_CLUSTER_ENABLED environment variable. </p>
|
||
|
<p>Example:
|
||
|
1 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">QZHBNEXT_SESSION_HANDLE</td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>This environment variable contains a new session
|
||
|
handle for a CGI program to use. If the CGI program is cluster-disabled, it
|
||
|
may ignore this session handle. The Web server generates a session handle
|
||
|
and sets the QZHBNEXT_SESSION_HANDLE environment variable to this value. If
|
||
|
the CGI program decides to be cluster-enabled, it must use the passed session
|
||
|
handle in the URLs of subsequent requests; otherwise, the Web server will
|
||
|
not associate subsequent requests with this session. </p>
|
||
|
<p>Example: 8B739003AB741824899F0004AC009021
|
||
|
</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">QZHBRECOVERY </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 ">Contains whether the highly available Web server has
|
||
|
gone through a recovery (primary to backup or backup to primary). If this
|
||
|
environment variable is present, recovery has occurred. If it is not present,
|
||
|
then recovery has not occurred</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">REDIRECT_QUERY_ STRING </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains QUERY_STRING from a re-directed request.
|
||
|
</p>
|
||
|
<p>Example: NAME=Eugene+T%2E+Fox=etfox%7Cibm.net=xyz</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">REDIRECT_QUERY_ URL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>This environment variable is used in the primary/backup
|
||
|
models only. This environment variable is used to indicate to a cluster-enabled
|
||
|
CGI program that it should perform a recovery operation (for example, restore
|
||
|
its state). The Web server passes a session handle to the CGI program through
|
||
|
the QZHBRECOVERY environment variable. The Web server passes the CGI's state
|
||
|
to the CGI program. If there is no recovery, this environment variable is
|
||
|
undefined. In the primary/backup model, the high availability CGI is also
|
||
|
treated as a persistent CGI. The high availability CGI state information can
|
||
|
also be retained in the CGI job. The next request for the next step in the
|
||
|
CGI is automatically run in the same job. Therefore, the CGI program can skip
|
||
|
reading its state unless this environment variable is defined. </p>
|
||
|
<p>Example:
|
||
|
4D868803AB731824899F0004AC009021</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">REFERER </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the referrer. </p>
|
||
|
<p>Example: http://www.myserver.com/cgi-bin/
|
||
|
</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTP_REFERER</td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the referrer.</p>
|
||
|
<p>Example: http://www.myserver.com/cgi-bin/</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">REFERER_URL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the referrer URL. </p>
|
||
|
<p>Example: http://WWW.MYSERVER.COM:8080/perlSetEnv/
|
||
|
</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">REMOTE_ADDR </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the IP address of the remote host (web browser)
|
||
|
that is making the request, if available. </p>
|
||
|
<p>Example: 10.10.2.3 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">REMOTE_PORT </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the remote user port number. </p>
|
||
|
<p>Example:
|
||
|
3630 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">REMOTE_IDENT </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the user ID of the remote user. </p>
|
||
|
<p>Example:
|
||
|
MyIdentityx </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">REMOTE_USER </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>If you have a protected script and the server supports
|
||
|
client authentication, this environment variable contains the user name that
|
||
|
is passed for authentication. </p>
|
||
|
<p>Example: SMITH </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">REQUEST_METHOD </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the method (as specified with the METHOD
|
||
|
attribute in an HTML form) that is used to send the request. </p>
|
||
|
<p>Example:
|
||
|
GET</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">REQUEST_URI </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Specifies URI to be requested. </p>
|
||
|
<p>Example:
|
||
|
/cgi-bin/hello.pgm </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">RULE_FILE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Specifies rule file to be used. </p>
|
||
|
<p>Example:
|
||
|
/www/myserver/conf/httpd.conf </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SCRIPT_FILENAME </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The file name of the document requested by the user.
|
||
|
</p>
|
||
|
<p>Example: /QSYS.LIB/CGI.LIB/HELLO.PGM</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SCRIPT_NAME </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>A virtual path to the program being run. Use this
|
||
|
for self-referring URLs. </p>
|
||
|
<p>Example: /cgi-bin/hello.pgm </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SERVER_ADDR </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the address of the server. </p>
|
||
|
<p>Example:
|
||
|
10.10.2.3</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SERVER_ADMIN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains information about the server administrator.
|
||
|
</p>
|
||
|
<p>Example: [no address given ] </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SERVER_NAME </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the server host name or IP address of the
|
||
|
server. </p>
|
||
|
<p>Example: 10.9.8.7 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SERVER_PORT </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the port number to which the client request
|
||
|
was sent. </p>
|
||
|
<p>Example: 2001</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SERVER_PROTOCOL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the name and version of the information
|
||
|
protocol that is used to make the request. </p>
|
||
|
<p>Example: HTTP/1.0 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SERVER_SIGNATURE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Allows configuration of a trailing footer line under
|
||
|
server generated documents like error messages, mod_proxy ftp directory listings,
|
||
|
and mod_info output. Enabling the footer line allows the user to tell which
|
||
|
chained servers in a proxy chain produced a returned error message. </p>
|
||
|
<p>Example:
|
||
|
On </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SERVER_SOFTWARE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the name and version of the information
|
||
|
server software that is answering the request. </p>
|
||
|
<p>Example: IBM-HTTP-SERVER/1.0 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSI_DIR </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The path of the current file relative to SSI_ROOT.
|
||
|
If the current file is in SSI_ROOT, this value is "/". </p>
|
||
|
<p>Example: ssi_child_dir/
|
||
|
</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSI_FILE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The file name of the current file. </p>
|
||
|
<p>Example:
|
||
|
ssi_parent.shtml </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSI_INCLUDE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The value that is used in the include command that
|
||
|
retrieved this file. This is not defined for the topmost file. </p>
|
||
|
<p>Example:
|
||
|
ssi_child_dir/ssi_child.shtml</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSI_PARENT </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The path and file name of the include, relative to
|
||
|
SSI_ROOT. </p>
|
||
|
<p>Example: ssi_parent.shtml</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSI_ROOT </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The path of the topmost file. All include requests
|
||
|
must be in this directory or a child of this directory. </p>
|
||
|
<p>Example:
|
||
|
#echo var=SSI_DIR -></p>
|
||
|
<div class="note"><span class="notetitle">Note:</span> You can use echo to display a value set by the
|
||
|
set or global directives.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">UNIQUE_ID </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Provides a unique magic token and acts as the identifier
|
||
|
across all requests under very specific conditions. </p>
|
||
|
<p>Example: aK8YOAkFBZkAABsuEC4AAACB
|
||
|
</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Returns <strong>ON</strong> if the system has completed an
|
||
|
SSL handshake. It returns <strong>OFF</strong> if the exchange of signals to set up
|
||
|
communications between two modems has failed. </p>
|
||
|
<p>Example: OFF</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CIPHER </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>This is the cipher that is used to negotiate with
|
||
|
the client on the SSL handshake. </p>
|
||
|
<p>Example: SSL_RSA_WITH_RC4_128_MD5
|
||
|
</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The entire certificate passed to the server from
|
||
|
the client browser when SSL client authentication is enabled. The format of
|
||
|
the certificate is a BASE64 encoded string that represents the DER format
|
||
|
of the X.509 certificate. As an environment variable the BASE64 encoded string
|
||
|
has been converted to EBCDIC and must be converted back to ASCII before it
|
||
|
can be used for typical digital certificate API's. </p>
|
||
|
<p>Example: MIIC0DCCAbigAwIBAgIHOL2Yx...</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_COMMON _NAME </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The common name from the client certificate's distinguished
|
||
|
name. </p>
|
||
|
<p>Example: SMITH </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_COUNTRY </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The country code from the client certificate's distinguished
|
||
|
name. </p>
|
||
|
<p>Example: US </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_DN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The client certificate's distinguished name. </p>
|
||
|
<p>Example:
|
||
|
:cn=CAPTAIN,ou=downtown,o=fire fighters,l=Minot,st=North Dakota,c=US</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_EMAIL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The email of the client owning the certificate.
|
||
|
</p>
|
||
|
<p>Example: me@mycompany.com</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ISSUER_ COMMON_NAME </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The common came of the certificate authority that
|
||
|
issued the client's certificate. </p>
|
||
|
<p>Example: SMITH </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ISSUER_ COUNTRY </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The country code of the certificate authority that
|
||
|
issued the client's certificate. </p>
|
||
|
<p>Example: US </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ISSUER_DN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The distinguished name of the certificate authority
|
||
|
that issued the client's certificate. </p>
|
||
|
<p>Example: :cn=testsystem.ibm.com
|
||
|
CA,ou=Test Organization Unit,o=System test, l=Rochester,st=Minnesota,c=US </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ISSUER_EMAIL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The e-mail address of the certificate authority that
|
||
|
issued the client's certificate. </p>
|
||
|
<p>Example: me@mydomain.net </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ISSUER_ LOCALITY </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The locality or city of the certificate authority
|
||
|
that issued the client's certificate. </p>
|
||
|
<p>Example: New York </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ISSUER_ORG_ UNIT </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The organizational unit of the certificate authority
|
||
|
that issued the client's certificate. </p>
|
||
|
<p>Example: bird watchers </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ISSUER_ ORGANIZATION </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The organization name of the certificate authority
|
||
|
that issued the client's certificate. </p>
|
||
|
<p>Example: dove </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ISSUER_ POSTAL_CODE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The postal code of the certificate authority that
|
||
|
issued the client's certificate. </p>
|
||
|
<p>Example: 12344-6789</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ISSUER_STATE_ OR_PROVINCE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The state or province of the certificate authority
|
||
|
that issued the client's certificate. </p>
|
||
|
<p>Example: North Dakota </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_LEN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The length of the certificate passed in HTTPS_CLIENT_CERT.
|
||
|
</p>
|
||
|
<p>Example: 968 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_LOCALITY </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The locality or city of the client certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: New York </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ORG_UNIT </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The organization unit name from the client certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: Pack234</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_ ORGANIZATION </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The organization name from the client certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: Scouts </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_POSTAL_CODE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The postal code assigned by the issueing certificate
|
||
|
authority. </p>
|
||
|
<p>Example: 80525</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_SERIAL_NUM </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The serial number assigned by the issuing certificate
|
||
|
authority. </p>
|
||
|
<p>Example: 3F:E4:83:81:02:D5:58 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ CERT_STATE_OR_ PROVINCE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The state or province from the client certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: Alberta</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_CLIENT_ ISSUER_EMAIL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>Contains the email address of the Certificate Authority
|
||
|
that issued the certificate. </p>
|
||
|
<p>Example: jones@mydomain.net</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_KEYSIZE </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>If a valid security product is installed and the
|
||
|
SSLMode directive is SSLMode=ON, this will be set to the size of the bulk
|
||
|
encryption key used in the SSL session. </p>
|
||
|
<p>Example: [ 128 ] </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_SESSION_ID </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 ">Set to NULL by default when used with HTTP Server (powered
|
||
|
by Apache).</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTPS_SESSION_ ID_NEW </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>If the value is <strong>TRUE</strong>, it indicates that a
|
||
|
full handshake was performed for this SSL session. If the value is <strong>FALSE</strong>,
|
||
|
it indicates that an abbreviated handshake was performed for this SSL session.
|
||
|
</p>
|
||
|
<p>Example: True </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CIPHER </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>This is the cipher that is used to negotiate with
|
||
|
the client on the SSL handshake. </p>
|
||
|
<p>Example: SSL_RSA_WITH_RC4_128_MD5 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_C </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The country code from the client certificate's distinguished
|
||
|
name. </p>
|
||
|
<p>Example: USA </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_ CERTBODY </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The entire certificate passed to the server from
|
||
|
the client browser when SSL Client authentication is enabled. The format of
|
||
|
the certificate is a BASE64 encoded string that represents the DER format
|
||
|
of the X.509 certificate. As an environment variable the BASE64 encoded string
|
||
|
has been converted to EBCDIC and must be converted back to ASCII before it
|
||
|
can be used for typical digital certificate API's. </p>
|
||
|
<p>Example: MIIC0DCC
|
||
|
big IB gIHOL2Yx... </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_ CERTBODYLEN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The length of the certificate passed in SSL_CLIENT_CERT.
|
||
|
</p>
|
||
|
<p>Example: 828 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_ CERT_EMAIL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The email of the client owning the certificate.
|
||
|
</p>
|
||
|
<p>Example: me@mycompany.com </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_CN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The common name from the client certificate's distinguished
|
||
|
name. </p>
|
||
|
<p>Example: SMITH </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_DN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The client's distinguished name. </p>
|
||
|
<p>Example:
|
||
|
:cn=CAPTAIN,ou=downtown,o=fire fighters,l=Minot,st=North Dakota,c=US HTTPS_CLIENT_CERT_DN
|
||
|
:cn=CAPTAIN,ou=downtown,o=fire fighters,l=Minot,st=North Dakota,c=US </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_ICN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The common name of the certificate authority that
|
||
|
issued the client's certificate. </p>
|
||
|
<p>Example: SMITH</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_IC </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The country code of the certificate authority that
|
||
|
issued the client's certificate. </p>
|
||
|
<p>Example: CA </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_IDN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The distinguished name of the certificate authority
|
||
|
that issued the client's certificate. </p>
|
||
|
<p>Example: :cn=testsystem.ibm.com
|
||
|
CA,ou=Test Organization Unit,o=System test, l=Rochester,st=Minnesota,c=US
|
||
|
</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_EMAIL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The e-mail of the certificate authority that issued
|
||
|
the client's certificate. </p>
|
||
|
<p>Example: me@mycompany.com </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_IL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The locality of the certificate authority that issued
|
||
|
the client's certificate. </p>
|
||
|
<p>Example: New York </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_IO </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The organization name of the certificate authority
|
||
|
that issued the client's certificate. </p>
|
||
|
<p>Example: bird watchers </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_IOU </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The organizational unit of the certificate authority
|
||
|
that issued the client's certificate. </p>
|
||
|
<p>Example: bird watchers</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_IPC </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The postal code of the certificate authority that
|
||
|
issued the client's certificate. </p>
|
||
|
<p>Example: 55901 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_IST </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The state or province of the certificate authority
|
||
|
that issued the client's certificate. </p>
|
||
|
<p>Example: MNA </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_L </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The locality or city of the client certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: New York</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_ NEWSESSIONID </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>If the value is <strong>TRUE</strong>, it indicates that a
|
||
|
full handshake was performed for this SSL session. If the value is <strong>FALSE</strong>,
|
||
|
it indicates that an abbreviated handshake was performed for this SSL session.
|
||
|
</p>
|
||
|
<p>Example: True</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_O </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The organization name from the client certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: bird watchers </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_OU </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The organizational unit name from the client certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: bird watchers </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_PC </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The postal code from the client certificate's distinguished
|
||
|
name. </p>
|
||
|
<p>Example: 58401 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_ SERIALNUM </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The serial number assigned by the issuing certificate
|
||
|
authority. </p>
|
||
|
<p>Example: 3F:E4:83:81:02:D5:58 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_ SESSIONID </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>If the value is <strong>TRUE</strong>, it indicates that a
|
||
|
full handshake was performed for this SSL session. If the value is <strong>FALSE</strong>,
|
||
|
it indicates that an abbreviated handshake was performed for this SSL session.
|
||
|
</p>
|
||
|
<p>Example: True </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_CLIENT_ST </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The state or province from the client certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: North Dakota </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_PROTOCOL_ VERSION </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The SSL protocol version negotiated on the SSL handshake
|
||
|
with the client. </p>
|
||
|
<p>Example: SSLV3 </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_SERVER_C </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The country where the server is located in. </p>
|
||
|
<p>Example:
|
||
|
Denmark </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_SERVER_CN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The common name from the server certificate's distinguished
|
||
|
name. </p>
|
||
|
<p>Example: WWW.MYDOMAIN.COM</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_SERVER_DN </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The server's distinguished name. </p>
|
||
|
<p>Example:
|
||
|
:cn=TESTSYSTEM.IBM.COM,ou=MyTestOrganizationUnit, o=Software test, l=Rochester,st=Minnesota,c=US
|
||
|
</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_SERVER_EMAIL </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The e-mail address of the server certificate. </p>
|
||
|
<p>Example:
|
||
|
me@mydomain.net </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_SERVER_L </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The locality of the server certificate's distinguished
|
||
|
name. </p>
|
||
|
<p>Example: New York</p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_SERVER_OU </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The organization unit name from the server certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: bird watchers </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_SERVER_O </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The organization name from the server certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: bird watchers </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">SSL_SERVER_ST </td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 "><p>The state or province from the server certificate's
|
||
|
distinguished name. </p>
|
||
|
<p>Example: North Dakota </p>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr><td valign="top" width="26.031746031746035%" headers="d0e40 ">HTTP_AS_ AUTH_PROFILETKN</td>
|
||
|
<td valign="top" width="11.11111111111111%" headers="d0e42 ">SSL and Non-SSL</td>
|
||
|
<td valign="top" width="62.857142857142854%" headers="d0e44 ">A 32-bit value used to identify or authenticate the
|
||
|
user. See the <a href="rzaiemod_core.htm#profiletoken">ProfileToken</a> directive for more information.</td>
|
||
|
</tr>
|
||
|
</tbody>
|
||
|
</table>
|
||
|
</div>
|
||
|
</div>
|
||
|
<div>
|
||
|
<div class="familylinks">
|
||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiereference.htm" title="This topic provides additional reference documentation for HTTP Server and the IBM Web Administration for i5/OS interface.">Reference documentation for HTTP Server</a></div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</body>
|
||
|
</html>
|