Mayhemfile の構成¶

Mayhem ランを実行してターゲットアプリケーションを解析する際、Mayhem は Mayhemfile という構成ファイルを使用します。ユーザーは、この設定ファイルに必須および任意パラメーターを指定し、カスタムターゲットをテストできます。

シンプルなアプリケーションでは、mayhem package コマンドを使用して、ターゲットアプリケーションの Mayhemfile を自動的に生成することができます。しかし、より複雑なソフトウェアでは、多くの場合、ターゲットを正しくファジングするには、ユーザーが Mayhemfile で追加の設定を指定する必要があります。そのため、ユーザーがそれぞれの Mayhem ランに合わせて Mayhemfile を構成するのに役立つ情報を以下に記載しています。

Mayhemfile ソースとランの違い¶

デバッグする際、ユーザーが作成して Mayhem にアップロードした Mayhemfile と、Mayhem が実際に Mayhem ランで使用する完全修飾された Mayhemfile の違いを意識する必要があります。

具体的には、Mayhem はユーザーがアップロードした Mayhemfile に特定のフィールドを追加、変更、削除して最終的な変更を加え、Mayhem ランの実行に使用する完全な構成を作成します。Mayhem は、以下を考慮してユーザーがアップロードした「ソース」Mayhemfileを調整します。

環境変数: ${MAYHEM_PROJECT} などの Mayhemfile 内の変数は、ユーザーの対応する環境変数 (存在する場合) の値に置き換えられます。
CLI のオーバーライド: Mayhem CLI で特定のパラメーター/フラグを指定して Mayhem ランを実行した結果として、Mayhemfile 内の値が上書きされます。
デフォルト値: カスタム値が指定されていない場合、自動的にデフォルトのパラメーターおよび値が Mayhemfile に追加されます。

環境変数¶

次のソース Mayhemfile を見てみましょう。

project: ${FOO}
target: ${BAR}
cmds:
  -  cmd: /bin/grep @@

${FOO} および ${BAR} 環境変数が設定されています。

Note

Mayhemfile で環境変数を指定する際、${FOO} または $FOO のどちらの構文を使用してもかまいません。この 2 つは同等です。

ユーザーの環境で ${FOO} に foo が設定され、${BAR} に bar が設定されている場合、mayhem run コマンドを実行すると、次のように環境変数の展開を確認するプロンプトが表示されます。”Y" を入力して続行します。

$ export FOO=foo
$ export BAR=bar
$ mayhem run .
Performing environment variable interpolation based on the following values from the local environment:
    FOO
    BAR
Proceed? [Y/n]? Y
Run started: foo/bar/1
Run URL: https://tutorial.forallsecure.com:443/mayhemuser/foo/bar/1

Tip

プロンプトをスキップしたい場合、mayhem run などの Mayhem CLI コマンドに任意オプション -y または --noninteractive を使用できます。たとえば、mayhem -y run . は現在のディレクトリ内の Mayhemfile を使用して非インタラクティブモードで Mayhem ランを実行します。

ランが実行され、このランの Mayhemfile を確認すると、${FOO} および ${BAR} 環境変数が適切な値に置換されていることがわかります。

project: foo
target: bar
cmds:
  -  cmd: /bin/grep @@

Info

Mayhemfile で文字をエスケープするには、バックスラッシュ \ を使用します。たとえば、$TARGET というターゲットがある場合、次のようにバックスラッシュを使用して $ をエスケープします:

# Source Mayhemfile
project: foo
target: bar
cmds:
  -  cmd: \$TARGET @@

これは次のようになります:

# Run Mayhemfile
project: foo
target: bar
cmds:
  -  cmd: $TARGET @@

CLI のオーバーライド¶

Mayhem CLI で次のオーバーライドパラメーターを指定して mayhem run を実行できます。

