Fuzzing mit libFuzzer

Beim Fuzzing werden einfach potenziell ungültige, unerwartete oder zufällige Daten als Eingabe für ein Programm bereitgestellt. Dies ist eine äußerst effektive Methode, um Fehler in großen Softwaresystemen zu finden, und ein wichtiger Teil des Softwareentwicklungszyklus.

Das Build-System von Android unterstützt das Fuzzing durch die Einbindung von libFuzzer aus dem LLVM Compiler Infrastructure Project. LibFuzzer ist mit der zu testenden Bibliothek verknüpft und verarbeitet alle Eingabeauswahl, Mutation und Absturzberichte, die während einer Fuzzing-Sitzung auftreten. Die Sanitizer von LLVM werden zur Erkennung von Speicherbeschädigungen und zur Ermittlung von Codeabdeckungsmesswerten verwendet.

In diesem Artikel erhalten Sie eine Einführung in libFuzzer unter Android und erfahren, wie Sie einen instrumentierten Build ausführen. Außerdem enthält es eine Anleitung zum Schreiben, Ausführen und Anpassen von Fuzzern.

Einrichtung und Build

Damit auf einem Gerät ein funktionierendes Image ausgeführt wird, können Sie ein Factory Image herunterladen und das Gerät flashen. Alternativ können Sie den AOSP-Quellcode herunterladen und der Anleitung unten zur Einrichtung und zum Erstellen folgen.

Beispiel für die Einrichtung

In diesem Beispiel wird davon ausgegangen, dass das Zielgerät ein Google Pixel (taimen) ist und bereits für das USB-Debugging (aosp_taimen-userdebug) vorbereitet ist. Andere Pixel-Binärdateien können Sie unter Treiber-Binärdateien herunterladen.

mkdir ~/bin
export PATH=~/bin:$PATH
curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
chmod a+x ~/bin/repo
repo init -u https://android.googlesource.com/platform/manifest -b main
repo sync -c -j8
wget https://dl.google.com/dl/android/aosp/google_devices-taimen-qq1a.191205.008-f4537f93.tgz
tar xvf google_devices-taimen-qq1a.191205.008-f4537f93.tgz
./extract-google_devices-taimen.sh
wget https://dl.google.com/dl/android/aosp/qcom-taimen-qq1a.191205.008-760afa6e.tgz
tar xvf qcom-taimen-qq1a.191205.008-760afa6e.tgz
./extract-qcom-taimen.sh
. build/envsetup.sh
lunch aosp_taimen-userdebug

Beispiel erstellen

Der erste Schritt beim Ausführen von Fuzz-Zielen besteht darin, ein neues System-Image zu erhalten. Wir empfehlen, mindestens die neueste Entwicklungsversion von Android zu verwenden.

  1. Führen Sie den ersten Build mit folgendem Befehl aus:
    m
  2. Damit Sie Ihr Gerät flashen können, starten Sie es mit der entsprechenden Tastenkombination im Fastboot-Modus.
  3. Entsperren Sie den Bootloader und flashen Sie das neu kompilierte Image mit den folgenden Befehlen.
    fastboot oem unlock
    fastboot flashall

Das Zielgerät sollte jetzt für das LibFuzzer-Fuzzing bereit sein.

Fuzzer schreiben

Um zu veranschaulichen, wie ein End-to-End-Fuzzer mit libFuzzer in Android geschrieben wird, verwenden Sie den folgenden unsicheren Code als Testfall. So können Sie den Fuzzer testen, dafür sorgen, dass alles richtig funktioniert, und sich ein Bild davon machen, wie Absturzdaten aussehen.

Hier ist die Testfunktion.

#include <stdint.h>
#include <stddef.h>
bool FuzzMe(const char *data, size_t dataSize) {
    return dataSize >= 3  &&
           data[0] == 'F' &&
           data[1] == 'U' &&
           data[2] == 'Z' &&
           data[3] == 'Z';  //  Out of bounds access
}

