ModSecurity/headers/modsecurity/rule_message.h

/*
 * ModSecurity, http://www.modsecurity.org/
 * Copyright (c) 2015 - 2020 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.
 *
 */

#ifdef __cplusplus
#include <stack>
#include <vector>
#include <string>
#include <list>
#include <cstring>
#endif

#ifndef HEADERS_MODSECURITY_RULE_MESSAGE_H_
#define HEADERS_MODSECURITY_RULE_MESSAGE_H_

#include "modsecurity/transaction.h"
#include "modsecurity/rule.h"


#ifdef __cplusplus

namespace modsecurity {
namespace actions {
class Tag;
};
class RuleWithActions;

class RuleMessage {
 public:
    enum LogMessageInfo {
        ErrorLogTailLogMessageInfo = 2,
        ClientLogMessageInfo = 4
    };


    explicit RuleMessage(const RuleMessage &ruleMessage) :
        m_severity(ruleMessage.m_severity),
        m_tags(),
        m_data(ruleMessage.m_data),
        m_match(ruleMessage.m_match),
        m_message(ruleMessage.m_message),
        m_reference(ruleMessage.m_reference),
        m_transaction(ruleMessage.m_transaction),
        m_rule(ruleMessage.m_rule)
    { }


    RuleMessage &operator=(const RuleMessage& ruleMessage) {
        m_severity = ruleMessage.m_severity;
        m_tags = ruleMessage.m_tags;
        m_data = ruleMessage.m_data;
        m_match = ruleMessage.m_match;
        m_message = ruleMessage.m_message;
        m_reference = ruleMessage.m_reference;
        m_transaction = ruleMessage.m_transaction;
        m_rule = ruleMessage.m_rule;
        return *this;
    }


    explicit RuleMessage(Transaction *transaction) :
        m_severity(0),
        m_tags(),
        m_data(""),
        m_match(""),
        m_message(""),
        m_reference(""),
        m_transaction(transaction),
        m_rule(nullptr)
    { }


    void clean() {
        m_data = "";
        m_match = "";
        m_reference = "";
        m_severity = 0;
    }

    std::string log() {
        return log(this, 0);
    }
    std::string log(int props) {
        return log(this, props);
    }
    std::string log(int props, int responseCode) {
        return log(this, props, responseCode);
    }
    std::string errorLog() {
        return log(this,
		ClientLogMessageInfo | ErrorLogTailLogMessageInfo);
    }

    static std::string log(const RuleMessage *rm, int props, int code);
    static std::string log(const RuleMessage *rm, int props) {
        return log(rm, props, -1);
    }
    static std::string log(const RuleMessage *rm) {
        return log(rm, 0);
    }

    static std::string _details(const RuleMessage *rm);
    static std::string _errorLogTail(const RuleMessage *rm);

    const RuleWithActions *getRule() const;
    void setRule(const RuleWithActions *rule);
    bool isSettle() const;
    int getRuleId() const;
    int getPhase() const;
    std::string getFileName() const;
    int getLineNumber() const;
    std::string getRev() const;
    std::string getVer() const;
    int getMaturity() const;
    int getAccuracy() const;
    std::string getClientIpAddress() const;
    std::string getServerIpAddress() const;
    std::string getRequestId() const;
    std::string getUri() const;
    bool isDisruptive() const;

    bool toBeAuditLog() const;

    int m_severity;
    std::list<std::string> m_tags;

    // Transaction
    std::string m_data;
    std::string m_match;

    std::string m_message;
    std::string m_reference;

 private:
    Transaction *m_transaction;
    const RuleWithActions *m_rule;
};


}  // namespace modsecurity
#endif


#endif  // HEADERS_MODSECURITY_RULE_MESSAGE_H_