Skip to content

Release v0.25.50

Choose a tag to compare

View all tags
@github-actions github-actions released this 21 May 01:48
· 65 commits to main since this release
v0.25.50
1d5c13a

What's Changed

Other Changes

  • chore: recompile all workflow lock files by @lpcox in #3345
  • refactor: split token-tracker.js into four focused modules by @Copilot in #3343
  • Make BuildConfigInputs internal to build-config by @Copilot in #3358
  • Refactor iptables/ip6tables chain teardown into shared helper by @Copilot in #3359
  • Deduplicate AWF_TOKEN_LOG_DIR setup across token-tracker tests by @Copilot in #3360
  • Refactor container cleanup to deduplicate log/session preservation paths by @Copilot in #3361
  • fix: add resilient gh-aw installer and --ignore-scripts to lock files by @lpcox in #3363
  • fix: revert --ignore-scripts for Claude Code (needs postinstall) by @lpcox in #3371
  • Narrow container-lifecycle API by moving kill-state helpers to test-only export by @Copilot in #3372
  • Narrow rules API surface by making mergeRuleSets internal by @Copilot in #3373
  • chore: recompile workflows after --ignore-scripts revert by @lpcox in #3378
  • Make resolveImages module-private in predownload and align tests to public API by @Copilot in #3384
  • Narrow domain-utils API by privatizing agent-image helper exports by @Copilot in #3385
  • Privatize ruleset internals and test rules parsing through public API by @Copilot in #3395
  • Internalize DOMAIN_CHAR_PATTERN and decouple tests from non-API regex internals by @Copilot in #3396
  • fix: switch doc-maintainer from copilot to claude engine by @lpcox in #3414
  • refactor: unexport internal helpers in copilot-api-resolver by @Copilot in #3394
  • Make DLP_PATTERNS internal and decouple tests from module internals by @Copilot in #3398
  • [Test Coverage] Improve host-iptables-shared branch coverage by @github-actions[bot] in #3403
  • Optimize export-audit workflow token usage by precomputing data and reducing verification/search fanout by @Copilot in #3411
  • Optimize Security Guard workflow token usage and reduce runaway turn cost by @Copilot in #3412
  • Refactor option parser facade to direct re-exports and unify flag validation type by @Copilot in #3428
  • Remove dead host-path-prefix re-exports from agent-volumes by @Copilot in #3425
  • Prune dead host-env compatibility re-exports after module split by @Copilot in #3426
  • tests: replace host-env barrel imports with canonical host-env split modules by @Copilot in #3427
  • Fail fast in chroot mode on Alpine/musl daemon hosts and document glibc requirements by @Copilot in #3397
  • Refactor api-proxy startup to adapter-only validation/model discovery paths by @Copilot in #3444
  • Align log discovery with canonical Squid container constant by @Copilot in #3445
  • Refactor duplicated host-service port allowance loops in setup-iptables by @Copilot in #3443
  • [Test Coverage] Add test coverage for build-config and predownload commands by @github-actions[bot] in #3455
  • Optimize Security Guard workflow cost profile (Sonnet 4.5, 3-turn cap, early noop gate) by @Copilot in #3461
  • feat: add OpenTelemetry distributed tracing to api-proxy sidecar by @Copilot in #3470
  • feat: Add smoke-otel-tracing workflow for api-proxy OTEL validation by @lpcox in #3475
  • fix: Use --build-local in smoke-otel-tracing for latest api-proxy code by @lpcox in #3483
  • fix: align OTEL attributes with gen_ai semconv spec by @lpcox in #3488
  • refactor: split validate-options.ts into focused validator modules by @Copilot in #3479
  • refactor: deduplicate SSL-Bump fixture in squid-config-security tests by @Copilot in #3480
  • refactor(tests): extract makeMockExecaProcess helper in log-streamer.test.ts by @Copilot in #3482
  • fix: flatten OTEL cache attribute names for Sentry compatibility by @lpcox in #3492
  • fix: use awf.usage namespace for cache/reasoning OTEL attributes by @lpcox in #3495
  • refactor: split anthropic-transforms.js into focused sub-modules by @Copilot in #3478
  • refactor: extract useCleanupTestDir to eliminate repeated test boilerplate by @Copilot in #3481
  • fix: use Sentry measurement naming for cache token attributes by @lpcox in #3498
  • fix: emit cache token OTEL attributes as strings for Sentry by @lpcox in #3501
  • fix: rename OTEL cache attrs to avoid Sentry PII scrubber by @lpcox in #3504
  • docs: add OTEL Sentry attribute reference by @lpcox in #3508

