feat: add Copilot BYOK support via COPILOT_API_KEY by Copilot · Pull Request #1918 · github/gh-aw-firewall

Copilot · 2026-04-11T18:40:55Z

Adds support for COPILOT_API_KEY as a direct Copilot API key (BYOK) alongside the existing COPILOT_GITHUB_TOKEN OAuth flow. When api-proxy is enabled, the key is held exclusively in the sidecar — never exposed to the agent.

Changes

src/types.ts — new copilotApiKey?: string field on WrapperConfig
src/cli.ts — reads COPILOT_API_KEY from env; updates validateApiProxyConfig to treat either token as satisfying the Copilot key requirement; excludes from redacted config log
src/docker-manager.ts:
- Adds COPILOT_API_KEY to AWF_ONE_SHOT_TOKENS
- Sets early placeholder (placeholder-token-for-credential-isolation) when api-proxy is enabled to block --env-all leakage
- Forwards real value to api-proxy sidecar; forwards to agent only when api-proxy is not enabled
- COPILOT_API_URL + COPILOT_TOKEN placeholder now also set when copilotApiKey is provided
containers/api-proxy/server.js — introduces COPILOT_AUTH_TOKEN = COPILOT_GITHUB_TOKEN || COPILOT_API_KEY (GitHub token takes precedence); Copilot proxy starts with either key present
containers/agent/api-proxy-health-check.sh — validates COPILOT_API_KEY is placeholder when api-proxy is active

Usage

export COPILOT_API_KEY="cpat_..."   # BYOK direct key
sudo -E awf --enable-api-proxy \
  --allow-domains api.githubcopilot.com \
  -- npx @github/copilot --prompt "..."

COPILOT_GITHUB_TOKEN and COPILOT_API_KEY are interchangeable; if both are set, COPILOT_GITHUB_TOKEN takes precedence in the proxy.

Agent-Logs-Url: https://github.com/github/gh-aw-firewall/sessions/048378d6-92ce-40bd-bf1b-e668cf5ceb38

Copilot

Pull request overview

Adds Bring Your Own Key (BYOK) support for GitHub Copilot via COPILOT_API_KEY, integrating it into the existing API-proxy credential-isolation flow so the real key can be kept in the sidecar (and only passed to the agent when the proxy is disabled).

Changes:

Extend config + CLI env parsing to support COPILOT_API_KEY alongside COPILOT_GITHUB_TOKEN.
Update docker-compose generation to protect/forward COPILOT_API_KEY correctly (one-shot-token + placeholder isolation + sidecar injection).
Update api-proxy sidecar to accept either Copilot credential, with precedence for COPILOT_GITHUB_TOKEN, plus docs/examples/tests adjustments.

Show a summary per file

