]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
http-log: deprecate
authorJason Ish <jason.ish@oisf.net>
Thu, 29 Aug 2024 14:31:05 +0000 (08:31 -0600)
committerVictor Julien <victor@inliniac.net>
Fri, 30 Aug 2024 13:19:02 +0000 (15:19 +0200)
http-log is now deprecated and will be removed in Suricata
9.0. Display a deprecation notice on use, and add notes to the
userguide.

Issue: #6543

doc/userguide/configuration/suricata-yaml.rst
doc/userguide/output/custom-http-logging.rst
doc/userguide/upgrade.rst
src/log-httplog.c
suricata.yaml.in

index 4c0516e088b4d6f61d64126ffe86d8ad58a2996b..75cf05a7af672579bb0cef36a57b85bf46e4a117 100644 (file)
@@ -424,6 +424,9 @@ Example:
 A line based log of HTTP requests (http.log)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. attention:: http-log is deprecated in Suricata 8.0 and will be
+               removed in Suricata 9.0.
+
 This log keeps track of all HTTP-traffic events. It contains the HTTP
 request, hostname, URI and the User-Agent. This information will be
 stored in the http.log (default name, in the suricata log
index e4ab4076436d04f0ae32bd6141b7b07dc32961c5..3b683337e86ebd0be145098f02c977e52c1495f7 100644 (file)
@@ -1,6 +1,9 @@
 Custom http logging
 ===================
 
+.. attention:: http-log is deprecated in Suricata 8.0 and will be
+               removed in Suricata 9.0.
+
 In your Suricata.yaml, find the http-log section and edit as follows:
 
 
index e8d811e69f9893fa34db010010231b94674a92f1..591ca986eafa3200fbe2e8379a6788a391640cea 100644 (file)
@@ -76,6 +76,10 @@ Removals
 ~~~~~~~~
 - The ssh keywords ``ssh.protoversion`` and ``ssh.softwareversion`` have been removed.
 
+Deprecations
+~~~~~~~~~~~~
+- The ``http-log`` output is now deprecated and will be removed in Suricata 9.0.
+
 Upgrading 6.0 to 7.0
 --------------------
 
index ee561f5609ea0e3fd9bcb233e8db8d7d4ee94702..87848100724af20ae3e6c167397dd26116ed1bd9 100644 (file)
@@ -547,6 +547,7 @@ TmEcode LogHttpLogThreadDeinit(ThreadVars *t, void *data)
  * */
 OutputInitResult LogHttpLogInitCtx(ConfNode *conf)
 {
+    SCLogWarning("The http-log output has been deprecated and will be removed in Suricata 9.0.");
     OutputInitResult result = { NULL, false };
     LogFileCtx* file_ctx = LogFileNewCtx();
     if(file_ctx == NULL) {
index 3aacfc569fa36c1fc033fae73dd31d112518954c..a8a63ec357ea3669bd7b5adcd9f7686d50c0f3da 100644 (file)
@@ -352,16 +352,6 @@ outputs:
         #   state-update: false             # log packets triggering a TCP state update
         #   spurious-retransmission: false  # log spurious retransmission packets
 
-  # a line based log of HTTP requests (no alerts)
-  - http-log:
-      enabled: no
-      filename: http.log
-      append: yes
-      #extended: yes     # enable this for extended logging information
-      #custom: yes       # enable the custom logging format (defined by customformat)
-      #customformat: "%{%D-%H:%M:%S}t.%z %{X-Forwarded-For}i %H %m %h %u %s %B %a:%p -> %A:%P"
-      #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
-
   # a line based log of TLS handshake parameters (no alerts)
   - tls-log:
       enabled: no  # Log TLS connections.