A partir de 27 de março de 2025, recomendamos usar android-latest-release em vez de aosp-main para criar e contribuir com o AOSP. Para mais informações, consulte Mudanças no AOSP.

Esta página foi traduzida pela API Cloud Translation.

Fuzz com libFuzzer

O fuzzing, que é simplesmente fornecer dados potencialmente inválidos, inesperados ou aleatórios como entrada para um programa, é uma maneira extremamente eficaz de encontrar bugs em grandes sistemas de software e é uma parte importante do ciclo de vida de desenvolvimento de software.

O sistema de build do Android oferece suporte a fuzzing pela inclusão de libFuzzer do projeto de infraestrutura do compilador LLVM. O LibFuzzer está vinculado à biblioteca em teste e processa todas as entradas de seleção, mutação e relatórios de falha que ocorrem durante uma sessão de fuzzing. Os limpadores do LLVM são usados para ajudar na detecção de corrupção de memória e nas métricas de cobertura de código.

Este artigo apresenta a libFuzzer no Android e como realizar um build instrumentado. Ele também inclui instruções para escrever, executar e personalizar fuzzers.

Configuração e build

Para garantir que uma imagem esteja funcionando em um dispositivo, faça o download de uma imagem de fábrica e atualize o dispositivo. Como alternativa, faça o download do código-fonte do AOSP e siga o exemplo de configuração e build abaixo.

Exemplo de configuração

Este exemplo pressupõe que o dispositivo de destino seja um Pixel (taimen) e que já esteja preparado para a depuração USB (aosp_taimen-userdebug). É possível fazer o download de outros binários do Pixel em Driver Binaries.

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

Exemplo de build

A primeira etapa para executar alvos de fuzz é ter uma imagem de sistema nova. Recomendamos que você use pelo menos a versão mais recente do Android para desenvolvimento.

Execute o build inicial emitindo:
```
m
```
Para atualizar o dispositivo, inicialize-o no modo fastboot usando a combinação de teclas adequada.
Desbloqueie o carregador de inicialização e faça o flash da imagem recém-compilada com os seguintes comandos.
```
fastboot oem unlock
fastboot flashall
```

O dispositivo de destino agora está pronto para fuzzing do libFuzzer.

Programar um fuzzer

Para ilustrar a criação de um fuzzer completo usando o libFuzzer no Android, use o código vulnerável abaixo como um caso de teste. Isso ajuda a testar o fuzzer, garantir que tudo esteja funcionando corretamente e ilustrar como são os dados de falha.

Esta é a função de teste.

#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 criar e executar esse fuzzer de teste:

Um alvo de fuzz consiste em dois arquivos: um build e o código-fonte do alvo de fuzz. Crie seus arquivos em um local próximo à biblioteca que você está testando. Dê um nome ao fuzzer que descreva o que ele faz.

Escreva um alvo de fuzz usando o libFuzzer. O alvo de fuzz é uma função que recebe um blob de dados de um tamanho especificado e o transmite para a função a ser fuzzificada. Confira um fuzzer básico para a função de teste vulnerável:

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

Diga ao sistema de build do Android para criar o binário do fuzzer. Para criar o fuzzer, adicione este código ao arquivo 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",
}

Para fazer o fuzzer ser executado no destino (dispositivo):
```
SANITIZE_TARGET=hwaddress m fuzz_me_fuzzer
```
Para fazer com que o fuzzer seja executado no host:
```
SANITIZE_HOST=address m fuzz_me_fuzzer
```

Para sua conveniência, defina algumas variáveis do shell que contêm o caminho para o alvo de fuzz e o nome do binário (do arquivo de build que você criou anteriormente).

export FUZZER_NAME=your_fuzz_target

Depois de seguir estas etapas, você terá um fuzzer criado. O local padrão do fuzzer (para este exemplo de build do Pixel) é:

$ANDROID_PRODUCT_OUT/data/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME para dispositivo.

$ANDROID_HOST_OUT/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME para o host.

Executar o fuzzer no host

Adicione ao arquivo de build Android.bp:

host_supported: true,

Isso só pode ser aplicado se a biblioteca que você quer fuzzificar tiver suporte ao host.

Execute o fuzzer no host simplesmente executando o binário do fuzzer criado:

$ANDROID_HOST_OUT/fuzz/x86_64/$FUZZER_NAME/$FUZZER_NAME

Executar o fuzzer no dispositivo

Queremos copiar isso para seu dispositivo usando adb.

Para fazer upload desses arquivos para um diretório no dispositivo, execute estes comandos:
```
adb root
adb sync data
```

Execute o fuzzer de teste no dispositivo com 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

Isso resulta em uma saída semelhante ao exemplo abaixo.

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

Na saída de exemplo, a falha foi causada por fuzz_me_fuzzer.cpp na linha 10:

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

Esta é uma leitura fora dos limites simples se data tiver comprimento 3.

Depois de executar o fuzzer, a saída geralmente resulta em uma falha, e a entrada infratora é salva no corpus e recebe um ID. No exemplo de saída, é crash-0eb8e4ed029b774d80f2b66408203801cb982a60.

Para extrair informações de falhas ao fuzz no dispositivo, emita este comando, especificando o ID da falha:

adb pull /data/fuzz/arm64/fuzz_me_fuzzer/corpus/CRASH_ID

Para salvar os casos de teste no diretório correto, use a pasta "corpus" (como no exemplo acima) ou o argumento "artifact_prefix" (por exemplo, "-artifact_prefix=/data/fuzz/where/my/crashes/go").

Quando o fuzzing é feito no host, as informações de falha aparecem na pasta de falhas na pasta local em que o fuzzer está sendo executado.

Gerar cobertura de linha

A cobertura de linha é muito útil para os desenvolvedores, porque eles podem identificar áreas no código que não estão cobertas e atualizar os fuzzers de acordo com isso para atingir essas áreas em execuções de fuzzing futuras.

Para gerar relatórios de cobertura do fuzzer, siga estas etapas :

CLANG_COVERAGE=true NATIVE_COVERAGE_PATHS='*' make ${FUZZER_NAME}

Depois de enviar o fuzzer e as dependências dele para o dispositivo, execute o alvo de fuzz com LLVM_PROFILE_FILE da seguinte maneira:

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

Para produzir o relatório de cobertura, primeiro extraia o arquivo profraw do dispositivo e gere o relatório HTML em uma pasta chamada coverage-html, conforme mostrado abaixo:

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 mais informações sobre o libFuzzer, consulte a documentação upstream.