Skip to content

Release v0.23.1

Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 26 Feb 17:45
· 15 commits to main since this release
v0.23.1
01950d5

What's Changed

Other Changes

  • docs: add sandbox design rationale (Docker vs microVMs) by @Mossaka in #1025
  • fix: always set NO_PROXY to bypass Squid for localhost by @Mossaka in #1032
  • chore: remove smoke-gemini workflow by @Mossaka in #1033
  • feat: group --help flags by category, hide dev-only options by @Mossaka in #1035
  • docs: add integration test coverage guide with gap analysis by @Mossaka in #1036
  • test: add --block-domains integration tests by @Mossaka in #1051
  • test: add --env-all integration tests by @Mossaka in #1053
  • test: add package installation integration tests by @Mossaka in #1052
  • feat: add API proxy port 10004 for OpenCode engine by @Mossaka in #1055
  • refactor: remove --allow-full-filesystem-access flag by @Mossaka in #1056
  • feat(proxy): add observability and rate limiting to API proxy by @Mossaka in #1038
  • feat(proxy): make copilot api target configurable for enterprise envi… by @lpcox in #1063

Full Changelog: v0.23.0...v0.23.1

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
  --allow-domains <domains>                      Comma-separated list of allowed domains. Supports wildcards and protocol prefixes:
                                     github.com         - exact domain + subdomains (HTTP & HTTPS)
                                     *.github.com       - 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 containing allowed domains (one per line or comma-separated, supports # comments)
  --block-domains <domains>                      Comma-separated list of blocked domains (takes precedence over allowed domains). Supports wildcards.
  --block-domains-file <path>                    Path to file containing blocked domains (one per line or comma-separated, supports # comments)
  --log-level <level>                            Log level: debug, info, warn, error (default: "info")
  --keep-containers                              Keep containers running after command exits (default: false)
  --tty                                          Allocate a pseudo-TTY for the container (required for interactive tools like Claude Code) (default: false)
  --work-dir <dir>                               Working directory for temporary files (default: "/tmp/awf-1772127942020")
  --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 (default: "latest")
  --skip-pull                                    Use local images without pulling from registry (requires images to be pre-downloaded) (default: false)
  -e, --env <KEY=VALUE>                          Additional environment variables to pass to container (can be specified multiple times) (default: [])
  --env-all                                      Pass all host environment variables to container (excludes system vars like PATH) (default: false)
  -v, --mount <host_path:container_path[:mode]>  Volume mount (can be specified multiple times). Format: host_path:container_path[:ro|rw] (default: [])
  --container-workdir <dir>                      Working directory inside the container (should match GITHUB_WORKSPACE for path consistency)
  --dns-servers <servers>                        Comma-separated list of trusted DNS servers. DNS traffic is ONLY allowed to these servers (default: 8.8.8.8,8.8.4.4) (default: "8.8.8.8,8.8.4.4")
  --proxy-logs-dir <path>                        Directory to save Squid proxy logs to (writes access.log directly to this directory)
  --enable-host-access                           Enable access to host services via host.docker.internal. Security warning: When combined with --allow-domains host.docker.internal, containers can access ANY service on the host machine. (default: false)
  --allow-host-ports <ports>                     Comma-separated list of ports or port ranges to allow when using --enable-host-access. By default, only ports 80 and 443 are allowed. Example: --allow-host-ports 3000 or --allow-host-ports 3000,8080 or --allow-host-ports 3000-3010,8000-8090
  --ssl-bump                                     Enable SSL Bump for HTTPS content inspection (allows URL path filtering for HTTPS) (default: false)
  --allow-urls <urls>                            Comma-separated list of allowed URL patterns for HTTPS (requires --ssl-bump).
                                     Supports wildcards: https://github.com/myorg/*
  --enable-api-proxy                             Enable API proxy sidecar for holding authentication credentials.
                                     Deploys a Node.js proxy that injects API keys securely.
                                     Supports OpenAI (Codex) and Anthropic (Claude) APIs. (default: false)
  --copilot-api-target <host>                    Target hostname for GitHub Copilot API requests in the api-proxy sidecar.
                                     Defaults to api.githubcopilot.com. Useful for GHES deployments.
                                     Can also be set via COPILOT_API_TARGET env var.
  --rate-limit-rpm <n>                           Enable rate limiting: max requests per minute per provider (requires --enable-api-proxy)
  --rate-limit-rph <n>                           Enable rate limiting: max requests per hour per provider (requires --enable-api-proxy)
  --rate-limit-bytes-pm <n>                      Enable rate limiting: max request bytes per minute per provider (requires --enable-api-proxy)
  --no-rate-limit                                Explicitly disable rate limiting in the API proxy (requires --enable-api-proxy)
  -h, --help                                     display help for command

Commands:
  logs [options]                                 View and analyze Squid proxy logs from current or previous runs

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.23.1/awf-linux-x64 -o awf
curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.23.1/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.23.1/awf-linux-arm64 -o awf
curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.23.1/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.23.1/awf-darwin-arm64 -o awf
curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.23.1/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.23.1/awf-darwin-x64 -o awf
curl -fL https://github.com/github/gh-aw-firewall/releases/download/v0.23.1/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.23.1/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.23.1
  • ghcr.io/github/gh-aw-firewall/agent:0.23.1
  • 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.23.1

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

Contributors

Mossaka and lpcox
Assets 8
Loading