fuzzer

About Shiguredo's open source software

We will not respond to PRs or issues that have not been discussed on Discord. Also, Discord is only available in Japanese.

Please read https://github.com/shiguredo/oss before use.

時雨堂のオープンソースソフトウェアについて

利用前に https://github.com/shiguredo/oss をお読みください。

概要

fuzzer は、Erlang で実装した関数を libFuzzer から実行するためのライブラリです。 feedback オプションを使うと、Erlang コードの行または節の到達を libFuzzer の 探索に使えます。

使い方

fuzz target を実装します。evaluate/1 が入力を処理し、ok を返します。 対象の関数が例外を送出すると、その入力はクラッシュ入力として保存されます。

-module(example_fuzz_target).

-behaviour(fuzzer_target).

-export([evaluate/1]).


-spec evaluate(binary()) -> ok.
evaluate(Data) ->
    % example_parser は利用者が用意する対象の関数
    % 通常の入力エラーは {error, Reason} として返るため、クラッシュにしない
    % 例外は捕捉しないため、その入力はクラッシュ入力として保存される
    case example_parser:decode(Data) of
        {ok, _Value} ->
            ok;
        {error, _Reason} ->
            ok
    end.

例外を捕捉して ok を返すと、クラッシュとして記録されません。例外は伝播させます。

fuzzer:run/1 で実行します。次の例は 30 秒で打ち切ります。feedback に対象のモジュールを指定すると、Erlang コードの行または節の到達が libFuzzer の探索に使われます。

fuzzer:run(#{target => example_fuzz_target,
             max_total_time => 30,
             feedback => [example_parser]}).

意味的な状態を追加で伝えたい場合だけ、evaluate/1 が {ok, Features} を返します。

rebar3 から実行する場合は rebar3_fuzzer を使います。

rebar3 fuzzer --target example_fuzz_target --max-total-time 30

fuzzer は Hex で公開しています。rebar3_fuzzer はこのリポジトリに含まれる プラグインで、Hex では公開していません。両方を使う場合、利用するプロジェクトの rebar.config に次の設定を追加します。

{deps, [{fuzzer, "2026.1.0-canary.0"}]}.

{project_plugins,
 [{rebar3_fuzzer,
   {git_subdir, "https://github.com/shiguredo/fuzzer.git",
    {branch, "develop"}, "rebar3_fuzzer"}}]}.

導入方法、オプション、コーパス、クラッシュレポートは doc/USAGE.md を参照してください。

動作環境

fuzzer の NIF をビルドするには、次のものが必要です。

• Erlang/OTP 29.1 以上
• rebar3
• Clang
• Clang と同じバージョンの compiler-rt (libclang_rt.fuzzer_no_main)

リポジトリのサンプルを実行する場合は、初期コーパスの変換に xxd も必要です。

ドキュメント

libFuzzer ライセンス

本ソフトウェアは libFuzzer のランタイム (libclang_rt.fuzzer_no_main) を NIF に静的リンクしています。 そのため、ビルドした priv/fuzzer_nif.so には libFuzzer のコードが含まれます。 libFuzzer は LLVM プロジェクトの一部で、Apache License 2.0 with LLVM Exceptions で配布されています。 ライセンス本文は THIRD_PARTY_LICENSES.md に同梱しています。

• https://llvm.org/LICENSE.txt

ライセンス

Apache License 2.0

Copyright 2026 Shiguredo Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.