CSP Gateway Configuration Guide - InterSystems Documentation

CGI Environment Variables
The client principal name (or client username) is that of the Gateway host. This is the name used to identify the key in the
Kerberos Key Table. Assign this principal the necessary privileges in the Caché server to allow the Gateway’s service to
operate.
2.3 CGI Environment Variables
CGI Environment Variables are derived both from the client’s HTTP request headers and from the environment in which
the Web server is operating. The CSP Gateway transmits the common environment variables to Caché with each and every
request. If extra environment variables are required by the application, they must be explicitly requested in the CSP Gateway
configuration (via the Extra CGI Environment Variables setting in the Application Access section of the configuration)
[Home] > [Configuration] > [CSP Gateway Managment] and select Application Access
The list of environment variables transmitted is shown in the table below together with a brief description of each. Further
documentation can be obtained from standard Web text books. See also the section “CgiEnvs Property and CGI Environment
Variables” in Using Caché Server Pages.
Environment Variable
AUTH_PASSWORD
AUTH_TYPE
CONTENT_TYPE
GATEWAY_INTERFACE
HTTP_ACCEPT
HTTP_ACCEPT_CHARSET
HTTP_ACCEPT_LANGUAGE
HTTP_AUTHORIZATION
HTTP_COOKIE
HTTP_REFERER
Value
Value entered in the client’s authentication dialog. This variable is
available only if Basic authentication is used.
Contains the authentication method that the server uses to validate
users when they attempt to access a protected script.
For requests which have attached information, such as HTTP POST
and PUT, this is the content type of the data.
Revision of the CGI specification to which this server complies.
Format: CGI/revision
Value of the Accept request header that contains a list of accepted
formats (MIME types). For example: image/gif, image/x-xbitmap,
image/jpeg, image/pjpeg, application/vnd.ms-excel. The values of
the fields for the HTTP_ACCEPT variable are concatenated, and
separated by a comma (,).
Comma-delimited list of the character encodings that the client
accepts.
Contains a string describing the language to use for displaying
content (such as en-us).
Contains the Base-64 encoded username, password, scheme and
realm sent by the client.
Holds the contents of the client’s cookie(s).
Holds a string that contains the URL of the page that referred the
request to the current page using an HTML tag. Note that the
URL is the one that the user typed into the browser address bar,
which may not include the name of a default document. If the page
is redirected, HTTP_REFERER is empty.
CSP Gateway Configuration Guide 31