mirror of https://github.com/trailofbits/buttercup synced 2026-06-21 14:11:39 +00:00

Files

T

Evan Downing f6067005e6 Download Kythe automatically (#84 )

* Add passing gh token

* Change docker to automatically download kythe release

* Update workflow

2025-02-21 13:33:38 -05:00

2.3 KiB

Raw Blame History

Program Model

Indexes a program into a graph database.

Requirements

n2-highmem-8 instance.

Setup

Set up working directory and tasks directory.

cd afc-crs-trail-of-bits/

cp env.template .env

sudo mkdir /crs_scratch/ && sudo chown `whoami`:`whoami` /crs_scratch && sudo mount --bind ./crs_scratch /crs_scratch

sudo mkdir /tasks_storage && sudo chown `whoami`:`whoami` /tasks_storage && sudo mount --bind ./tasks_storage /tasks_storage

Set up a GitHub token.

gh auth login
GitHub.com
SSH
No
Paste the authentication token

gh auth token

Put GitHub token in .env.

See REST API if you need to find the asset ID of a new release.

Usage

Prepare example challenge project.

cd afc-crs-trail-of-bits/

./orchestrator/scripts/task_crs.sh

Start up CRS.

cd afc-crs-trail-of-bits/

docker compose up -d --build --remove-orphans

# cd common/
# uv run src/buttercup/common/msg_publisher.py send tasks_ready_queue ../program-model/mock_data/ready_msg.json

Send task to Program Model via Redis queue.

docker compose logs -f program-model

cd afc-crs-trail-of-bits/program-model/

uv run mock/trigger_pm.py \
  --build_type full \
  --package_name libpng \
  --sanitizer AddressSanitizer \
  --task_dir ../tasks_storage/5cea8f59-a7ab-4c77-97a9-f92fcfeb33d8 \
  --task_id libpng

Testing on Challenges

See challenges.md.

Development

Create a new virtual environment and enter it:

cd afc-crs-trail-of-bits/program-model/

uv venv
source .venv/bin/activate
uv sync --all-extras

Run tests:

pytest

Lock, reformat, and lint before committing changes:

just lock
just reformat
just lint

FAQs

Why does this use a ubuntu base image?
- Since Kythe uses OSS Fuzz to build and index the challenge source code, we have to use the same base image as ClusterFuzz.
Why does this use Python 3.10?
- ClusterFuzz uses Python 3.10.
How do I build Kythe?
- Follow the instructions in dev.md.
What are available APIs for this component?
- See api.md.

2.3 KiB Raw Blame History