Skip to main content
OCLC Support

HTTPHeader

HTTPHeader allows EZproxy administrators to configure EZproxy to pass through custom HTTP headers created by browser applications to pass information to EZproxy. Without the HTTPHeader directive, EZproxy will ignore these custom headers, and allow only those headers it has been explicitly configured to handle.

HTTPHeader works to specify additional HTTP headers for EZproxy to allow to pass through, but this directive can now be configured to allow arbitrary processing of both the headers sent from the user to the content provider and from the content provider back to the user. This directive only applies when proxying content and not when the user is interacting with internal EZproxy services such as the login page or administration pages.

Syntax
The HTTPHeader directive takes the following form:
HTTPHeader [-global] [-ignoreGlobal] -direction -method header [expression]

Any entries using the standard form of HTTPHeader wildheader from before V6.1 will be read as:

HTTPHeader -request -global CustomHeader
Qualifiers
The following qualifiers can be used with the HTTPHeader directive to customize how EZproxy processes headers.
Qualifier Description
-global Apply this directive to all database stanzas except those that contain HTTPHeader -ignoreGlobal.
-ignoreGlobal Within the current database stanza, ignore all HTTPHeader -global directives defined in config.txt. The HTTPHeader directive with this qualifier must be placed AFTER the Title directive to apply to this stanza.
-direction: Use these options to designate how EZproxy should process the header.
-request Designates the header is in the request from the user's browser to the content provider.
-response Designates the header is in the response from the content provider to the user's browser.
-method: Use these options to designate how EZproxy should process the header
-process Process the header by allowing EZproxy to perform standard processing on the header's value or allow a header that EZproxy would normally block to pass through.
-block Block the header in its value
-rewrite Treat the value of the header as a URL and rewrite it into EZproxy form (this is typically used with -response).
-unrewrite Treat the value of the header as a URL that is rewritten in EZproxy form that needs to be unrewritten into its original form (typically used with -request).
-edit Provide the header as hh:header and its value as hh:value to the user-specified expression; if the returned value is non-empty, send the header with that value; if the returned value is empty, suppress the header.
-inject Provide the header as hh:header to the user-specified expression; if the returned value is non-empty, send the header with that value; if the returned value is empty, suppress the header.
header HTTP header to be affected.
expression Required by -edit and -inject.
Example
The HTTPHeader allows you to apply the HTTPHeader directive selectively to database stanzas. For example, the header specified in the following stanza will only be applied to this single resource since it is placed after the Title directive and does not contain the -global qualifier:
Title First Database
HTTPHeader -request CustomHeader
URL http://www.firstdb.com
HJ firstdb.com
DJ firstdb.com

The following configuration will apply the first HTTPHeader directive to the first and third database stanzas as well as any others in config.txt,but not the middle stanza because it includes the HTTPHeader -ignoreGlobal directive after the Title directive. Using the -ignoreGlobal qualifier with this directive will cause this stanza to ignore all global HTTPHeader directives that are located anywhere in config.txt.

HTTPHeader -global SpecialHeader

Title Science Database
URL http://www.sciencedb.com
DJ sciencedb.com

Title History Database
HTTPHeader -ignoreGlobal SpecialHeader
URL http://www.historydb.com
DJ historydb.com

Title Literature Database
URL http://www.litdb.com
DJ litdb.com
Related directives
  • Was this article helpful?