246 lines
8.0 KiB
YAML
246 lines
8.0 KiB
YAML
name: 'Cairn Zig Fuzz (AFL++)'
|
|
description: 'Install AFL++, then build and run AFL++ fuzz targets, reporting crashes to Cairn. Each line in zig_build_args is a separate target.'
|
|
|
|
inputs:
|
|
cairn_server:
|
|
description: 'Cairn server URL'
|
|
required: true
|
|
repo:
|
|
description: 'Repository name'
|
|
required: true
|
|
owner:
|
|
description: 'Repository owner'
|
|
required: true
|
|
commit:
|
|
description: 'Commit SHA'
|
|
required: false
|
|
default: '${{ github.sha }}'
|
|
zig_build_args:
|
|
description: |
|
|
Line-delimited zig build argument sets. Each line builds and fuzzes one target.
|
|
Example:
|
|
fuzz -Dfuzz-target=lexer
|
|
fuzz -Dfuzz-target=parser
|
|
fuzz -Dfuzz-target=varint_decode
|
|
required: true
|
|
fuzz_binary:
|
|
description: 'Binary name in zig-out/bin/ (auto-detected if only one)'
|
|
required: false
|
|
default: ''
|
|
corpus_dir:
|
|
description: 'Seed corpus directory (minimal seed created if empty)'
|
|
required: false
|
|
default: ''
|
|
duration:
|
|
description: 'Fuzz duration per target in seconds'
|
|
required: false
|
|
default: '600'
|
|
afl_args:
|
|
description: 'Extra afl-fuzz arguments'
|
|
required: false
|
|
default: ''
|
|
target:
|
|
description: 'Target platform metadata'
|
|
required: false
|
|
default: ''
|
|
cairn_version:
|
|
description: 'Cairn CLI version'
|
|
required: false
|
|
default: 'latest'
|
|
|
|
runs:
|
|
using: 'composite'
|
|
steps:
|
|
- name: Setup AFL++
|
|
uses: mattnite/cairn/actions/setup-afl@main
|
|
|
|
- name: Check prerequisites
|
|
shell: sh
|
|
run: |
|
|
set -eu
|
|
command -v zig >/dev/null 2>&1 || { echo "ERROR: zig not found in PATH. Install Zig before using this action (e.g. https://codeberg.org/mlugg/setup-zig@v2)."; exit 1; }
|
|
command -v afl-cc >/dev/null 2>&1 || { echo "ERROR: afl-cc not found in PATH after setup-afl step."; exit 1; }
|
|
echo "zig $(zig version), afl-cc found"
|
|
|
|
- name: Setup Cairn CLI
|
|
uses: mattnite/cairn/actions/setup-cairn@main
|
|
with:
|
|
version: ${{ inputs.cairn_version }}
|
|
server_url: ${{ inputs.cairn_server }}
|
|
|
|
- name: Build and fuzz with AFL++
|
|
shell: bash
|
|
env:
|
|
CAIRN_SERVER: ${{ inputs.cairn_server }}
|
|
REPO: ${{ inputs.repo }}
|
|
OWNER: ${{ inputs.owner }}
|
|
COMMIT: ${{ inputs.commit }}
|
|
ZIG_BUILD_ARGS: ${{ inputs.zig_build_args }}
|
|
FUZZ_BINARY: ${{ inputs.fuzz_binary }}
|
|
CORPUS_DIR: ${{ inputs.corpus_dir }}
|
|
DURATION: ${{ inputs.duration }}
|
|
AFL_ARGS: ${{ inputs.afl_args }}
|
|
TARGET: ${{ inputs.target }}
|
|
run: |
|
|
set -eu
|
|
|
|
# ── Start Cairn campaign ──
|
|
SHORT_SHA=$(printf '%.8s' "${COMMIT}")
|
|
CAMPAIGN_OUTPUT=$(cairn campaign start \
|
|
-server "${CAIRN_SERVER}" \
|
|
-repo "${REPO}" \
|
|
-owner "${OWNER}" \
|
|
-name "fuzz-${SHORT_SHA}" \
|
|
-type fuzzing)
|
|
CAMPAIGN_ID="${CAMPAIGN_OUTPUT#Campaign started: }"
|
|
echo "Campaign ${CAMPAIGN_ID} started"
|
|
|
|
cleanup() {
|
|
cairn campaign finish -server "${CAIRN_SERVER}" -id "${CAMPAIGN_ID}" || true
|
|
}
|
|
trap cleanup EXIT
|
|
|
|
TOTAL_CRASHES=0
|
|
TARGET_NUM=0
|
|
|
|
# ── Iterate over each line of zig_build_args ──
|
|
while IFS= read -r BUILD_ARGS; do
|
|
# Skip empty lines and comments
|
|
BUILD_ARGS=$(echo "${BUILD_ARGS}" | sed 's/#.*//' | xargs)
|
|
[ -z "${BUILD_ARGS}" ] && continue
|
|
|
|
TARGET_NUM=$((TARGET_NUM + 1))
|
|
echo ""
|
|
echo "=========================================="
|
|
echo "Target ${TARGET_NUM}: zig build ${BUILD_ARGS}"
|
|
echo "=========================================="
|
|
|
|
# ── Build ──
|
|
rm -rf zig-out
|
|
zig build ${BUILD_ARGS}
|
|
|
|
# ── Locate fuzz binary ──
|
|
if [ -n "${FUZZ_BINARY}" ]; then
|
|
FUZZ_BIN="zig-out/bin/${FUZZ_BINARY}"
|
|
else
|
|
BIN_COUNT=$(find zig-out/bin -maxdepth 1 -type f -executable 2>/dev/null | wc -l)
|
|
if [ "${BIN_COUNT}" -eq 0 ]; then
|
|
echo "ERROR: No executable found in zig-out/bin/"
|
|
exit 1
|
|
elif [ "${BIN_COUNT}" -gt 1 ]; then
|
|
echo "ERROR: Multiple executables in zig-out/bin/, specify fuzz_binary input"
|
|
find zig-out/bin -maxdepth 1 -type f -executable
|
|
exit 1
|
|
fi
|
|
FUZZ_BIN=$(find zig-out/bin -maxdepth 1 -type f -executable)
|
|
fi
|
|
|
|
if [ ! -x "${FUZZ_BIN}" ]; then
|
|
echo "ERROR: Fuzz binary not found or not executable: ${FUZZ_BIN}"
|
|
exit 1
|
|
fi
|
|
echo "Fuzz binary: ${FUZZ_BIN}"
|
|
|
|
# ── Seed corpus ──
|
|
if [ -n "${CORPUS_DIR}" ] && [ -d "${CORPUS_DIR}" ]; then
|
|
SEEDS="${CORPUS_DIR}"
|
|
else
|
|
SEEDS="afl-seeds"
|
|
mkdir -p "${SEEDS}"
|
|
printf 'A' > "${SEEDS}/seed-0"
|
|
fi
|
|
|
|
# ── Run AFL++ ──
|
|
FINDINGS="findings-${TARGET_NUM}"
|
|
rm -rf "${FINDINGS}"
|
|
mkdir -p "${FINDINGS}"
|
|
|
|
AFL_EXIT=0
|
|
AFL_NO_UI=1 \
|
|
AFL_SKIP_CPUFREQ=1 \
|
|
AFL_I_DONT_CARE_ABOUT_MISSING_CRASHES=1 \
|
|
AFL_NO_CRASH_README=1 \
|
|
AFL_EXIT_ON_TIME=60 \
|
|
timeout "${DURATION}s" \
|
|
afl-fuzz \
|
|
-i "${SEEDS}" \
|
|
-o "${FINDINGS}" \
|
|
${AFL_ARGS} \
|
|
-- "${FUZZ_BIN}" \
|
|
|| AFL_EXIT=$?
|
|
|
|
if [ "${AFL_EXIT}" -eq 124 ]; then
|
|
echo "AFL++ ran for full duration (${DURATION}s)"
|
|
elif [ "${AFL_EXIT}" -eq 0 ]; then
|
|
echo "AFL++ exited normally (coverage stagnated)"
|
|
else
|
|
echo "AFL++ exited with code ${AFL_EXIT}"
|
|
fi
|
|
|
|
# ── Upload crashes ──
|
|
CRASH_DIR="${FINDINGS}/default/crashes"
|
|
if [ -d "${CRASH_DIR}" ]; then
|
|
for crash_file in "${CRASH_DIR}"/id:*; do
|
|
[ -f "${crash_file}" ] || continue
|
|
|
|
CRASH_NAME=$(basename "${crash_file}")
|
|
SIG=""
|
|
case "${CRASH_NAME}" in
|
|
*,sig:*)
|
|
SIG=$(echo "${CRASH_NAME}" | sed 's/.*,sig:\([0-9]*\).*/\1/')
|
|
;;
|
|
esac
|
|
|
|
echo "Uploading crash: ${CRASH_NAME}"
|
|
set -- -server "${CAIRN_SERVER}" -repo "${REPO}" -owner "${OWNER}" \
|
|
-commit "${COMMIT}" -type fuzz -file "${crash_file}" \
|
|
-crash-message "AFL++ crash (${BUILD_ARGS}): ${CRASH_NAME}"
|
|
|
|
if [ -n "${TARGET}" ]; then
|
|
set -- "$@" -target "${TARGET}"
|
|
fi
|
|
if [ -n "${SIG}" ]; then
|
|
set -- "$@" -signal "${SIG}"
|
|
fi
|
|
|
|
cairn upload "$@"
|
|
TOTAL_CRASHES=$((TOTAL_CRASHES + 1))
|
|
done
|
|
fi
|
|
|
|
# ── Upload corpus ──
|
|
QUEUE_DIR="${FINDINGS}/default/queue"
|
|
if [ -d "${QUEUE_DIR}" ]; then
|
|
QUEUE_COUNT=$(find "${QUEUE_DIR}" -maxdepth 1 -type f -name 'id:*' | wc -l)
|
|
if [ "${QUEUE_COUNT}" -gt 0 ]; then
|
|
echo "Uploading corpus (${QUEUE_COUNT} entries)..."
|
|
tar czf "corpus-${TARGET_NUM}.tar.gz" -C "${QUEUE_DIR}" .
|
|
|
|
set -- -server "${CAIRN_SERVER}" -repo "${REPO}" -owner "${OWNER}" \
|
|
-commit "${COMMIT}" -type fuzz -file "corpus-${TARGET_NUM}.tar.gz"
|
|
if [ -n "${TARGET}" ]; then
|
|
set -- "$@" -target "${TARGET}"
|
|
fi
|
|
|
|
cairn upload "$@"
|
|
rm -f "corpus-${TARGET_NUM}.tar.gz"
|
|
fi
|
|
fi
|
|
|
|
done <<EOF
|
|
${ZIG_BUILD_ARGS}
|
|
EOF
|
|
|
|
# ── Final report ──
|
|
echo ""
|
|
echo "=========================================="
|
|
echo "Fuzzed ${TARGET_NUM} target(s), ${TOTAL_CRASHES} total crash(es)"
|
|
echo "=========================================="
|
|
|
|
if [ "${TOTAL_CRASHES}" -gt 0 ]; then
|
|
echo "FAIL: ${TOTAL_CRASHES} crash(es) found"
|
|
exit 1
|
|
fi
|
|
|
|
echo "OK: No crashes found"
|