Add pquerna's mod_allowmethod plus igalic's docs from the sandbox (r1001151)

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1023229 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/docs/manual/mod/mod_allowmethods.xml b/docs/manual/mod/mod_allowmethods.xml
new file mode 100644 (file)
index 0000000..9314bcb
--- /dev/null
+++ b/docs/manual/mod/mod_allowmethods.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0"?> 
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?> 
+<!-- $LastChangedRevision$ -->
+
+<!--
+Upon adding a new module XML doc, you will need to:
+
+svn ps svn:eol-style native <alltextfiles>
+svn ps svn:keywords LastChangedRevision mod_allowmethods.xml
+
+in order for it to rebuild correctly.
+
+-->
+                                                                                                                                  
+<!--                                                                                                                              
+ Licensed to the Apache Software Foundation (ASF) under one or more 
+ contributor license agreements.  See the NOTICE file distributed with 
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0 
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<modulesynopsis metafile="mod_allowmethods.xml.meta"> 
+<name>mod_allowmethods</name>
+<description>Easily restrict what HTTP methods can be used on the server</description>
+<status>experimental</status>
+<sourcefile>mod_allowmethods.c</sourcefile>
+<identifier>allowmethods_module</identifier>
+
+
+<summary>
+<p>This modules makes it easy to restrict what HTTP methods can
+used on an server. The most common configuration would be:</p>
+
+<example><title>Example</title>
+&lt;Directory /&gt;<br />
+<indent>
+   AllowMethods GET HEAD OPTIONS<br />
+</indent>
+&lt;/Directory&gt;
+</example>
+
+</summary>
+
+<directivesynopsis>
+<name>AllowMethods</name>
+<description>Changes absolutely nothing</description>
+<syntax>AllowMethods reset|<em>HTTP-method</em> 
+[<em>HTTP-method</em>]...</syntax>
+<default>AllowMethods reset</default>
+<contextlist><context>directory</context></contextlist>
+<status>Experimental</status>
+
+<usage>
+
+<p>The HTTP-methods are case sensitive, and are generally as per
+RFC given in upper case. The <code>reset</code> keyword can be used
+turn off <module>mod_allowmethods</module> in a deeper nested context:</p>
+
+<example><title>Example</title>
+&lt;Location /svn&gt;<br />
+<indent>
+   AllowMethods reset<br />
+</indent>
+&lt;/Location&gt;
+</example>
+
+<p><module>mod_allowmethods</module> was written to replace the rather
+kludgy implementation of <directive module="core">Limit</directive> and
+<directive module="core">LimitExcept</directive>.</p>
+</usage>
+</directivesynopsis>
+
+</modulesynopsis>
+

diff --git a/modules/aaa/mod_allowmethods.c b/modules/aaa/mod_allowmethods.c
new file mode 100644 (file)
index 0000000..424c7c4
--- /dev/null
+++ b/modules/aaa/mod_allowmethods.c
@@ -0,0 +1,140 @@
+/* Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "httpd.h"
+#include "http_core.h"
+#include "http_config.h"
+#include "http_protocol.h"
+#include "http_request.h"
+#include "http_log.h"
+#include "apr_strings.h"
+
+/**
+ * This module makes it easy to restrict what HTTP methods can be ran against
+ * a server.
+ *
+ * It provides one comand:
+ *    AllowMethods
+ * This command takes a list of HTTP methods to allow.
+ *
+ *  The most common configuration should be like this:
+ *   <Directory />
+ *    AllowMethods GET HEAD OPTIONS
+ *   </Directory>
+ *   <Directory /special/cgi-bin>
+ *      AllowMethods GET HEAD OPTIONS POST
+ *   </Directory>
+ *  Non-matching methods will be returned a status 405 (method not allowed)
+ *  
+ *  To allow all methods, and effectively turn off mod_allowmethods, use:
+ *    AllowMethods reset
+ */
+
+typedef struct am_conf_t {
+  int allowed;
+} am_conf_t;
+
+module AP_MODULE_DECLARE_DATA allowmethods_module;
+
+static int am_check_access(request_rec *r)
+{
+  int method = r->method_number;
+  am_conf_t *conf;
+  
+  conf = (am_conf_t *) ap_get_module_config(r->per_dir_config,
+                                            &allowmethods_module);
+  if (!conf || conf->allowed == 0) {
+    return DECLINED;
+  }
+  
+  r->allowed = conf->allowed;
+
+  if (conf->allowed & (AP_METHOD_BIT << method)) {
+    return DECLINED;
+  }
+  
+  ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
+                  "client method denied by server configuration: '%s' to %s%s",
+                  r->method,
+                  r->filename ? "" : "uri ",
+                  r->filename ? r->filename : r->uri);
+  
+  return HTTP_METHOD_NOT_ALLOWED;
+}
+
+static void *am_create_conf(apr_pool_t * p, char *dummy)
+{
+  am_conf_t *conf = apr_pcalloc(p, sizeof(am_conf_t));
+  
+  conf->allowed = 0;
+  return conf;
+}
+
+static void* am_merge_conf(apr_pool_t* pool, void* a, void* b) {
+  am_conf_t* base = (am_conf_t*) a;
+  am_conf_t* add = (am_conf_t*) b;
+  am_conf_t* conf = apr_palloc(pool, sizeof(am_conf_t));
+  
+  conf->allowed = add->allowed ? add->allowed : base->allowed;
+
+  return conf;
+}
+
+static const char *am_allowmethods(cmd_parms *cmd, void *d, int argc, char *const argv[])
+{
+  int i;
+  am_conf_t* conf = (am_conf_t*) d;
+  if (argc == 1) {
+    if (strcasecmp("reset", argv[0]) == 0) {
+      conf->allowed = 0;
+      return NULL;
+    }
+  }
+
+  for (i = 0; i < argc; i++) {
+    int m = 0;
+    m = ap_method_number_of(argv[i]);
+    if (m == M_INVALID) {
+      return apr_pstrcat(cmd->pool, "AllowMethods: Invalid Method '", argv[i], "'", NULL);
+    }
+
+    conf->allowed |= (AP_METHOD_BIT << m);
+  }
+  return NULL;
+}
+
+static void am_register_hooks(apr_pool_t * p)
+{
+  ap_hook_access_checker(am_check_access, NULL, NULL, APR_HOOK_REALLY_FIRST);
+}
+
+static const command_rec am_cmds[] = {
+  AP_INIT_TAKE_ARGV("AllowMethods", am_allowmethods, NULL,
+              ACCESS_CONF,
+              "only allow specific methods"),
+  {NULL}
+};
+
+module AP_MODULE_DECLARE_DATA allowmethods_module = {
+  STANDARD20_MODULE_STUFF,
+  am_create_conf,
+  am_merge_conf,
+  NULL,
+  NULL,
+  am_cmds,
+  am_register_hooks,
+};
+