add tvbuff_zstd.c

epan/CMakeLists.txt

@@ -253,6 +253,7 @@ set(LIBWIRESHARK_NONGENERATED_FILES
 	tvbuff_real.c
 	tvbuff_subset.c
 	tvbuff_zlib.c
+	tvbuff_zstd.c
 	tvbuff_lz77.c
 	tvbuff_lz77huff.c
 	tvbuff_lznt1.c
@@ -418,7 +419,8 @@ set_target_properties(reassemble_test PROPERTIES
 )
 
 add_executable(tvbtest EXCLUDE_FROM_ALL tvbtest.c)
-target_link_libraries(tvbtest epan)
+# TODO: revert this change. linking to zstd was necessary for generating test data only.
+target_link_libraries(tvbtest epan ${ZSTD_LIBRARIES})
 set_target_properties(tvbtest PROPERTIES
 	FOLDER "Tests"
 	EXCLUDE_FROM_DEFAULT_BUILD True

epan/tvbuff.h

@@ -1109,6 +1109,24 @@ WS_DLL_PUBLIC tvbuff_t *tvb_uncompress_lznt1(tvbuff_t *tvb,
 WS_DLL_PUBLIC tvbuff_t *tvb_child_uncompress_lznt1(tvbuff_t *parent,
     tvbuff_t *tvb, const int offset, int comprlen);
 
+/**
+ * Uncompresses a ZSTD compressed payload inside a
+ * tvbuff at offset with length comprlen.  Returns an uncompressed
+ * tvbuffer if uncompression succeeded or NULL if uncompression
+ * failed.
+ */
+WS_DLL_PUBLIC tvbuff_t *tvb_uncompress_zstd(tvbuff_t *tvb,
+    const int offset, int comprlen);
+
+/**
+ * Uncompresses a ZSTD compressed payload inside a
+ * tvbuff at offset with length comprlen.  Returns an uncompressed
+ * tvbuffer if uncompression succeeded or NULL if uncompression
+ * failed.
+ */
+WS_DLL_PUBLIC tvbuff_t *tvb_child_uncompress_zstd(tvbuff_t *parent,
+    tvbuff_t *tvb, const int offset, int comprlen);
+
 /* From tvbuff_base64.c */
 
 /** Return a tvb that contains the binary representation of a base64

epan/tvbuff_zstd.c

@@ -0,0 +1,100 @@
+/* tvbuff_zstd.c
+ * Copyright 2022, Kevin Albertson <kevin.eric.albertson [AT] gmail.com>
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+/*
+ * Decompress ZSTD: http://facebook.github.io/zstd/
+ */
+
+#include "config.h"
+
+#ifdef HAVE_ZSTD
+#include <zstd.h>
+#endif
+
+#include "proto.h" // DISSECTOR_ASSERT_HINT
+#include "tvbuff.h"
+
+#include "tvbuff-int.h" // tvb_add_to_chain
+
+#define MAX_LOOP_ITERATIONS 100
+
+tvbuff_t *tvb_uncompress_zstd(tvbuff_t *tvb, const int offset, int comprlen)
+{
+#ifndef HAVE_ZSTD
+    // Cast to void to silence unused warnings.
+    (void)tvb;
+    (void)offset;
+    (void)comprlen;
+    return NULL;
+#else
+    ZSTD_inBuffer input = {tvb_memdup(NULL, tvb, offset, comprlen), comprlen, 0};
+    ZSTD_DStream *zds = ZSTD_createDStream();
+    size_t rc = 0;
+    tvbuff_t *composite_tvb = NULL;
+    bool ok = false;
+    int count = 0;
+
+    // ZSTD does not consume the last byte of the frame until it has flushed all of the decompressed data of the frame.
+    // Therefore, loop while there is more input.
+    ZSTD_outBuffer output = {g_malloc(ZSTD_DStreamOutSize()), ZSTD_DStreamOutSize(), 0};
+    while (input.pos < input.size && count < MAX_LOOP_ITERATIONS)
+    {
+        rc = ZSTD_decompressStream(zds, &output, &input);
+        if (ZSTD_isError(rc))
+        {
+            goto end;
+        }
+
+        if (!composite_tvb)
+        {
+            composite_tvb = tvb_new_composite();
+        }
+        tvbuff_t *output_tvb = tvb_new_real_data((guint8 *)output.dst, (guint)output.pos, (gint)output.pos);
+        tvb_set_free_cb(output_tvb, g_free);
+        tvb_composite_append(composite_tvb, output_tvb);
+        // Reset the output buffer.
+        output = (ZSTD_outBuffer){g_malloc(ZSTD_DStreamOutSize()), ZSTD_DStreamOutSize(), 0};
+        count++;
+        DISSECTOR_ASSERT_HINT(count < MAX_LOOP_ITERATIONS, "MAX_LOOP_ITERATIONS exceeded");
+    }
+
+    ok = true;
+end:
+    g_free((void *)output.dst);
+    wmem_free(NULL, (void *)input.src);
+    if (composite_tvb)
+    {
+        tvb_composite_finalize(composite_tvb);
+    }
+    ZSTD_freeDStream(zds);
+    if (ok)
+    {
+        return composite_tvb;
+    }
+
+    if (composite_tvb)
+    {
+        tvb_free(composite_tvb);
+    }
+
+    return NULL;
+#endif /* HAVE_ZSTD */
+}
+
+tvbuff_t *tvb_child_uncompress_zstd(tvbuff_t *parent, tvbuff_t *tvb, const int offset, int comprlen)
+{
+    tvbuff_t *uncompressed = tvb_uncompress_zstd(tvb, offset, comprlen);
+    if (!uncompressed)
+    {
+        return uncompressed;
+    }
+    tvb_add_to_chain(parent, uncompressed);
+    return uncompressed;
+}