mirror of
https://github.com/trailofbits/buttercup
synced 2026-06-21 14:11:39 +00:00
Michael D Brown
48cbaca8a0
* Update apis Closes #436 Updates APIs to 1.2-rc1 ahead of unscored round 2 * Update values.yaml * Bump competition/crs API to v1.2 * Breaking changes in competition api config * Check for SARIFs in CI (#527) * Check for SARIFs in CI * Remove trailing bracket --------- Co-authored-by: Henrik Brodin <90325907+hbrodin@users.noreply.github.com>
Trail of Bits AIxCC Finals CRS
Dependencies
Follow the install instructions for the required dependencies:
Configuration
Create a new configuration file, starting from the default template:
cp \
deployment/env.template \
deployment/env
Next, configure the following options. Follow the instructions in the comments when setting the GHCR_AUTH value.
SCANTRON_GITHUB_PAT
GHCR_AUTH
OPENAI_API_KEY
ANTHROPIC_API_KEY
DOCKER_USERNAME
DOCKER_PAT
Settings specific to local development and testing
Use the hardcoded test credentials found in the comments:
AZURE_ENABLED=false
TAILSCALE_ENABLED=false
COMPETITION_API_KEY_ID: `11111111-1111-1111-1111-111111111111`
COMPETITION_API_KEY_TOKEN: `secret`
CRS_KEY_ID="515cc8a0-3019-4c9f-8c1c-72d0b54ae561"
CRS_KEY_TOKEN="VGuAC8axfOnFXKBB7irpNDOKcDjOlnyB"
CRS_API_HOSTNAME="<generated with: openssl rand -hex 16>"
BUTTERCUP_K8S_VALUES_TEMPLATE="k8s/values-minikube.template"
Keep empty:
AZURE_API_BASE=""
AZURE_API_KEY=""
Commented out:
CRS_URL
CRS_API_HOSTNAME
LANGFUSE_HOST
LANGFUSE_PUBLIC_KEY
LANGFUSE_SECRET_KEY
OTEL_ENDPOINT
OTEL_TOKEN
Authentication
Docker
Log into ghcr.io:
docker login ghcr.io -u <username>
Running the CRS
Starting the services
cd deployment && make up
Stopping the services
cd deployment && make down
Sending the example-libpng task to the system
kubectl port-forward -n crs service/buttercup-competition-api 31323:1323
./orchestrator/scripts/task_crs.sh
Send a SARIF message
./orchestrator/scripts/send_sarif.sh <TASK-ID-FROM-TASK-CRS>