-h, --help            Show this help message and exit.
--regression          Run regression tests on available test cases.
--static              Run static checks on the entrypoint of the target.
--dynamic             Run dynamic analysis on the target.
--coverage            Perform coverage analysis on the target.
--all                 Enable all supported analyses.
-f FILE, --file FILE  Path to the Mayhemfile used (default:
                      <package>/Mayhemfile).
-b BUILD_ID, --build-id BUILD_ID
                      Build id to associate with this specific run.
--docker              Indicates whether the package is a docker image tag or
                      hash.
--warning-as-error    Have the warnings be treated as errors.
--testsuite TESTSUITE Specify a testsuite directory.
--project PROJECT     Name of the project.
--owner OWNER         The owner for this project.
--target TARGET       Name of the target.
--image IMAGE         Docker image you want to analyze.
--duration DURATION   How long to run for in seconds (wall clock time).
--uid UID             User id for running the target.
--gid GID             Group id for running the target.
--advanced-triage ADVANCED_TRIAGE
                      Set extra advanced triage analysis. Increases the
                      number of CWEs Mayhem finds but also increases test
                      case processing time.
--cmd CMD             Command to invoke the target.
--cwd CWD             Current working directory for running the target.
--env KEY=VALUE       Environment variable to include while running.
--filepath FILEPATH   Input file path where the target reads from.
--network-url NETWORK_URL
                      Network URI where the target reads from.
--network-timeout NETWORK_TIMEOUT
                      The time (in seconds) for Mayhem to wait for the
                      target to accept network input.
--network-client NETWORK_CLIENT
                      Specify whether this network target is a client or
                      server.
--libfuzzer LIBFUZZER
                      Specify whether this is a libfuzzer target or not.
--honggfuzz HONGGFUZZ
                      Specify whether this is a honggfuzz target or not.
--sanitizer SANITIZER
                      Specify whether sanitization is compiled in or not.
--max-length MAX_LENGTH
                      Maximum length for test cases.
--memory-limit MEMORY_LIMIT
                      How much memory to allow the target in megabytes (MB).
--url URL             URL to running Mayhem API.
--token TOKEN         Authentication token for accessing Mayhem API.
-k, --insecure        Disable SSL verification.
--cacert CACERT       Path to the mayhem server's certificate.
--timeout TIMEOUT     Seconds to wait for API responses (useful for slow
                      connections).

たとえば、次のソース Mayhemfile があるとします。

project: foo
target: bar
image: mock_image
cmds:
-  cmd: /bin/grep @@

その後、Mayhem CLI コマンド mayhem run . --image forallsecure/tutorial を上記の Mayhemfile と同じ現行ディレクトリ内から実行すると、image パラメーターが Docker Hub のイメージ forallsecure/tutorial で上書きされ、ランに対して次の Mayhemfile が生成されます。

project: foo
target: bar
image: forallsecure/tutorial
cmds:
-  cmd: /bin/grep @@

Info

パラメーターのオーバーライドは、オーバーライドするキーがすでにソース Mayhemfile に存在するかどうかに応じてパラメーターを変更または追加します。

デフォルト値¶

次のいずれかのパラメーターに対してカスタム値が指定されていない場合、Mayhem は Mayhem ランの Mayhemfile に次のデフォルト値を追加します。

testsuite:
  - https://${MAYHEM_DOMAIN}/${MAYHEM_PROJECT}/${MAYHEM_TARGET}/testsuite.tar
  - https://${MAYHEM_DOMAIN}/${MAYHEM_PROJECT}/${MAYHEM_TARGET}/uploaded/<hash>/testsuite.tgz
image: ${MAYHEM_DOCKER_REGISTRY}/forallsecure/debian-buster:latest
advanced_triage: false
tasks:
  - name: exploitability_factors
  - name: regression_testing
  - name: behavior_testing

上記のデフォルト値を構築するため、Mayhem は次のインビルト値の値を置換します。これらの値は、カスタム環境変数で指定されないかぎり、自動的に設定されます。これらは testsuite や image の値などのさまざまな箇所で置換されます。

