ModSecurity/src/rule.cc
Felipe Zimmerle 507ec44cc2
Refactoring on `utils.cc' and adjacents
Completely removed the `utils.cc' by moving residual functions into
sub-classes of `utils/'
2016-11-03 20:26:27 -03:00

642 lines
21 KiB
C++

/*
* ModSecurity, http://www.modsecurity.org/
* Copyright (c) 2015 Trustwave Holdings, Inc. (http://www.trustwave.com/)
*
* 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
*
* If any of the files related to licensing are missing or if you have any
* other questions related to licensing please contact Trustwave Holdings, Inc.
* directly using the email address security@modsecurity.org.
*
*/
#include "modsecurity/rule.h"
#include <stdio.h>
#include <algorithm>
#include <iostream>
#include <string>
#include <cstring>
#include <list>
#include <utility>
#include "operators/operator.h"
#include "actions/action.h"
#include "modsecurity/modsecurity.h"
#include "actions/transformations/none.h"
#include "actions/tag.h"
#include "variables/variations/exclusion.h"
#include "utils/msc_string.h"
#include "modsecurity/rules.h"
#include "src/macro_expansion.h"
using modsecurity::Variables::Variations::Exclusion;
using modsecurity::utils::String;
namespace modsecurity {
using operators::Operator;
using actions::Action;
using Variables::Variable;
using actions::transformations::None;
Rule::~Rule() {
if (op != NULL) {
delete op;
}
while (actions_conf.empty() == false) {
auto *a = actions_conf.back();
actions_conf.pop_back();
delete a;
}
while (actions_runtime_pre.empty() == false) {
auto *a = actions_runtime_pre.back();
actions_runtime_pre.pop_back();
delete a;
}
while (actions_runtime_pos.empty() == false) {
auto *a = actions_runtime_pos.back();
actions_runtime_pos.pop_back();
delete a;
}
while (variables != NULL && variables->empty() == false) {
auto *a = variables->back();
variables->pop_back();
delete a;
}
if (variables != NULL) {
delete variables;
}
}
Rule::Rule(std::string marker)
: chained(false),
chainedRule(NULL),
variables(NULL),
op(NULL),
rule_id(0),
phase(-1),
m_accuracy(0),
m_unconditional(false),
m_secmarker(true),
m_marker(marker),
m_maturity(0),
m_referenceCount(0),
m_fileName(""),
m_lineNumber(0) { }
Rule::Rule(Operator *_op,
std::vector<Variable *> *_variables,
std::vector<Action *> *actions,
std::string fileName,
int lineNumber): chained(false),
chainedRule(NULL),
variables(_variables),
op(_op),
rule_id(0),
phase(-1),
m_accuracy(0),
m_unconditional(false),
m_secmarker(false),
m_marker(""),
m_maturity(0),
m_referenceCount(0),
m_fileName(fileName),
m_lineNumber(lineNumber) {
if (actions != NULL) {
for (Action *a : *actions) {
if (a->action_kind == Action::ConfigurationKind) {
actions_conf.push_back(a);
a->evaluate(this, NULL);
} else if (a->action_kind
== Action::RunTimeBeforeMatchAttemptKind) {
actions_runtime_pre.push_back(a);
} else if (a->action_kind == Action::RunTimeOnlyIfMatchKind) {
actions_runtime_pos.push_back(a);
} else {
std::cout << "General failure, action: " << a->m_name;
std::cout << " has an unknown type." << std::endl;
delete a;
}
}
}
/**
* If phase is not entered, we assume phase 2. For historical reasons.
*
*/
if (phase == -1) {
phase = modsecurity::Phases::RequestHeadersPhase;
}
if (op == NULL) {
m_unconditional = true;
}
delete actions;
}
std::vector<std::string> Rule::getActionNames() {
std::vector<std::string> a;
for (auto &z : this->actions_runtime_pos) {
a.push_back(z->m_name);
}
for (auto &z : this->actions_runtime_pre) {
a.push_back(z->m_name);
}
for (auto &z : this->actions_conf) {
a.push_back(z->m_name);
}
return a;
}
bool Rule::evaluateActions(Transaction *trasn) {
int none = 0;
bool containsDisruptive = false;
// int transformations = 0;
for (Action *a : this->actions_runtime_pre) {
if (a->m_isNone) {
none++;
}
}
#ifndef NO_LOGS
trasn->debug(4, "Running unconditional rule.");
#endif
if (none == 0) {
/*
for (Action *a : trasn->m_rules->defaultActions[this->phase]) {
if (a->action_kind == actions::Action::RunTimeBeforeMatchAttemptKind) {
value = a->evaluate(value, trasn);
trasn->debug(9, "(SecDefaultAction) T (" + \
std::to_string(transformations) + ") " + \
a->name + ": \"" + value +"\"");
transformations++;
}
}
*/
}
for (Action *a : this->actions_runtime_pre) {
/*
if (none == 0) {
value = a->evaluate(value, trasn);
trasn->debug(9, " T (" + \
std::to_string(transformations) + ") " + \
a->name + ": \"" + value +"\"");
transformations++;
}
*/
if (a->m_isNone) {
none--;
}
}
for (Action *a : this->actions_runtime_pos) {
if (a->isDisruptive() == false) {
#ifndef NO_LOGS
trasn->debug(4, "Running (_non_ disruptive) action: " +
a->m_name + ".");
#endif
a->evaluate(this, trasn);
} else {
containsDisruptive = true;
}
}
for (Action *a : trasn->m_rules->defaultActions[this->phase]) {
if (a->action_kind == actions::Action::RunTimeOnlyIfMatchKind) {
if (a->isDisruptive()) {
if (containsDisruptive) {
#ifndef NO_LOGS
trasn->debug(4, "(SecDefaultAction) " \
"_ignoring_ action: " + a->m_name + \
" (rule contains a disruptive action)");
#endif
} else {
if (trasn->m_rules->m_secRuleEngine
== Rules::EnabledRuleEngine) {
#ifndef NO_LOGS
trasn->debug(4, "(SecDefaultAction) " \
"Running action: " + a->m_name + \
" (rule _does not_ contains a " \
"disruptive action)");
#endif
a->evaluate(this, trasn);
} else {
#ifndef NO_LOGS
trasn->debug(4, "(SecDefaultAction) " \
"_Not_ running action: " + a->m_name + \
". Rule _does not_ contains a " \
"disruptive action, but SecRuleEngine is not On.");
#endif
}
}
} else {
#ifndef NO_LOGS
trasn->debug(4, "(SecDefaultAction) Running action: " + \
a->m_name);
a->evaluate(this, trasn);
#endif
}
}
}
for (Action *a : this->actions_runtime_pos) {
if (a->isDisruptive()
&& trasn->m_rules->m_secRuleEngine
== Rules::EnabledRuleEngine) {
#ifndef NO_LOGS
trasn->debug(4, "Running (disruptive) action: " + a->m_name);
#endif
a->evaluate(this, trasn);
} else if (a->isDisruptive()) {
#ifndef NO_LOGS
trasn->debug(4, "Not running disruptive action: " + \
a->m_name + ". SecRuleEngine is not On");
#endif
}
}
return true;
}
bool Rule::evaluate(Transaction *trasn) {
bool ret = false;
bool globalRet = false;
std::vector<Variable *> *variables = this->variables;
RuleMessage *ruleMessage = NULL;
trasn->m_matched.clear();
if (m_secmarker == true) {
return true;
}
if (m_unconditional == true) {
return evaluateActions(trasn);
}
for (auto &i : trasn->m_ruleRemoveById) {
if (rule_id != i) {
continue;
}
trasn->debug(9, "Rule id: " + std::to_string(rule_id) +
" was skipped due to an ruleRemoveById action...");
return true;
}
ruleMessage = new modsecurity::RuleMessage(this, m_log_message);
#ifndef NO_LOGS
std::string eparam = MacroExpansion::expand(this->op->m_param, trasn);
if (this->op->m_param != eparam) {
eparam = "\"" + eparam + "\" Was: \"" + this->op->m_param + "\"";
} else {
eparam = "\"" + eparam + "\"";
}
trasn->debug(4, "(Rule: " + std::to_string(rule_id) \
+ ") Executing operator \"" + this->op->m_op \
+ "\" with param " \
+ eparam \
+ " against " \
+ Variable::to_s(variables) + ".");
clock_t begin = clock();
#endif
std::list<std::string> exclusions;
for (int i = 0; i < variables->size(); i++) {
Variable *variable = variables->at(i);
if (variable->m_isExclusion) {
std::vector<const collection::Variable *> z;
variable->evaluateInternal(trasn, this, &z);
for (auto &y : z) {
exclusions.push_back(y->m_key);
delete y;
}
exclusions.push_back(variable->m_name);
}
}
for (int i = 0; i < variables->size(); i++) {
int transformations = 0;
Variable *variable = variables->at(i);
if (variable->m_isExclusion) {
continue;
}
std::vector<const collection::Variable *> e;
variable->evaluateInternal(trasn, this, &e);
for (auto &v : e) {
bool ignoreVariable = false;
if (std::find(exclusions.begin(), exclusions.end(),
v->m_key) != exclusions.end()) {
#ifndef NO_LOGS
trasn->debug(9, "Variable: " + v->m_key +
" is part of the exclusion list, skipping...");
#endif
continue;
}
for (auto &i : trasn->m_ruleRemoveTargetByTag) {
std::string tag = i.first;
std::string args = i.second;
if (containsTag(tag, trasn) == false) {
continue;
}
if (args == v->m_key) {
trasn->debug(9, "Variable: " + v->m_key +
" was excluded by ruleRemoteTargetByTag...");
ignoreVariable = true;
break;
}
}
if (ignoreVariable) {
continue;
}
for (auto &i : trasn->m_ruleRemoveTargetById) {
int id = i.first;
std::string args = i.second;
if (rule_id != id) {
continue;
}
if (args == v->m_key) {
trasn->debug(9, "Variable: " + v->m_key +
" was excluded by ruleRemoteTargetById...");
ignoreVariable = true;
break;
}
}
if (ignoreVariable) {
continue;
}
std::string value = v->m_value;
int none = 0;
for (Action *a : this->actions_runtime_pre) {
if (a->m_isNone) {
none++;
}
}
// Check for transformations on the SecDefaultAction
// Notice that first we make sure that won't be a t:none
// on the target rule.
if (none == 0) {
for (Action *a :
trasn->m_rules->defaultActions[this->phase]) {
if (a->action_kind ==
actions::Action::RunTimeBeforeMatchAttemptKind) {
value = a->evaluate(value, trasn);
#ifndef NO_LOGS
trasn->debug(9, "(SecDefaultAction) T (" + \
std::to_string(transformations) + ") " + \
a->m_name + ": \"" + value +"\"");
#endif
transformations++;
}
}
}
for (Action *a : this->actions_runtime_pre) {
if (none == 0) {
value = a->evaluate(value, trasn);
#ifndef NO_LOGS
trasn->debug(9, " T (" + \
std::to_string(transformations) + ") " + \
a->m_name + ": \"" + value +"\"");
#endif
transformations++;
}
if (a->m_isNone) {
none--;
}
}
#ifndef NO_LOGS
trasn->debug(9, "Target value: \"" + String::limitTo(80,
String::toHexIfNeeded(value)) \
+ "\" (Variable: " + v->m_key + ")");
#endif
ret = this->op->evaluateInternal(trasn, value);
#ifndef NO_LOGS
clock_t end = clock();
double elapsed_secs = static_cast<double>(end - begin) \
/ CLOCKS_PER_SEC;
trasn->debug(4, "Operator completed in " + \
std::to_string(elapsed_secs) + " seconds");
#endif
if (ret) {
bool containsDisruptive = false;
bool chainResult = false;
bool containsPassAction = false;
globalRet = true;
if (this->op->m_match_message.empty() == true) {
ruleMessage->m_match = "Matched \"Operator `" +
this->op->m_op + "' with parameter `" +
String::limitTo(200, this->op->m_param) +
"' against variable `" + v->m_key + "' (Value: `" +
String::limitTo(100, String::toHexIfNeeded(value)) +
"' ) \" at " + v->m_key;
} else {
ruleMessage->m_match = this->op->m_match_message;
}
#ifndef NO_LOGS
trasn->debug(4, "Rule returned 1.");
trasn->m_collections.storeOrUpdateFirst("MATCHED_VAR",
value);
trasn->m_collections.storeOrUpdateFirst("MATCHED_VAR_NAME",
v->m_key);
trasn->m_collections.store("MATCHED_VARS:"
+ v->m_key, value);
trasn->m_collections.store("MATCHED_VARS_NAMES:"
+ v->m_key, v->m_key);
#endif
for (Action *a :
this->actions_runtime_pos) {
if (a->isDisruptive() == true) {
if (a->m_name == "pass") {
containsPassAction = true;
trasn->debug(4, "Rule contains a `pass' action");
} else {
containsDisruptive = true;
}
}
}
if (this->chained && this->chainedRule == NULL) {
#ifndef NO_LOGS
trasn->debug(4, "Rule is marked as chained but there " \
"isn't a subsequent rule.");
#endif
}
if (this->chained && this->chainedRule != NULL) {
#ifndef NO_LOGS
trasn->debug(4, "Executing chained rule.");
#endif
chainResult = this->chainedRule->evaluate(trasn);
}
if ((this->chained && chainResult == true) || !this->chained) {
for (Action *a :
trasn->m_rules->defaultActions[this->phase]) {
if (a->action_kind
== actions::Action::RunTimeOnlyIfMatchKind) {
if (a->isDisruptive()) {
if (containsDisruptive) {
#ifndef NO_LOGS
trasn->debug(4,
"(SecDefaultAction) _ignoring_ " \
"action: " + a->m_name + \
" (rule contains a disruptive action)");
#endif
} else {
if (trasn->m_rules->m_secRuleEngine
== Rules::EnabledRuleEngine) {
#ifndef NO_LOGS
trasn->debug(4, "(SecDefaultAction) " \
"Running action: " + a->m_name + \
" (rule _does not_ contains a " \
"disruptive action)");
#endif
a->evaluate(this, trasn, ruleMessage);
} else {
#ifndef NO_LOGS
trasn->debug(4, "(SecDefaultAction) " \
"_Not_ running action: " \
+ a->m_name + ". Rule _does not_" \
+ " contains a disruptive action,"\
+ " but SecRuleEngine is not On.");
#endif
}
}
} else {
#ifndef NO_LOGS
trasn->debug(4, "(SecDefaultAction) Running " \
"action: " + a->m_name + "!!" \
+ std::to_string(a->isDisruptive()));
#endif
a->evaluate(this, trasn, ruleMessage);
}
}
}
for (Action *a :
this->actions_runtime_pos) {
if (a->isDisruptive()
&& trasn->m_rules->m_secRuleEngine
== Rules::EnabledRuleEngine
&& containsPassAction == false) {
#ifndef NO_LOGS
trasn->debug(4, "Running (disruptive) " \
"action: " + a->m_name);
#endif
a->evaluate(this, trasn);
} else if (a->isDisruptive()
&& containsPassAction == false) {
#ifndef NO_LOGS
trasn->debug(4,
"Not running disruptive action: " + \
a->m_name + ". SecRuleEngine " + \
"is not On");
#endif
} else if (a->isDisruptive() &&
containsPassAction == true) {
if (a->m_name != "pass") {
#ifndef NO_LOGS
trasn->debug(4, "Not running disruptive " \
"action: " + a->m_name + ". It was " \
"silenced by an `pass' action.");
#endif
}
} else if (!a->isDisruptive()) {
#ifndef NO_LOGS
trasn->debug(4, "Running (_non_ disruptive) " \
"action: " + a->m_name);
#endif
a->evaluate(this, trasn, ruleMessage);
}
}
}
} else if (globalRet != true) {
#ifndef NO_LOGS
trasn->debug(4, "Rule returned 0.");
trasn->m_collections.storeOrUpdateFirst("MATCHED_VAR", "");
trasn->m_collections.del("MATCHED_VARS:" + v->m_key);
trasn->m_collections.del("MATCHED_VARS_NAMES:" + v->m_key);
trasn->m_collections.del("MATCHED_VARS_NAME");
#endif
}
}
while (e.empty() == false) {
delete e.back();
e.pop_back();
}
}
if (globalRet == true && rule_id != 0
&& ruleMessage->m_saveMessage == true) {
ruleMessage->m_message = m_log_message;
trasn->debug(4, "Saving on the server log: "
+ ruleMessage->errorLog(trasn));
trasn->serverLog(ruleMessage->errorLog(trasn));
} else {
delete ruleMessage;
}
return globalRet;
}
std::vector<actions::Action *> Rule::getActionsByName(const std::string& name) {
std::vector<actions::Action *> ret;
for (auto &z : this->actions_runtime_pos) {
if (z->m_name == name) {
ret.push_back(z);
}
}
for (auto &z : this->actions_runtime_pre) {
if (z->m_name == name) {
ret.push_back(z);
}
}
for (auto &z : this->actions_conf) {
if (z->m_name == name) {
ret.push_back(z);
}
}
return ret;
}
bool Rule::containsTag(const std::string& name, Transaction *t) {
std::vector<std::string *> ret;
for (auto &z : this->actions_runtime_pos) {
actions::Tag *tag = dynamic_cast<actions::Tag *> (z);
if (tag != NULL && tag->getName(t) == name) {
return true;
}
}
return false;
}
} // namespace modsecurity