So erstellen und führen Sie diesen Test-Fuzzer aus:

  1. Ein Fuzz-Ziel besteht aus zwei Dateien: einer Build-Datei und dem Quellcode des Fuzz-Ziels. Erstellen Sie Ihre Dateien an einem Ort neben der Bibliothek, die Sie fuzzen. Geben Sie dem Fuzzer einen Namen, der seine Funktion beschreibt.
  2. Mit libFuzzer ein Fuzz-Ziel schreiben Das Fuzz-Ziel ist eine Funktion, die einen Datenblob einer bestimmten Größe annimmt und an die zu fuzzende Funktion weitergibt. Hier ist ein einfacher Fuzzer für die unsichere Testfunktion:
    #include <stddef.h>
    #include <stdint.h>
    
    extern "C" int LLVMFuzzerTestOneInput(const char *data, size_t size) {
      // ...
      // Use the data to call the library you are fuzzing.
      // ...
      return FuzzMe(data, size);
    }
  3. Das Build-System von Android anweisen, die Fuzzer-Binärdatei zu erstellen Fügen Sie der Datei Android.bp folgenden Code hinzu, um den Fuzzer zu erstellen:
    cc_fuzz {
      name: "fuzz_me_fuzzer",
      srcs: [
        "fuzz_me_fuzzer.cpp",
      ],
      // If the fuzzer has a dependent library, uncomment the following section and
      // include it.
      // static_libs: [
      //   "libfoo", // Dependent library
      // ],
      //
      // The advanced features below allow you to package your corpus and
      // dictionary files during building. You can find more information about
      // these features at:
      //  - Corpus: https://llvm.org/docs/LibFuzzer.html#corpus
      //  - Dictionaries: https://llvm.org/docs/LibFuzzer.html#dictionaries
      // These features are not required for fuzzing, but are highly recommended
      // to gain extra coverage.
      // To include a corpus folder, uncomment the following line.
      // corpus: ["corpus/*"],
      // To include a dictionary, uncomment the following line.
      // dictionary: "fuzz_me_fuzzer.dict",
    }
  4. So sorgen Sie dafür, dass der Fuzzer auf dem Ziel (Gerät) ausgeführt wird:
    SANITIZE_TARGET=hwaddress m fuzz_me_fuzzer
    
  5. So sorgen Sie dafür, dass der Fuzzer auf dem Host ausgeführt wird:
    SANITIZE_HOST=address m fuzz_me_fuzzer
    

Definieren Sie zur Vereinfachung einige Shell-Variablen mit dem Pfad zum Fuzzing-Ziel und dem Namen der Binärdatei (aus der zuvor erstellten Build-Datei).

export FUZZER_NAME=your_fuzz_target

