Kiểm thử tìm lỗi mã nguồn bằng libFuzzer

Tìm lỗi mã nguồn (fuzzing) đơn giản là cung cấp dữ liệu có thể không hợp lệ, không mong muốn hoặc ngẫu nhiên làm dữ liệu đầu vào cho một chương trình. Đây là một cách cực kỳ hiệu quả để tìm lỗi trong các hệ thống phần mềm lớn và là một phần quan trọng trong vòng đời phát triển phần mềm.

Hệ thống xây dựng của Android hỗ trợ tính năng tìm lỗi mã nguồn ngẫu nhiên thông qua việc đưa libFuzzer vào dự án cơ sở hạ tầng trình biên dịch LLVM. LibFuzzer được liên kết với thư viện đang được kiểm thử và xử lý tất cả các hoạt động lựa chọn, đột biến và báo cáo sự cố đầu vào xảy ra trong một phiên tìm lỗi mã nguồn. Trình dọn dẹp của LLVM được dùng để hỗ trợ phát hiện lỗi hỏng bộ nhớ và các chỉ số về mức độ sử dụng mã.

Bài viết này giới thiệu về libFuzzer trên Android và cách tạo bản dựng được đo lường. Tài liệu này cũng bao gồm hướng dẫn viết, chạy và tùy chỉnh trình tìm lỗi mã nguồn.

Thiết lập và tạo bản dựng

Để đảm bảo bạn có hình ảnh đang hoạt động trên một thiết bị, bạn có thể tải hình ảnh ban đầu xuống và cài đặt ROM cho thiết bị. Ngoài ra, bạn có thể tải mã nguồn AOSP xuống rồi làm theo ví dụ về cách thiết lập và tạo bản dựng ở bên dưới.

Ví dụ về cách thiết lập

Ví dụ này giả định thiết bị mục tiêu là Pixel (taimen) và đã được chuẩn bị để gỡ lỗi qua USB (aosp_taimen-userdebug). Bạn có thể tải các tệp nhị phân Pixel khác xuống từ Tệp nhị phân trình điều khiển.

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

Ví dụ về bản dựng

Bước đầu tiên để chạy các mục tiêu tìm lỗi mã nguồn là tải một hình ảnh hệ thống mới. Bạn nên sử dụng ít nhất là phiên bản phát triển mới nhất của Android.

  1. Thực hiện bản dựng ban đầu bằng cách phát hành:
    m
  2. Để cho phép bạn cài đặt ROM cho thiết bị, hãy khởi động thiết bị của bạn vào chế độ khởi động nhanh bằng kiểu kết hợp phím thích hợp.
  3. Mở khoá trình tải khởi động và cài đặt ROM hình ảnh mới biên dịch bằng các lệnh sau.
    fastboot oem unlock
    fastboot flashall

Giờ đây, thiết bị mục tiêu đã sẵn sàng để tạo lỗi ngẫu nhiên bằng libFuzzer.

Viết trình tìm lỗi mã nguồn

Để minh hoạ cách viết trình tìm lỗi mã nguồn toàn diện bằng libFuzzer trong Android, hãy sử dụng mã dễ bị tấn công sau đây làm trường hợp kiểm thử. Điều này giúp kiểm thử trình tạo dữ liệu ngẫu nhiên, đảm bảo mọi thứ đang hoạt động chính xác và minh hoạ hình thức của dữ liệu sự cố.

Dưới đây là hàm kiểm thử.

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

Cách tạo và chạy công cụ kiểm thử tìm lỗi ngẫu nhiên này:

  1. Mục tiêu tìm lỗi mã nguồn bao gồm hai tệp: tệp bản dựng và mã nguồn mục tiêu tìm lỗi mã nguồn. Tạo tệp ở vị trí bên cạnh thư viện mà bạn đang tìm lỗi mã nguồn. Đặt tên cho trình tạo dữ liệu ngẫu nhiên mô tả chức năng của trình tạo dữ liệu ngẫu nhiên.
  2. Viết mục tiêu tìm lỗi mã nguồn bằng libFuzzer. Mục tiêu làm rối mã nguồn là một hàm lấy một blob dữ liệu có kích thước đã chỉ định và truyền blob đó đến hàm cần làm rối mã nguồn. Dưới đây là một trình tìm lỗi mã nguồn cơ bản cho hàm kiểm thử dễ bị tấn công:
    #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. Yêu cầu hệ thống xây dựng của Android tạo tệp nhị phân của trình tạo dữ liệu ngẫu nhiên. Để tạo trình tạo dữ liệu ngẫu nhiên, hãy thêm mã này vào tệp 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. Cách tạo trình tạo dữ liệu ngẫu nhiên để chạy trên mục tiêu (Thiết bị):
    SANITIZE_TARGET=hwaddress m fuzz_me_fuzzer
    
  5. Cách tạo trình tìm lỗi mã nguồn để chạy trên máy chủ lưu trữ:
    SANITIZE_HOST=address m fuzz_me_fuzzer
    