${MAYHEM_DOCKER_REGISTRY}: ランを実行する Mayhem インスタンスの Mayhem Docker レジストリ URL が設定されます (例: tutorial.forallsecure.com:5000)。
${MAYHEM_DOMAIN}: ランを実行する Mayhem インスタンスの URL が設定されます (例: tutorial.forallsecure.com)。
${MAYHEM_PROJECT}: Mayhemfile の必須フィールド project の前にユーザーまたは組織の名前を付加した値が設定されます (例: forallsecure/project1)。
${MAYHEM_TARGET}: Mayhemfile の必須フィールド target から導かれた値が設定されます。
${MAYHEM_URL}: 次の構文に従って値が設定されます。https://${MAYHEM_DOMAIN} (例: https://tutorial.forallsecure.com)
${MAYHEM_OWNER}: Mayhemfile で project フィールドの一部として指定されたオーナー (例: project: forallsecure/project1)、またはログインした Mayhem ユーザーのユーザー名が設定されます。このケースでは、オーナーには forallsecure が設定されます。

たとえば、ユーザー mayhemuser が Mayhem ランの実行時に次の Mayhemfile をアップロードしたとします。

project: foo
target: bar
cmds:
  -  cmd: /bin/grep @@

Mayhem は結果のランの Mayhemfile に次のデフォルト値を自動的に追加します (またインビルト変数を適宜置換します)。

project: foo
target: bar
cmds:
  - cmd: /bin/grep @@
    env: {}
testsuite:
  - https://tutorial.forallsecure.com/mayhemuser/foo/bar/testsuite.tar
  - https://tutorial.forallsecure.com/mayhemuser/foo/bar/uploaded/f3364b2ee694e27d558aa38ce325b624a1f11e8718da0d5b1ff16419a61eeb3e/testsuite.tgz
image: $MAYHEM_DOCKER_REGISTRY/forallsecure/debian-buster:latest
advanced_triage: false
tasks:
  - name: exploitability_factors
  - name: regression_testing
  - name: behavior_testing

Mayhemfile のサンプル¶

Mayhem はファイル入力、標準入力、TCP/UDP 入力を使用してターゲットアプリケーションをファジングできます。このセクションには、タイプが異なる Mayhemfile 構成のサンプルがあります。

ファイル入力¶

コマンドライン上で単一の入力を受け取ります (objdump から)。

# Project name that the target belongs to
project: objdump

# Target name (should be unique within the project)
target: objdump

# Base image to run the binary in.
image: forallsecure/debian-buster:latest

# Time that analysis will run for in seconds - if absent, run forever
duration: 90

# List of commands used to test the target
cmds:

  # Command used to start the target, "@@" is the input file
  - cmd: /usr/bin/objdump -x @@

標準入力 (stdin)¶

/dev/stdin から入力を受け取るあいだ、ずっと djpeg に対してテストを実行します。

# Mayhemfile: configuration file for testing your target with Mayhem
# Format: YAML 1.1

# Project name that the target belongs to
project: libjpeg

# Target name (should be unique within the project)
target: djpeg

# Base image to run the binary in.
image: forallsecure/debian-buster:latest

# Commented out duration to run forever
# duration: 90

# List of commands used to test the target
cmds:

  # Command used to start the target. "@@" is missing so
  # input will be read from /dev/stdin.
  - cmd: /usr/bin/djpeg

TCP/UDP 入力¶

パブリックな Docker Hub イメージを使用し、TCP ポートの 80 でネットワークから単一の入力を受け取ります (sebp/lighttpd から)。

project: lighttpd-docker
target: lighttpd
image: sebp/lighttpd
duration: 90
cmds:
  - cmd: /usr/sbin/lighttpd -D -f /etc/lighttpd/lighttpd.conf
    network:
      client: false
      url: tcp://127.0.0.1:80
      timeout: 1.0

Mayhemfile のパラメーター¶

