Pull request #4234: Rename Kaizen to Snort ML.

Merge in SNORT/snort3 from ~OSHUMEIK/snort3:rename_ml to master

Squashed commit of the following:

commit 7508b261bf66ef79e93ae300c5dee1287898b294
Author: Oleksii Shumeiko <oshumeik@cisco.com>
Date:   Fri Mar 1 15:55:49 2024 +0200

    kaizen: rename to Snort ML

diff --git a/configure_cmake.sh b/configure_cmake.sh
index ad93cc69a4f4ba92a809538ea23308194df00996..9b312d6c5e79e84f18854fad104425b0f5724886 100755 (executable)
--- a/configure_cmake.sh
+++ b/configure_cmake.sh
@@ -124,7 +124,7 @@ Optional Packages:
                             libml include directory
     --with-libml-libraries=DIR
                             libml library directory
-    --without-libml         build Kaizen ML with mock of LibML
+    --without-libml         build Snort ML with mock of LibML
 
 Some influential variable definitions:
     SIGNAL_SNORT_RELOAD=<int>

diff --git a/src/network_inspectors/kaizen/dev_notes.txt b/src/network_inspectors/kaizen/dev_notes.txt
index 08a0d0df129174c9e5c648d7a81fa88b1ccf1e4c..b8a3dc0a013c26e048981e74fd27260ff677cbe8 100644 (file)
--- a/src/network_inspectors/kaizen/dev_notes.txt
+++ b/src/network_inspectors/kaizen/dev_notes.txt
@@ -1,21 +1,21 @@
-Kaizen ML is a neural network-based exploit detector for the Snort intrusion
+Snort ML is a neural network-based exploit detector for the Snort intrusion
 prevention system. It is designed to not only learn to detect known attacks
 from training data, but also learn to detect attacks it has never seen before.
 
-Kaizen uses TensorFlow, included as LibML library.
+Snort ML uses TensorFlow, included as LibML library.
 
 Global configuration sets the trained network model to use. For example:
 
-    kaizen_ml_engine.http_param_model = { 'model.file' }
+    snort_ml_engine.http_param_model = { 'model.file' }
 
 While per policy configuration sets data source and inspection depth in
 the selected Inspection policy. The following example enables two sources,
 HTTP URI and HTTP body:
 
-    kaizen_ml.uri_depth = -1
-    kaizen_ml.client_body_depth = 100
+    snort_ml.uri_depth = -1
+    snort_ml.client_body_depth = 100
 
 Trace messages are available:
 
-* trace.modules.kaizen_ml.classifier turns on messages from Kaizen
+* trace.modules.snort_ml.classifier turns on messages from Snort ML
 

diff --git a/src/network_inspectors/kaizen/kaizen_engine.cc b/src/network_inspectors/kaizen/kaizen_engine.cc
index 2e592e72ca393ac6e816ab58164af0510031e0ef..38c45106de6b7840a7ad8fba029a2587e2954e1b 100644 (file)
--- a/src/network_inspectors/kaizen/kaizen_engine.cc
+++ b/src/network_inspectors/kaizen/kaizen_engine.cc
@@ -123,7 +123,7 @@ string KaizenEngine::read_model()
 
     if (!get_config_file(hint, path) || !get_file_size(path, size))
     {
-        ParseError("kaizen_ml_engine: could not read model file: %s", hint);
+        ParseError("snort_ml_engine: could not read model file: %s", hint);
         return {};
     }
 
@@ -131,13 +131,13 @@ string KaizenEngine::read_model()
 
     if (!file.is_open())
     {
-        ParseError("kaizen_ml_engine: could not read model file: %s", hint);
+        ParseError("snort_ml_engine: could not read model file: %s", hint);
         return {};
     }
 
     if (size == 0)
     {
-        ParseError("kaizen_ml_engine: empty model file: %s", hint);
+        ParseError("snort_ml_engine: empty model file: %s", hint);
         return {};
     }
 

