Apache HTTP Server Version 2.2
Apache HTTP Server Version 2.2
This document refers to the 2.2 version of Apache httpd, which is no longer maintained. The active release is documented here. If you have not already upgraded, please follow this link for more information.
You may follow this link to go to the current version of this document.
| Description: | Customization of HTTP request and response headers |
|---|---|
| Status: | Extension |
| Module Identifier: | headers_module |
| Source File: | mod_headers.c |
This module provides directives to control and modify HTTP request and response headers. Headers can be merged, replaced or removed.
The directives provided by mod_headers can
occur almost anywhere within the server configuration, and can be
limited in scope by enclosing them in configuration sections.
Order of processing is important and is affected both by the order in the configuration file and by placement in configuration sections. These two directives have a different effect if reversed:
RequestHeader append MirrorID "mirror 12"
RequestHeader unset MirrorID
This way round, the MirrorID header is not set. If
reversed, the MirrorID header is set to "mirror 12".
mod_headers can be applied either early or late
in the request. The normal mode is late, when Request Headers are
set immediately before running the content generator and Response
Headers just as the response is sent down the wire. Always use
Late mode in an operational server.
Early mode is designed as a test/debugging aid for developers.
Directives defined using the early keyword are set
right at the beginning of processing the request. This means
they can be used to simulate different requests and set up test
cases, but it also means that headers may be changed at any time
by other modules before generating a Response.
Because early directives are processed before the request path's
configuration is traversed, early headers can only be set in a
main server or virtual host context. Early directives cannot depend
on a request path, so they will fail in contexts such as
<Directory> or <Location>.
Header echo ^TS
MyHeader, to the response including a
timestamp for when the request was received and how long it
took to begin serving the request. This header can be used by
the client to intuit load on the server or in isolating
bottlenecks between the client and the server.
Header set MyHeader "%D %t"
results in this header being added to the response:
MyHeader: D=3775428 t=991424704447256
Header set MyHeader "Hello Joe. It took %D microseconds \
for Apache to serve this request."
results in this header being added to the response:
MyHeader: Hello Joe. It took D=3775428 microseconds for Apache
to serve this request.
MyHeader on the response if and
only if header MyRequestHeader is present on the request.
This is useful for constructing headers in response to some client
stimulus. Note that this example requires the services of the
mod_setenvif module.
SetEnvIf MyRequestHeader myvalue HAVE_MyRequestHeader
Header set MyHeader "%D %t mytext" env=HAVE_MyRequestHeader
If the header MyRequestHeader: myvalue is present on
the HTTP request, the response will contain the following header:
MyHeader: D=3775428 t=991424704447256 mytext
RequestHeader edit Destination ^https: http: early
CGI, NO_CACHE and
NO_STORE environment variables all existed for the
request):
Header merge Cache-Control no-cache env=CGI
Header merge Cache-Control no-cache env=NO_CACHE
Header merge Cache-Control no-store env=NO_STORE
then the response would contain the following header:
Cache-Control: no-cache, no-store
If append was used instead of merge,
then the response would contain the following header:
Cache-Control: no-cache, no-cache, no-store
| Description: | Configure HTTP response headers |
|---|---|
| Syntax: | Header [condition] set|append|merge|add|unset|echo|edit
header [value] [replacement]
[early|env=[!]variable] |
| Context: | server config, virtual host, directory, .htaccess |
| Override: | FileInfo |
| Status: | Extension |
| Module: | mod_headers |
| Compatibility: | The merge argument is available in version
2.2.9 and later. The edit argument is available in version
2.2.4 and later. |
This directive can replace, merge or remove HTTP response headers. The header is modified just after the content handler and output filters are run, allowing outgoing headers to be modified.
The optional condition argument determines which internal
table of responses headers this directive will operate against. Other
components of the server may have stored their response headers in either
the table that corresponds to onsuccess or the table that
corresponds to always. "Always" in this context refers to
whether headers you add will be sent during both a successful and unsucessful
response, but if your action is a function of an existing header, you
will have to read on for further complications.
The default value of onsuccess may need to be changed to
always under the circumstances similar to those listed below.
Note also that repeating this directive with both conditions makes sense in
some scenarios because always is not a superset of
onsuccess with respect to existing headers:
always is used in the ultimate response.
always and not in the default table.
onsuccess condition.
The action it performs is determined by the first argument (second argument if a condition is specified). This can be one of the following values:
setappendmergeaddset,
append or merge should be used instead.
unsetechoeditThis argument is followed by a header name, which
can include the final colon, but it is not required. Case is
ignored for set, append, merge,
add, unset and edit.
The header name for echo
is case sensitive and may be a regular
expression.
For set, append, merge and
add a value is specified as the next argument.
If value
contains spaces, it should be surrounded by double quotes.
value may be a character string, a string containing format
specifiers or a combination of both. The following format specifiers
are supported in value:
| Format | Description |
|---|---|
%% |
The percent sign |
%t |
The time the request was received in Universal Coordinated Time
since the epoch (Jan. 1, 1970) measured in microseconds. The value
is preceded by t=. |
%D |
The time from when the request was received to the time the
headers are sent on the wire. This is a measure of the duration
of the request. The value is preceded by D=.
The value is measured in microseconds. |
%{FOOBAR}e |
The contents of the environment
variable FOOBAR. |
%{FOOBAR}s |
The contents of the SSL environment
variable FOOBAR, if mod_ssl is enabled. |
The %s format specifier is only available in
Apache 2.1 and later; it can be used instead of %e
to avoid the overhead of enabling SSLOptions
+StdEnvVars. If SSLOptions +StdEnvVars must
be enabled anyway for some other reason, %e will be
more efficient than %s.
For edit there is both a value argument
which is a regular expression,
and an additional replacement string.
The Header directive may be followed by an
an additional argument, which may be used to specify conditions under
which the action will be taken, or may be the keyword early
to specify early processing. If the
environment variable specified in the
env=... argument exists (or if the environment
variable does not exist and env=!... is specified)
then the action specified by the Header directive
will take effect. Otherwise, the directive will have no effect
on the request.
Except in early mode, the
Header directives are processed just
before the response is sent to the network. This means that it is
possible to set and/or override most headers, except for some headers
added by the HTTP header filter. Prior to 2.2.12, it was not possible
to change the Content-Type header with this directive.
| Description: | Configure HTTP request headers |
|---|---|
| Syntax: | RequestHeader set|append|merge|add|unset|edit header
[value] [replacement] [early|env=[!]variable] |
| Context: | server config, virtual host, directory, .htaccess |
| Override: | FileInfo |
| Status: | Extension |
| Module: | mod_headers |
| Compatibility: | The merge argument is available in version
2.2.9 and later. The edit argument is available in version
2.2.4 and later. |
This directive can replace, merge, change or remove HTTP request headers. The header is modified just before the content handler is run, allowing incoming headers to be modified. The action it performs is determined by the first argument. This can be one of the following values:
setappendmergeaddset,
append or merge should be used instead.
unseteditThis argument is followed by a header name, which can
include the final colon, but it is not required. Case is
ignored. For set, append, merge and
add a value is given as the third argument. If a
value contains spaces, it should be surrounded by double
quotes. For unset, no value should be given.
value may be a character string, a string containing format
specifiers or a combination of both. The supported format specifiers
are the same as for the Header,
please have a look there for details. For edit both
a value and a replacement are required, and are
a regular expression and a
replacement string respectively.
The RequestHeader directive may be followed by
an additional argument, which may be used to specify conditions under
which the action will be taken, or may be the keyword early
to specify early processing. If the
environment
variable specified in the env=... argument
exists (or if the environment variable does not exist and
env=!... is specified) then the action specified
by the RequestHeader directive will take effect.
Otherwise, the directive will have no effect on the request.
Except in early mode, the
RequestHeader directive is processed
just before the request is run by its handler in the fixup phase.
This should allow headers generated by the browser, or by Apache
input filters to be overridden or modified.