以下に Mayhemfile で利用可能なすべてのパラメーターを示します。

Important

複数レベルの Mayhemfile があるため、パラメーターの階層を意識してください。

`version`¶

Mayhem のバージョンを指定します。

任意
データタイプ: string
サンプル:

version: '2.10'

Info

Mayhemfile のバージョンには 0.4 以上を指定できます。注意: ただし、古いバージョンの Mayhem を指定した Mayhemfile には、より新しいバージョンの機能が含まれていない場合があります。

`project`¶

ターゲットが所属するプロジェクト組織およびプロジェクトの固有名です。

Owner (任意), Projectname (任意)
データタイプ: string
サンプル:

project: owner/projectname

`target`¶

テスト対象のターゲットの名前です。1 つの target に複数のターゲットを設定できます。

任意
データタイプ: string
サンプル:

target: targetname

`image`¶

Warning

このフィールドは、以前は baseimage でしたが、現在 mCode version 2.X では image です。

image は、使用される Docker イメージの名前です。イメージにはターゲット (Docker パッケージを使用している場合) が含まれる場合があります。または、root/ フォルダーにターゲットが含まれる場合もあります。その場合、ターゲットがイメージに重ねられます (mayhem package コマンドを参照)。イメージが指定されていない場合、Debian buster を基にした ForAllSecure のデフォルトの Docker イメージが使用されます: $MAYHEM_DOCKER_REGISTRY/forallsecure/debian-buster内部的な Docker レジストリまたはパブリックな Docker Hub レジストリを使用して Mayhem に Docker イメージをアップロードできます。

Info

Mayhem にアップロードされた Docker イメージをもっと簡単に参照するには、$MAYHEM_DOCKER_REGISTRY 変数を使用してサーバーの内部的な Docker レジストリの場所を参照します。Mayhem には ForAllSecure のデフォルトのイメージが事前インストールされています。

任意
データタイプ: string
デフォルト値: $MAYHEM_DOCKER_REGISTRY/forallsecure/debian-buster
サンプル:

image: $MAYHEM_DOCKER_REGISTRY/forallsecure/debian-buster

`duration`¶

アプリケーションを実行する秒数。

Info

duration パラメーターに null を設定した場合 (つまりデフォルトの期間が指定されなかった場合)、期間は無期限になります。

任意
データタイプ integer
デフォルト値: null
サンプル:

duration: 90

`advanced_triage`¶

追加のテストケース処理によって追加の解析が行われ、メモリリークや未初期化変数の使用などの UNIX シグナルが送信されない欠陥が検出されます。

Info

特別なテストケース処理が追加されるため、advanced_triage を有効にすると Mayhem ランの全体的なパフォーマンスが低下する可能性があります。対照的に、通常の選別を伴うランは、advanced_triage が有効化されたランよりも最大で 10 倍も高速な可能性があります。

任意
データタイプ: boolean
デフォルト値: false
サンプル:

advanced_triage: false

`tasks`¶

Mayhem ランで実行されるタスクを設定します。tasks パラメーターに設定できるタスクには以下のようなものがあります。

悪用可能性ファクター
リグレッションテスト
ビヘイビアテスト
カバレッジ解析

任意
データタイプ: object

デフォルト値:

tasks:
    - name: exploitability_factors
    - name: regression_testing
    - name: behavior_testing

サンプル:

tasks:
    - name: exploitability_factors
    - name: regression_testing
    - name: behavior_testing
    - name: coverage_analysis

Note

task パラメーターを指定して mayhem run コマンドを実行すると、Mayhemfile の tasks キーがオーバーライドされます。たとえば、Mayhemfile で tasks キーに behavior_testing だけが設定されていても、mayhem run --all . は Mayhem ランですべてのタスクを実行します。

`testsuite`¶

Note

このフィールドは、以前は corpus でしたが、現在 mCode version 2.X では testsuite です。