Full Changelog: v0.25.49...v0.25.50

CLI Options

Usage: awf [options] [command] [args...]

Network firewall for agentic workflows with domain whitelisting

Arguments:
  args                                           Command and arguments to execute (use -- to separate from options)

Options:
    -V, --version                                  output the version number

  Configuration:
    --config <path>                                Path to AWF JSON/YAML config file (use "-" to read from stdin)

  Domain Filtering:
    -d, --allow-domains <domains>                  Comma-separated list of allowed domains. Supports wildcards and protocol prefixes:
                                       github.com         - exact domain + subdomains (HTTP & HTTPS)
                                       *.github.qkg1.top       - any subdomain of github.com
                                       api-*.example.com  - api-* subdomains
                                       https://secure.com - HTTPS only
                                       http://legacy.com  - HTTP only
                                       localhost          - auto-configure for local testing (Playwright, etc.)
    --allow-domains-file <path>                    Path to file with allowed domains (one per line, supports # comments)
    --ruleset-file <path>                          YAML rule file for domain allowlisting (repeatable). Schema: version: 1, rules: [{domain, subdomains}] (default: [])
    --block-domains <domains>                      Comma-separated blocked domains (overrides allow list). Supports wildcards.
    --block-domains-file <path>                    Path to file with blocked domains (one per line, supports # comments)
    --ssl-bump                                     Enable SSL Bump for HTTPS content inspection (allows URL path filtering) (default: false)
    --allow-urls <urls>                            Comma-separated allowed URL patterns for HTTPS (requires --ssl-bump).
                                       Supports wildcards: https://github.com/myorg/*

  Image Management:
    -b, --build-local                              Build containers locally instead of using GHCR images (default: false)
    --agent-image <value>                          Agent container image (default: "default")
                                       Presets (pre-built, fast):
                                         default  - Minimal ubuntu:22.04 (~200MB)
                                         act      - GitHub Actions parity (~2GB)
                                       Custom base images (requires --build-local):
                                         ubuntu:XX.XX
                                         ghcr.io/catthehacker/ubuntu:runner-XX.XX
                                         ghcr.io/catthehacker/ubuntu:full-XX.XX
    --image-registry <registry>                    Container image registry (default: "ghcr.io/github/gh-aw-firewall")
    --image-tag <tag>                              Container image tag (applies to squid, agent/agent-act, api-proxy, and cli-proxy when enabled)
                                       Optional digest metadata format:
                                         <tag>,squid=sha256:...,agent=sha256:...,agent-act=sha256:...,api-proxy=sha256:...,cli-proxy=sha256:...
                                       Image name varies by --agent-image preset:
                                         default → agent:<tag>
                                         act     → agent-act:<tag> (default: "latest")
    --skip-pull                                    Use local images without pulling from registry (requires pre-downloaded images) (default: false)
    --docker-host <socket>                         Docker socket for AWF's own containers (default: auto-detect from DOCKER_HOST env).
                                       Use when Docker is at a non-standard path.
                                       Example: unix:///run/user/1000/docker.sock
    --docker-host-path-prefix <prefix>             Prefix bind-mount source paths so Docker daemon can resolve runner filesystem paths.
                                       Useful for split runner/daemon filesystems (e.g. ARC DinD).
                                       Example: /host

  Container Configuration:
    -e, --env <KEY=VALUE>                          Environment variable for the container (repeatable) (default: [])
    --env-all                                      Pass all host environment variables to container (excludes system vars like PATH) (default: false)
    --exclude-env <name>                           Exclude a specific environment variable from --env-all passthrough (repeatable) (default: [])
    --env-file <path>                              Read environment variables from a file (KEY=VALUE format, one per line)
    -v, --mount <host_path:container_path[:mode]>
                                                   Volume mount (repeatable). Format: host_path:container_path[:ro|rw] (default: [])
    --container-workdir <dir>                      Working directory inside the container
    --memory-limit <limit>                         Memory limit for the agent container (e.g., 4g, 6g, 8g, 512m). Default: 6g (default: "6g")
    --tty                                          Allocate a pseudo-TTY (required for interactive tools like Claude Code) (default: false)

  Network & Security:
    --dns-servers <servers>                        Comma-separated trusted DNS servers (auto-detected from host if omitted)
    --dns-over-https [resolver-url]                Enable DNS-over-HTTPS via sidecar proxy (default: https://dns.google/dns-query)

  Network & Security:
    --upstream-proxy <url>                         Upstream (corporate) proxy URL for Squid to chain through.
                                       Auto-detected from host https_proxy/http_proxy if not set.
                                       Example: http://proxy.corp.com:3128
    --enable-host-access                           Enable access to host services via host.docker.internal (default: false)
    --allow-host-ports <ports>                     Ports/ranges to allow with --enable-host-access (default: 80,443).
                                       Example: 3000,8080 or 3000-3010,8000-8090
    --allow-host-service-ports <ports>             Ports to allow ONLY to host gateway (for GitHub Actions services).
                                       Bypasses dangerous port restrictions. Auto-enables host access.
                                       WARNING: Allowing port 22 grants SSH access to the host.
                                       Example: 5432,6379
    --enable-dind                                  Enable Docker-in-Docker by exposing host Docker socket.
                                       WARNING: allows firewall bypass via docker run (default: false)
    --enable-dlp                                   Enable DLP (Data Loss Prevention) scanning to block credential
                                       exfiltration in outbound request URLs. (default: false)

  API Proxy:
    --enable-api-proxy                             Enable API proxy sidecar for secure credential injection.
                                       Supports OpenAI (Codex) and Anthropic (Claude) APIs. (default: false)
    --copilot-api-target <host>                    Target hostname for Copilot API requests (default: api.githubcopilot.com)
    --openai-api-target <host>                     Target hostname for OpenAI API requests (default: api.openai.com)
    --openai-api-base-path <path>                  Base path prefix for OpenAI API requests (e.g. /serving-endpoints for Databricks)
    --anthropic-api-target <host>                  Target hostname for Anthropic API requests (default: api.anthropic.com)
    --anthropic-api-base-path <path>               Base path prefix for Anthropic API requests (e.g. /anthropic)
    --gemini-api-target <host>                     Target hostname for Gemini API requests (default: generativelanguage.googleapis.com)
    --gemini-api-base-path <path>                  Base path prefix for Gemini API requests
    --enable-opencode                              Enable OpenCode API proxy listener on port 10004 (requires --enable-api-proxy).
                                       Only start this when the workflow uses the OpenCode engine. (default: false)
    --anthropic-auto-cache                         Enable Anthropic prompt-cache optimizations in the API proxy (requires --enable-api-proxy).
                                       Injects cache breakpoints on tools/system/messages, upgrades TTL to 1h,
                                       and strips ANSI codes — typically saves ~90% on Anthropic API input costs. (default: false)
    --anthropic-cache-tail-ttl <5m|1h>             TTL for the rolling-tail cache breakpoint when --anthropic-auto-cache is enabled.
                                       Use "5m" (default) for fast interactive sessions, "1h" for long agentic tasks.
    --rate-limit-rpm <n>                           Max requests per minute per provider (requires --enable-api-proxy)
    --rate-limit-rph <n>                           Max requests per hour per provider (requires --enable-api-proxy)
    --rate-limit-bytes-pm <n>                      Max request bytes per minute per provider (requires --enable-api-proxy)
    --no-rate-limit                                Disable rate limiting in the API proxy (requires --enable-api-proxy)
    --max-model-multiplier <model:multiplier,...>
                                                   Per-model cost multipliers for effective token accounting (requires --enable-api-proxy).
                                       Format: comma-separated model:multiplier pairs, e.g.
                                       claude-opus-4-5-1m:10,claude-opus-4-5-200k:2.5
                                       Multipliers must be positive numbers. Models without
                                       a multiplier default to 1×.
    --enable-token-steering                        Enable effective token budget steering in the API proxy (requires --enable-api-proxy).
                                       Injects budget-warning system messages at 80%, 90%, 95%, and 99%
                                       usage to nudge the agent to wrap up before hitting the hard limit. (default: false)
    --difc-proxy-host <host:port>                  Connect to an external DIFC proxy (mcpg) at host:port.
                                       Enables the CLI proxy sidecar that routes gh commands through the DIFC proxy.
                                       The DIFC proxy must be started externally (e.g., by the gh-aw compiler).
    --difc-proxy-ca-cert <path>                    Path to TLS CA cert written by the external DIFC proxy.
                                       Recommended when --difc-proxy-host is set for TLS verification.

  Logging & Debug:
    --log-level <level>                            Log level: debug, info, warn, error (default: "info")
    -k, --keep-containers                          Keep containers running after command exits (default: false)
    --agent-timeout <minutes>                      Maximum time in minutes for the agent command to run (default: no limit)
    --work-dir <dir>                               Working directory for temporary files (default: "/tmp/awf-1779328118038")
    --proxy-logs-dir <path>                        Directory to save Squid proxy access.log
    --audit-dir <path>                             Directory for firewall audit artifacts (configs, policy manifest, iptables state)
    --session-state-dir <path>                     Directory to save Copilot CLI session state (events.jsonl, session data)
    --diagnostic-logs                              Collect container logs, exit state, and sanitized config on non-zero exit.
                                       Useful for debugging container startup failures (e.g. Squid crashes in DinD).
                                       Written to <workDir>/diagnostics/ (or <audit-dir>/diagnostics/ when set). (default: false)
    -h, --help                                     display help for command

Installation

One-Line Installer (Recommended)

Linux and macOS (x64 and ARM64) with automatic SHA verification:

curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/install.sh | sudo bash

This installer:

  • Automatically detects your OS (Linux or macOS) and architecture (x86_64/aarch64/arm64)
  • Downloads the correct release binary
  • Verifies SHA256 checksum against checksums.txt
  • Validates the file is a valid executable (ELF on Linux, Mach-O on macOS)
  • Installs to /usr/local/bin/awf

Manual Binary Installation (Alternative)

Linux (x64):

curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.25.50/awf-linux-x64 -o awf
curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.25.50/checksums.txt -o checksums.txt
sha256sum -c checksums.txt --ignore-missing
chmod +x awf
sudo mv awf /usr/local/bin/

Linux (ARM64):

curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.25.50/awf-linux-arm64 -o awf
curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.25.50/checksums.txt -o checksums.txt
sha256sum -c checksums.txt --ignore-missing
chmod +x awf
sudo mv awf /usr/local/bin/

macOS (Apple Silicon / ARM64):

curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.25.50/awf-darwin-arm64 -o awf
curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.25.50/checksums.txt -o checksums.txt
shasum -a 256 -c checksums.txt --ignore-missing
chmod +x awf
sudo mv awf /usr/local/bin/

macOS (Intel / x64):

curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.25.50/awf-darwin-x64 -o awf
curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.25.50/checksums.txt -o checksums.txt
shasum -a 256 -c checksums.txt --ignore-missing
chmod +x awf
sudo mv awf /usr/local/bin/

NPM Installation (Alternative)

# Install from tarball
npm install -g https://github.com/github/gh-aw-firewall/releases/download/v0.25.50/awf.tgz

Quick Start

# Basic usage with domain whitelist
sudo awf --allow-domains github.com,api.github.com -- curl https://api.github.com

# Pass environment variables
sudo awf --allow-domains api.github.com -e GITHUB_TOKEN=xxx -- gh api /user

# Mount additional volumes
sudo awf --allow-domains github.com -v /my/data:/data:ro -- cat /data/file.txt

# Set working directory in container
sudo awf --allow-domains github.com --container-workdir /workspace -- pwd

See README.md for full documentation.

Container Images

Published to GitHub Container Registry:

  • ghcr.io/github/gh-aw-firewall/squid:0.25.50
  • ghcr.io/github/gh-aw-firewall/agent:0.25.50
  • ghcr.io/github/gh-aw-firewall/squid:latest
  • ghcr.io/github/gh-aw-firewall/agent:latest

Image Verification

All container images are cryptographically signed with cosign for authenticity verification.

# Verify image signature
cosign verify \
  --certificate-identity-regexp 'https://github.com/github/gh-aw-firewall/.*' \
  --certificate-oidc-issuer 'https://token.actions.githubusercontent.com' \
  ghcr.io/github/gh-aw-firewall/squid:0.25.50

For detailed instructions including SBOM verification, see docs/image-verification.md.

Contributors

lpcox
Assets 14
Loading