Fuzz con libFuzzer

El fuzzing, que simplemente proporciona datos potencialmente no válidos, inesperados o aleatorios como entrada a un programa, es una forma extremadamente eficaz de encontrar errores en sistemas de software grandes y es una parte importante del ciclo de vida de desarrollo de software.

El sistema de compilación de Android admite el fuzzing a través de la inclusión de libFuzzer desde el proyecto de infraestructura del compilador LLVM. LibFuzzer está vinculado con la biblioteca en prueba y controla toda la selección de entradas, mutación y generación de informes de fallas que se produce durante una sesión de fuzzing. Los validadores de LLVM se usan para ayudar en la detección de daños en la memoria y las métricas de cobertura de código.

En este artículo, se proporciona una introducción a libFuzzer en Android y cómo realizar una compilación instrumentada. También incluye instrucciones para escribir, ejecutar y personalizar generadores de fuzz.

Configuración y compilación

Para asegurarte de tener una imagen que funcione en un dispositivo, puedes descargar una imagen de fábrica y actualizar el dispositivo. Como alternativa, puedes descargar el código fuente de AOSP y seguir el ejemplo de configuración y compilación que se indica a continuación.

Ejemplo de configuración

En este ejemplo, se supone que el dispositivo de destino es un Pixel (taimen) y que ya está preparado para la depuración por USB (aosp_taimen-userdebug). Puedes descargar otros objetos binarios de Pixel desde Objetos binarios del controlador.

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

Ejemplo de compilación

El primer paso para ejecutar objetivos de fuzz es obtener una imagen del sistema nueva. Te recomendamos que tengas, al menos, la versión de desarrollo más reciente de Android.

  1. Para realizar la compilación inicial, escribe lo siguiente:
    m
  2. Para que puedas actualizar el firmware del dispositivo, inícialo en modo fastboot con la combinación de teclas adecuada.
  3. Desbloquea el bootloader y escribe en la memoria flash la imagen compilada recientemente con los siguientes comandos.
    fastboot oem unlock
    fastboot flashall

El dispositivo de destino ahora debería estar listo para el fuzzing de libFuzzer.

Cómo escribir un fuzzer

Para ilustrar cómo escribir un generador de fuzz de extremo a extremo con libFuzzer en Android, usa el siguiente código vulnerable como caso de prueba. Esto ayuda a probar el generador de fuzz, a garantizar que todo funcione correctamente y a mostrar cómo se ven los datos de fallas.

Esta es la función de prueba.

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

Para compilar y ejecutar este generador de fuzz de prueba, haz lo siguiente:

  1. Un objetivo de fuzz consta de dos archivos: un archivo de compilación y el código fuente del objetivo de fuzz. Crea tus archivos en una ubicación junto a la biblioteca a la que le estás aplicando fuzzing. Asigna un nombre al generador de fuzz que describa lo que hace.
  2. Escribe un objetivo de fuzz con libFuzzer. El objetivo de fuzz es una función que toma un blob de datos de un tamaño especificado y lo pasa a la función que se fuzzificará. Este es un generador de fuzz básico para la función de prueba vulnerable:
    #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. Indica al sistema de compilación de Android que cree el objeto binario del generador de fuzz. Para compilar el generador de fuzz, agrega este código al archivo Android.bp:
    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. Para que el generador de fuzz se ejecute en el destino (dispositivo), haz lo siguiente:
    SANITIZE_TARGET=hwaddress m fuzz_me_fuzzer
    
  5. Para hacer que el generador de fuzz se ejecute en el host, haz lo siguiente:
    SANITIZE_HOST=address m fuzz_me_fuzzer
    

Para mayor comodidad, define algunas variables de shell que contengan la ruta de acceso a tu objetivo de fuzz y el nombre del binario (del archivo de compilación que escribiste antes).

export FUZZER_NAME=your_fuzz_target

Después de seguir estos pasos, deberías tener un generador de fuzz compilado. La ubicación predeterminada del generador de fuzz (para esta compilación de Pixel de ejemplo) es la siguiente:

  • $ANDROID_PRODUCT_OUT/data/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME para el dispositivo
  • $ANDROID_HOST_OUT/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME para el host
  • Ejecuta tu generador de fuzz en el host

  • Agrega lo siguiente a tu archivo de compilación Android.bp:
    host_supported: true,
    Ten en cuenta que esto solo se puede aplicar si la biblioteca que deseas generar fuzz es compatible con el host.
  • Ejecuta el generador de fuzz en el host simplemente ejecutando el objeto binario del generador de fuzz compilado:
    $ANDROID_HOST_OUT/fuzz/x86_64/$FUZZER_NAME/$FUZZER_NAME
  • Ejecuta tu generador de fuzz en el dispositivo

    Queremos copiar esto en tu dispositivo con adb.

    1. Para subir estos archivos a un directorio en el dispositivo, ejecuta los siguientes comandos:
      adb root
      adb sync data
    2. Ejecuta el generador de fuzz de prueba en el dispositivo con este comando:
      adb shell /data/fuzz/$(get_build_var TARGET_ARCH)/$FUZZER_NAME/$FUZZER_NAME \
        /data/fuzz/$(get_build_var TARGET_ARCH)/$FUZZER_NAME/corpus

    Esto genera un resultado similar al siguiente ejemplo.

    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
    

    En el resultado del ejemplo, fuzz_me_fuzzer.cpp fue la causa de la falla en la línea 10:

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

    Esta es una operación de lectura fuera de rango directa si data tiene una longitud de 3.

    Después de ejecutar el generador de fuzz, el resultado suele provocar una falla, y la entrada ofensiva se guarda en el corpus y se le asigna un ID. En el resultado del ejemplo, es crash-0eb8e4ed029b774d80f2b66408203801cb982a60.

    Para recuperar información de fallas cuando se genera fuzz en el dispositivo, emite este comando y especifica el ID de falla:

    adb pull /data/fuzz/arm64/fuzz_me_fuzzer/corpus/CRASH_ID
    Ten en cuenta que, para que los casos de prueba se guarden en el directorio correcto, puedes usar la carpeta corpus (como en el ejemplo anterior) o el argumento artifact_prefix (p.ej., "-artifact_prefix=/data/fuzz/where/my/crashes/go").

    Cuando se genera fuzz en el host, la información de falla aparece en la carpeta de fallas en la carpeta local donde se ejecuta el generador de fuzz.

    Genera cobertura de línea

    La cobertura de líneas es muy útil para los desarrolladores, ya que pueden identificar áreas del código que no están cubiertas y actualizar sus generadores de fuzz en consecuencia para llegar a esas áreas en futuras ejecuciones de fuzzing.

    1. Para generar informes de cobertura del generador de fuzz, sigue estos pasos :
      CLANG_COVERAGE=true NATIVE_COVERAGE_PATHS='*' make ${FUZZER_NAME}
    2. Después de enviar el generador de fuzz y sus dependencias al dispositivo, ejecuta el objetivo de fuzz con LLVM_PROFILE_FILE de la siguiente manera:
      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. Para generar el informe de cobertura, primero extrae el archivo profraw del dispositivo y, luego, genera el informe HTML en una carpeta llamada coverage-html, como se muestra a continuación:
      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

    Para obtener más información sobre libFuzzer, consulta la documentación upstream.