File	Description
`src/types.ts`	Adds `copilotApiKey?: string` and documents behavior when API proxy is enabled.
`src/cli.ts`	Reads `COPILOT_API_KEY`, updates API-proxy validation + config redaction + status logging.
`src/docker-manager.ts`	Adds `COPILOT_API_KEY` to one-shot-token list; sets placeholders; forwards real key to sidecar and conditionally to agent.
`src/docker-manager.test.ts`	Adds unit tests for forwarding/isolation behavior of `COPILOT_API_KEY`.
`src/cli.test.ts`	Updates validation warning expectations to include `COPILOT_API_KEY`.
`containers/api-proxy/server.js`	Introduces `COPILOT_AUTH_TOKEN` (`COPILOT_GITHUB_TOKEN
`containers/agent/api-proxy-health-check.sh`	Ensures `COPILOT_API_KEY` is a placeholder in the agent when API-proxy is active.
`examples/github-copilot.sh`	Updates example commentary to focus on `COPILOT_API_KEY` usage with the sidecar.
`docs/api-proxy-sidecar.md`	Documents `COPILOT_API_KEY` as a sidecar-held secret and placeholder behavior in the agent.
`docs-site/src/content/docs/reference/cli-reference.md`	Adds `COPILOT_API_KEY` to the CLI environment variable reference.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Files reviewed: 10/10 changed files
Comments generated: 3

Copilot · 2026-04-11T19:05:36Z

    // it gets a placeholder value set earlier (line ~362) for credential isolation
    if (process.env.COPILOT_GITHUB_TOKEN && !config.enableApiProxy) environment.COPILOT_GITHUB_TOKEN = process.env.COPILOT_GITHUB_TOKEN;
+    // COPILOT_API_KEY (BYOK) — forward when api-proxy is NOT enabled; when api-proxy IS enabled,
+    // it is excluded from agent env (held securely in api-proxy sidecar)


The comment says COPILOT_API_KEY is “excluded from agent env” when api-proxy is enabled, but the implementation sets a placeholder value in the agent environment for credential isolation. Please reword to clarify that the real key is not forwarded and a placeholder may still be present.

Suggested change

// it is excluded from agent env (held securely in api-proxy sidecar)

// the real key is not forwarded to the agent env and a placeholder may still be present

// for credential isolation while the real key is held securely in the api-proxy sidecar

Copilot · 2026-04-11T19:05:37Z

 # Run Copilot CLI with API proxy enabled
-# Use sudo -E to preserve environment variables (COPILOT_GITHUB_TOKEN, GITHUB_TOKEN, AWF_ONE_SHOT_TOKEN_DEBUG)
+# Use sudo -E to preserve environment variables (COPILOT_API_KEY, GITHUB_TOKEN, AWF_ONE_SHOT_TOKEN_DEBUG)
+# The api-proxy sidecar holds the real COPILOT_API_KEY and injects it into requests.


This example script currently hard-requires COPILOT_API_KEY; however, the PR description/documentation states COPILOT_GITHUB_TOKEN and COPILOT_API_KEY are interchangeable. Consider updating the example to accept either credential (and mention/preserve both in the sudo -E comment) so it matches the supported behavior.

Copilot · 2026-04-11T19:05:37Z

 const OPENAI_API_KEY = (process.env.OPENAI_API_KEY || '').trim() || undefined;
 const ANTHROPIC_API_KEY = (process.env.ANTHROPIC_API_KEY || '').trim() || undefined;
 const COPILOT_GITHUB_TOKEN = (process.env.COPILOT_GITHUB_TOKEN || '').trim() || undefined;
+const COPILOT_API_KEY = (process.env.COPILOT_API_KEY || '').trim() || undefined;
+// BYOK: use COPILOT_GITHUB_TOKEN (GitHub OAuth) or COPILOT_API_KEY (direct key), GitHub token takes precedence
+const COPILOT_AUTH_TOKEN = COPILOT_GITHUB_TOKEN || COPILOT_API_KEY;


COPILOT_API_KEY / COPILOT_AUTH_TOKEN support was added here, but there are no unit tests covering the new env var path or the precedence rule (COPILOT_GITHUB_TOKEN should win when both are set). Since containers/api-proxy/server.js already has a test suite, please add/extend tests to validate these cases.

Suggested change

const OPENAI_API_KEY = (process.env.OPENAI_API_KEY || '').trim() || undefined;

const ANTHROPIC_API_KEY = (process.env.ANTHROPIC_API_KEY || '').trim() || undefined;

const COPILOT_GITHUB_TOKEN = (process.env.COPILOT_GITHUB_TOKEN || '').trim() || undefined;

const COPILOT_API_KEY = (process.env.COPILOT_API_KEY || '').trim() || undefined;

// BYOK: use COPILOT_GITHUB_TOKEN (GitHub OAuth) or COPILOT_API_KEY (direct key), GitHub token takes precedence

const COPILOT_AUTH_TOKEN = COPILOT_GITHUB_TOKEN || COPILOT_API_KEY;

function resolveCopilotAuthToken(env = process.env) {

const githubToken = (env.COPILOT_GITHUB_TOKEN || '').trim() || undefined;

const apiKey = (env.COPILOT_API_KEY || '').trim() || undefined;

// BYOK: use COPILOT_GITHUB_TOKEN (GitHub OAuth) or COPILOT_API_KEY (direct key),

// with GitHub token taking precedence when both are set.

return githubToken || apiKey;

}

const OPENAI_API_KEY = (process.env.OPENAI_API_KEY || '').trim() || undefined;

const ANTHROPIC_API_KEY = (process.env.ANTHROPIC_API_KEY || '').trim() || undefined;

const COPILOT_GITHUB_TOKEN = (process.env.COPILOT_GITHUB_TOKEN || '').trim() || undefined;

const COPILOT_API_KEY = (process.env.COPILOT_API_KEY || '').trim() || undefined;

const COPILOT_AUTH_TOKEN = resolveCopilotAuthToken(process.env);

- Reword docker-manager comment to clarify placeholder behavior when api-proxy is enabled - Update github-copilot example to accept either COPILOT_GITHUB_TOKEN or COPILOT_API_KEY instead of hard-requiring COPILOT_API_KEY - Extract resolveCopilotAuthToken() as a testable function with JSDoc and export it from server.js - Add 8 unit tests covering precedence, fallback, empty/whitespace handling, and trimming behavior Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions · 2026-04-11T19:48:48Z

Documentation Preview

Documentation build failed for this PR. View logs.

Built from commit a2cb887

github-actions · 2026-04-11T19:51:13Z

Smoke test results:

✅ GitHub MCP: feat: add containers.txt to release assets / [WIP] Fix code for comments in review thread #1917
✅ Playwright: GitHub page title contains "GitHub"
✅ File write: /tmp/gh-aw/agent/smoke-test-claude-24290215008.txt created
✅ Bash verify: file content confirmed

Overall: PASS

💥 [THE END] — Illustrated by Smoke Claude

github-actions · 2026-04-11T19:51:43Z

🔥 Smoke Test Results — PASS

Test	Result
GitHub MCP (list merged PRs)	✅ PR #1916: "feat: add containers.txt to release assets for immutable image references"
GitHub.com connectivity (HTTP 200)	✅
File write/read	✅ `smoke-test-copilot-24290215001.txt` confirmed

PR: feat: add Copilot BYOK support via COPILOT_API_KEY
Author: @app/copilot-swe-agent | Assignees: @lpcox @Copilot

Overall: ✅ PASS

📰 BREAKING: Report filed by Smoke Copilot

github-actions · 2026-04-11T19:52:13Z

Smoke test results:

Merged PR titles: "fix: exclude Actions artifact token from agent container environment"; "feat: add containers.txt to release assets for immutable image references" ✅
safeinputs-gh PR query (required tool) ❌
Playwright github.com title contains "GitHub" ✅
Tavily search "GitHub Agentic Workflows Firewall" (required tool) ❌
File write/read /tmp/gh-aw/agent/smoke-test-codex-24290214994.txt ✅
Bash verification via cat ✅
Discussion query + mystical discussion comment (required tool path) ❌
npm ci && npm run build ✅
Overall status: FAIL

🔮 The oracle has spoken through Smoke Codex

github-actions · 2026-04-11T19:52:39Z

🔍 Chroot Version Comparison Results

Runtime	Host Version	Chroot Version	Match?
Python	`Python 3.12.13`	`Python 3.12.3`	❌
Node.js	`v24.14.1`	`v20.20.2`	❌
Go	`go1.22.12`	`go1.22.12`	✅

Overall: ❌ Not all tests passed — Python and Node.js versions differ between host and chroot environment.

Tested by Smoke Chroot

github-actions · 2026-04-11T19:52:45Z

Smoke Test: GitHub Actions Services Connectivity ✅

Check	Result
Redis `PING` (`host.docker.internal:6379`)	✅ `PONG`
`pg_isready` (`host.docker.internal:5432`)	✅ accepting connections
`psql SELECT 1` (db: `smoketest`, user: `postgres`)	✅ returned `1`

All checks passed.

🔌 Service connectivity validated by Smoke Services

github-actions · 2026-04-11T19:53:24Z

🏗️ Build Test Suite Results

Ecosystem	Project	Build/Install	Tests	Status
Bun	elysia	✅	1/1 passed	✅ PASS
Bun	hono	✅	1/1 passed	✅ PASS
C++	fmt	✅	N/A	✅ PASS
C++	json	✅	N/A	✅ PASS
Deno	oak	N/A	1/1 passed	✅ PASS
Deno	std	N/A	1/1 passed	✅ PASS
.NET	hello-world	✅	N/A	✅ PASS
.NET	json-parse	✅	N/A	✅ PASS
Go	color	✅	1/1 passed	✅ PASS
Go	env	✅	1/1 passed	✅ PASS
Go	uuid	✅	1/1 passed	✅ PASS
Java	gson	✅	1/1 passed	✅ PASS
Java	caffeine	✅	1/1 passed	✅ PASS
Node.js	clsx	✅	All passed	✅ PASS
Node.js	execa	✅	All passed	✅ PASS
Node.js	p-limit	✅	All passed	✅ PASS
Rust	fd	✅	1/1 passed	✅ PASS
Rust	zoxide	✅	1/1 passed	✅ PASS

Overall: 8/8 ecosystems passed — ✅ PASS

Generated by Build Test Suite for issue #1918 · ● 803.9K · ◷

Initial plan

f52daca

Copilot AI assigned Copilot and lpcox Apr 11, 2026

Copilot started work on behalf of lpcox April 11, 2026 18:40 View session

Copilot AI linked an issue Apr 11, 2026 that may be closed by this pull request

Copilot BYOK #1750

Closed

Copilot AI added 2 commits April 11, 2026 18:53

feat: add Copilot BYOK support via COPILOT_API_KEY env var

56a924a

Agent-Logs-Url: https://github.com/github/gh-aw-firewall/sessions/048378d6-92ce-40bd-bf1b-e668cf5ceb38

test: improve warning message assertion for COPILOT_API_KEY

9691e45

Agent-Logs-Url: https://github.com/github/gh-aw-firewall/sessions/048378d6-92ce-40bd-bf1b-e668cf5ceb38

Copilot AI changed the title ~~[WIP] Add support for new BYOK env var~~ feat: add Copilot BYOK support via COPILOT_API_KEY Apr 11, 2026

Copilot AI requested a review from lpcox April 11, 2026 18:55

Copilot finished work on behalf of lpcox April 11, 2026 18:55

lpcox marked this pull request as ready for review April 11, 2026 19:02

lpcox requested a review from Mossaka as a code owner April 11, 2026 19:02

Copilot AI review requested due to automatic review settings April 11, 2026 19:02

Copilot started reviewing on behalf of lpcox April 11, 2026 19:03 View session

Copilot AI reviewed Apr 11, 2026

View reviewed changes

github-actions Bot added smoke-claude smoke-copilot labels Apr 11, 2026

github-actions Bot added smoke-services build-test labels Apr 11, 2026

github-actions Bot mentioned this pull request Apr 11, 2026

[aw] No-Op Runs #1668

Closed

lpcox merged commit 2aac716 into main Apr 11, 2026
55 of 57 checks passed

lpcox deleted the copilot/add-support-for-byok-env-var branch April 11, 2026 20:12

lpcox mentioned this pull request Apr 11, 2026

Support Copilot CLI offline mode + BYOK for gatewayed deployments #1922

Closed

Copilot AI mentioned this pull request Apr 11, 2026

feat: configure Copilot CLI offline+BYOK mode when api-proxy is enabled with COPILOT_API_KEY #1923

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add Copilot BYOK support via COPILOT_API_KEY#1918

feat: add Copilot BYOK support via COPILOT_API_KEY#1918
lpcox merged 4 commits intomainfrom
copilot/add-support-for-byok-env-var

Copilot AI commented Apr 11, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

Copilot AI Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	// it is excluded from agent env (held securely in api-proxy sidecar)
	// the real key is not forwarded to the agent env and a placeholder may still be present
	// for credential isolation while the real key is held securely in the api-proxy sidecar

Conversation

Copilot AI commented Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Usage

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 11, 2026

Documentation Preview

Uh oh!

github-actions Bot commented Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026

🔥 Smoke Test Results — PASS

Uh oh!

github-actions Bot commented Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026

🔍 Chroot Version Comparison Results

Uh oh!

github-actions Bot commented Apr 11, 2026

Smoke Test: GitHub Actions Services Connectivity ✅

Uh oh!

github-actions Bot commented Apr 11, 2026

🏗️ Build Test Suite Results

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Apr 11, 2026 •

edited

Loading