Add api-proxy CA certificate support by Copilot · Pull Request #7816 · github/gh-aw-firewall

Copilot · 2026-08-28T04:10:11Z

Custom api-proxy upstream targets can use TLS certificates chained to private or corporate CAs, but the sidecar had no way to extend Node’s trust store. This adds a supported CA path for api-proxy without disabling certificate verification.

Configuration + CLI
- Adds apiProxy.caCert to AWF config.
- Adds --api-proxy-ca-cert <path> CLI plumbing.
Sidecar wiring
- Bind-mounts the host CA file read-only into api-proxy at:
  /usr/local/share/ca-certificates/awf-upstream-ca.crt
- Sets NODE_EXTRA_CA_CERTS to that mounted path so Node trusts the additional CA alongside built-in roots.
Schema, tests, docs
- Updates config schema and generated runtime schema.
- Adds focused coverage for config mapping, validation, type composition, build config, and Docker Compose output.
- Documents the new flag and sidecar environment behavior.

Example:

apiProxy:
  caCert: /etc/ssl/certs/corporate-ca.crt
  targets:
    openai:
      host: llm-router.internal.example.com

Equivalent CLI:

awf \
  --openai-api-target llm-router.internal.example.com \
  --api-proxy-ca-cert /etc/ssl/certs/corporate-ca.crt \
  --allow-domains llm-router.internal.example.com \
  -- command

Fixes api-proxy: no way to trust a private CA for a custom upstream target (the agent and cli-proxy sidecars already have one) #7807

Copilot

Pull request overview

Adds private/corporate CA trust for custom API proxy upstreams without disabling TLS verification.

Changes:

Adds config and CLI plumbing for apiProxy.caCert.
Mounts the CA into API proxy containers and configures NODE_EXTRA_CA_CERTS.
Updates schemas, tests, and documentation.

Show a summary per file

File	Description
`src/types/api-proxy-routing-options.ts`	Adds the CA option type.
`src/types/api-proxy-options.test.ts`	Tests type composition.
`src/services/api-proxy-service-config.ts`	Adds the read-only CA mount.
`src/services/api-proxy-service-config.test.ts`	Tests Compose CA wiring.
`src/services/api-proxy-env-config.ts`	Sets `NODE_EXTRA_CA_CERTS`.
`src/schema.test.ts`	Covers valid schema usage.
`src/config-mapper.ts`	Maps file configuration.
`src/config-file.ts`	Adds the file-config field.
`src/config-file-validation.test.ts`	Tests field type validation.
`src/config-file-mapping.test.ts`	Tests config mapping.
`src/commands/build-config.ts`	Propagates the resolved option.
`src/commands/build-config.test.ts`	Tests option propagation.
`src/cli-options.ts`	Adds the CLI flag.
`src/awf-config-schema.json`	Updates the runtime schema.
`docs/awf-config.schema.json`	Updates the canonical schema.
`docs/awf-config-spec.md`	Documents config mapping.
`docs/api-proxy-sidecar.md`	Documents the environment variable.
`docs-site/src/content/docs/reference/cli-reference.md`	Documents CLI usage.