diff --git a/src/network_inspectors/kaizen/kaizen_engine.h b/src/network_inspectors/kaizen/kaizen_engine.h
index c0961ff554c9933b04e15326fb0fc383bfb3be51..7c7381ba5244db5a17f81c2744138804d3f50739 100644 (file)
--- a/src/network_inspectors/kaizen/kaizen_engine.h
+++ b/src/network_inspectors/kaizen/kaizen_engine.h
@@ -24,7 +24,7 @@
 #include "framework/inspector.h"
 
 
-#define KZ_ENGINE_NAME "kaizen_ml_engine"
+#define KZ_ENGINE_NAME "snort_ml_engine"
 #define KZ_ENGINE_HELP "configure machine learning engine settings"
 
 class BinaryClassifier;

diff --git a/src/network_inspectors/kaizen/kaizen_inspector.cc b/src/network_inspectors/kaizen/kaizen_inspector.cc
index d77022ec5a6de885c5d16a2affb8ea01434c20e0..10744ba6087793cdd0baa22418e6cc7dc46c36da 100644 (file)
--- a/src/network_inspectors/kaizen/kaizen_inspector.cc
+++ b/src/network_inspectors/kaizen/kaizen_inspector.cc
@@ -179,7 +179,7 @@ bool Kaizen::configure(SnortConfig* sc)
 
     if(!InspectorManager::get_inspector(KZ_ENGINE_NAME, true, sc))
     {
-        ParseError("kaizen_ml requires %s to be configured in the global policy.", KZ_ENGINE_NAME);
+        ParseError("snort_ml requires %s to be configured in the global policy.", KZ_ENGINE_NAME);
         return false;
     }
 

diff --git a/src/network_inspectors/kaizen/kaizen_module.cc b/src/network_inspectors/kaizen/kaizen_module.cc
index a0d99c56ea7fd1c0dc9cb1ffb1b92f2d8237c25c..3baec15ef5b6457f68c01a96804c8c48a185c9ce 100644 (file)
--- a/src/network_inspectors/kaizen/kaizen_module.cc
+++ b/src/network_inspectors/kaizen/kaizen_module.cc
@@ -46,7 +46,7 @@ static const Parameter kaizen_params[] =
 
 static const RuleMap kaizen_rules[] =
 {
-    { KZ_SID, "potential threat found in http parameters via Neural Network Based Exploit Detection" },
+    { KZ_SID, "potential threat found in HTTP parameters via Neural Network Based Exploit Detection" },
     { 0, nullptr }
 };
 
@@ -63,7 +63,7 @@ static const PegInfo peg_names[] =
 #ifdef DEBUG_MSGS
 static const TraceOption kaizen_trace_options[] =
 {
-    { "classifier", TRACE_CLASSIFIER, "enable Kaizen ML classifier trace logging" },
+    { "classifier", TRACE_CLASSIFIER, "enable Snort ML classifier trace logging" },
     { nullptr, 0, nullptr }
 };
 #endif
@@ -103,7 +103,7 @@ bool KaizenModule::end(const char*, int, snort::SnortConfig*)
 {
     if (!conf.uri_depth && !conf.client_body_depth)
         ParseWarning(WARN_CONF,
-            "If neither of Kaizen ML source depth is set, it won't process traffic.");
+            "Neither of snort_ml source depth is set, snort_ml won't process traffic.");
 
     return true;
 }

diff --git a/src/network_inspectors/kaizen/kaizen_module.h b/src/network_inspectors/kaizen/kaizen_module.h
index da2fce4449ac884de736dd52fbedeb2c78249e45..59624bddf3e4652d0ffc4aef76a2d42fd47721f7 100644 (file)
--- a/src/network_inspectors/kaizen/kaizen_module.h
+++ b/src/network_inspectors/kaizen/kaizen_module.h
@@ -28,7 +28,7 @@
 #define KZ_GID 411
 #define KZ_SID 1
 
-#define KZ_NAME "kaizen_ml"
+#define KZ_NAME "snort_ml"
 #define KZ_HELP "machine learning based exploit detector"
 
 enum { TRACE_CLASSIFIER };