Skip to content

github-sandbox.md

Latest commit

 

History

History
382 lines (284 loc) · 15.8 KB

github-sandbox.md

File metadata and controls

382 lines (284 loc) · 15.8 KB
title
page nav
Grant GitHub Push Access to a Sandboxed Agent
GitHub Push Access
description Learn the iterative policy workflow by launching a sandbox, diagnosing a GitHub access denial, and applying a custom policy to fix it.
topics
Generative AI
Cybersecurity
tags
Tutorial
GitHub
Sandbox
Policy
Claude Code
content
type difficulty audience
tutorial
technical_intermediate
engineer

Grant GitHub Push Access to a Sandboxed Agent

This tutorial walks through an iterative sandbox policy workflow. You launch a sandbox, ask Claude Code to push code to GitHub, and observe the default network policy denying the request. You then diagnose the denial from your machine and from inside the sandbox, apply a policy update, and verify that the policy update to the sandbox takes effect.

After completing this tutorial, you will have:

  • A running sandbox with Claude Code that can push to a GitHub repository.
  • A custom network policy that grants GitHub access for a specific repository.
  • Experience with the policy iteration workflow: fail, diagnose, update, verify.

:::{note} This tutorial shows example prompts and responses from Claude Code. The exact wording you see might vary between sessions. Use the examples as a guide for the type of interaction, not as expected output. :::

Prerequisites

This tutorial requires the following:

  • A working OpenShell installation. Complete the {doc}Quickstart </get-started/quickstart> before proceeding.
  • A GitHub personal access token (PAT) with repo scope. Generate one from the GitHub personal access token settings page by selecting Generate new token (classic) and enabling the repo scope.
  • An Anthropic account with access to Claude Code. OpenShell provides the sandbox runtime, not the agent. You must authenticate with your own account.
  • A GitHub repository you own to use as the push target. A scratch repository is sufficient. You can create one with a README if needed.

This tutorial uses two terminals to demonstrate the iterative policy workflow:

  • Terminal 1: The sandbox terminal. You create the sandbox in this terminal by running openshell sandbox create and interact with Claude Code inside it.
  • Terminal 2: A terminal outside the sandbox on your machine. You use this terminal for viewing the sandbox logs with openshell term and applying an updated policy with openshell policy set.

Each section below indicates which terminal to use.

Set Up a Sandbox with Your GitHub Token

Depending on whether you start a new sandbox or use an existing sandbox, choose the appropriate tab and follow the instructions.

::::{tab-set}

:::{tab-item} Starting a new sandbox

In terminal 2, create a new sandbox with Claude Code. The {doc}default policy </reference/default-policy> is applied automatically, which allows read-only access to GitHub.

Create a {doc}credential provider </sandboxes/manage-providers> that injects your GitHub token into the sandbox automatically. The provider reads GITHUB_TOKEN from your host environment and sets it as an environment variable inside the sandbox:

$ GITHUB_TOKEN=<your-token>
$ openshell provider create --name my-github --type github --from-existing
$ openshell sandbox create --provider my-github -- claude

openshell sandbox create keeps the sandbox running after Claude Code exits, so you can apply policy updates later without recreating the environment. Add --no-keep if you want the sandbox deleted automatically instead.

Claude Code starts inside the sandbox. It prints an authentication link. Open it in your browser, sign in to your Anthropic account, and return to the terminal. When prompted, trust the /sandbox workspace to allow Claude Code to read and write files. :::

:::{tab-item} Using an existing sandbox

In terminal 1, connect to a sandbox that is already running and set your GitHub token as an environment variable:

$ openshell sandbox connect <sandbox-name>
$ export GITHUB_TOKEN=<your-token>

To find the name of running sandboxes, run openshell sandbox list in terminal 2.

:::

::::

Push Code to GitHub

In terminal 1, ask Claude Code to write a simple script and push it to your repository. Replace <org> with your GitHub organization or username and <repo> with your repository name.

:::{dropdown} Prompt :open: :icon: terminal

Write a hello_world.py script and push it to https://github.com/<org>/<repo>. :::

Claude recognizes that it needs GitHub credentials. It asks how you want to authenticate. Provide your GitHub personal access token by pasting it into the conversation. Claude configures authentication and attempts the push.

The push fails. Claude reports an error, but the failure is not an authentication problem. The default sandbox policy permits read-only access to GitHub and blocks write operations, so the proxy denies the push before the request reaches the GitHub server.

Diagnose the Denial

In this section, you diagnose the denial from your machine and from inside the sandbox.

View the Logs from Your Machine

In terminal 2, launch the OpenShell terminal:

$ openshell term

