Mulai 27 Maret 2025, sebaiknya gunakan android-latest-release, bukan aosp-main, untuk mem-build dan berkontribusi pada AOSP. Untuk mengetahui informasi selengkapnya, lihat Perubahan pada AOSP.

Halaman ini diterjemahkan oleh Cloud Translation API.

Fuzz dengan libFuzzer
Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Fuzzing, yang hanya menyediakan data yang berpotensi tidak valid, tidak terduga, atau acak sebagai input ke program, adalah cara yang sangat efektif untuk menemukan bug dalam sistem software besar, dan merupakan bagian penting dari siklus proses pengembangan software.

Sistem build Android mendukung fuzzing melalui penyertaan libFuzzer dari project project infrastruktur compiler LLVM. LibFuzzer ditautkan dengan library yang sedang diuji dan menangani semua pemilihan, mutasi, dan pelaporan error input yang terjadi selama sesi fuzzing. Sanitizer LLVM digunakan untuk membantu deteksi kerusakan memori dan metrik cakupan kode.

Artikel ini memberikan pengantar tentang libFuzzer di Android dan cara melakukan build berinstrumen. Panduan ini juga mencakup petunjuk untuk menulis, menjalankan, dan menyesuaikan fuzzer.

Penyiapan dan build

Untuk memastikan Anda memiliki image yang berfungsi dan berjalan di perangkat, Anda dapat mendownload image pabrik dan mem-flash perangkat. Atau, Anda dapat mendownload kode sumber AOSP dan mengikuti contoh penyiapan dan build di bawah.

Contoh penyiapan

Contoh ini mengasumsikan bahwa perangkat target adalah Pixel (taimen) dan sudah siap untuk proses debug USB (aosp_taimen-userdebug). Anda dapat mendownload biner Pixel lainnya dari Biner 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

Contoh build

Langkah pertama untuk menjalankan target fuzz adalah mendapatkan image sistem baru. Sebaiknya gunakan setidaknya versi pengembangan Android terbaru.

Lakukan build awal dengan mengeluarkan:
```
m
```
Agar Anda dapat mem-flash perangkat, booting perangkat ke mode fastboot menggunakan kombinasi tombol yang sesuai.
Buka kunci bootloader dan flash image yang baru dikompilasi dengan perintah berikut.
```
fastboot oem unlock
fastboot flashall
```

Perangkat target kini siap untuk fuzzing libFuzzer.

Menulis fuzzer

Untuk mengilustrasikan penulisan fuzzer menyeluruh menggunakan libFuzzer di Android, gunakan kode rentan berikut sebagai kasus pengujian. Hal ini membantu menguji fuzzer, memastikan semuanya berfungsi dengan benar, dan menggambarkan tampilan data error.

Berikut adalah fungsi pengujian.

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

Untuk mem-build dan menjalankan fuzzer pengujian ini:

Target fuzz terdiri dari dua file: file build dan kode sumber target fuzz. Buat file di lokasi di samping library yang Anda fuzzing. Beri fuzzer nama yang menjelaskan fungsi fuzzer.

Menulis target fuzz menggunakan libFuzzer. Target fuzz adalah fungsi yang mengambil blob data dengan ukuran yang ditentukan dan meneruskannya ke fungsi yang akan di-fuzz. Berikut adalah fuzzer dasar untuk fungsi pengujian yang rentan:

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

Beri tahu sistem build Android untuk membuat biner fuzzer. Untuk mem-build fuzzer, tambahkan kode ini ke file 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",
}

Untuk membuat fuzzer agar berjalan di target (Perangkat):
```
SANITIZE_TARGET=hwaddress m fuzz_me_fuzzer
```
Untuk membuat fuzzer agar dapat berjalan di host:
```
SANITIZE_HOST=address m fuzz_me_fuzzer
```

Untuk memudahkan, tentukan beberapa variabel shell yang berisi jalur ke target fuzz dan nama biner (dari file build yang Anda tulis sebelumnya).

export FUZZER_NAME=your_fuzz_target

Setelah mengikuti langkah-langkah ini, Anda akan memiliki fuzzer bawaan. Lokasi default untuk fuzzer (untuk contoh build Pixel ini) adalah:

$ANDROID_PRODUCT_OUT/data/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME untuk perangkat.

$ANDROID_HOST_OUT/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME untuk host.

Menjalankan fuzzer di host

Tambahkan ke file build Android.bp Anda:

host_supported: true,

Perhatikan bahwa hal ini hanya dapat diterapkan jika library yang ingin Anda fuzz didukung host.

Jalankan fuzzer di host dengan menjalankan biner fuzzer yang telah dibuat:

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

Menjalankan fuzzer di perangkat

Kita ingin menyalinnya ke perangkat Anda menggunakan adb.

Untuk mengupload file ini ke direktori di perangkat, jalankan perintah berikut:
```
adb root
adb sync data
```

Jalankan fuzzer pengujian di perangkat dengan perintah ini:

adb shell /data/fuzz/$(get_build_var TARGET_ARCH)/$FUZZER_NAME/$FUZZER_NAME \
  /data/fuzz/$(get_build_var TARGET_ARCH)/$FUZZER_NAME/corpus

Tindakan ini akan menghasilkan output yang mirip dengan contoh output di bawah.

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

Dalam contoh output, error disebabkan oleh fuzz_me_fuzzer.cpp di baris 10:

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

Ini adalah pembacaan di luar batas yang sederhana jika data memiliki panjang 3.

Setelah Anda menjalankan fuzzer, output sering kali menyebabkan error dan input yang melanggar disimpan dalam korpus dan diberi ID. Dalam contoh output, ini adalah crash-0eb8e4ed029b774d80f2b66408203801cb982a60.

Untuk mengambil informasi error saat melakukan fuzzing di perangkat, berikan perintah ini, yang menentukan ID error Anda:

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

Perhatikan bahwa untuk menyimpan testcase ke direktori yang tepat, Anda dapat menggunakan folder korpus (seperti pada contoh di atas) atau menggunakan argumen artifact_prefix (misalnya, `-artifact_prefix=/data/fuzz/where/my/crashes/go`).

Saat melakukan fuzzing di host, informasi error akan muncul di folder error dalam folder lokal tempat fuzzer dijalankan.

Membuat cakupan baris

Cakupan baris sangat berguna bagi developer karena mereka dapat menentukan area dalam kode yang tidak tercakup dan memperbarui fuzzer mereka dengan sesuai untuk menjangkau area tersebut dalam menjalankan fuzzing pada masa mendatang.

Untuk membuat laporan cakupan fuzzer, jalankan langkah-langkah berikut :
```
CLANG_COVERAGE=true NATIVE_COVERAGE_PATHS='*' make ${FUZZER_NAME}
```

Setelah mendorong fuzzer dan dependensinya ke perangkat, jalankan target fuzz dengan LLVM_PROFILE_FILE sebagai berikut:

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

Buat laporan cakupan dengan terlebih dahulu mengambil file profraw dari perangkat, lalu membuat laporan html ke folder bernama coverage-html seperti yang ditunjukkan di bawah:

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

Untuk informasi selengkapnya tentang libFuzzer, lihat dokumentasi upstream.