Nachdem Sie diese Schritte ausgeführt haben, sollten Sie einen Fuzzer haben. Der Standardspeicherort für den Fuzzer (in diesem Beispiel für Pixel-Build) lautet:

  • $ANDROID_PRODUCT_OUT/data/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME für das Gerät.
  • $ANDROID_HOST_OUT/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME für den Host.
  • Fuzzer auf dem Host ausführen

  • Fügen Sie der Build-Datei „Android.bp“ Folgendes hinzu:
    host_supported: true,
    Hinweis: Diese Option kann nur angewendet werden, wenn die Bibliothek, die Sie fuzzen möchten, vom Host unterstützt wird.
  • Führen Sie den Fuzzer auf dem Host aus, indem Sie einfach die erstellte Fuzzer-Binärdatei ausführen:
    $ANDROID_HOST_OUT/fuzz/x86_64/$FUZZER_NAME/$FUZZER_NAME
  • Fuzzer auf dem Gerät ausführen

    Wir möchten diese Daten mit adb auf Ihr Gerät kopieren.

    1. Führen Sie die folgenden Befehle aus, um diese Dateien in ein Verzeichnis auf dem Gerät hochzuladen:
      adb root
      adb sync data
    2. Führen Sie den Test-Fuzzer mit dem folgenden Befehl auf dem Gerät aus:
      adb shell /data/fuzz/$(get_build_var TARGET_ARCH)/$FUZZER_NAME/$FUZZER_NAME \
        /data/fuzz/$(get_build_var TARGET_ARCH)/$FUZZER_NAME/corpus

    Die Ausgabe sieht dann in etwa so aus wie im Beispiel unten.

    INFO: Seed: 913963180
    INFO: Loaded 2 modules   (16039 inline 8-bit counters): 16033 [0x7041769b88, 0x704176da29), 6 [0x60e00f4df0, 0x60e00f4df6),
    INFO: Loaded 2 PC tables (16039 PCs): 16033 [0x704176da30,0x70417ac440), 6 [0x60e00f4df8,0x60e00f4e58),
    INFO: -max_len is not provided; libFuzzer will not generate inputs larger than 4096 bytes
    INFO: A corpus is not provided, starting from an empty corpus
    #2	INITED cov: 5 ft: 5 corp: 1/1b exec/s: 0 rss: 24Mb
    #10	NEW    cov: 6 ft: 6 corp: 2/4b lim: 4 exec/s: 0 rss: 24Mb L: 3/3 MS: 3 CopyPart-ChangeByte-InsertByte-
    #712	NEW    cov: 7 ft: 7 corp: 3/9b lim: 8 exec/s: 0 rss: 24Mb L: 5/5 MS: 2 InsertByte-InsertByte-
    #744	REDUCE cov: 7 ft: 7 corp: 3/7b lim: 8 exec/s: 0 rss: 25Mb L: 3/3 MS: 2 ShuffleBytes-EraseBytes-
    #990	REDUCE cov: 8 ft: 8 corp: 4/10b lim: 8 exec/s: 0 rss: 25Mb L: 3/3 MS: 1 ChangeByte-
    ==18631==ERROR: HWAddressSanitizer: tag-mismatch on address 0x0041e00b4183 at pc 0x0060e00c5144
    READ of size 1 at 0x0041e00b4183 tags: f8/03 (ptr/mem) in thread T0
        #0 0x60e00c5140  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0xf140)
        #1 0x60e00ca130  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x14130)
        #2 0x60e00c9b8c  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x13b8c)
        #3 0x60e00cb188  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x15188)
        #4 0x60e00cbdec  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x15dec)
        #5 0x60e00d8fbc  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x22fbc)
        #6 0x60e00f0a98  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x3aa98)
        #7 0x7041b75d34  (/data/fuzz/arm64/lib/libc.so+0xa9d34)
    
    [0x0041e00b4180,0x0041e00b41a0) is a small allocated heap chunk; size: 32 offset: 3
    0x0041e00b4183 is located 0 bytes to the right of 3-byte region [0x0041e00b4180,0x0041e00b4183)
    allocated here:
        #0 0x70418392bc  (/data/fuzz/arm64/lib/libclang_rt.hwasan-aarch64-android.so+0x212bc)
        #1 0x60e00ca040  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x14040)
        #2 0x60e00c9b8c  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x13b8c)
        #3 0x60e00cb188  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x15188)
        #4 0x60e00cbdec  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x15dec)
        #5 0x60e00d8fbc  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x22fbc)
        #6 0x60e00f0a98  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x3aa98)
        #7 0x7041b75d34  (/data/fuzz/arm64/lib/libc.so+0xa9d34)
        #8 0x60e00c504c  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0xf04c)
        #9 0x70431aa9c4  (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0x519c4)
    
    Thread: T1 0x006700006000 stack: [0x007040c55000,0x007040d4ecc0) sz: 1023168 tls: [0x000000000000,0x000000000000)
    Thread: T0 0x006700002000 stack: [0x007fe51f3000,0x007fe59f3000) sz: 8388608 tls: [0x000000000000,0x000000000000)
    Memory tags around the buggy address (one tag corresponds to 16 bytes):
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       08  00  cf  08  dc  08  cd  08  b9  08  1a  1a  0b  00  04  3f
    => 27  00  08  00  bd  bd  2d  07 [03] 73  66  66  27  27  20  f6 <=
       5b  5b  87  87  03  00  01  00  4f  04  24  24  03  39  2c  2c
       05  00  04  00  be  be  85  85  04  00  4a  4a  05  05  5f  5f
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
       00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
    Tags for short granules around the buggy address (one tag corresponds to 16 bytes):
       04  ..  ..  cf  ..  dc  ..  cd  ..  b9  ..  ..  3f  ..  57  ..
    => ..  ..  21  ..  ..  ..  ..  2d [f8] ..  ..  ..  ..  ..  ..  .. <=
       ..  ..  ..  ..  9c  ..  e2  ..  ..  4f  ..  ..  99  ..  ..  ..
    See https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html#short-granules for a description of short granule tags
    Registers where the failure occurred (pc 0x0060e00c5144):
        x0  f8000041e00b4183  x1  000000000000005a  x2  0000000000000006  x3  000000704176d9c0
        x4  00000060e00f4df6  x5  0000000000000004  x6  0000000000000046  x7  000000000000005a
        x8  00000060e00f4df0  x9  0000006800000000  x10 0000000000000001  x11 00000060e0126a00
        x12 0000000000000001  x13 0000000000000231  x14 0000000000000000  x15 000e81434c909ede
        x16 0000007041838b14  x17 0000000000000003  x18 0000007042b80000  x19 f8000041e00b4180
        x20 0000006800000000  x21 000000000000005a  x22 24000056e00b4000  x23 00000060e00f5200
        x24 00000060e0128c88  x25 00000060e0128c20  x26 00000060e0128000  x27 00000060e0128000
        x28 0000007fe59f16e0  x29 0000007fe59f1400  x30 00000060e00c5144
    SUMMARY: HWAddressSanitizer: tag-mismatch (/data/fuzz/arm64/example_fuzzer/example_fuzzer+0xf140)
    MS: 1 ChangeByte-; base unit: e09f9c158989c56012ccd88111b82f778a816eae
    0x46,0x55,0x5a,
    FUZ
    artifact_prefix='./'; Test unit written to ./crash-0eb8e4ed029b774d80f2b66408203801cb982a60
    Base64: RlVa
    

    In der Beispielausgabe wurde der Absturz durch fuzz_me_fuzzer.cpp in Zeile 10 verursacht:

          data[3] == 'Z';  // :(

    Dies ist ein einfacher Lesevorgang außerhalb des Gültigkeitsbereichs, wenn data eine Länge von 3 hat.

    Nach dem Ausführen des Fuzzers führt die Ausgabe häufig zu einem Absturz und die fehlerhafte Eingabe wird im Corpus gespeichert und erhält eine ID. In der Beispielausgabe ist das crash-0eb8e4ed029b774d80f2b66408203801cb982a60.

    Wenn Sie beim Fuzzing auf dem Gerät Absturzinformationen abrufen möchten, geben Sie diesen Befehl mit Ihrer Absturz-ID ein:

    adb pull /data/fuzz/arm64/fuzz_me_fuzzer/corpus/CRASH_ID
    Wenn Sie TestCases im richtigen Verzeichnis speichern möchten, können Sie den Ordner „corpus“ (wie im Beispiel oben) oder das Argument „artifact_prefix“ verwenden (z.B. „-artifact_prefix=/data/fuzz/where/my/crashes/go“).

    Beim Fuzzing auf dem Host werden Informationen zu Abstürzen im Crash-Ordner im lokalen Verzeichnis angezeigt, in dem der Fuzzer ausgeführt wird.

    Linienabdeckung generieren

    Die Zeilenabdeckung ist für Entwickler sehr nützlich, da sie Bereiche im Code identifizieren und ihre Fuzzer entsprechend aktualisieren können, um diese Bereiche bei zukünftigen Fuzzing-Ausführungen zu erreichen.

    1. Führen Sie die folgenden Schritte aus, um Berichte zur Fuzzer-Abdeckung zu generieren :
      CLANG_COVERAGE=true NATIVE_COVERAGE_PATHS='*' make ${FUZZER_NAME}
    2. Nachdem Sie den Fuzzer und seine Abhängigkeiten auf das Gerät gepusht haben, führen Sie das Fuzz-Ziel mit LLVM_PROFILE_FILE wie unten beschrieben aus:
      DEVICE_TRACE_PATH=/data/fuzz/$(get_build_var TARGET_ARCH)/${FUZZER_NAME}/data.profraw
      adb shell LLVM_PROFILE_FILE=${DEVICE_TRACE_PATH} /data/fuzz/$(get_build_var TARGET_ARCH)/${FUZZER_NAME}/${FUZZER_NAME} -runs=1000
    3. Erstellen Sie den Abdeckungsbericht, indem Sie zuerst die profraw-Datei vom Gerät abrufen und dann den HTML-Bericht im Ordner „coverage-html“ generieren, wie unten dargestellt:
      adb pull ${DEVICE_TRACE_PATH} data.profraw
      llvm-profdata merge --sparse data.profraw --output data.profdata
      llvm-cov show --format=html --instr-profile=data.profdata \
        symbols/data/fuzz/$(get_build_var TARGET_ARCH)/${FUZZER_NAME}/${FUZZER_NAME} \
        --output-dir=coverage-html --path-equivalence=/proc/self/cwd/,$ANDROID_BUILD_TOP

    Weitere Informationen zu libFuzzer finden Sie in der Upstream-Dokumentation.