Merge pull request #3209 from eduar-hte/cleanup_api

Add cleanup methods to complete C based ABI

Author: airween

examples/simple_example_using_c/test.c

@@ -68,6 +68,8 @@ int main (int argc, char **argv)
     msc_process_response_body(transaction);
     msc_process_logging(transaction);
 end:
+    if(error != NULL)
+        msc_rules_error_cleanup(error);
     msc_rules_cleanup(rules);
     msc_cleanup(modsec);
 

headers/modsecurity/rules_set.h

@@ -99,6 +99,7 @@ int msc_rules_add_remote(RulesSet *rules, const char *key, const char *uri,
     const char **error);
 int msc_rules_add_file(RulesSet *rules, const char *file, const char **error);
 int msc_rules_add(RulesSet *rules, const char *plain_rules, const char **error);
+void msc_rules_error_cleanup(const char *error);
 int msc_rules_cleanup(RulesSet *rules);
 
 #ifdef __cplusplus

headers/modsecurity/transaction.h

@@ -723,6 +723,9 @@ void msc_transaction_cleanup(Transaction *transaction);
 /** @ingroup ModSecurity_C_API */
 int msc_intervention(Transaction *transaction, ModSecurityIntervention *it);
 
+/** @ingroup ModSecurity_C_API */
+void msc_intervention_cleanup(ModSecurityIntervention *it);
+
 /** @ingroup ModSecurity_C_API */
 int msc_process_logging(Transaction *transaction);
 

src/rules_set.cc

@@ -311,6 +311,21 @@ extern "C" int msc_rules_add(RulesSet *rules, const char *plain_rules,
 }
 
 
+/**
+ * @name    msc_rules_error_cleanup
+ * @brief   Deallocates an error message buffer returned by a msc_rules_xxx function.
+ *
+ * This is a helper function to free the error message buffer allocated
+ * by a msc_rules_xxx function.
+ *
+ * @param error Error message pointer.
+ *
+ */
+extern "C" void msc_rules_error_cleanup(const char *error) {
+    free((void*) error);
+}
+
+
 extern "C" int msc_rules_cleanup(RulesSet *rules) {
     delete rules;
     return true;

src/transaction.cc

@@ -2273,6 +2273,22 @@ extern "C" int msc_intervention(Transaction *transaction,
 }
 
 
+/**
+ * @name    msc_intervention_cleanup
+ * @brief   Removes all the resources allocated by a given Intervention.
+ *
+ * This is a helper function to free any allocated buffers owned by the
+ * intervention.
+ *
+ * @param it ModSecurity intervention.
+ *
+ */
+extern "C" void msc_intervention_cleanup(ModSecurityIntervention *it) {
+    intervention::free(it);
+    intervention::clean(it);
+}
+
+
 /**
  * @name    msc_get_response_body
  * @brief   Retrieve a buffer with the updated response body.

test/benchmark/benchmark.cc

@@ -73,7 +73,7 @@ int main(int argc, char *argv[]) {
     modsecurity::ModSecurity *modsec;
     modsecurity::RulesSet *rules;
     modsecurity::ModSecurityIntervention it;
-    modsecurity::intervention::reset(&it);
+    modsecurity::intervention::clean(&it);
     modsec = new modsecurity::ModSecurity();
     modsec->setConnectorInformation("ModSecurity-benchmark v0.0.1-alpha" \
             " (ModSecurity benchmark utility)");
@@ -167,6 +167,8 @@ int main(int argc, char *argv[]) {
 next_request:
         modsecTransaction->processLogging();
         delete modsecTransaction;
+        modsecurity::intervention::free(&it);
+        modsecurity::intervention::clean(&it);
     }
 
     delete rules;