libextractor

fuzz_plugin_name.h (14426B)

---

 /*
      This file is part of libextractor.
      Copyright (C) 2026 Christian Grothoff
 
      libextractor is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
      by the Free Software Foundation; either version 3, or (at your
      option) any later version.
 
      libextractor is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      General Public License for more details.
 
      You should have received a copy of the GNU General Public License
      along with libextractor; see the file COPYING.  If not, write to the
      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
      Boston, MA 02110-1301, USA.
  */
 /**
  * @file fuzz/fuzz_plugin_name.h
  * @brief per-plugin compile-time configuration of fuzz_plugin.c
  * @author Christian Grothoff
  *
  * fuzz_plugin.c is compiled once per plugin.  The Makefile passes two
  * defines per target:
  *
  *   -DLE_FUZZ_PLUGIN=gif     the plugin's short name, used to build the
  *                            symbol names EXTRACTOR_gif_extract_method()
  *                            and EXTRACTOR_gif_options()
  *   -DLE_FUZZ_ID=GIF         selects the format description below
  *
  * The description is only used by the *generator* (the built-in driver's
  * structure-aware input synthesiser).  It is not a correctness
  * constraint: getting it wrong costs coverage, never soundness, and a
  * plugin with no entry here simply gets random bytes.
  *
  * To add a plugin: give it an LE_ID_* number, add the `#elif` block with
  * its magic and body shape, and add the target to Makefile.am.
  */
 #ifndef LE_FUZZ_PLUGIN_NAME_H
 #define LE_FUZZ_PLUGIN_NAME_H 1
 
 #ifndef LE_FUZZ_PLUGIN
 #error "fuzz_plugin.c must be compiled with -DLE_FUZZ_PLUGIN=<short name>"
 #endif
 #ifndef LE_FUZZ_ID
 #error "fuzz_plugin.c must be compiled with -DLE_FUZZ_ID=<ID>"
 #endif
 
 #define LE_FUZZ_CAT2(a, b) a ## b
 #define LE_FUZZ_CAT(a, b) LE_FUZZ_CAT2 (a, b)
 #define LE_FUZZ_STR2(a) # a
 #define LE_FUZZ_STR(a) LE_FUZZ_STR2 (a)
 
 /**
  * The plugin's short name as a string literal, e.g. "gif".
  */
 #define LE_FUZZ_PLUGIN_STR LE_FUZZ_STR (LE_FUZZ_PLUGIN)
 
 /**
  * Name of the plugin's mandatory entry point.
  */
 #define LE_FUZZ_EXTRACT_METHOD \
         LE_FUZZ_CAT (LE_FUZZ_CAT (EXTRACTOR_, LE_FUZZ_PLUGIN), _extract_method)
 
 /**
  * Name of the plugin's optional configuration hook.
  */
 #define LE_FUZZ_OPTIONS_METHOD \
         LE_FUZZ_CAT (LE_FUZZ_CAT (EXTRACTOR_, LE_FUZZ_PLUGIN), _options)
 
 
 /* Body shapes; must match enum le_fuzz_shape in fuzz_plugin.c.  They are
    spelled as plain integers here because this header is included before
    that enum exists. */
 #define LE_SHAPE_RAW      0
 #define LE_SHAPE_CHUNK_BE 1
 #define LE_SHAPE_CHUNK_LE 2
 #define LE_SHAPE_TEXT     3
 #define LE_SHAPE_ZIP      4
 
 #define LE_ID_APPLEFILE  1
 #define LE_ID_ARCHIVE    2
 #define LE_ID_DEB        3
 #define LE_ID_DVI        4
 #define LE_ID_ELF        5
 #define LE_ID_FLAC       6
 #define LE_ID_GIF        7
 #define LE_ID_HTML       8
 #define LE_ID_IT         9
 #define LE_ID_JPEG      10
 #define LE_ID_MAN       11
 #define LE_ID_MIME      12
 #define LE_ID_MPEG      13
 #define LE_ID_MSOFFICE  14
 #define LE_ID_NSF       15
 #define LE_ID_NSFE      16
 #define LE_ID_ODF       17
 #define LE_ID_OGG       18
 #define LE_ID_PNG       19
 #define LE_ID_PS        20
 #define LE_ID_QT        21
 #define LE_ID_REAL      22
 #define LE_ID_RIFF      23
 #define LE_ID_RTF       24
 #define LE_ID_S3M       25
 #define LE_ID_SID       26
 #define LE_ID_TIFF      27
 #define LE_ID_WAV       28
 #define LE_ID_XM        29
 #define LE_ID_ZIP       30
 #define LE_ID_OLE2      31
 #define LE_ID_THUMBNAILFFMPEG 32
 #define LE_ID_PREVIEWOPUS     33
 #define LE_ID_PECOFF        34
 #define LE_ID_LNK           35
 #define LE_ID_SQLITE        36
 #define LE_ID_TAR           37
 #define LE_ID_ISO9660       38
 #define LE_ID_DISKIMAGE     39
 #define LE_ID_HEIF          40
 #define LE_ID_WEBP          41
 #define LE_ID_PLIST         42
 #define LE_ID_ID3           43
 #define LE_ID_GPX           44
 #define LE_ID_KML           45
 #define LE_ID_GEOTIFF       46
 #define LE_ID_MBOX          47
 #define LE_ID_APK           48
 #define LE_ID_EBOOK         49
 #define LE_ID_PDF           60
 #define LE_ID_THUMBNAILGST  70
 
 #define LE_FUZZ_IDVAL LE_FUZZ_CAT (LE_ID_, LE_FUZZ_ID)
 
 #if LE_FUZZ_IDVAL == LE_ID_APPLEFILE
 /* AppleSingle / AppleDouble: big-endian magic 0x00051600 / 0x00051607 */
 #define LE_FUZZ_MAGIC "\x00\x05\x16\x00\x00\x02\x00\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_ARCHIVE
 #define LE_FUZZ_MAGIC "!<arch>\n"
 #define LE_FUZZ_SHAPE LE_SHAPE_TEXT
 
 #elif LE_FUZZ_IDVAL == LE_ID_DEB
 #define LE_FUZZ_MAGIC "!<arch>\ndebian-binary   "
 #define LE_FUZZ_SHAPE LE_SHAPE_TEXT
 
 #elif LE_FUZZ_IDVAL == LE_ID_DVI
 /* DVI preamble: 0xF7 0x02 */
 #define LE_FUZZ_MAGIC "\xf7\x02"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 #define LE_FUZZ_CONFIGS NULL, "fulltext"
 
 #elif LE_FUZZ_IDVAL == LE_ID_PDF
 /* the interesting inputs are real documents: seed the corpus with
    testdata/pdf_*.pdf (make_seed_corpus.sh does) */
 #define LE_FUZZ_MAGIC "%PDF-1.4\n"
 #define LE_FUZZ_SHAPE LE_SHAPE_TEXT
 #define LE_FUZZ_CONFIGS NULL, "fulltext"
 
 #elif LE_FUZZ_IDVAL == LE_ID_ELF
 #define LE_FUZZ_MAGIC "\x7f" "ELF\x01\x01\x01\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_FLAC
 #define LE_FUZZ_MAGIC "fLaC"
 #define LE_FUZZ_SHAPE LE_SHAPE_CHUNK_BE
 
 #elif LE_FUZZ_IDVAL == LE_ID_GIF
 #define LE_FUZZ_MAGIC "GIF89a"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_HTML
 #define LE_FUZZ_MAGIC "<!DOCTYPE html>\n<html>"
 #define LE_FUZZ_SHAPE LE_SHAPE_TEXT
 #define LE_FUZZ_CONFIGS NULL, "fulltext"
 
 #elif LE_FUZZ_IDVAL == LE_ID_IT
 /* Impulse Tracker module */
 #define LE_FUZZ_MAGIC "IMPM"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_JPEG
 #define LE_FUZZ_MAGIC "\xff\xd8\xff\xe0\x00\x10JFIF\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_MAN
 #define LE_FUZZ_MAGIC ".TH "
 #define LE_FUZZ_SHAPE LE_SHAPE_TEXT
 
 #elif LE_FUZZ_IDVAL == LE_ID_MIME
 /* libmagic sniffs everything; no useful magic of our own */
 #define LE_FUZZ_MAGIC ""
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_THUMBNAILFFMPEG
 /* Ogg, which is what the media plugins are tested against; libmagic has
    to recognize it as video/* or the plugin declines to look at all */
 #define LE_FUZZ_MAGIC "OggS\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 #define LE_FUZZ_CONFIGS NULL, "srt:en", "gallery:4", \
         "gallery:9,format=png,srt:de", "size=32,gallery:100"
 
 #elif LE_FUZZ_IDVAL == LE_ID_THUMBNAILGST
 /* Matroska (EBML header with DocType "matroska"), what the srt and
    gallery options are tested against; libmagic has to call it video/*
    or the plugin declines to look at all */
 #define LE_FUZZ_MAGIC \
         "\x1a\x45\xdf\xa3\xa3\x42\x86\x81\x01\x42\xf7\x81\x01\x42\xf2" \
         "\x81\x04\x42\xf3\x81\x08\x42\x82\x88matroska\x42\x87\x81\x04" \
         "\x42\x85\x81\x02"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 /* srt and gallery raise the default deadline to 60s; a hostile file can
    stall GStreamer's preroll for all of it, which the harness watchdog
    (20s) would report as a hang, so the deadline is lowered explicitly */
 #define LE_FUZZ_CONFIGS NULL, "srt:en,deadline=5000", \
         "gallery:4,deadline=5000", \
         "gallery:9,format=png,srt:de,deadline=5000", \
         "size=32,gallery:100,deadline=5000"
 /* GStreamer never frees its registry, type system and thread pools;
    only suppress leaks with a GStreamer frame on the stack, so that
    leaks in the plugin's own glue are still reported */
 #define LE_FUZZ_LSAN_SUPPRESSIONS \
         "leak:libgstreamer-1.0.so\n" \
         "leak:libgstbase-1.0.so\n" \
         "leak:/gstreamer-1.0/\n"
 
 #elif LE_FUZZ_IDVAL == LE_ID_PECOFF
 /* MZ header; the PE header offset lives at 0x3c */
 /* carries a valid e_lfanew at 0x3c pointing at the "PE\0\0" signature;
    without it every generated input dies at the second check */
 #define LE_FUZZ_MAGIC \
         "\x4d\x5a" \
         "\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e\x2e" \
         "\x40\x00\x00\x00\x50\x45\x00\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_LNK
 /* header size 0x4c followed by the shell link CLSID */
 #define LE_FUZZ_MAGIC \
         "\x4c\x00\x00\x00\x01\x14\x02\x00\x00\x00\x00\x00\xc0\x00\x00\x00\x00\x00\x00\x46"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_SQLITE
 /* the header is the first 100 bytes */
 #define LE_FUZZ_MAGIC "SQLite format 3\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_TAR
 /* the ustar magic is at offset 257, so the prefix only seeds the name field */
 #define LE_FUZZ_MAGIC "testfile\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_ISO9660
 /* the primary volume descriptor is at offset 32768, out of reach of a prefix */
 #define LE_FUZZ_MAGIC "\x01" "CD001"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_DISKIMAGE
 /* qcow2; the VMDK/VHD/VHDX branches are reached from the corpus */
 #define LE_FUZZ_MAGIC "QFI\xfb\x00\x00\x00\x03"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_HEIF
 /* ISO base media file format: big-endian length-prefixed boxes */
 #define LE_FUZZ_MAGIC "\x00\x00\x00\x18" "ftypheic\x00\x00\x00\x00mif1heic"
 #define LE_FUZZ_SHAPE LE_SHAPE_CHUNK_BE
 
 #elif LE_FUZZ_IDVAL == LE_ID_WEBP
 /* RIFF: little-endian length-prefixed chunks */
 #define LE_FUZZ_MAGIC "RIFF\x00\x00\x00\x00WEBPVP8X"
 #define LE_FUZZ_SHAPE LE_SHAPE_CHUNK_LE
 
 #elif LE_FUZZ_IDVAL == LE_ID_PLIST
 /* the trailer is the last 32 bytes */
 #define LE_FUZZ_MAGIC "bplist00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_ID3
 /* ID3v2 header with a synchsafe size */
 #define LE_FUZZ_MAGIC "ID3\x03\x00\x00\x00\x00\x00\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_GPX
 #define LE_FUZZ_MAGIC \
         "<?xml version=\"1.0\"?>\n<gpx version=\"1.1\" creator=\"x\">"
 #define LE_FUZZ_SHAPE LE_SHAPE_TEXT
 
 #elif LE_FUZZ_IDVAL == LE_ID_KML
 #define LE_FUZZ_MAGIC \
         "<?xml version=\"1.0\"?>\n<kml xmlns=\"http://www.opengis.net/kml/2.2\">"
 #define LE_FUZZ_SHAPE LE_SHAPE_TEXT
 
 #elif LE_FUZZ_IDVAL == LE_ID_GEOTIFF
 /* little-endian classic TIFF; the geo tags live in the IFD */
 #define LE_FUZZ_MAGIC "II\x2a\x00\x08\x00\x00\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_MBOX
 /* the envelope line alone is rejected: the plugin also requires a
    well-formed header block behind it */
 #define LE_FUZZ_MAGIC \
         "From a@b Mon Jan  1 00:00:00 2024\n" \
         "From: a@b\nDate: 1 Jan 2024 00:00:00 +0000\n"
 #define LE_FUZZ_SHAPE LE_SHAPE_TEXT
 
 #elif LE_FUZZ_IDVAL == LE_ID_APK
 /* LE_SHAPE_ZIP synthesises the whole container, so a magic prefix
    would sit in front of it and invalidate every local header
    offset; the zip harness leaves it empty for the same reason */
 #define LE_FUZZ_MAGIC ""
 #define LE_FUZZ_SHAPE LE_SHAPE_ZIP
 
 #elif LE_FUZZ_IDVAL == LE_ID_EBOOK
 /* EPUB; the MOBI branch has its "BOOKMOBI" magic at offset 60 and
    cannot be expressed as a prefix, so seed the corpus with
    testdata/ebook_test.mobi to reach it */
 #define LE_FUZZ_MAGIC ""
 #define LE_FUZZ_SHAPE LE_SHAPE_ZIP
 #define LE_FUZZ_CONFIGS NULL, "fulltext"
 
 #elif LE_FUZZ_IDVAL == LE_ID_PREVIEWOPUS
 #define LE_FUZZ_MAGIC "OggS\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_MPEG
 #define LE_FUZZ_MAGIC "\x00\x00\x01\xba"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_MSOFFICE
 /* OOXML is a ZIP */
 #define LE_FUZZ_MAGIC ""
 #define LE_FUZZ_SHAPE LE_SHAPE_ZIP
 
 #elif LE_FUZZ_IDVAL == LE_ID_NSF
 #define LE_FUZZ_MAGIC "NESM\x1a\x01"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_NSFE
 #define LE_FUZZ_MAGIC "NSFE"
 #define LE_FUZZ_SHAPE LE_SHAPE_CHUNK_BE
 
 #elif LE_FUZZ_IDVAL == LE_ID_ODF
 #define LE_FUZZ_MAGIC ""
 #define LE_FUZZ_SHAPE LE_SHAPE_ZIP
 #define LE_FUZZ_CONFIGS NULL, "fulltext"
 
 #elif LE_FUZZ_IDVAL == LE_ID_OGG
 #define LE_FUZZ_MAGIC "OggS\x00\x02"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_OLE2
 #define LE_FUZZ_MAGIC "\xd0\xcf\x11\xe0\xa1\xb1\x1a\xe1"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 #define LE_FUZZ_CONFIGS NULL, "fulltext"
 
 #elif LE_FUZZ_IDVAL == LE_ID_PNG
 #define LE_FUZZ_MAGIC "\x89PNG\r\n\x1a\n"
 #define LE_FUZZ_SHAPE LE_SHAPE_CHUNK_BE
 
 #elif LE_FUZZ_IDVAL == LE_ID_PS
 #define LE_FUZZ_MAGIC "%!PS-Adobe-3.0\n"
 #define LE_FUZZ_SHAPE LE_SHAPE_TEXT
 
 #elif LE_FUZZ_IDVAL == LE_ID_QT
 /* QuickTime: size + 'moov' at the very start is the easy way in */
 #define LE_FUZZ_MAGIC "\x00\x00\x00\x08moov"
 #define LE_FUZZ_SHAPE LE_SHAPE_CHUNK_BE
 
 #elif LE_FUZZ_IDVAL == LE_ID_REAL
 #define LE_FUZZ_MAGIC ".RMF\x00\x00\x00\x12"
 #define LE_FUZZ_SHAPE LE_SHAPE_CHUNK_BE
 
 #elif LE_FUZZ_IDVAL == LE_ID_RIFF
 #define LE_FUZZ_MAGIC "RIFF"
 #define LE_FUZZ_SHAPE LE_SHAPE_CHUNK_LE
 
 #elif LE_FUZZ_IDVAL == LE_ID_RTF
 #define LE_FUZZ_MAGIC "{\\rtf1"
 #define LE_FUZZ_SHAPE LE_SHAPE_TEXT
 
 #elif LE_FUZZ_IDVAL == LE_ID_S3M
 /* the 'SCRM' tag lives at offset 0x2c, so the magic here is the whole
    leading header up to and including it */
 #define LE_FUZZ_MAGIC \
         "fuzz s3m module\x00" "\x1a\x10\x00\x00" \
         "\x01\x00\x01\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
         "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" "SCRM"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_SID
 #define LE_FUZZ_MAGIC "PSID\x00\x02\x00\x7c\x00\x7c"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_TIFF
 #define LE_FUZZ_MAGIC "II\x2a\x00\x08\x00\x00\x00"
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_WAV
 #define LE_FUZZ_MAGIC "RIFF"
 #define LE_FUZZ_SHAPE LE_SHAPE_CHUNK_LE
 
 #elif LE_FUZZ_IDVAL == LE_ID_XM
 #define LE_FUZZ_MAGIC "Extended Module: "
 #define LE_FUZZ_SHAPE LE_SHAPE_RAW
 
 #elif LE_FUZZ_IDVAL == LE_ID_ZIP
 #define LE_FUZZ_MAGIC ""
 #define LE_FUZZ_SHAPE LE_SHAPE_ZIP
 
 #else
 #error "no format description for this LE_FUZZ_ID; add one above"
 #endif
 
 #endif /* LE_FUZZ_PLUGIN_NAME_H */