Mayhem ランの初期テストスイートの場所を定義します。次のように処理されます。

要素が file:// で始まる場合、ローカルファイルソースであり、CLI が実行を開始するのと同じシステム上のファイルまたはディレクトリを表します。
パスは相対パスを使用することができます (例えば file://foo)。その場合、ファイルは Mayhemfile を含むディレクトリへの相対パスとして解決されます。
パスは絶対パスを使用することができます (file:///。3 つのスラッシュは先頭のスラッシュで始まるパスを示します)。
Mayhemfile でイメージファイルシステムのルートに /corpus または /testsuite フォルダーを含む Docker イメージが指定された場合、これらのフォルダーの内容が初期テストスイートに追加されます。
任意
データタイプ: string のリスト
デフォルト値:
https://$MAYHEM_DOMAIN/$MAYHEM_PROJECT/$MAYHEM_TARGET/testsuite.tar
file://testsuite

Info

https://$MAYHEM_DOMAIN/$MAYHEM_PROJECT/$MAYHEM_TARGET/testsuite.tar は、指定されたプロジェクトおよびターゲットの Mayhem インスタンスに保存された testsuite.tar ファイルを指す URL を指定します (利用可能な場合)。これにより、特定のプロジェクトおよびターゲットの以前の Mayhem ランのテストケースが次の Mayhem ランに引き継がれます。

サンプル:

testsuite:
  - file://testsuite

`uid`¶

ターゲット uid として使用するオプションの数値 UNIX ユーザー ID です。未設定の場合、特権なしの UNIX ユーザー ID が使用され、ファイルへのアクセスの問題の原因になる可能性があります。0 以外の uid が使用された場合、一般的にターゲットは 1024 未満のポートへのバインドなどの特権的操作を実行できません。Docker はこのオプションのデフォルトを 0 にしますが、USER コマンドでオーバーライドできます。デフォルトのベースイメージを使用した場合、この値は 1000 です。

任意
データタイプ: integer
デフォルト値: image から取得
サンプル:

uid: 0

`gid`¶

ターゲット uid として使用するオプションの数値 UNIX グループ ID です。未設定の場合、特権なしの UNIX グループ ID が使用され、ファイルへのアクセスの問題の原因になる可能性があります。未指定の場合、gid はベースイメージから継承されます。Docker はこのオプションのデフォルトを 0 にしますが、USER コマンドでオーバーライドできます。デフォルトのベースイメージを使用した場合、この値は 1000 です。

任意
データタイプ: integer
デフォルト値: image から取得
サンプル:

gid: 0

`cmds`¶

パッケージ化されたアプリケーションをテストするさまざまな方法を指定する cmd オブジェクトのリストです。各 cmd オブジェクトは、Mayhem にターゲット実行ファイルを解析する方法を通知します。各 cmd オブジェクトには、以下の任意フィールドが含まれています。これらのフィールドは、ターゲットが追加の情報を必要とする場合、または実行の前に環境に変更を加える必要がある場合にだけ使用するべきです。

必須
データタイプ: dictionary

`cmd`¶

ターゲット実行ファイルの呼び出しです。

コマンドラインで @@ 識別子を省略し、ターゲットがネットワークを使用するよう指定しなかった場合、Mayhem は標準入力 (/dev/stdin) が主要な入力ソースであると仮定します。

Note

@@ のファジングデータをファイルシステムファイルとして操作したい場合、このユースケースを実現するには filepath パラメーターの項を参照してください。cmd の内容は、bash インタープリターを経由せずに直接実行されます。

必須
データタイプ: string
サンプル 1:

cmd: /usr/bin/objdump -x @@

サンプル 2:

- cmd: /host/tinyxml2-2.0.1/parse-fuzzer
libfuzzer: true
- cmd: /host/tinyxml2-2.0.1/orig-collapse @@

Info

異なるインストゥルメンテーションのインスタンスを使用してターゲットを複数回実行したい場合、1 つの Mayhemfile で複数の cmd パラメーターを実行することができます。たとえば、ターゲットは libFuzzer ハーネスを実行する cmd とファイルを読み込み同じコードを呼び出すインストゥルメントなし/ベース実行ファイルの cmd の両方を実行する場合があります。シンボリック実行は libFuzzer をサポートしませんが、インストゥルメントされていない/ベース実行ファイルバイナリでシンボリック実行が見つけたテストケースは、libFuzzer の実行でも共有でき、新しいコードをカバーするのに役立つため、複数の cmd パラメーターを指定することには利点があります。

`max_length`¶

ファジングターゲットへの入力として与えられる最大の長さ (単位: バイト) です。100 MB を超えてはいけません。100 MB を超えた場合、検証が失敗します。開始テストの指定された最大の長さよりも大きいテストケースは、指定された値に切り捨てられます。

Info

ユーザーが Mayhemfile V1.10 を使用し、Mayhemfile で明示的に max_length を指定しなかった場合、デフォルト値は 8192 バイトになります。Mayhemfile V1.9 以下の場合、libFuzzer ターゲットのデフォルト値は 8192 バイトになり、インストゥルメンテーションなしのターゲットに対してはデフォルト値はありません。

任意
データタイプ: integer
デフォルト値: 8192
サンプル:

max_length: 8192

`cwd`¶

Warning

このフィールドは、以前は chdir でしたが、現在 mCode version 2.X では cwd です。

ターゲットを実行する前に Mayhem がスイッチするパスです。(現在のワーキングディレクトリ - CWD とも呼ばれます)

任意
データタイプ: string
デフォルト値: image から取得
サンプル:

cwd: /usr/bin

`filepath`¶

Warning

このフィールドは、以前は target_path でしたが、現在 mCode version 2.X では filepath です。

@@ 変数のファズデータをファイルシステムファイルとして操作する必要がある場合、Mayhem が入力ファイルに与える名前です。

任意
データタイプ: string
デフォルト値: null
サンプル:

filepath: /tmp/my_custom_file

`env`¶

プログラム実行時に設定される環境変数を指定します。さらに、Mayhem によって使用されるパフォーマンス拡張の一部とプログラムの互換性がない場合、特別な環境変数を指定できます。通常は必要ありませんが、一部のマルチスレッドプログラムでは解析が困難になる可能性があります。

Mayhem 実行時に使用する特別な環境変数は次のとおりです。

環境変数	値	説明
`DISABLE_SMOKETEST`	`1`	`1` を設定すると、スモークテストが無効化されます。スモークテストは、簡易的なサニティチェックを実行し、ターゲットが動作しているかを確認します。ターゲットが動作していない場合、パッケージ/Mayhemfile でユーザーの介入を必要とする一般的な構成の誤りを検出し、レポートします。
`MAYHEM_AUTORESOLUTION`	`true` または `false`	`true` を設定すると、Mayhem の自動解決が有効化されます。Mayhem は、Mayhem ランの実行時に発生する可能性がある Mayhemfile 構成の問題の自動解決を試みます。`false` を設定すると、Mayhem の自動解決が無効されます。
`MFUZZ_COMPAT_LEVEL`	`1` または `2`	`1` を設定すると、Mayhem のパフォーマンス最適化の一部が無効化されます (とくにフォークサーバーの実行延期)。`2` を設定すると、マルチスレッドプログラムと干渉する可能性がある最適化が完全に無効化されます。
`MFUZZ_JAVA_MAIN_CLASS`	例: `com.forallsecure.FuzzMe`	指定された JAR ファイルのメインクラスを設定します。
`MFUZZ_JAVA`	`1`	`1` は Java ターゲットのファジングを Mayhem に指示します。
`MFUZZ_CUSTOM_MUTATOR`	例: `/libmutator.so`	カスタムミューテーターのサポート用の共有オブジェクトを設定します。
`MFUZZ_DOCKER_ENTRYPOINT`	`1`	`1` は Docker イメージターゲットで利用可能な `docker-entrypoint.sh` スクリプトを実行するよう Mayhem に指示します。
`MAYHEM_TIMEOUTS_AS_DEFECTS`	`1`	`1` はテストケースのタイムアウトを欠陥として扱い、Mayhem UI のランページで Defects/Test Case ペインにレポートするよう Mayhem に指示します。これらの欠陥の CWE は `407 Inefficient Algorithmic Complexity` になります。

Info

env パラメーターの値のフォーマットは、YAML の flow または block スタイルのどちらでもかまいません。複数の環境変数がサポートされています。

任意
データタイプ: object
サンプル 1:

env: { "ENV_VAR1": "value1", "ENV_VAR2": "value2", "ENV_VAR3": "value3" }

サンプル 2:

env:
  ENV_VAR1: value1
  ENV_VAR2: value2
  ENV_VAR3: value3

デフォルト値: image パラメーターで指定された Docker イメージにすでに存在する環境変数から取得します。

`network`¶

ターゲットがネットワークターゲットであることを指定します。

ターゲットがネットワーク経由で入力を受け取る場合は必須です。
データタイプ: string
デフォルト値: {}

`url`¶

解析対象のプロトコル、ホスト、ポートを指定します。サポート対象のプロトコルは次のとおりです: "tcp"、"udp"、"unix+stream"、"unix+dgram" および "unix+seqpacket"

Mayhem では、localhost は任意のローカルインターフェイス、IPv4 または IPv6 を意味し、テストするプロトコルの自動検出が試みられます。いずれかを指定する必要がある場合、IPv4 の場合は 127.0.0.1、IPv6 の場合は [::1] と記述します。たとえば、tcp://127.0.0.1:80 は IPv4 接続のポート 80 に入力をフィードします。

ターゲットの通信方法を常に意識するようにします。特に、コンテナー内で localhost を使用するには、localhost ホスト名のルックアップが必要な場合があり、期待どおり解決されない可能性があります。あいまいさを避けるために、可能であれば、内部ターゲット構成ではバインディングと接続に一貫して IP アドレスを使用します。

ターゲットがネットワーク経由で入力を受け取る場合は必須です。
データタイプ: string
デフォルト値: empty
サンプル:

url: tcp://localhost:8080

`timeout`¶

選別時にターゲットがネットワーク入力を受信するのを Mayhem が待機する時間 (単位: 秒) です。この制限時間内にターゲットがネットワーク入力を受信しなかった場合、テストケースは破棄されます。制限時間が短すぎると、テストケースは通常どおりレポートを返す場合があります。ターゲットの開始に時間がかかる場合、タイムアウトを長くする必要がある場合があります。

Note

このフィールドはネットワークターゲットの timeout を意味し、非ネットワークターゲットの timeout パラメーターとは異なります。

任意
データタイプ: number
デフォルト値: 2
サンプル:

timeout: 10

`client`¶

Warning

このフィールドは、以前は is_client でしたが、現在 mCode version 2.X では client です。

テスト対象の実行ファイルがクライアントの場合、'true' を設定します。クライアントはネットワーク接続を開始することが期待されるいっぽう、サーバーは Mayhem を待機することが期待されます。

任意
データタイプ: boolean
デフォルト値: false
サンプル:

client: true

`timeout`¶

個別のテストが完了するのを Mayhem が待機する時間 (単位: 秒) です。

Info

デプロイメント/インストール時の環境変数 MAX_CMD_TIMEOUT_SECONDS でオーバーライドして timeout 制限を増やさないかぎり、許可される timeout の最大値は 60 秒です。設定最大値 (デフォルトの 60 秒または MAX_CMD_TIMEOUT_SECONDS によって指定された値) を超える値は、自動的に timeout 制限の最大値にダウンサイズされます。必要に応じて組織の管理者に連絡し、MAX_CMD_TIMEOUT_SECONDS 環境変数を設定してください。

任意:
データタイプ: number
デフォルト値: automatic
サンプル:

timeout: 1.5

`memory_limit`¶

Warning

このフィールドは、以前は memory_limit_in_mb でしたが、現在 mCode version 2.X では memory_limit です。

ターゲットが割り当てることができるメモリ量の最大値です (単位: MB)。Mayhem はこの制限値を超えるテストをキルし、クラッシュとして報告します。

任意
データタイプ: integer
デフォルト値: automatic
サンプル:

memory_limit: 8192

`sanitizer`¶

ターゲット実行ファイルがサニタイザー付きでコンパイルされている場合にだけ true を設定します。

任意
データタイプ: boolean
デフォルト値: automatic
サンプル:

sanitizer: false

`libfuzzer`¶

ターゲット実行ファイルが libFuzzer 付きでコンパイルされている場合にだけ true を設定します。

任意
データタイプ: boolean
デフォルト値: automatic
サンプル:

libfuzzer: false

`afl`¶

ターゲット実行ファイルが AFL/AFL++ インストゥルメンテーション付きでコンパイルされている場合にだけ true を設定します。

任意
データタイプ: boolean
デフォルト値: automatic
サンプル:

afl: false

`honggfuzz`¶

ターゲット実行ファイルが Honggfuzz 付きでコンパイルされている場合にだけ true を設定します。

任意
データタイプ: boolean
デフォルト値: automatic
サンプル:

honggfuzz: false

`gcov`¶

ターゲット実行ファイルが gcov サポート付きでコンパイルされている場合にだけ true を設定します。また、ターゲット実行ファイルと同じパスに gcno がなければなりません。

任意
データタイプ: boolean
デフォルト値: false
サンプル:

gcov: true

`sancov`¶

ターゲット実行ファイルが sancov サポート付きでコンパイルされている場合にだけ true を設定します。

任意
データタイプ: boolean
デフォルト値: false
サンプル:

sancov: true

`dictionary`¶

AFL/AFL++ 互換ディクショナリファイルへのパスです。パスはコンテナーのルートへの相対パスである必要があります。たとえば、ディクショナリがイメージ内の /etc/foo/bar/http.dict の下にある場合、Mayhemfile のディクショナリパスは /etc/foo/bar/http.dict である必要があります。

Tip

ファザー入力としてディクショナリを使用する場合の現実的なサンプルについては「AFL-compatibile dictionaries」を参照してください。

任意
データタイプ: string
デフォルト値: empty
サンプル:

dictionary: /tmp/my-dictionary

Mayhemfile の構成¶

Mayhemfile ソースとランの違い¶

環境変数¶

CLI のオーバーライド¶

デフォルト値¶

Mayhemfile のサンプル¶

ファイル入力¶

標準入力 (stdin)¶

TCP/UDP 入力¶

Mayhemfile のパラメーター¶

version¶

project¶

target¶

image¶

duration¶

advanced_triage¶

tasks¶

testsuite¶

uid¶

gid¶

cmds¶

cmd¶

max_length¶

cwd¶

filepath¶

env¶

network¶

url¶

timeout¶

client¶

timeout¶

memory_limit¶

sanitizer¶

libfuzzer¶

afl¶

honggfuzz¶

gcov¶

sancov¶

dictionary¶

`version`¶

`project`¶

`target`¶

`image`¶

`duration`¶

`advanced_triage`¶

`tasks`¶

`testsuite`¶

`uid`¶

`gid`¶

`cmds`¶

`cmd`¶

`max_length`¶

`cwd`¶

`filepath`¶

`env`¶

`network`¶

`url`¶

`timeout`¶

`client`¶

`timeout`¶

`memory_limit`¶

`sanitizer`¶

`libfuzzer`¶

`afl`¶

`honggfuzz`¶

`gcov`¶

`sancov`¶

`dictionary`¶