mirror of
https://github.com/owasp-modsecurity/ModSecurity.git
synced 2025-08-13 13:26:01 +03:00
- Avoids copying std::shared_ptr when lifetime of the RuleMessage is controlled by the caller. - The RuleMessage instance is created in RuleWithActions::evaluate and then used to call the overloaded version of this method that is specialized by subclasses. - Once the call to the overloaded method returns, the std::shared_ptr is destroyed as it's not stored by any of the callers, so it can be replaced with a stack variable and avoid paying the cost of copying the std::shared_ptr (and its control block that is guaranteed to be thread-safe and thus is not a straightforward pointer copy) - Introduced RuleMessage::reset because this is required by RuleWithActions::performLogging when it's not the 'last log', the rule has multimatch and it's to be logged. - The current version is creating allocating another instance of RuleMessage on the heap to copy the Rule & Transaction related state while all the other members in the RuleMessage are set to their default values. - The new version leverages the existent, unused and incomplete function 'clean' (renamed as 'reset') to do this on the current instance. - Notice that the current code preserves the value of m_saveMessage, so 'reset' provides an argument for the caller to control whether this member should be reinitialized.
114 lines
2.6 KiB
C++
114 lines
2.6 KiB
C++
/*
|
|
* ModSecurity, http://www.modsecurity.org/
|
|
* Copyright (c) 2015 - 2021 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.
|
|
*
|
|
*/
|
|
|
|
#ifndef HEADERS_MODSECURITY_RULE_H_
|
|
#define HEADERS_MODSECURITY_RULE_H_
|
|
|
|
#include "modsecurity/transaction.h"
|
|
#include "modsecurity/modsecurity.h"
|
|
#include "modsecurity/variable_value.h"
|
|
|
|
#ifdef __cplusplus
|
|
|
|
#include <vector>
|
|
#include <string>
|
|
#include <list>
|
|
#include <memory>
|
|
#include <utility>
|
|
|
|
namespace modsecurity {
|
|
namespace variables {
|
|
class Variable;
|
|
class Variables;
|
|
}
|
|
namespace actions {
|
|
class Action;
|
|
class Severity;
|
|
class LogData;
|
|
class Msg;
|
|
class Rev;
|
|
class SetVar;
|
|
class Tag;
|
|
namespace transformations {
|
|
class Transformation;
|
|
}
|
|
}
|
|
namespace operators {
|
|
class Operator;
|
|
}
|
|
|
|
using TransformationResult = std::pair<std::string,
|
|
std::shared_ptr<std::string>>;
|
|
using TransformationResults = std::list<TransformationResult>;
|
|
|
|
using Transformation = actions::transformations::Transformation;
|
|
using Transformations = std::vector<Transformation *>;
|
|
|
|
using Actions = std::vector<actions::Action *>;
|
|
|
|
using Tags = std::vector<actions::Tag *>;
|
|
using SetVars = std::vector<actions::SetVar *>;
|
|
using MatchActions = std::vector<actions::Action *>;
|
|
|
|
class Rule {
|
|
public:
|
|
Rule(const std::string &fileName, int lineNumber)
|
|
: m_fileName(fileName),
|
|
m_lineNumber(lineNumber),
|
|
m_phase(modsecurity::Phases::RequestHeadersPhase) {
|
|
}
|
|
|
|
Rule(const Rule &other) = delete;
|
|
|
|
Rule &operator=(const Rule &other) = delete;
|
|
|
|
virtual ~Rule() {}
|
|
|
|
virtual bool evaluate(Transaction *transaction) = 0;
|
|
|
|
virtual bool evaluate(Transaction *transaction, RuleMessage &ruleMessage) = 0;
|
|
|
|
const std::string& getFileName() const {
|
|
return m_fileName;
|
|
}
|
|
|
|
int getLineNumber() const {
|
|
return m_lineNumber;
|
|
}
|
|
|
|
int getPhase() const { return m_phase; }
|
|
void setPhase(int phase) { m_phase = phase; }
|
|
|
|
virtual std::string getReference() {
|
|
return m_fileName + ":" + std::to_string(m_lineNumber);
|
|
}
|
|
|
|
|
|
virtual bool isMarker() { return false; }
|
|
|
|
private:
|
|
const std::string m_fileName;
|
|
const int m_lineNumber;
|
|
// FIXME: phase may not be neede to SecMarker.
|
|
int m_phase;
|
|
};
|
|
|
|
|
|
} // namespace modsecurity
|
|
#endif
|
|
|
|
|
|
#endif // HEADERS_MODSECURITY_RULE_H_
|