mod_headers.c revision ca53a74f4012a45cbad48e940eddf27d866981f9
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering/* ====================================================================
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * The Apache Software License, Version 1.1
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Copyright (c) 2000 The Apache Software Foundation. All rights
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Redistribution and use in source and binary forms, with or without
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * modification, are permitted provided that the following conditions
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * 1. Redistributions of source code must retain the above copyright
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * notice, this list of conditions and the following disclaimer.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * 2. Redistributions in binary form must reproduce the above copyright
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * notice, this list of conditions and the following disclaimer in
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * the documentation and/or other materials provided with the
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * distribution.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * 3. The end-user documentation included with the redistribution,
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * if any, must include the following acknowledgment:
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * "This product includes software developed by the
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Apache Software Foundation (http://www.apache.org/)."
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Alternately, this acknowledgment may appear in the software itself,
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * if and wherever such third-party acknowledgments normally appear.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * 4. The names "Apache" and "Apache Software Foundation" must
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * not be used to endorse or promote products derived from this
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * software without prior written permission. For written
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * permission, please contact apache@apache.org.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * 5. Products derived from this software may not be called "Apache",
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * nor may "Apache" appear in their name, without prior written
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * permission of the Apache Software Foundation.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * SUCH DAMAGE.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * ====================================================================
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * This software consists of voluntary contributions made by many
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * individuals on behalf of the Apache Software Foundation. For more
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * information on the Apache Software Foundation, please see
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Portions of this software are based upon public domain software
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * originally written at the National Center for Supercomputing Applications,
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * University of Illinois, Urbana-Champaign.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * mod_headers.c: Add/append/remove HTTP response headers
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Written by Paul Sutton, paul@ukweb.com, 1 Oct 1996
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * New directive, Header, can be used to add/replace/remove HTTP headers.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Valid in both per-server and per-dir configurations.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Header action header value
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Where action is one of:
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * set - set this header, replacing any old value
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * add - add this header, possible resulting in two or more
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * headers with the same name
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * append - append this text onto any existing header of this same
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * unset - remove this header
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Where action is unset, the third argument (value) should not be given.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * The header name can include the colon, or not.
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * The Header directive can only be used where allowed by the FileInfo
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * When the request is processed, the header directives are processed in
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * this order: firstly, the main server, then the virtual server handling
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * this request (if any), then any <Directory> sections (working downwards
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * from the root dir), then an <Location> sections (working down from
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * shortest URL component), the any <File> sections. This order is
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * important if any 'set' or 'unset' actions are used. For example,
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * the following two directives have different effect if applied in
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * the reverse order:
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Header append Author "John P. Doe"
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Header unset Author
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * To set the "Author" header, use
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Header add Author "John P. Doe"
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * To remove a header:
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * Header unset Author
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering hdr_add = 'a', /* add header (could mean multiple hdrs) */
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering hdr_set = 's', /* set (replace old value) */
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering hdr_append = 'm', /* append (merge into any old value) */
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poetteringtypedef struct {
df3fb561b2df486a495a5f0bcc83168bd1860533Lennart Poettering * headers_conf is our per-module configuration. This is used as both
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering * a per-dir and per-server config
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poetteringtypedef struct {
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poetteringmodule AP_MODULE_DECLARE_DATA headers_module;
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poetteringstatic void *create_headers_config(apr_pool_t *p, server_rec *s)
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering (headers_conf *) apr_pcalloc(p, sizeof(headers_conf));
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering a->headers = apr_make_array(p, 2, sizeof(header_entry));
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poetteringstatic void *create_headers_dir_config(apr_pool_t *p, char *d)
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering return (headers_conf *) create_headers_config(p, NULL);
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poetteringstatic void *merge_headers_config(apr_pool_t *p, void *basev, void *overridesv)
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering (headers_conf *) apr_pcalloc(p, sizeof(headers_conf));
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering headers_conf *base = (headers_conf *) basev, *overrides = (headers_conf *) overridesv;
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering a->headers = apr_append_arrays(p, base->headers, overrides->headers);
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poetteringstatic const char *header_cmd(cmd_parms *cmd, void *indirconf,
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering const char *action, const char *inhdr, const char *value)
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering char *hdr = apr_pstrdup(cmd->pool, inhdr);
df3fb561b2df486a495a5f0bcc83168bd1860533Lennart Poettering (headers_conf *) ap_get_module_config(s->module_config, &headers_module);
df3fb561b2df486a495a5f0bcc83168bd1860533Lennart Poettering new = (header_entry *) apr_push_array(dirconf->headers);
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering new = (header_entry *) apr_push_array(serverconf->headers);
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering return "first argument must be add, set, append or unset.";
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering return "Header unset takes two arguments";
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering return "Header requires three arguments";
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering AP_INIT_TAKE23("Header", header_cmd, NULL, OR_FILEINFO,
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering "an action, header and value"),
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poetteringstatic void do_headers_fixup(request_rec *r, apr_array_header_t *headers)
ee8c45689526ca973407cbb77bce7b96a062c40bLennart Poettering header_entry *hdr = &((header_entry *) (headers->elts))[i];
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering apr_table_addn(r->headers_out, hdr->header, hdr->value);
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering apr_table_mergen(r->headers_out, hdr->header, hdr->value);
df3fb561b2df486a495a5f0bcc83168bd1860533Lennart Poettering apr_table_setn(r->headers_out, hdr->header, hdr->value);
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering apr_table_unset(r->headers_out, hdr->header);
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering (headers_conf *) ap_get_module_config(sconf, &headers_module);
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering (headers_conf *) ap_get_module_config(dconf, &headers_module);
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering do_headers_fixup(r, serverconf->headers);
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poetteringstatic void register_hooks(void)
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering ap_hook_fixups(fixup_headers,NULL,NULL,AP_HOOK_MIDDLE);
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poetteringmodule AP_MODULE_DECLARE_DATA headers_module =
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering create_headers_dir_config, /* dir config creater */
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering merge_headers_config, /* dir merger --- default is to override */
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering create_headers_config, /* server config */
9085f64a6694f2928c79fcce365edb1dca6937d4Lennart Poettering merge_headers_config, /* merge server configs */