ModSecurity/src/rule.cc

/*
 * 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 "src/operators/operator.h"
#include "modsecurity/actions/action.h"
#include "modsecurity/modsecurity.h"
#include "src/actions/transformations/none.h"
#include "src/actions/tag.h"
#include "src/variables/variations/exclusion.h"
#include "src/utils/string.h"
#include "modsecurity/rules.h"
#include "modsecurity/rule_message.h"
#include "src/macro_expansion.h"
#include "src/actions/msg.h"
#include "src/actions/log_data.h"
#include "src/actions/severity.h"


using modsecurity::Variables::Variations::Exclusion;

namespace modsecurity {

using operators::Operator;
using actions::Action;
using Variables::Variable;
using actions::transformations::None;

Rule::~Rule() {
    if (op != NULL) {
        delete op;
    }
    while (m_actionsConf.empty() == false) {
        auto *a = m_actionsConf.back();
        m_actionsConf.pop_back();
        delete a;
    }
    while (m_actionsRuntimePre.empty() == false) {
        auto *a = m_actionsRuntimePre.back();
        m_actionsRuntimePre.pop_back();
        delete a;
    }
    while (m_actionsRuntimePos.empty() == false) {
        auto *a = m_actionsRuntimePos.back();
        m_actionsRuntimePos.pop_back();
        delete a;
    }
    while (variables != NULL && variables->empty() == false) {
        auto *a = variables->back();
        variables->pop_back();
        delete a;
    }

    if (variables != NULL) {
        delete variables;
    }

    if (chainedRule != NULL) {
        delete chainedRule;
    }
}

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) {
                m_actionsConf.push_back(a);
                a->evaluate(this, NULL);
            } else if (a->action_kind
                == Action::RunTimeBeforeMatchAttemptKind) {
                m_actionsRuntimePre.push_back(a);
            } else if (a->action_kind == Action::RunTimeOnlyIfMatchKind) {
                m_actionsRuntimePos.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->m_actionsRuntimePos) {
        a.push_back(z->m_name);
    }
    for (auto &z : this->m_actionsRuntimePre) {
        a.push_back(z->m_name);
    }
    for (auto &z : this->m_actionsConf) {
        a.push_back(z->m_name);
    }

    return a;
}


bool Rule::evaluateActions(Transaction *trasn) {
    return true;
}


void Rule::updateMatchedVars(Transaction *trasn, std::string key,
    std::string value) {
    trasn->debug(4, "Matched vars updated.");
    trasn->m_collections.storeOrUpdateFirst("MATCHED_VAR", value);
    trasn->m_collections.storeOrUpdateFirst("MATCHED_VAR_NAME", key);
    trasn->m_collections.store("MATCHED_VARS:" + key, value);
    trasn->m_collections.store("MATCHED_VARS_NAMES:" + key, key);
}


void Rule::cleanMatchedVars(Transaction *trasn) {
    trasn->debug(4, "Matched vars cleaned.");
    trasn->m_collections.storeOrUpdateFirst("MATCHED_VAR", "");
    trasn->m_collections.del("MATCHED_VARS_NAME");
    trasn->m_collections.del("MATCHED_VARS");
    trasn->m_collections.del("MATCHED_VARS_NAMES");
}


void Rule::updateRulesVariable(Transaction *trasn) {
    if (rule_id != 0) {
        trasn->m_collections.storeOrUpdateFirst("RULE:id",
            std::to_string(rule_id));
    }
    if (m_rev.empty() == false) {
        trasn->m_collections.storeOrUpdateFirst("RULE:rev", m_rev);
    }
    if (getActionsByName("msg").size() > 0) {
        actions::Msg *msg = dynamic_cast<actions::Msg*>(
            getActionsByName("msg")[0]);
        trasn->m_collections.storeOrUpdateFirst("RULE:msg", msg->data(trasn));
    }
    if (getActionsByName("logdata").size() > 0) {
        actions::LogData *data = dynamic_cast<actions::LogData*>(
            getActionsByName("logdata")[0]);
        trasn->m_collections.storeOrUpdateFirst("RULE:logdata",
            data->data(trasn));
    }
    if (getActionsByName("severity").size() > 0) {
        actions::Severity *data = dynamic_cast<actions::Severity*>(
            getActionsByName("severity")[0]);
        trasn->m_collections.storeOrUpdateFirst("RULE:severity",
            std::to_string(data->m_severity));
    }
}


std::string Rule::resolveMatchMessage(std::string key, std::string value) {
    std::string ret = this->op->m_match_message;

    if (ret.empty() == true) {
        ret = "Matched \"Operator `" + this->op->m_op + "' with parameter `" +
            utils::string::limitTo(200, this->op->m_param) +
            "' against variable `" + key + "' (Value: `" +
            utils::string::limitTo(100, utils::string::toHexIfNeeded(value)) +
            "' ) \" at " + key;
    }

    return ret;
}


void Rule::executeActionsIndependentOfChainedRuleResult(Transaction *trasn,
    bool *containsDisruptive, RuleMessage *ruleMessage) {
    for (Action *a : this->m_actionsRuntimePos) {
        if (a->isDisruptive() == true) {
            if (a->m_name == "pass") {
                trasn->debug(4, "Rule contains a `pass' action");
            } else {
                *containsDisruptive = true;
            }
        } else {
            if (a->m_name == "setvar"
                || a->m_name == "msg"
                || a->m_name == "log") {
                trasn->debug(4, "Running [I] (_non_ disruptive) " \
                    "action: " + a->m_name);
                    a->evaluate(this, trasn, ruleMessage);
            }
        }
    }
    for (auto &z : ruleMessage->m_tmp_actions) {
        trasn->m_actions.push_back(z);
    }
}


bool Rule::executeOperatorAt(Transaction *trasn, std::string key,
    std::string value) {
    clock_t begin = clock();
    clock_t end;
    double elapsed_s = 0;
    bool ret;

    trasn->debug(9, "Target value: \"" + utils::string::limitTo(80,
            utils::string::toHexIfNeeded(value)) \
            + "\" (Variable: " + key + ")");

    ret = this->op->evaluateInternal(trasn, this, value);
    if (ret == false) {
        return false;
    }

    end = clock();
    elapsed_s = static_cast<double>(end - begin) / CLOCKS_PER_SEC;

    trasn->debug(4, "Operator completed in " + \
        std::to_string(elapsed_s) + " seconds");

    return ret;
}

// FIXME: this should be a list instead of a vector, keeping the but
// of v2 alive.
std::vector<std::string> Rule::executeSecDefaultActionTransofrmations(
    Transaction *trasn, std::string &value, bool multiMatch) {
    int none = 0;
    int transformations = 0;
    std::vector<std::string> ret;

    if (multiMatch == true) {
        ret.push_back(value);
        ret.push_back(value);
    }

    for (Action *a : this->m_actionsRuntimePre) {
        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) {
                std::string oldValue = value;
                if (multiMatch) {
                    oldValue = ret.back();
                }
                std::string newValue = a->evaluate(oldValue, trasn);
                if (multiMatch == true) {
                    if (newValue != oldValue) {
                        ret.push_back(newValue);
                    }
                } else {
                    value = newValue;
                }

                trasn->debug(9, "(SecDefaultAction) T (" + \
                    std::to_string(transformations) + ") " + \
                    a->m_name + ": \"" + \
                    utils::string::limitTo(80, newValue) +"\"");

                transformations++;
            }
        }
    }

    for (Action *a : this->m_actionsRuntimePre) {
        if (none == 0) {
            std::string oldValue = value;
            if (multiMatch) {
                oldValue = ret.back();
            }

            std::string newValue = a->evaluate(oldValue, trasn);
            if (multiMatch == true) {
                if (newValue != oldValue) {
                    ret.push_back(newValue);
                }
            } else {
                value = newValue;
            }

            trasn->debug(9, " T (" + \
                std::to_string(transformations) + ") " + \
                a->m_name + ": \"" + \
                utils::string::limitTo(80, newValue) + "\"");
            transformations++;
        }
        if (a->m_isNone) {
            none--;
        }
    }
    if (multiMatch == true) {
        // v2 checks the last entry twice. Don't know why.
        ret.push_back(ret.back());
        trasn->debug(9, "multiMatch is enabled. " \
            + std::to_string(ret.size()) + \
            " values to be tested.");
        for (const std::string &a : ret) {
            trasn->debug(9, " - " + a);
        }
    } else {
        ret.push_back(value);
    }

    return ret;
}


std::vector<const collection::Variable *> Rule::getFinalVars(
    Transaction *trasn) {
    std::list<std::string> exclusions;
    std::vector<Variable *> *variables = this->variables;
    std::vector<const collection::Variable *> finalVars;

    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++) {
        Variable *variable = variables->at(i);
        std::vector<const collection::Variable *> e;
        bool ignoreVariable = false;

        if (variable->m_isExclusion) {
            continue;
        }

        variable->evaluateInternal(trasn, this, &e);
        for (const collection::Variable *v : e) {
            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;
            }

            finalVars.push_back(v);
        }
    }
    return finalVars;
}


void Rule::executeActionsAfterFullMatch(Transaction *trasn,
    bool containsDisruptive, RuleMessage *ruleMessage) {

    for (Action *a : trasn->m_rules->defaultActions[this->phase]) {
        if (a->action_kind != actions::Action::RunTimeOnlyIfMatchKind) {
            continue;
        }

        if (a->isDisruptive() == false) {
            trasn->debug(4, "(SecDefaultAction) Running " \
                "action: " + a->m_name);
                a->evaluate(this, trasn, ruleMessage);
            continue;
        }

        if (containsDisruptive) {
            trasn->debug(4, "(SecDefaultAction) _ignoring_ " \
                "action: " + a->m_name + \
                " (rule contains a disruptive action)");
            continue;
        }

        if (trasn->m_rules->m_secRuleEngine == Rules::EnabledRuleEngine) {
            trasn->debug(4, "(SecDefaultAction) " \
                "Running action: " + a->m_name + \
                " (rule _does not_ contains a " \
                "disruptive action)");
            a->evaluate(this, trasn, ruleMessage);
            continue;
        }

        trasn->debug(4, "(SecDefaultAction) _Not_ running action: " \
                + a->m_name + ". Rule _does not_contains a disruptive action,"\
                + " but SecRuleEngine is not On.");
    }

    for (Action *a : this->m_actionsRuntimePos) {
        if (a->isDisruptive() == false) {
            if (a->m_name != "setvar" && a->m_name != "log"
                && a->m_name != "msg") {
                trasn->debug(4, "Running [I] (_non_ disruptive) " \
                    "action: " + a->m_name);
                    a->evaluate(this, trasn, ruleMessage);
            }
            continue;
        }
        if (trasn->m_rules->m_secRuleEngine == Rules::EnabledRuleEngine) {
            trasn->debug(4, "Running (disruptive) action: " + a->m_name);
            a->evaluate(this, trasn, ruleMessage);
            continue;
        } else {
            continue;
        }

        trasn->debug(4, "Not running disruptive action: " + \
                a->m_name + ". SecRuleEngine is not On");
    }

    for (auto &z : ruleMessage->m_tmp_actions) {
        trasn->m_actions.push_back(z);
    }
}


bool Rule::evaluate(Transaction *trasn) {
    bool isThisAChainedRule = rule_id == 0;
    bool globalRet = false;
    std::vector<Variable *> *variables = this->variables;
    bool recursiveGlobalRet;
    bool containsDisruptive = false;
    RuleMessage ruleMessage(this);

    trasn->m_matched.clear();

    if (m_secmarker == true) {
        return true;
    }
    if (m_unconditional == true) {
        trasn->debug(4, "(Rule: " + std::to_string(rule_id) \
            + ") Executing unconditional rule...");
        executeActionsIndependentOfChainedRuleResult(trasn,
            &containsDisruptive, &ruleMessage);
        executeActionsAfterFullMatch(trasn, false, &ruleMessage);
        return true;
    }

    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;
    }

    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) + ".");

    updateRulesVariable(trasn);

    std::vector<const collection::Variable *> finalVars = getFinalVars(trasn);

    for (const collection::Variable *v : finalVars) {
        std::string value = v->m_value;
        std::vector<std::string> values;
        bool ret;
        bool multiMatch = getActionsByName("multimatch").size() > 0;

        values = executeSecDefaultActionTransofrmations(trasn, value,
            multiMatch);

        for (const std::string &valueTemp : values) {
            ret = executeOperatorAt(trasn, v->m_key, valueTemp);
            if (ret == true) {
                ruleMessage.m_match = resolveMatchMessage(v->m_key, value);
                updateMatchedVars(trasn, v->m_key, value);
                executeActionsIndependentOfChainedRuleResult(trasn,
                    &containsDisruptive, &ruleMessage);
                std::string msg2save = ruleMessage.errorLog(trasn);
                if (ruleMessage.m_message.empty() == false) {
                    trasn->debug(4, "Scheduled to be saved on the server " +
                        "log: " + msg2save + "");
                    ruleMessage.m_server_logs.push_back(msg2save);
                }
                globalRet = true;
            }
        }
    }

    if (globalRet == false) {
        trasn->debug(4, "Rule returned 0.");
        cleanMatchedVars(trasn);
        return false;
    }

    trasn->debug(4, "Rule returned 1.");

    if (this->chained == false) {
        executeActionsAfterFullMatch(trasn, containsDisruptive, &ruleMessage);
        trasn->debug(4, "Merging temporary actions to the main transaction.");

        for (const auto &u : ruleMessage.m_server_logs) {
            trasn->debug(8, "To save: " + u);
            trasn->serverLog(u);
        }
        return true;
    }

    if (this->chainedRule == NULL) {
        trasn->debug(4, "Rule is marked as chained but there " \
            "isn't a subsequent rule.");
        return false;
    }

    trasn->debug(4, "Executing chained rule.");
    recursiveGlobalRet = this->chainedRule->evaluate(trasn);

    if (recursiveGlobalRet == true) {
        executeActionsAfterFullMatch(trasn, containsDisruptive, &ruleMessage);
        trasn->debug(4, "Merging temporary actions to the main transaction.");
        for (const auto &u : ruleMessage.m_server_logs) {
            trasn->serverLog(u);
        }
        return true;
    }

    return false;
}


std::vector<actions::Action *> Rule::getActionsByName(const std::string& name) {
    std::vector<actions::Action *> ret;
    for (auto &z : m_actionsRuntimePos) {
        if (z->m_name == name) {
            ret.push_back(z);
        }
    }
    for (auto &z : m_actionsRuntimePre) {
        if (z->m_name == name) {
            ret.push_back(z);
        }
    }
    for (auto &z : m_actionsConf) {
        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->m_actionsRuntimePos) {
        actions::Tag *tag = dynamic_cast<actions::Tag *> (z);
        if (tag != NULL && tag->getName(t) == name) {
            return true;
        }
    }
    return false;
}


}  // namespace modsecurity