Fuzz z libFuzzer

Fuzzing, czyli podawanie potencjalnie nieprawidłowego, nieoczekiwanego lub losowego wejścia do programu, jest bardzo skutecznym sposobem na znajdowanie błędów w dużych systemach oprogramowania. Jest też ważną częścią cyklu życia procesu tworzenia oprogramowania.

System kompilacji Androida obsługuje fuzzing dzięki uwzględnieniu biblioteki libFuzzer z projektu infrastruktury kompilatora LLVM. LibFuzzer jest połączony z testowaną biblioteką i obsługuje wszystkie operacje wyboru, mutacji i zgłaszania awarii, które występują podczas sesji fuzzingu. Sanitaryzery LLVM pomagają wykrywać uszkodzenia pamięci i zliczać pokrycie kodu.

Z tego artykułu dowiesz się, czym jest libFuzzer na Androidzie i jak wykonać kompilację z instrumentacją. Zawiera też instrukcje tworzenia, uruchamiania i dostosowywania fuzzerów.

Konfiguracja i kompilacja

Aby mieć pewność, że na urządzeniu działa działający obraz, możesz pobrać obraz fabryczny i przeprowadzić aktualizację. Możesz też pobrać kod źródłowy AOSP i użyć przykładu konfiguracji i kompilacji podanego poniżej.

Przykład konfiguracji

W tym przykładzie zakładamy, że urządzenie docelowe to Pixel (taimen) i że jest już gotowe do debugowania przez USB (aosp_taimen-userdebug). Inne pliki binarne Pixela możesz pobrać z pliku Binaries Driver.

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

Przykład kompilacji

Pierwszym krokiem do uruchomienia celów fuzz jest pobranie nowego obrazu systemu. Zalecamy korzystanie z co najmniej najnowszej wersji deweloperskiej Androida.

  1. Wykonaj początkową kompilację, wykonując te czynności:
    m
  2. Aby umożliwić sobie flashowanie urządzenia, uruchom je w trybie Fastboot za pomocą odpowiedniej kombinacji klawiszy.
  3. Odblokuj bootloader i sflashuj nowo skompilowany obraz za pomocą tych poleceń.
    fastboot oem unlock
    fastboot flashall

Urządzenie docelowe powinno być teraz gotowe do fuzzingu za pomocą libFuzzer.

Pisanie fuzzera

Aby zilustrować tworzenie kompleksowego fuzzera za pomocą biblioteki libFuzzer na Androidzie, użyj podanego niżej kodu z luką jako testu. Pomaga to przetestować fuzzer, sprawdzić, czy wszystko działa prawidłowo, i pokazać, jak wyglądają dane o awariach.

Oto funkcja testowa.

#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
}

Aby skompilować i uruchomić ten test fuzzera:

  1. Docelowy obiekt fuzz składa się z 2 plików: pliku kompilacji i kodu źródłowego docelowego obiektu fuzz. Utwórz pliki w miejscu znajdującym się obok biblioteki, którą chcesz zmienić. Nadaj fuzzerowi nazwę, która opisuje jego działanie.
  2. Zapisz cel fuzz za pomocą libFuzzer. Docelowy element fuzz to funkcja, która pobiera blok danych o określonym rozmiarze i przekazuje go do funkcji, która ma być zmodyfikowana. Oto podstawowy fuzzer dla podatnej na ataki funkcji testowej:
    #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. Poinformuj system kompilacji Androida, aby utworzył binarny fuzzer. Aby skompilować fuzzer, dodaj do pliku Android.bp ten kod:
    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. Aby uruchomić fuzzer na urządzeniu docelowym:
    SANITIZE_TARGET=hwaddress m fuzz_me_fuzzer
    
  5. Aby uruchomić fuzzer na hoście:
    SANITIZE_HOST=address m fuzz_me_fuzzer
    

Dla wygody zdefiniuj zmienne powłoki zawierające ścieżkę do celu fuzzingu i nazwę binarnego (z utworzonego wcześniej pliku kompilacji).

export FUZZER_NAME=your_fuzz_target

Po wykonaniu tych czynności powinieneś mieć utworzonego fuzzera. Domyślna lokalizacja fuzzera (w przypadku tej wersji Pixela) to:

  • $ANDROID_PRODUCT_OUT/data/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME na urządzeniu.
  • ANDROID_HOST_OUT/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME dla gospodarza.
  • Uruchamianie fuzzera na hoście

  • Dodaj do pliku kompilacji Android.bp:
    host_supported: true,
    Pamiętaj, że ta opcja jest dostępna tylko wtedy, gdy biblioteka, którą chcesz fuzzować, jest obsługiwana przez hosta.
  • Uruchom fuzzer na hoście, uruchamiając wygenerowany plik binarny fuzzera:
    $ANDROID_HOST_OUT/fuzz/x86_64/$FUZZER_NAME/$FUZZER_NAME
  • Uruchom fuzzer na urządzeniu

    Chcemy skopiować te dane na Twoje urządzenie za pomocą adb.

    1. Aby przesłać te pliki do katalogu na urządzeniu, uruchom te komendy:
      adb root
      adb sync data
    2. Uruchom test fuzzer na urządzeniu za pomocą tego polecenia:
      adb shell /data/fuzz/$(get_build_var TARGET_ARCH)/$FUZZER_NAME/$FUZZER_NAME \
        /data/fuzz/$(get_build_var TARGET_ARCH)/$FUZZER_NAME/corpus

    W rezultacie otrzymasz dane wyjściowe podobne do tych poniżej.

    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
    

    W przykładowych danych wyjściowych awarię spowodował element fuzz_me_fuzzer.cpp w wierszu 10:

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

    Jest to proste odczytanie poza zakresem, jeśli data ma długość 3.

    Po uruchomieniu fuzzera wyniki często prowadzą do awarii, a sprawczy input jest zapisywany w korpusie i otrzymuje identyfikator. W przykładzie danych wyjściowych jest to crash-0eb8e4ed029b774d80f2b66408203801cb982a60.

    Aby pobrać informacje o awarii podczas fuzzingu na urządzeniu, wykonaj to polecenie, podając identyfikator awarii:

    adb pull /data/fuzz/arm64/fuzz_me_fuzzer/corpus/CRASH_ID
    Pamiętaj, że aby testy były zapisywane w prawidłowym katalogu, możesz użyć folderu corpus (jak w przykładzie powyżej) lub użyć argumentu artifact_prefix (np. `-artifact_prefix=/data/fuzz/where/my/crashes/go`).

    W przypadku fuzzingu na hoście informacje o awarii pojawiają się w folderze lokalnym, w którym działa fuzzer.

    Generowanie pokrycia linii

    Zasięg linii jest bardzo przydatny dla programistów, ponieważ pozwala im wskazać obszary kodu, które nie są objęte testowaniem, i odpowiednio zaktualizować fuzzery, aby uwzględnić te obszary w przyszłych testach.

    1. Aby wygenerować raporty o zasięgu fuzzera, wykonaj te czynności :
      CLANG_COVERAGE=true NATIVE_COVERAGE_PATHS='*' make ${FUZZER_NAME}
    2. Po przesłaniu fuzzera i jego zależności na urządzenie uruchom cel fuzzingu za pomocą LLVM_PROFILE_FILE w ten sposób:
      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. Aby wygenerować raport o zasięgu, najpierw pobierz plik profraw z urządzenia, a potem wygeneruj raport HTML w folderze o nazwie coverage-html, jak pokazano poniżej:
      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

    Więcej informacji o libFuzzer znajdziesz w dokumentacji.