Support --enable-debug-logs=no option of configure script (owasp-modsecurity#2)

michaelgranzow-avi · Abhi Joglekar · commit c3cb094d90e9 · 2017-08-22T21:05:05.000Z
* Support --enable-debug-logs=no option of configure script

* Undo unintended white space changes

* Undo more unintended white space changes

* Address review comments - thanks Mirko

* Address more review comments - thanks Mirko
diff --git a/src/actions/ctl/rule_engine.cc b/src/actions/ctl/rule_engine.cc
@@ -50,7 +50,9 @@ bool RuleEngine::evaluate(Rule *rule, Transaction *transaction) {
     a << modsecurity::RulesProperties::ruleEngineStateString(m_ruleEngine);
     a << " as requested by a ctl:ruleEngine action";
 
+#ifndef NO_LOGS
     transaction->debug(8, a.str());
+#endif
 
     transaction->m_secRuleEngine = m_ruleEngine;
     return true;
diff --git a/src/actions/disruptive/allow.cc b/src/actions/disruptive/allow.cc
@@ -49,9 +49,11 @@ bool Allow::init(std::string *error) {
 
 
 bool Allow::evaluate(Rule *rule, Transaction *transaction) {
+#ifndef NO_LOGS
     transaction->debug(4, "Dropping the evaluation of upcoming rules " \
         "in favor of an `allow' action of type: " \
         + allowTypeToName(m_allowType));
+#endif
 
     transaction->m_allowType = m_allowType;
 
diff --git a/src/actions/disruptive/block.cc b/src/actions/disruptive/block.cc
@@ -32,7 +32,9 @@ namespace disruptive {
 
 bool Block::evaluate(Rule *rule, Transaction *transaction,
     std::shared_ptr<RuleMessage> rm) {
+#ifndef NO_LOGS
     transaction->debug(8, "Marking request as disruptive.");
+#endif
 
     for (Action *a : transaction->m_rules->m_defaultActions[rule->m_phase]) {
         if (a->isDisruptive() == false) {
diff --git a/src/actions/disruptive/pass.cc b/src/actions/disruptive/pass.cc
@@ -33,7 +33,9 @@ bool Pass::evaluate(Rule *rule, Transaction *transaction,
     intervention::free(&transaction->m_it);
     intervention::reset(&transaction->m_it);
 
+#ifndef NO_LOGS
     transaction->debug(8, "Running action pass");
+#endif
 
     return true;
 }
diff --git a/src/actions/init_col.cc b/src/actions/init_col.cc
@@ -71,8 +71,10 @@ bool InitCol::evaluate(Rule *rule, Transaction *t) {
         return false;
     }
 
+#ifndef NO_LOGS
     t->debug(5, "Collection `" + m_collection_key + "' initialized with " \
         "value: " + collectionName);
+#endif
 
     return true;
 }
diff --git a/src/actions/log.cc b/src/actions/log.cc
@@ -30,7 +30,9 @@ namespace actions {
 
 bool Log::evaluate(Rule *rule, Transaction *transaction,
     std::shared_ptr<RuleMessage> rm) {
+#ifndef NO_LOGS
     transaction->debug(9, "Saving transaction to logs");
+#endif
     rm->m_saveMessage = true;
     return true;
 }
diff --git a/src/actions/msg.cc b/src/actions/msg.cc
@@ -51,7 +51,9 @@ bool Msg::evaluate(Rule *rule, Transaction *transaction,
     std::shared_ptr<RuleMessage> rm) {
     std::string msg = data(transaction);
     rm->m_message = msg;
+#ifndef NO_LOGS
     transaction->debug(9, "Saving msg: " + msg);
+#endif
 
     transaction->m_collections.storeOrUpdateFirst("RULE:msg", msg);
 
diff --git a/src/audit_log/audit_log.cc b/src/audit_log/audit_log.cc
@@ -276,26 +276,34 @@ bool AuditLog::saveIfRelevant(Transaction *transaction, int parts) {
     if ((m_status == RelevantOnlyAuditLogStatus
         && this->isRelevant(transaction->m_httpCodeReturned) == false)
         && saveAnyway == false) {
+#ifndef NO_LOGS
         transaction->debug(9, "Return code `" +
             std::to_string(transaction->m_httpCodeReturned) + "'" \
             " is not interesting to audit logs, relevant code(s): `" +
             m_relevant + "'.");
+#endif
 
         return false;
     }
 
     if (parts == -1) {
         parts = m_parts;
     }
+#ifndef NO_LOGS
     transaction->debug(5, "Saving this request as part " \
             "of the audit logs.");
+#endif
     if (m_writer == NULL) {
+#ifndef NO_LOGS
         transaction->debug(1, "Internal error, audit log writer is null");
+#endif
     } else {
         std::string error;
         bool a = m_writer->write(transaction, parts, &error);
         if (a == false) {
+#ifndef NO_LOGS
             transaction->debug(1, "Cannot save the audit log: " + error);
+#endif
             return false;
         }
     }
diff --git a/src/audit_log/writer/https.cc b/src/audit_log/writer/https.cc
@@ -47,7 +47,9 @@ bool Https::init(std::string *error) {
 
 bool Https::write(Transaction *transaction, int parts, std::string *error) {
     Utils::HttpsClient m_http_client;
+#ifndef NO_LOGS
     transaction->debug(7, "Sending logs to: " + m_audit->m_path1);
+#endif
 
     std::string log = transaction->toJSON(parts);
     m_http_client.setRequestType("application/json");
diff --git a/src/macro_expansion.cc b/src/macro_expansion.cc
@@ -301,12 +301,14 @@ std::string MacroExpansion::expand(const std::string& input,
             }
         }
 
+#ifndef NO_LOGS
         if (variableValue) {
             transaction->debug(6, "Resolving: " + variable + " to: " +
                 *variableValue);
         } else {
             transaction->debug(6, "Resolving: " + variable + " to: NULL");
         }
+#endif
         res.erase(start, end - start + 1);
         if (res[start] == '%') {
             res.erase(start, 1);
diff --git a/src/operators/pm.cc b/src/operators/pm.cc
@@ -99,8 +99,10 @@ bool Pm::evaluate(Transaction *transaction, Rule *rule,
     if (capture && transaction && rc) {
         transaction->m_collections.storeOrUpdateFirst("TX", "0",
             std::string(match));
+#ifndef NO_LOGS
         transaction->debug(7, "Added pm match TX.0: " + \
             std::string(match));
+#endif
     }
 
     return rc > 0;
diff --git a/src/operators/rx.cc b/src/operators/rx.cc
@@ -45,8 +45,10 @@ bool Rx::evaluate(Transaction *transaction, Rule *rule,
         for (const SMatch& a : matches) {
             transaction->m_collections.storeOrUpdateFirst("TX",
                 std::to_string(i), a.match);
+#ifndef NO_LOGS
             transaction->debug(7, "Added regex subexpression TX." +
                 std::to_string(i) + ": " + a.match);
+#endif
             transaction->m_matched.push_back(a.match);
             i++;
         }
diff --git a/src/operators/validate_dtd.cc b/src/operators/validate_dtd.cc
@@ -50,19 +50,25 @@ bool ValidateDTD::evaluate(Transaction *t, const std::string &str) {
     if (m_dtd == NULL) {
         std::string err = std::string("XML: Failed to load DTD: ") \
             + m_resource;
+#ifndef NO_LOGS
         t->debug(4, err);
+#endif
         return true;
     }
 
     if (t->m_xml->m_data.doc == NULL) {
+#ifndef NO_LOGS
         t->debug(4, "XML document tree could not "\
             "be found for DTD validation.");
+#endif
         return true;
     }
 
     if (t->m_xml->m_data.well_formed != 1) {
+#ifndef NO_LOGS
         t->debug(4, "XML: DTD validation failed because " \
             "content is not well formed.");
+#endif
         return true;
     }
 
@@ -78,7 +84,9 @@ bool ValidateDTD::evaluate(Transaction *t, const std::string &str) {
 
     cvp = xmlNewValidCtxt();
     if (cvp == NULL) {
+#ifndef NO_LOGS
         t->debug(4, "XML: Failed to create a validation context.");
+#endif
         return true;
     }
 
@@ -88,13 +96,17 @@ bool ValidateDTD::evaluate(Transaction *t, const std::string &str) {
     cvp->userData = t;
 
     if (!xmlValidateDtd(cvp, t->m_xml->m_data.doc, m_dtd)) {
+#ifndef NO_LOGS
         t->debug(4, "XML: DTD validation failed.");
+#endif
         xmlFreeValidCtxt(cvp);
         return true;
     }
 
+#ifndef NO_LOGS
     t->debug(4, std::string("XML: Successfully validated " \
         "payload against DTD: ") + m_resource);
+#endif
 
     xmlFreeValidCtxt(cvp);
 
diff --git a/src/operators/validate_dtd.h b/src/operators/validate_dtd.h
@@ -62,7 +62,9 @@ class ValidateDTD : public Operator {
         if (len > 0) {
             s = "XML Error: " + std::string(buf);
         }
+#ifndef NO_LOGS
         t->debug(4, s);
+#endif
     }
 
 
@@ -79,7 +81,9 @@ class ValidateDTD : public Operator {
         if (len > 0) {
             s = "XML Warning: " + std::string(buf);
         }
+#ifndef NO_LOGS
         t->debug(4, s);
+#endif
     }
 
 
diff --git a/src/operators/validate_schema.cc b/src/operators/validate_schema.cc
@@ -50,7 +50,9 @@ bool ValidateSchema::evaluate(Transaction *t,
         if (m_err.empty() == false) {
             err << m_err;
         }
+#ifndef NO_LOGS
         t->debug(4, err.str());
+#endif
         return true;
     }
 
@@ -73,7 +75,9 @@ bool ValidateSchema::evaluate(Transaction *t,
         if (m_err.empty() == false) {
             err << " " << m_err;
         }
+#ifndef NO_LOGS
         t->debug(4, err.str());
+#endif
         xmlSchemaFreeParserCtxt(m_parserCtx);
         return true;
     }
@@ -84,7 +88,9 @@ bool ValidateSchema::evaluate(Transaction *t,
         if (m_err.empty() == false) {
             err << " " << m_err;
         }
+#ifndef NO_LOGS
         t->debug(4, err.str());
+#endif
         return true;
     }
 
@@ -94,36 +100,46 @@ bool ValidateSchema::evaluate(Transaction *t,
         (xmlSchemaValidityWarningFunc)warn_runtime, t);
 
     if (t->m_xml->m_data.doc == NULL) {
+#ifndef NO_LOGS
         t->debug(4, "XML document tree could not be found for " \
             "schema validation.");
+#endif
         return true;
     }
 
     if (t->m_xml->m_data.well_formed != 1) {
+#ifndef NO_LOGS
         t->debug(4, "XML: Schema validation failed because " \
             "content is not well formed.");
+#endif
         return true;
     }
 
     /* Make sure there were no other generic processing errors */
     /*
     if (msr->msc_reqbody_error) {
+#ifndef NO_LOGS
         t->debug(4, "XML: Schema validation could not proceed due to previous"
                 " processing errors.");
+#endif
         return true;
     }
     */
 
     rc = xmlSchemaValidateDoc(m_validCtx, t->m_xml->m_data.doc);
     if (rc != 0) {
-       t->debug(4, "XML: Schema validation failed.");
+#ifndef NO_LOGS
+        t->debug(4, "XML: Schema validation failed.");
+#endif
         xmlSchemaFree(m_schema);
         xmlSchemaFreeParserCtxt(m_parserCtx);
         return true; /* No match. */
     }
 
+#ifndef NO_LOGS
     t->debug(4, "XML: Successfully validated payload against " \
         "Schema: " + m_resource);
+#endif
 
     return false;
 }
diff --git a/src/operators/validate_schema.h b/src/operators/validate_schema.h
@@ -103,7 +103,9 @@ class ValidateSchema : public Operator {
         if (len > 0) {
             s = "XML Error: " + std::string(buf);
         }
+#ifndef NO_LOGS
         t->debug(4, s);
+#endif
     }
 
 
@@ -120,7 +122,9 @@ class ValidateSchema : public Operator {
         if (len > 0) {
             s = "XML Warning: " + std::string(buf);
         }
+#ifndef NO_LOGS
         t->debug(4, s);
+#endif
     }
 
     static void null_error(void *ctx, const char *msg, ...) {
diff --git a/src/request_body_processor/json.cc b/src/request_body_processor/json.cc
@@ -48,7 +48,9 @@ int JSON::yajl_map_key(void *ctx, const unsigned char *key, size_t length) {
      */
     safe_key.assign((const char *)key, length);
 
+#ifndef NO_LOGS
     tthis->debug(9, "New JSON hash key '" + safe_key + "'");
+#endif
 
     /**
      * TODO: How do we free the previously string value stored here?
@@ -128,8 +130,10 @@ int JSON::yajl_start_map(void *ctx) {
         tthis->m_data.prefix.assign(tthis->m_data.current_key);
     }
 
+#ifndef NO_LOGS
     tthis->debug(9, "New JSON hash context (prefix '" + \
         tthis->m_data.prefix + "')");
+#endif
 
     return 1;
 }
@@ -176,7 +180,9 @@ int JSON::addArgument(const std::string& value) {
      * to reference this argument; for now we simply ignore these
      */
     if (m_data.current_key.empty()) {
+#ifndef NO_LOGS
         debug(3, "Cannot add scalar value without an associated key");
+#endif
         return 1;
     }
 
@@ -245,7 +251,9 @@ JSON::JSON(Transaction *transaction) : m_transaction(transaction) {
     };
 
 
+#ifndef NO_LOGS
     debug(9, "JSON parser initialization");
+#endif
 
     /**
      * Prefix and current key are initially empty
@@ -261,15 +269,19 @@ JSON::JSON(Transaction *transaction) : m_transaction(transaction) {
      *
      * TODO: make UTF8 validation optional, as it depends on Content-Encoding
      */
+#ifndef NO_LOGS
     debug(9, "yajl JSON parsing callback initialization");
+#endif
     m_data.handle = yajl_alloc(&callbacks, NULL, this);
 
     yajl_config(m_data.handle, yajl_allow_partial_values, 0);
 }
 
 
 JSON::~JSON() {
+#ifndef NO_LOGS
     debug(9, "JSON: Cleaning up JSON results");
+#endif
     yajl_free(m_data.handle);
 }
 
diff --git a/src/request_body_processor/multipart.cc b/src/request_body_processor/multipart.cc
diff --git a/src/request_body_processor/xml.cc b/src/request_body_processor/xml.cc
diff --git a/src/rule.cc b/src/rule.cc
diff --git a/src/transaction.cc b/src/transaction.cc
diff --git a/src/variables/xml.cc b/src/variables/xml.cc

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,9 @@ bool Pass::evaluate(Rule rule, Transaction transaction,`
`33`	`33`	`intervention::free(&transaction->m_it);`
`34`	`34`	`intervention::reset(&transaction->m_it);`
`35`	`35`
	`36`	`+#ifndef NO_LOGS`
`36`	`37`	`transaction->debug(8, "Running action pass");`
	`38`	`+#endif`
`37`	`39`
`38`	`40`	`return true;`
`39`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,8 +71,10 @@ bool InitCol::evaluate(Rule rule, Transaction t) {`
`71`	`71`	`return false;`
`72`	`72`	`}`
`73`	`73`
	`74`	`+#ifndef NO_LOGS`
`74`	`75`	t->debug(5, "Collection `" + m_collection_key + "' initialized with " \
`75`	`76`	`"value: " + collectionName);`
	`77`	`+#endif`
`76`	`78`
`77`	`79`	`return true;`
`78`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,9 @@ namespace actions {`
`30`	`30`
`31`	`31`	`bool Log::evaluate(Rule rule, Transaction transaction,`
`32`	`32`	`std::shared_ptr<RuleMessage> rm) {`
	`33`	`+#ifndef NO_LOGS`
`33`	`34`	`transaction->debug(9, "Saving transaction to logs");`
	`35`	`+#endif`
`34`	`36`	`rm->m_saveMessage = true;`
`35`	`37`	`return true;`
`36`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -301,12 +301,14 @@ std::string MacroExpansion::expand(const std::string& input,`
`301`	`301`	`}`
`302`	`302`	`}`
`303`	`303`
	`304`	`+#ifndef NO_LOGS`
`304`	`305`	`if (variableValue) {`
`305`	`306`	`transaction->debug(6, "Resolving: " + variable + " to: " +`
`306`	`307`	`*variableValue);`
`307`	`308`	`} else {`
`308`	`309`	`transaction->debug(6, "Resolving: " + variable + " to: NULL");`
`309`	`310`	`}`
	`311`	`+#endif`
`310`	`312`	`res.erase(start, end - start + 1);`
`311`	`313`	`if (res[start] == '%') {`
`312`	`314`	`res.erase(start, 1);`