The dashboard shows sandbox status and a live stream of policy decisions. Look for entries with l7_decision=deny. Select a deny entry to see the full detail:

l7_action:      PUT
l7_target:      /repos/<org>/<repo>/contents/hello_world.py
l7_decision:    deny
dst_host:       api.github.com
dst_port:       443
l7_protocol:    rest
policy:         github_rest_api
l7_deny_reason: PUT /repos/<org>/<repo>/contents/hello_world.py not permitted by policy

The log shows that the sandbox proxy intercepted an outbound PUT request to api.github.com and denied it. The github_rest_api policy allows read operations (GET) but blocks write operations (PUT, POST, DELETE) to the GitHub API. A similar denial appears for github.com if Claude attempted a git push over HTTPS.

Ask Claude Code to Check the Sandbox Logs

In terminal 1, ask Claude Code to check the sandbox logs for denied requests:

:::{dropdown} Prompt :open: :icon: terminal

Check the sandbox logs for any denied network requests. What is blocking the push? :::

Claude reads the deny entries and identifies the root cause. It explains that the failure is a sandbox network policy restriction, not a token permissions issue. For example, the following is a possible response:

:::{dropdown} Response :open: :icon: comment

The sandbox runs a proxy that enforces policies on outbound traffic. The github_rest_api policy allows GET requests (used to read the file) but blocks PUT/write requests to GitHub. This is a sandbox-level restriction, not a token issue. No matter what token you provide, pushes through the API will be blocked until the policy is updated. :::

Both perspectives confirm the same thing: the proxy is doing its job. The default policy is designed to be restrictive. To allow GitHub pushes, you need to update the network policy.

Copy the deny reason from Claude's response. You paste it into an agent running on your machine in the next step.

Update the Policy from Your Machine

In terminal 2, paste the deny reason from the previous step into your coding agent on your machine, such as Claude Code or Cursor, and ask it to recommend a policy update. The deny reason gives the agent the context it needs to generate the correct policy rules. After pasting the following prompt sample, properly provide the GitHub organization and repository names of the repository you are pushing to.

:::{dropdown} Prompt :open: :icon: terminal

Based on the following deny reasons, recommend a sandbox policy update that allows GitHub pushes to https://github.com/<org>/<repo>, and save to /tmp/sandbox-policy-update.yaml:

The filesystem_policy, landlock, and process sections are static. They are read once at sandbox creation and cannot be changed by a hot-reload. They are included here for completeness so the file is self-contained, but only the network_policies section takes effect when you apply this to a running sandbox. :::

The following steps outline the expected process done by the agent:

  1. Inspects the deny reasons.
  2. Writes an updated policy that adds github_git and github_api blocks that grant write access to your repository.
  3. Saves the policy to /tmp/sandbox-policy-update.yaml.

Review the Generated Policy

Refer to the following policy example to compare with the generated policy before applying it. Confirm that the policy grants only the access you expect. In this case, git push operations and GitHub REST API access scoped to a single repository.

::::{dropdown} Full reference policy :icon: code

The following YAML shows a complete policy that extends the {doc}default policy </reference/default-policy> with GitHub access for a single repository. Replace <org> with your GitHub organization or username and <repo> with your repository name.

The filesystem_policy, landlock, and process sections are static. They are read once at sandbox creation and cannot be changed by a hot-reload. They are included here for completeness so the file is self-contained, but only the network_policies section takes effect when you apply this to a running sandbox.

:emphasize-lines: 54-100

version: 1

# ── Static (locked at sandbox creation) ──────────────────────────

filesystem_policy:
  include_workdir: true
  read_only:
    - /usr
    - /lib
    - /proc
    - /dev/urandom
    - /app
    - /etc
    - /var/log
  read_write:
    - /sandbox
    - /tmp
    - /dev/null

landlock:
  compatibility: best_effort

process:
  run_as_user: sandbox
  run_as_group: sandbox

# ── Dynamic (hot-reloadable) ─────────────────────────────────────

