tutorial_ja.md

チュートリアル

ファザーコレクションとしてのfuzzufの使い方

ここでは、ファザーコレクションとしてのfuzzufを、どのように使えばよいかを段階的に説明します。 ファザー構築フレームワークとしてのfuzzufの使い方は、別のドキュメントを参照してください。

ビルド方法

推奨環境: Ubuntu 20.04（あるいは18.04）

まずはUbuntu 20.04を例に、fuzzufのビルド手順を示します。

$ sudo apt update
$ sudo apt install -y \
  build-essential cmake git libboost-all-dev \
  python3 nlohmann-json3-dev pybind11-dev libcrypto++-dev
$ git clone https://github.com/fuzzuf/fuzzuf.git
$ cd fuzzuf
$ cmake -B build -DCMAKE_BUILD_TYPE=Release # デバッグログを出力する場合はDebugに変更
$ cmake --build build -j$(nproc)

Ubuntu 18.04の場合、代わりに以下のコマンドを実行してビルドしてください。

$ sudo apt update
$ sudo apt install -y \
  build-essential cmake git libboost-all-dev \
  python3 nlohmann-json-dev pybind11-dev libcrypto++-dev
$ git clone https://github.com/fuzzuf/fuzzuf.git
$ mkdir fuzzuf/build
$ cd $_
$ cmake ../ -DCMAKE_BUILD_TYPE=Release # 古い形式のコマンドなのは、aptでインストールされるCMakeのバージョンが古いため
$ make -j$(nproc)

詳しいビルド方法についてはbuilding.mdを参照してください。

ファザーの使い方

このセクションでは、docs/resources/exifutilディレクトリ以下に配置された、JPEGファイルからexif情報をパースするプログラムexifutilに対して、ファジングを行います。 ファジングを行うためには、プログラムのコンパイル時に計装を呼ばれる作業が必要です。このために、追加でaptからafl++-clangまたはafl-clangパッケージをインストールする必要があります。

以下のコマンドで計装用コンパイララッパーをインストールし、プログラムを計装ビルドします。

$ # afl++-clangはUbuntu 20.04+でのみ利用可能
$ # それ以下のUbuntuバージョンでは、代わりにafl-clangをインストール
$ # 両パッケージともに、afl-clang-fastがインストールされます
$ sudo apt install -y afl++-clang
$ pushd docs/resources/exifutil
$ CC=afl-clang-fast make
$ popd

次に、ファジングに使う初期シードを準備します。初期シードはPUT（Program Under Test: ファジング対象のプログラム）の、ミューテーションを適用する前の、最初のテストケースとして使用されます。今回のPUTはJPEGパーサーであるため、docs/resources/exifutil/fuzz_input/jpeg.jpgなど適当なJPEGファイルを用意します。 これで、ファジングのための準備が整いました。次のコマンドで、AFLを使ったファジングを行います。

$ mkdir /tmp/input # 初期シードのためのディレクトリを作成
$ cp /path/to/jpeg/image.jpg /tmp/input
$ cd /path/to/fuzzuf/build
$ ./fuzzuf afl --in_dir=/tmp/input \
  --out_dir=/tmp/afl.out -- \
  ../docs/resources/exifutil/exifutil -f @@

最後のコマンドの-fオプションは、PUT固有のものであり、fuzzufのオプションではないことに留意してください。

上記のコマンドを実行すると、ターミナルに以下のようなユーザーインターフェースが表示され、AFLによるファジングが開始します。

このとき、PUTはファザーにより様々な入力を与えられながら繰り返し実行されており、その実行結果がクラッシュ、またはハングするようなら、その入力は保存されます。
具体的にはPUTをクラッシュさせる入力が発見され、それ以前に保存されたものと重複しないと判断されると、その入力は--out_dirオプションで示されたディレクトリ以下の、crashesディレクトリに保存され、上記UIの右上にあるunique crashesの数値が1増加します。
ファジングを終了するには、Ctrl-Cでfuzzufプロセスに対してSIGINTを送ります。--out_dirディレクトリ以下の、クラッシュやハングを引き起こした入力を確認し、その原因を分析しましょう。

使用するファザーの変更

fuzzufで利用できるファザーは、AFLだけではありません。次は、AFLFastを使って、同じテスト用バイナリをファジングします。AFLFastがどのようなファザーかについては、AFLFastのドキュメントを参照してください。 使用するファザーを変更するには、fuzzufのコマンドライン引数（およびそれに伴うオプション）を変えるだけです。先ほどのコマンドにおけるファザーの指定を、aflからaflfastに変えて実行してみましょう。

$ ./fuzzuf aflfast --in_dir=/tmp/input \
  --out_dir=/tmp/aflfast.out \
  ../docs/resources/exifutil/exifutil -f @@

AFLFastで採用されているパワースケジューリングは、ファザーを長時間実行することで、そのパフォーマンスをオリジナルのAFLのものから上昇させます。詳しくは、上記で挙げたドキュメントをご参照ください。

そのほかのファザーを試したい場合、同様にコマンドライン引数とオプションを変更すれば可能です。ただし、使用するファザーによっては、バイナリに対して特殊な処理を施す必要がある点に留意してください。
各ファザーの使い方については、ドキュメントフォルダを参考にしてください。