Review details

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Files reviewed: 18/18 changed files
Comments generated: 1
Review effort level: Balanced

      [
        // Mount log directory for api-proxy logs
        `${apiProxyLogsPath}:/var/log/api-proxy:rw`,
+        ...(config.apiProxyCaCert ? [`${config.apiProxyCaCert}:${API_PROXY_UPSTREAM_CA_CERT_CONTAINER_PATH}:ro`] : []),


lpcox · 2026-08-28T04:35:55Z

@copilot address review feedback

Copilot · 2026-08-28T04:40:58Z

@copilot address review feedback

Addressed in commit 5b0d7c1: relative CA paths are resolved from the invocation directory, and empty, missing, or non-file paths now fail with actionable errors before the Compose bind mount is emitted. Added focused coverage for normalization and rejection cases.

github-actions · 2026-08-28T14:40:28Z

✅ Copilot review passed with no inline comments.

@copilot Add the ready-for-aw label to this PR to trigger agentic CI smoke tests.

github-actions · 2026-08-28T14:40:48Z

Documentation Preview

Documentation build failed for this PR. View logs.

Built from commit c6a4462

github-actions · 2026-08-28T16:03:32Z

🔌 Smoke Services — All services reachable! ✅

🔌 Service connectivity validated by Smoke Services

github-actions · 2026-08-28T16:03:34Z

🛡️ Smoke Copilot Network Isolation confirmed the egress allowlist is enforced. ✅

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

example.com

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "example.com"

See Network Configuration for more information.

🛡️ Egress verdict from Smoke Copilot Network Isolation

github-actions · 2026-08-28T16:03:39Z

❌ Smoke Gemini reports failed. Facets need polishing...

💎 Faceted by Smoke Gemini

github-actions · 2026-08-28T16:03:43Z

📰 VERDICT: Smoke Copilot has concluded. All systems operational. This is a developing story. 🎤

📰 BREAKING: Report filed by Smoke Copilot

github-actions · 2026-08-28T16:03:44Z

✅ Smoke Claude passed

Generated by Smoke Claude for #7816

github-actions · 2026-08-28T16:03:45Z

📰 VERDICT: Smoke Docker Sbx has concluded. All systems operational. This is a developing story. 🎤

📰 BREAKING: Report filed by Smoke Docker Sbx

github-actions · 2026-08-28T16:03:48Z

🚀 Security Guard has started processing this pull request

github-actions · 2026-08-28T16:03:49Z

Chroot tests passed! Smoke Chroot - All security and functionality tests succeeded.

Tested by Smoke Chroot

github-actions · 2026-08-28T16:03:52Z

📡 Smoke OTel Tracing completed. All tracing scenarios validated. ✅

📡 OTel tracing validated by Smoke OTel Tracing

github-actions · 2026-08-28T16:04:29Z

✨ The prophecy is fulfilled... Smoke Codex has completed its mystical journey. The stars align. 🌟

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

registry.npmjs.org

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "registry.npmjs.org"

See Network Configuration for more information.

🔮 The oracle has spoken through Smoke Codex

github-actions · 2026-08-28T16:06:58Z

EGRESS_RESULT allow=pass deny=pass

✅ Allowed domain (github.com) reachable: allowed=200
✅ Blocked domain (example.com) denied: 403 proxy tunnel failure

Overall: PASS

@lpcox

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

example.com

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "example.com"

See Network Configuration for more information.

🛡️ Egress verdict from Smoke Copilot Network Isolation
_{Add label ready-for-aw to run again}

github-actions · 2026-08-28T16:07:14Z

Smoke Test: Claude Engine Validation

Check	Status
API	✅ PASS
GitHub CLI	✅ PASS
File	✅ PASS

Overall result: PASS

Generated by Smoke Claude for #7816 · claude · haiku45 · 32.7 AIC · ⊞ 4.5K · ◷
_{Add label ready-for-aw to run again}

github-actions · 2026-08-28T16:07:31Z

Smoke Test: GitHub Actions Services Connectivity

Redis PING: ❌ (Temporary failure in name resolution)
PostgreSQL pg_isready: ❌ (no response)
PostgreSQL SELECT 1: ❌ (could not translate host name)

Overall: FAIL — host.docker.internal did not resolve from the AWF sandbox.

🔌 Service connectivity validated by Smoke Services
_{Add label ready-for-aw to run again}

github-actions · 2026-08-28T16:07:45Z

🧪 Smoke Test: Copilot BYOK (Direct) Mode

✅ GitHub MCP Testing — MCP connected, PR list verified
✅ GitHub.com Connectivity — HTTP 200
✅ File Write/Read Test — smoke-test-copilot-byok.txt exists
✅ BYOK Inference Test — Agent responding via api-proxy → api.githubcopilot.com

Status: ✅ PASS
Running in direct BYOK mode (COPILOT_PROVIDER_API_KEY) via api-proxy.

🔑 BYOK report filed by Smoke Copilot BYOK
_{Add label ready-for-aw to run again}

github-actions · 2026-08-28T16:08:25Z

Smoke Test: Copilot Engine — @lpcox

✅ GitHub MCP: PR Upgrade gh-aw workflows to v0.87.8 #7823 (Upgrade gh-aw workflows), PR refactor: split Cloud Hypervisor backend helpers #7797 (refactor Cloud Hypervisor)
✅ github.com connectivity (HTTP 200)
✅ File write/read test

Overall: PASS

📰 BREAKING: Report filed by Smoke Copilot
_{Add label ready-for-aw to run again}

github-actions · 2026-08-28T16:08:30Z

Docker Sbx Smoke Test

✅ GitHub MCP connectivity (list_pull_requests OK)
✅ GitHub.com connectivity (HTTP 200)
✅ File write/read test

Overall: PASS

cc @lpcox

📰 BREAKING: Report filed by Smoke Docker Sbx
_{Add label ready-for-aw to run again}

github-actions · 2026-08-28T16:08:47Z

Chroot Version Comparison

Runtime	Host Version	Chroot Version	Match?
Python	Python 3.12.14	Python 3.12.14	✅ YES
Node.js	v24.19.0	v22.23.2	❌ NO
Go	go1.22.12	go1.22.12	✅ YES

Overall: FAILED — Node.js version mismatch between host and chroot environment. smoke-chroot label not added.

Tested by Smoke Chroot
_{Add label ready-for-aw to run again}

github-actions · 2026-08-28T16:08:56Z

Smoke Test: API Proxy OTel Tracing — results:

✅ Module Loading — otel.js loads; isEnabled: true; exports startRequestSpan, setTokenAttributes, setBudgetAttributes, endSpan, endSpanError, shutdown, isEnabled, _provider, ... and internal helpers.
✅ Test Suite — 3 suites / 68 tests passed (otel.test.js, otel-fanout.test.js, otel-workload-identity.test.js). Note: the workflow step uses the deprecated Jest flag --testPathPattern, which errors under the installed Jest version (needs --testPathPatterns); re-running with the correct flag confirms all 68 tests pass — CI step output itself may show a config error, not a real test failure.
✅ Env Var Forwarding — env-passthrough.ts forwards GITHUB_AW_OTEL_TRACE_ID/GITHUB_AW_OTEL_PARENT_SPAN_ID to the agent; api-proxy-env-config.ts forwards GH_AW_OTLP_ENDPOINTS, OTEL_EXPORTER_OTLP_ENDPOINT, and both trace-context vars to api-proxy.
✅ Token Tracker Integration — token-tracker-http.js contains onUsage (4 references) as the OTEL hook point.
⚠️ OTEL Diagnostics — no otel.jsonl was found under /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/ for this run (only token-usage.jsonl, token-tracker-audit.jsonl, models.json), so no spans were exported during this smoke run — expected since no live API traffic through the sidecar occurred in this workflow invocation.

Overall: all core OTEL integration points verified; no unexpected failures. Recommend fixing the Jest flag (--testPathPattern → --testPathPatterns) in the workflow to avoid a spurious CI error message.

📡 OTel tracing validated by Smoke OTel Tracing
_{Add label ready-for-aw to run again}

github-actions · 2026-08-28T16:09:15Z

fix: validate api proxy CA certificate paths
fix: add api proxy upstream CA option
GitHub MCP: ❌
safeinputs-gh: ❌
Playwright: ✅
File write/read: ✅
Build AWF: ✅
Discussion: ❌
Overall: FAIL

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

registry.npmjs.org

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "registry.npmjs.org"

See Network Configuration for more information.

🔮 The oracle has spoken through Smoke Codex
_{Add label ready-for-aw to run again}

github-actions · 2026-08-28T16:09:17Z

🏗️ 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 (ran, "Hello, World!")	✅ PASS
.NET	json-parse	✅	N/A (ran successfully)	✅ PASS
Go	color	✅	ok	✅ PASS
Go	env	✅	ok	✅ PASS
Go	uuid	✅	ok	✅ PASS
Java	gson	✅	1/1 passed	✅ PASS
Java	caffeine	✅	1/1 passed	✅ PASS
Node.js	clsx	✅	All tests passed	✅ PASS
Node.js	execa	✅	All tests passed	✅ PASS
Node.js	p-limit	✅	All tests passed	✅ PASS
Rust	fd	✅	1/1 passed	✅ PASS
Rust	zoxide	✅	1/1 passed	✅ PASS

Overall: 8/8 ecosystems passed — ✅ PASS

Note: Java's Maven local repository (~/.m2/repository) was not writable by the runner user (pre-existing permission issue, root-owned .m2 dir); tests were run with -Dmaven.repo.local pointed at a writable temp directory to work around it. Everything else ran as specified with no issues.

Generated by Build Test Suite for #7816 · copilot · auto · 40.8 AIC · ⊞ 12K · ◷
_{Add label ready-for-aw to run again}

Initial plan

4fdd424

Copilot AI assigned Copilot and lpcox Aug 28, 2026

Copilot started work on behalf of lpcox August 28, 2026 04:10 View session

Copilot AI linked an issue Aug 28, 2026 that may be closed by this pull request

api-proxy: no way to trust a private CA for a custom upstream target (the agent and cli-proxy sidecars already have one) #7807

Closed

fix: add api proxy upstream CA option

204e1ea

Copilot AI changed the title ~~[WIP] Add support to trust private CA for custom upstream target~~ Add api-proxy CA certificate support Aug 28, 2026

Copilot finished work on behalf of lpcox August 28, 2026 04:23

Copilot AI requested a review from lpcox August 28, 2026 04:23

lpcox marked this pull request as ready for review August 28, 2026 04:25

Copilot AI balanced review requested due to automatic review settings August 28, 2026 04:25

Copilot started reviewing on behalf of lpcox August 28, 2026 04:25 View session

Copilot AI reviewed Aug 28, 2026

View reviewed changes

Comment thread src/services/api-proxy-service-config.ts Outdated

[

// Mount log directory for api-proxy logs

`${apiProxyLogsPath}:/var/log/api-proxy:rw`,

...(config.apiProxyCaCert ? [`${config.apiProxyCaCert}:${API_PROXY_UPSTREAM_CA_CERT_CONTAINER_PATH}:ro`] : []),

Copilot started work on behalf of lpcox August 28, 2026 04:36 View session

fix: validate api proxy CA certificate paths

2316a0b

Copilot finished work on behalf of lpcox August 28, 2026 04:41

lpcox added the ready-for-aw label Aug 28, 2026

lpcox had a problem deploying to aoai-model August 28, 2026 16:04 — with GitHub Actions Failure

github-actions Bot added the smoke-copilot-network-isolation Copilot network-isolation egress smoke test label Aug 28, 2026

github-actions Bot added the smoke-claude label Aug 28, 2026

github-actions Bot added the smoke-copilot-byok label Aug 28, 2026

github-actions Bot added the smoke-copilot label Aug 28, 2026

github-actions Bot added the smoke-docker-sbx label Aug 28, 2026

github-actions Bot added the build-test label Aug 28, 2026

lpcox deployed to aoai-model August 28, 2026 16:09 — with GitHub Actions Active

This was referenced Aug 28, 2026

[aw] Contribution Check hit engine rate limit (HTTP 429) #7830

Closed

[aw] Smoke Copilot BYOK AOAI (Entra) hit engine rate limit (HTTP 429) #7832

Closed

lpcox merged commit d98e918 into main Aug 28, 2026
158 of 164 checks passed

lpcox deleted the copilot/api-proxy-trust-private-ca branch August 28, 2026 21:45

This was referenced Aug 29, 2026

🩺 Runner Doctor Updateadd B28 (api-proxy corporate/private CA support) from 2026-08-27+ scan #7856

Closed

[docs] auth: docs: reconcile Codex auto-model caveat between authentication-architecture and api-proxy-sidecar #7860

Merged

golivax mentioned this pull request Aug 30, 2026

api-proxy: http:// API targets are accepted and allowlisted as HTTP, but the sidecar always dials https://<host>:443 #7862

Closed

github-actions Bot mentioned this pull request Aug 30, 2026

[deps-release-notes] awf — upstream release action items githubnext/ado-aw#2028

Open

This was referenced Aug 30, 2026

api-proxy: honour explicit http:// scheme in target dialing instead of always dialing 443 #7868

Merged

docs: add B28 runner-doctor coverage for private-CA api-proxy TLS failures #7871

Merged

Uh oh!

Conversation

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

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Review details

Uh oh!

lpcox commented Aug 28, 2026

Uh oh!

Copilot AI commented Aug 28, 2026

Uh oh!

github-actions Bot commented Aug 28, 2026

Uh oh!

github-actions Bot commented Aug 28, 2026

Documentation Preview

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 28, 2026

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 28, 2026

Uh oh!

github-actions Bot commented Aug 28, 2026

Smoke Test: Claude Engine Validation

Uh oh!

github-actions Bot commented Aug 28, 2026

Uh oh!

github-actions Bot commented Aug 28, 2026

🧪 Smoke Test: Copilot BYOK (Direct) Mode

Uh oh!

github-actions Bot commented Aug 28, 2026

Uh oh!

github-actions Bot commented Aug 28, 2026

Uh oh!

github-actions Bot commented Aug 28, 2026

Chroot Version Comparison

Uh oh!

github-actions Bot commented Aug 28, 2026

Uh oh!

github-actions Bot commented Aug 28, 2026

Uh oh!

github-actions Bot commented Aug 28, 2026

🏗️ Build Test Suite Results

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

Copilot AI commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading

github-actions Bot commented Aug 28, 2026 •

edited

Loading