Để thuận tiện, hãy xác định một số biến shell chứa đường dẫn đến mục tiêu tìm lỗi mã nguồn và tên của tệp nhị phân (từ tệp bản dựng mà bạn đã viết trước đó).

export FUZZER_NAME=your_fuzz_target

Sau khi làm theo các bước này, bạn sẽ có một trình tạo dữ liệu ngẫu nhiên được tạo sẵn. Vị trí mặc định cho trình tạo dữ liệu ngẫu nhiên (cho bản dựng Pixel trong ví dụ này) là:

  • $ANDROID_PRODUCT_OUT/data/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME cho thiết bị.
  • $ANDROID_HOST_OUT/fuzz/$TARGET_ARCH/$FUZZER_NAME/$FUZZER_NAME cho máy chủ lưu trữ.
  • Chạy trình tìm lỗi mã nguồn trên máy chủ lưu trữ

  • Thêm vào tệp bản dựng Android.bp:
    host_supported: true,
    Xin lưu ý rằng bạn chỉ có thể áp dụng tính năng này nếu thư viện bạn muốn tạo mã nguồn ngẫu nhiên được máy chủ hỗ trợ.
  • Chạy trình tìm lỗi mã nguồn trên máy chủ lưu trữ bằng cách chạy tệp nhị phân trình tìm lỗi mã nguồn đã tạo:
    $ANDROID_HOST_OUT/fuzz/x86_64/$FUZZER_NAME/$FUZZER_NAME
  • Chạy trình tìm lỗi mã nguồn trên thiết bị

    Chúng ta muốn sao chép nội dung này sang thiết bị của bạn bằng adb.

    1. Để tải các tệp này lên một thư mục trên thiết bị, hãy chạy các lệnh sau:
      adb root
      adb sync data
    2. Chạy trình tạo dữ liệu ngẫu nhiên kiểm thử trên thiết bị bằng lệnh sau:
      adb shell /data/fuzz/$(get_build_var TARGET_ARCH)/$FUZZER_NAME/$FUZZER_NAME \
        /data/fuzz/$(get_build_var TARGET_ARCH)/$FUZZER_NAME/corpus

    Thao tác này sẽ tạo ra kết quả tương tự như kết quả mẫu bên dưới.

    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
    

    Trong kết quả ví dụ, sự cố là do fuzz_me_fuzzer.cpp gây ra ở dòng 10:

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

    Đây là một trường hợp đọc vượt quá giới hạn đơn giản nếu data có độ dài 3.

    Sau khi bạn chạy trình tìm lỗi mã nguồn, kết quả thường dẫn đến sự cố và dữ liệu đầu vào vi phạm sẽ được lưu trong tập hợp văn bản và được cấp mã nhận dạng. Trong kết quả ví dụ, đây là crash-0eb8e4ed029b774d80f2b66408203801cb982a60.

    Để truy xuất thông tin sự cố khi tìm lỗi mã nguồn trên thiết bị, hãy đưa ra lệnh này, chỉ định mã sự cố:

    adb pull /data/fuzz/arm64/fuzz_me_fuzzer/corpus/CRASH_ID
    Lưu ý rằng để lưu các trường hợp kiểm thử vào thư mục phù hợp, bạn có thể sử dụng thư mục corpus (như trong ví dụ trên) hoặc sử dụng đối số artifact_prefix (ví dụ: `-artifact_prefix=/data/fuzz/where/my/crashes/go`).

    Khi tạo lỗi ngẫu nhiên trên máy chủ, thông tin về sự cố sẽ xuất hiện trong thư mục sự cố trong thư mục cục bộ nơi trình tạo lỗi ngẫu nhiên đang chạy.

    Tạo mức độ sử dụng dòng

    Mức độ sử dụng dòng rất hữu ích cho nhà phát triển vì họ có thể xác định chính xác các khu vực trong mã không được sử dụng và cập nhật trình kiểm thử mờ cho phù hợp để kiểm thử các khu vực đó trong các lần chạy kiểm thử mờ trong tương lai.

    1. Để tạo báo cáo mức độ sử dụng trình tạo dữ liệu ngẫu nhiên, hãy chạy các bước sau :
      CLANG_COVERAGE=true NATIVE_COVERAGE_PATHS='*' make ${FUZZER_NAME}
    2. Sau khi đẩy trình tạo dữ liệu ngẫu nhiên và các phần phụ thuộc của trình tạo dữ liệu ngẫu nhiên đó vào thiết bị, hãy chạy mục tiêu dữ liệu ngẫu nhiên bằng LLVM_PROFILE_FILE như sau:
      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. Tạo báo cáo mức độ sử dụng bằng cách trước tiên, hãy lấy tệp profraw ra khỏi thiết bị, sau đó tạo báo cáo html vào một thư mục có tên coverage-html như minh hoạ dưới đây:
      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

    Để biết thêm thông tin về libFuzzer, hãy xem tài liệu cấp trên.