network_policies:

  # Claude Code ↔ Anthropic API
  claude_code:
    name: claude-code
    endpoints:
      - { host: api.anthropic.com, port: 443, protocol: rest, enforcement: enforce, access: full, tls: terminate }
      - { host: statsig.anthropic.com, port: 443 }
      - { host: sentry.io, port: 443 }
      - { host: raw.githubusercontent.com, port: 443 }
      - { host: platform.claude.com, port: 443 }
    binaries:
      - { path: /usr/local/bin/claude }
      - { path: /usr/bin/node }

  # NVIDIA inference endpoint
  nvidia_inference:
    name: nvidia-inference
    endpoints:
      - { host: integrate.api.nvidia.com, port: 443 }
    binaries:
      - { path: /usr/bin/curl }
      - { path: /bin/bash }
      - { path: /usr/local/bin/opencode }

  # ── GitHub: git operations (clone, fetch, push) ──────────────

  github_git:
    name: github-git
    endpoints:
      - host: github.com
        port: 443
        protocol: rest
        tls: terminate
        enforcement: enforce
        rules:
          - allow:
              method: GET
              path: "/<org>/<repo>.git/info/refs*"
          - allow:
              method: POST
              path: "/<org>/<repo>.git/git-upload-pack"
          - allow:
              method: POST
              path: "/<org>/<repo>.git/git-receive-pack"
    binaries:
      - { path: /usr/bin/git }

  # ── GitHub: REST API ─────────────────────────────────────────

  github_api:
    name: github-api
    endpoints:
      - host: api.github.com
        port: 443
        protocol: rest
        tls: terminate
        enforcement: enforce
        rules:
          # GraphQL API (used by gh CLI)
          - allow:
              method: POST
              path: "/graphql"
          # Full read-write access to the repository
          - allow:
              method: "*"
              path: "/repos/<org>/<repo>/**"
    binaries:
      - { path: /usr/local/bin/claude }
      - { path: /usr/local/bin/opencode }
      - { path: /usr/bin/gh }
      - { path: /usr/bin/curl }

  # ── Package managers ─────────────────────────────────────────

  pypi:
    name: pypi
    endpoints:
      - { host: pypi.org, port: 443 }
      - { host: files.pythonhosted.org, port: 443 }
      - { host: github.com, port: 443 }
      - { host: objects.githubusercontent.com, port: 443 }
      - { host: api.github.com, port: 443 }
      - { host: downloads.python.org, port: 443 }
    binaries:
      - { path: /sandbox/.venv/bin/python }
      - { path: /sandbox/.venv/bin/python3 }
      - { path: /sandbox/.venv/bin/pip }
      - { path: "/sandbox/.uv/python/**/python*" }
      - { path: /usr/local/bin/uv }
      - { path: "/sandbox/.uv/python/**" }

  # ── VS Code Remote ──────────────────────────────────────────

  vscode:
    name: vscode
    endpoints:
      - { host: update.code.visualstudio.com, port: 443 }
      - { host: "*.vo.msecnd.net", port: 443 }
      - { host: vscode.download.prss.microsoft.com, port: 443 }
      - { host: marketplace.visualstudio.com, port: 443 }
      - { host: "*.gallerycdn.vsassets.io", port: 443 }
    binaries:
      - { path: /usr/bin/curl }
      - { path: /usr/bin/wget }
      - { path: "/sandbox/.vscode-server/**" }
      - { path: "/sandbox/.vscode-remote-containers/**" }

The following table summarizes the two GitHub-specific blocks:

Block Endpoint Behavior
github_git github.com:443 Git Smart HTTP protocol with TLS termination. Permits info/refs (clone/fetch), git-upload-pack (fetch data), and git-receive-pack (push) for the specified repository. Denies all operations on unlisted repositories.
github_api api.github.com:443 REST API with TLS termination. Permits all HTTP methods for the specified repository and GraphQL queries. Denies API access to unlisted repositories.

The remaining blocks (claude_code, nvidia_inference, pypi, vscode) are identical to the {doc}default policy </reference/default-policy>. The default policy's github_ssh_over_https and github_rest_api blocks are replaced by the github_git and github_api blocks above, which grant write access to the specified repository. Sandbox behavior outside of GitHub operations is unchanged.

For details on policy block structure, refer to Policies. ::::

Apply the Policy

After you have reviewed the generated policy, apply it to the running sandbox:

$ openshell policy set <sandbox-name> --policy /tmp/sandbox-policy-update.yaml --wait

Network policies are hot-reloadable. The --wait flag blocks until the policy engine confirms the new revision loaded, and the update takes effect immediately without restarting the sandbox or reconnecting Claude Code.

Retry the Push

In terminal 1, ask Claude Code to retry the push:

The sandbox policy has been updated. Try pushing to the repository again.

The push completes successfully. The openshell term dashboard now shows l7_decision=allow entries for api.github.com and github.com where it previously showed denials.

Clean Up

When you are finished, delete the sandbox to free cluster resources:

$ openshell sandbox delete <sandbox-name>

Next Steps

The following resources cover related topics in greater depth:

  • To add per-repository access levels (read-write vs read-only) or restrict to specific API methods, refer to the Policy Schema Reference.
  • To learn the full policy iteration workflow (pull, edit, push, verify), refer to {doc}/sandboxes/policies.
  • To inject credentials automatically instead of pasting tokens, refer to {doc}/sandboxes/manage-providers.