Pull request #3593: Wizard: client_first option deprecated

Merge in SNORT/snort3 from ~ANOROKH/snort3:doc_wiz_deprec to master

Squashed commit of the following:

commit 6a684948e243332335f4633460c0286c562eeab3
Author: AnnaNorokh <annanorokh15@gmail.comm>
Date:   Mon Sep 19 15:08:31 2022 +0300

    wizard: deprecate client_first option

diff --git a/doc/user/wizard.txt b/doc/user/wizard.txt
index 92698ff6372462ffe4916dafaab57f0718a46439..1605967557c7ab9075914009c5b8830479ca564b 100644 (file)
--- a/doc/user/wizard.txt
+++ b/doc/user/wizard.txt
@@ -55,7 +55,7 @@ contain following options:
 
   * 'service' - name of the service that would be assigned
   * 'proto' - protocol to scan
-  * 'client_first' - indicator of which end initiates data transfer
+  * 'client_first' - indicator of which end initiates data transfer (deprecated)
   * 'to_server' - list of text patterns to search in the data sent to the client
   * 'to_client' - list of text patterns to search in the data sent to the server
 

diff --git a/src/service_inspectors/wizard/wiz_module.cc b/src/service_inspectors/wizard/wiz_module.cc
index 4d725f3f7bc38f73fb9a76ad9fe6acfc894423f4..bcc79f56dbf4b8e5fb791935859c7bdbb4f8b00b 100644 (file)
--- a/src/service_inspectors/wizard/wiz_module.cc
+++ b/src/service_inspectors/wizard/wiz_module.cc
@@ -55,7 +55,7 @@ static const Parameter wizard_hexes_params[] =
       "protocol to scan" },
 
     { "client_first", Parameter::PT_BOOL, nullptr, "true",
-      "which end initiates data transfer" },
+      "which end initiates data transfer (deprecated)" },
 
     { "to_server", Parameter::PT_LIST, wizard_hex_param, nullptr,
       "sequence of data with wild chars (?)" },
@@ -83,7 +83,7 @@ static const Parameter wizard_spells_params[] =
       "protocol to scan" },
 
     { "client_first", Parameter::PT_BOOL, nullptr, "true",
-      "which end initiates data transfer" },
+      "which end initiates data transfer (deprecated)" },
 
     { "to_server", Parameter::PT_LIST, wizard_spell_param, nullptr,
       "list of initial tokens with wild cards (*)" },