純粋なRubyコードおよびRubyのC拡張向けのカバレッジガイド付きファザーです。
Ruzzyは、Python向けファザーであるGoogleのAtherisに大きな影響を受けています。Ruzzyはカバレッジ計測とファジングエンジンにlibFuzzer(またはLibAFL)を使用しています。またRuzzyは、C拡張をファジングする際にAddressSanitizerとUndefinedBehaviorSanitizerもサポートしています。Ruzzyの着想の背景について詳しく知りたい場合は、論文「Design and Implementation of a Coverage-Guided Ruby Fuzzer」をご覧ください。
目次:
RuzzyはLinux(x86-64、AArch64/ARM64)およびmacOS(Apple Silicon)をサポートしています。Windowsでは、Dockerfileをビルドするか、開発環境を使用できます。Ruzzyには比較的新しいバージョンのclang(14.0.0以降でテスト済み)が必要で、できれば最新リリースの使用を推奨します。macOS固有のセットアップについては、macOSユーザー向けの注意事項を参照してください。
Ruzzyは以下のコマンドでインストールします:
MAKE="make --environment-overrides V=1" \
CC="/path/to/clang" \
CXX="/path/to/clang++" \
LDSHARED="/path/to/clang -shared" \
LDSHAREDXX="/path/to/clang++ -shared" \
gem install ruzzy
ここでは多くのことが行われているため、分解して説明します:
MAKE 環境変数は、Ruzzy C 拡張機能をコンパイルする際に make コマンドを上書きします。これにより、make は拡張機能のコンパイル時に後続の環境変数を尊重するようになります。clang バイナリを使用していることを保証します。これにより、適切なファジングに必要な最新の clang 機能を利用できることが保証されます。インストール時に問題が発生した場合は、次のコマンドを実行してデバッグ出力を取得できます:
RUZZY_DEBUG=1 gem install --verbose ruzzy
純粋なRubyのファジング対象が正規表現を多用する場合は、regexp_parserをインストールしてください:
gem install regexp_parser
インストールされると、Ruzzyはこの機能を自動的に使用して、ファジング中に遭遇した正規表現をサンプリング(つまり解決)します。これにより、ファザーは正規表現の条件を突破して追加のカバレッジを解放できます。
Ruzzyには、その動作を示すためのおもちゃの例が含まれています。まず、次の環境変数を設定します:
export ASAN_OPTIONS="allocator_may_return_null=1:detect_leaks=0:use_sigaltstack=0"
ASAN_OPTIONSその後、次のコマンドでサンプルを実行できます:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby -e 'require "ruzzy"; Ruzzy.dummy'
LD_PRELOAD が必要な理由は Atheris の場合と同じです。ただし、ASAN_OPTIONS とは異なり、他のプログラムに干渉する可能性があるため、おそらく export したくないでしょう。
次のようなクラッシュがすぐに発生するはずです:
INFO: Running with entropic power schedule (0xFF, 100).
INFO: Seed: 2527961537
...
==45==ERROR: AddressSanitizer: heap-use-after-free on address 0x50c0009bab80 at pc 0xffff99ea1b44 bp 0xffffce8a67d0 sp 0xffffce8a67c8
...
SUMMARY: AddressSanitizer: heap-use-after-free /var/lib/gems/3.1.0/gems/ruzzy-0.9.0/ext/dummy/dummy.c:18:24 in _c_dummy_test_one_input
...
==45==ABORTING
MS: 4 EraseBytes-CopyPart-CopyPart-ChangeBit-; base unit: 410e5346bca8ee150ffd507311dd85789f2e171e
0x48,0x49,
HI
artifact_prefix='./'; Test unit written to ./crash-253420c1158bc6382093d409ce2e9cff5806e980
Base64: SEk=
入力("HI")がメモリ違反を引き起こしたことを正しく検出できていることがわかります。詳細については、この違反が発生した理由を確認するために dummy.c を参照してください。
次のコマンドでクラッシュケースを再実行できます:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby -e 'require "ruzzy"; Ruzzy.dummy' \
./crash-253420c1158bc6382093d409ce2e9cff5806e980
以下のサニタイザーが利用可能です:
Ruzzy::ASAN_PATH(AddressSanitizer 用)Ruzzy::UBSAN_PATH(UndefinedBehaviorSanitizer 用)例として、小さな Ruby スクリプトをファジングしてみましょう。純粋な Ruby コードのファジングには、トレーサースクリプトとファジングハーネスの 2 つの Ruby スクリプトが必要です。トレーサースクリプトは、Ruby インタープリターの実装上の詳細のために必要となります。
まず、トレーサースクリプトです。これを test_tracer.rb と呼ぶことにします:
# frozen_string_literal: true
require 'ruzzy'
Ruzzy.trace('test_harness.rb')
次に、ファジングハーネスです。これを test_harness.rb と呼びましょう:
# frozen_string_literal: true
require 'ruzzy'
def fuzzing_target(input)
if input.length == 4
if input[0] == 'F'
if input[1] == 'U'
if input[2] == 'Z'
if input[3] == 'Z'
raise
end
end
end
end
end
end
test_one_input = lambda do |data|
fuzzing_target(data) # Your fuzzing target would go here
return 0
end
Ruzzy.fuzz(test_one_input)
このファイルを実行し、次のコマンドでファジングを開始できます:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby test_tracer.rb
次のようなクラッシュがすぐに発生するはずです:
INFO: Running with entropic power schedule (0xFF, 100).
INFO: Seed: 2311041000
...
/app/ruzzy/bin/test_harness.rb:12:in `block in <top (required)>': unhandled exception
from /var/lib/gems/3.1.0/gems/ruzzy-0.9.0/lib/ruzzy.rb:15:in `c_fuzz'
from /var/lib/gems/3.1.0/gems/ruzzy-0.9.0/lib/ruzzy.rb:15:in `fuzz'
from /app/ruzzy/bin/test_harness.rb:35:in `<top (required)>'
from bin/test_tracer.rb:7:in `require_relative'
from bin/test_tracer.rb:7:in `<main>'
...
SUMMARY: libFuzzer: fuzz target exited
MS: 1 CopyPart-; base unit: 24b4b428cf94c21616893d6f94b30398a49d27cc
0x46,0x55,0x5a,0x5a,
FUZZ
artifact_prefix='./'; Test unit written to ./crash-aea2e3923af219a8956f626558ef32f30a914ebc
Base64: RlVaWg==
入力("FUZZ")が例外を引き起こすことを正しく検出できていることがわかります。
独自のターゲットをファジングするには、test_one_input の lambda を変更して、対象の関数を呼び出すようにします。
例として、msgpack-ruby ライブラリをファジングしてみましょう。まず、gem をインストールします:
MAKE="make --environment-overrides V=1" \
CC="/path/to/clang" \
CXX="/path/to/clang++" \
LDSHARED="/path/to/clang -shared" \
LDSHAREDXX="/path/to/clang++ -shared" \
CFLAGS="-fsanitize=address,fuzzer-no-link -fno-omit-frame-pointer -fno-common -fPIC -g" \
CXXFLAGS="-fsanitize=address,fuzzer-no-link -fno-omit-frame-pointer -fno-common -fPIC -g" \
gem install msgpack
Ruzzy のコンパイル時に使用する環境変数に加えて、CFLAGS と CXXFLAGS を指定しています。これらのフラグはファジングプロセスを支援します。アドレスサニタイザーやスタックトレース情報の改善など、有用な機能を有効にします。詳細については AddressSanitizerFlags を参照してください。
次に、msgpack 用のファジングハーネスが必要です。以下は libFuzzer の経験がある方には馴染み深いかもしれません:
# frozen_string_literal: true
require 'msgpack'
require 'ruzzy'
test_one_input = lambda do |data|
begin
MessagePack.unpack(data)
rescue Exception
# We're looking for memory corruption, not Ruby exceptions
end
return 0
end
Ruzzy.fuzz(test_one_input)
このファイルを fuzz_msgpack.rb と呼ぶことにします。このファイルを実行し、次のコマンドでファジングを開始できます:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby fuzz_msgpack.rb
libFuzzer のオプションは、次のように Ruby スクリプトに渡すことができます: