mirror of
https://github.com/owasp-modsecurity/ModSecurity.git
synced 2025-09-30 03:34:29 +03:00
Moved api examples to "ext" dir and hooked them into autotools for building with "--enable-extentions".
Upgraded to autoconf 2.65.
This commit is contained in:
@@ -140,6 +140,8 @@ BUILD_DOCS_FALSE = @BUILD_DOCS_FALSE@
|
||||
BUILD_DOCS_TRUE = @BUILD_DOCS_TRUE@
|
||||
BUILD_MLOGC_FALSE = @BUILD_MLOGC_FALSE@
|
||||
BUILD_MLOGC_TRUE = @BUILD_MLOGC_TRUE@
|
||||
BUILD_extentions_FALSE = @BUILD_extentions_FALSE@
|
||||
BUILD_extentions_TRUE = @BUILD_extentions_TRUE@
|
||||
CC = @CC@
|
||||
CCDEPMODE = @CCDEPMODE@
|
||||
CFLAGS = @CFLAGS@
|
||||
|
@@ -1,72 +0,0 @@
|
||||
Custom ModSecurity Modules
|
||||
--------------------------
|
||||
|
||||
This directory contains three examples how you can extend
|
||||
ModSecurity without having to touch it directly, simply
|
||||
by creating custom Apache modules.
|
||||
|
||||
NOTE: ModSecurity must be compiled with API support
|
||||
to use this feature (the API is enabled by default,
|
||||
but it will have been disabled if you used -DNO_MODSEC_API).
|
||||
|
||||
|
||||
Building the Example Custom Modules
|
||||
-----------------------------------
|
||||
|
||||
1) Example custom transformation function module
|
||||
|
||||
Module mod_tfn_reverse.c creates a custom transformation
|
||||
function "reverse" that reverses the content it receives
|
||||
on input.
|
||||
|
||||
# Compile as a normal user
|
||||
apxs -I<MODSECURITY_SOURCE_CODE> -I/usr/include/libxml2 \
|
||||
-ca mod_tfn_reverse.c
|
||||
|
||||
# Install as superuser
|
||||
sudo apxs -i mod_tfn_reverse.la
|
||||
|
||||
|
||||
2) Example custom operator module
|
||||
|
||||
Module mod_op_strstr.c creates a custom operator "strstr"
|
||||
that implements fast matching using the Boyer-Moore-Horspool
|
||||
algorithm.
|
||||
|
||||
# Compile as a normal user
|
||||
apxs -I<MODSECURITY_SOURCE_CODE> -I/usr/include/libxml2 \
|
||||
-ca mod_op_strstr.c
|
||||
|
||||
# Install as superuser
|
||||
sudo apxs -i mod_op_strstr.la
|
||||
|
||||
|
||||
3) Example custom target variable module
|
||||
|
||||
Module mod_var_remote_addr_port.c creates a custom variable "REMOTE_ADDR_PORT"
|
||||
that combines the REMOTE_ADDR and REMOTE_PORT into a.b.c.d:port format.
|
||||
|
||||
# Compile as a normal user
|
||||
apxs -I<MODSECURITY_SOURCE_CODE> -I/usr/include/libxml2 \
|
||||
-ca mod_var_remote_addr_port.c
|
||||
|
||||
# Install as superuser
|
||||
sudo apxs -i mod_var_remote_addr_port.la
|
||||
|
||||
|
||||
Using the Modules
|
||||
-----------------
|
||||
|
||||
Once the modules are built and installed, you load them like any other Apache module, but they must be loaded *after* the mod_security2.so module.
|
||||
|
||||
# Load ModSecurity
|
||||
LoadModule security2_module modules/mod_security2.so
|
||||
|
||||
# Load ModSecurity custom modules
|
||||
LoadModule tfn_reverse_module modules/mod_tfn_reverse.so
|
||||
LoadModule op_strstr_module modules/mod_op_strstr.so
|
||||
LoadModule var_remote_addr_port_module modules/mod_var_remote_addr_port.so
|
||||
|
||||
# All three custom var/op/tfn used
|
||||
SecRule REMOTE_ADDR_PORT "@strstr 1.2.3.4:5678" "t:reverse"
|
||||
|
@@ -1,174 +0,0 @@
|
||||
|
||||
#include "httpd.h"
|
||||
#include "http_core.h"
|
||||
#include "http_config.h"
|
||||
#include "http_log.h"
|
||||
#include "http_protocol.h"
|
||||
#include "ap_config.h"
|
||||
#include "apr_optional.h"
|
||||
|
||||
#include "modsecurity.h"
|
||||
|
||||
#define ALPHABET_SIZE 256
|
||||
#define MAX_PATTERN_SIZE 64
|
||||
|
||||
static void initBoyerMooreHorspool(const char *pattern, int patlength,
|
||||
int *bm_badcharacter_array);
|
||||
|
||||
static int BoyerMooreHorspool(const char *pattern, int patlength,
|
||||
const char *text, int textlen, int *bm_badcharacter_array);
|
||||
|
||||
/**
|
||||
* Operator parameter initialisation entry point.
|
||||
*/
|
||||
static int op_strstr_init(msre_rule *rule, char **error_msg) {
|
||||
/* Operator initialisation function will be called once per
|
||||
* statement where operator is used. It is meant to be used
|
||||
* to check the parameters to see whether they are present
|
||||
* and if they are in the correct format.
|
||||
*/
|
||||
|
||||
/* In this example we just look for a simple non-empty parameter. */
|
||||
if ((rule->op_param == NULL)||(strlen(rule->op_param) == 0)) {
|
||||
*error_msg = apr_psprintf(rule->ruleset->mp, "Missing parameter for operator 'strstr'.");
|
||||
return 0; /* ERROR */
|
||||
}
|
||||
|
||||
/* If you need to transform the data in the parameter into something
|
||||
* else you should do that here. Simply create a new structure to hold
|
||||
* the transformed data and place the pointer to it into rule->op_param_data.
|
||||
* You will have access to this pointer later on.
|
||||
*/
|
||||
rule->op_param_data = apr_pcalloc(rule->ruleset->mp, ALPHABET_SIZE * sizeof(int));
|
||||
initBoyerMooreHorspool(rule->op_param, strlen(rule->op_param), (int *)rule->op_param_data);
|
||||
|
||||
/* OK */
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Operator execution entry point.
|
||||
*/
|
||||
static int op_strstr_exec(modsec_rec *msr, msre_rule *rule, msre_var *var, char **error_msg) {
|
||||
/* Here we need to inspect the contents of the supplied variable. */
|
||||
|
||||
/* In a general case it is possible for the value
|
||||
* to be NULL. What you need to do in this case
|
||||
* depends on your operator. In this example we return
|
||||
* a "no match" response.
|
||||
*/
|
||||
if (var->value == NULL) return 0; /* No match. */
|
||||
|
||||
/* Another thing to note is that variables are not C strings,
|
||||
* meaning the NULL byte is not used to determine the end
|
||||
* of the string. Variable length var->value_len should be
|
||||
* used for this purpose.
|
||||
*/
|
||||
|
||||
if (BoyerMooreHorspool(rule->op_param, strlen(rule->op_param),
|
||||
var->value, var->value_len, (int *)rule->op_param_data) >= 0)
|
||||
{
|
||||
return 1; /* Match. */
|
||||
}
|
||||
|
||||
return 0; /* No match. */
|
||||
}
|
||||
|
||||
static int hook_pre_config(apr_pool_t *mp, apr_pool_t *mp_log, apr_pool_t *mp_temp) {
|
||||
void (*fn)(const char *name, void *fn_init, void *fn_exec);
|
||||
|
||||
/* Look for the registration function
|
||||
* exported by ModSecurity.
|
||||
*/
|
||||
fn = APR_RETRIEVE_OPTIONAL_FN(modsec_register_operator);
|
||||
if (fn) {
|
||||
/* Use it to register our new
|
||||
* transformation function under the
|
||||
* name "reverse".
|
||||
*/
|
||||
fn("strstr", (void *)op_strstr_init, (void *)op_strstr_exec);
|
||||
} else {
|
||||
ap_log_error(APLOG_MARK, APLOG_ERR | APLOG_NOERRNO, 0, NULL,
|
||||
"mod_op_strstr: Unable to find modsec_register_operator.");
|
||||
}
|
||||
|
||||
return OK;
|
||||
}
|
||||
|
||||
static void register_hooks(apr_pool_t *p) {
|
||||
ap_hook_pre_config(hook_pre_config, NULL, NULL, APR_HOOK_LAST);
|
||||
}
|
||||
|
||||
/* Dispatch list for API hooks */
|
||||
module AP_MODULE_DECLARE_DATA op_strstr_module = {
|
||||
STANDARD20_MODULE_STUFF,
|
||||
NULL, /* create per-dir config structures */
|
||||
NULL, /* merge per-dir config structures */
|
||||
NULL, /* create per-server config structures */
|
||||
NULL, /* merge per-server config structures */
|
||||
NULL, /* table of config file commands */
|
||||
register_hooks /* register hooks */
|
||||
};
|
||||
|
||||
/*
|
||||
|
||||
This example uses an implementation Boyer-Moore-Horspool
|
||||
matching algorithm as implemented in Streamline (http://ffpf.sourceforge.net).
|
||||
|
||||
Copyright (c) 2004-2006, Vrije Universiteit Amsterdam
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification,
|
||||
are permitted provided that the following conditions are met:
|
||||
|
||||
Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
Neither the name of the Vrije Universiteit nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software without
|
||||
specific prior written permission.
|
||||
|
||||
*/
|
||||
|
||||
static void precompute_badcharacter(const char *pattern, int patlength,
|
||||
int bm_badcharacter_array[])
|
||||
{
|
||||
int i;
|
||||
|
||||
for (i = 0; i < ALPHABET_SIZE; ++i) {
|
||||
bm_badcharacter_array[i] = patlength;
|
||||
}
|
||||
|
||||
for (i = 0; i < patlength - 1; ++i){
|
||||
bm_badcharacter_array[(uint8_t)pattern[i]] = patlength - i - 1;
|
||||
}
|
||||
}
|
||||
|
||||
static void initBoyerMooreHorspool(const char *pattern, int patlength,
|
||||
int *bm_badcharacter_array)
|
||||
{
|
||||
precompute_badcharacter(pattern,
|
||||
(patlength < MAX_PATTERN_SIZE ? patlength : MAX_PATTERN_SIZE), bm_badcharacter_array);
|
||||
}
|
||||
|
||||
static int BoyerMooreHorspool(const char *pattern, int patlength,
|
||||
const char *text, int textlen, int *bm_badcharacter_array)
|
||||
{
|
||||
int j;
|
||||
char c;
|
||||
|
||||
j = 0;
|
||||
while (j <= textlen - patlength) {
|
||||
c = text[j + patlength - 1];
|
||||
if (pattern[patlength - 1] == c && memcmp(pattern, text + j, patlength - 1) == 0) {
|
||||
return j;
|
||||
}
|
||||
j += bm_badcharacter_array[(uint8_t)c];
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
@@ -1,89 +0,0 @@
|
||||
|
||||
#include "httpd.h"
|
||||
#include "http_core.h"
|
||||
#include "http_config.h"
|
||||
#include "http_log.h"
|
||||
#include "http_protocol.h"
|
||||
#include "ap_config.h"
|
||||
#include "apr_optional.h"
|
||||
|
||||
#include "modsecurity.h"
|
||||
|
||||
/**
|
||||
* This function will be invoked by
|
||||
* ModSecurity to transform input.
|
||||
*/
|
||||
static int reverse(apr_pool_t *mptmp, unsigned char *input,
|
||||
long int input_len, char **rval, long int *rval_len)
|
||||
{
|
||||
/* Transformation functions can choose to do their
|
||||
* thing in-place, overwriting the existing content. This
|
||||
* is normally possible only if the transformed content
|
||||
* is of equal length or shorter.
|
||||
*
|
||||
* If you need to expand the content use the temporary
|
||||
* memory pool mptmp to allocate the space.
|
||||
*/
|
||||
|
||||
/* Reverse the string in place, but only if it's long enough. */
|
||||
if (input_len > 1) {
|
||||
long int i = 0;
|
||||
long int j = input_len - 1;
|
||||
while(i < j) {
|
||||
char c = input[i];
|
||||
input[i] = input[j];
|
||||
input[j] = c;
|
||||
i++;
|
||||
j--;
|
||||
}
|
||||
}
|
||||
|
||||
/* Tell ModSecurity about the content
|
||||
* we have generated. In this case we
|
||||
* merely point back to the input buffer.
|
||||
*/
|
||||
*rval = (char *)input;
|
||||
*rval_len = input_len;
|
||||
|
||||
/* Must return 1 if the content was
|
||||
* changed, or 0 otherwise.
|
||||
*/
|
||||
return 1;
|
||||
}
|
||||
|
||||
static int hook_pre_config(apr_pool_t *mp, apr_pool_t *mp_log, apr_pool_t *mp_temp) {
|
||||
void (*fn)(const char *name, void *fn);
|
||||
|
||||
/* Look for the registration function
|
||||
* exported by ModSecurity.
|
||||
*/
|
||||
fn = APR_RETRIEVE_OPTIONAL_FN(modsec_register_tfn);
|
||||
if (fn) {
|
||||
/* Use it to register our new
|
||||
* transformation function under the
|
||||
* name "reverse".
|
||||
*/
|
||||
fn("reverse", (void *)reverse);
|
||||
} else {
|
||||
ap_log_error(APLOG_MARK, APLOG_ERR | APLOG_NOERRNO, 0, NULL,
|
||||
"mod_tfn_reverse: Unable to find modsec_register_tfn.");
|
||||
}
|
||||
|
||||
return OK;
|
||||
}
|
||||
|
||||
static void register_hooks(apr_pool_t *p) {
|
||||
ap_hook_pre_config(hook_pre_config, NULL, NULL, APR_HOOK_LAST);
|
||||
}
|
||||
|
||||
/* Dispatch list for API hooks */
|
||||
module AP_MODULE_DECLARE_DATA tfn_reverse_module = {
|
||||
STANDARD20_MODULE_STUFF,
|
||||
NULL, /* create per-dir config structures */
|
||||
NULL, /* merge per-dir config structures */
|
||||
NULL, /* create per-server config structures */
|
||||
NULL, /* merge per-server config structures */
|
||||
NULL, /* table of config file commands */
|
||||
register_hooks /* register hooks */
|
||||
};
|
||||
|
@@ -1,102 +0,0 @@
|
||||
|
||||
#include "httpd.h"
|
||||
#include "http_core.h"
|
||||
#include "http_config.h"
|
||||
#include "http_log.h"
|
||||
#include "http_protocol.h"
|
||||
#include "ap_config.h"
|
||||
#include "apr_optional.h"
|
||||
|
||||
#include "modsecurity.h"
|
||||
|
||||
/* -- Generic generators/validators from re_variables.c -- */
|
||||
|
||||
/**
|
||||
* Generates a variable from a string and a length.
|
||||
*/
|
||||
static int var_simple_generate_ex(msre_var *var, apr_table_t *vartab, apr_pool_t *mptmp,
|
||||
const char *value, int value_len)
|
||||
{
|
||||
msre_var *rvar = NULL;
|
||||
|
||||
if (value == NULL) return 0;
|
||||
|
||||
rvar = apr_pmemdup(mptmp, var, sizeof(msre_var));
|
||||
rvar->value = value;
|
||||
rvar->value_len = value_len;
|
||||
apr_table_addn(vartab, rvar->name, (void *)rvar);
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a variable from a NULL-terminated string.
|
||||
*/
|
||||
static int var_simple_generate(msre_var *var, apr_table_t *vartab, apr_pool_t *mptmp,
|
||||
const char *value)
|
||||
{
|
||||
if (value == NULL) return 0;
|
||||
return var_simple_generate_ex(var, vartab, mptmp, value, strlen(value));
|
||||
}
|
||||
|
||||
|
||||
/* -- Module specific code -- */
|
||||
|
||||
/**
|
||||
* Create a silly variable with value = a.b.c.d:port
|
||||
*/
|
||||
static int var_remote_addr_port_generate(modsec_rec *msr, msre_var *var, msre_rule *rule,
|
||||
apr_table_t *vartab, apr_pool_t *mptmp)
|
||||
{
|
||||
const char *value = apr_psprintf(mptmp, "%s:%d", msr->remote_addr, msr->remote_port);
|
||||
|
||||
return var_simple_generate(var, vartab, mptmp, value);
|
||||
}
|
||||
|
||||
static int hook_pre_config(apr_pool_t *mp, apr_pool_t *mp_log, apr_pool_t *mp_temp) {
|
||||
void (*register_fn)(const char *name, unsigned int type,
|
||||
unsigned int argc_min, unsigned int argc_max,
|
||||
void *fn_validate, void *fn_generate,
|
||||
unsigned int is_cacheable, unsigned int availability);
|
||||
|
||||
/* Look for the registration function
|
||||
* exported by ModSecurity.
|
||||
*/
|
||||
register_fn = APR_RETRIEVE_OPTIONAL_FN(modsec_register_variable);
|
||||
if (register_fn) {
|
||||
/* Use it to register our new
|
||||
* variable under the
|
||||
* name "REMOTE_ADDR_PORT".
|
||||
*/
|
||||
register_fn(
|
||||
"REMOTE_ADDR_PORT",
|
||||
VAR_SIMPLE,
|
||||
0, 0,
|
||||
NULL,
|
||||
var_remote_addr_port_generate,
|
||||
VAR_DONT_CACHE,
|
||||
PHASE_REQUEST_HEADERS
|
||||
);
|
||||
} else {
|
||||
ap_log_error(APLOG_MARK, APLOG_ERR | APLOG_NOERRNO, 0, NULL,
|
||||
"mod_var_remote_addr_port: Unable to find modsec_register_variable.");
|
||||
}
|
||||
|
||||
return OK;
|
||||
}
|
||||
|
||||
static void register_hooks(apr_pool_t *p) {
|
||||
ap_hook_pre_config(hook_pre_config, NULL, NULL, APR_HOOK_LAST);
|
||||
}
|
||||
|
||||
/* Dispatch list for API hooks */
|
||||
module AP_MODULE_DECLARE_DATA var_remote_addr_port_module = {
|
||||
STANDARD20_MODULE_STUFF,
|
||||
NULL, /* create per-dir config structures */
|
||||
NULL, /* merge per-dir config structures */
|
||||
NULL, /* create per-server config structures */
|
||||
NULL, /* merge per-server config structures */
|
||||
NULL, /* table of config file commands */
|
||||
register_hooks /* register hooks */
|
||||
};
|
||||
|
Reference in New Issue
Block a user