Skip to content

providers-v2.mdx

Latest commit

 

History

History
744 lines (574 loc) · 37 KB

providers-v2.mdx

File metadata and controls

744 lines (574 loc) · 37 KB
Raw
title Providers v2
sidebar-title Providers v2
description Use provider profiles to attach credentials, network policy, and refresh metadata to OpenShell sandboxes.
keywords Generative AI, Cybersecurity, Providers, Provider Profiles, Credentials, Policy, Sandbox
position 4

Providers v2 turns providers from credential records into profile-backed access bundles. A provider profile describes the credentials, endpoints, binaries, policy rules, and refresh behavior for a provider type. A provider instance stores the concrete credential and config values for one gateway.

Use Providers v2 when you want provider-owned policy rules to travel with provider credentials. For example, a GitHub provider can describe both GITHUB_TOKEN and the GitHub API endpoints that a sandbox needs, so users do not have to copy the same network policy into every sandbox.

Why Providers v2 Exists

Provider credentials and network policy were previously configured through separate workflows. A user could create a GitHub provider that stored GITHUB_TOKEN, but the sandbox still needed a separate policy that allowed api.github.com, selected the right binaries, and configured REST enforcement.

Providers v2 keeps those pieces together:

Need Providers v2 behavior
Repeatable provider setup Built-in and custom provider profiles define reusable provider types.
Provider-aware policy Attached providers contribute _provider_* network policy entries to the effective sandbox policy.
Custom provider definitions You can export, edit, lint, import, list, and delete custom profiles.
Runtime provider lifecycle You can list, attach, and detach providers on existing sandboxes.
Credential rotation Provider refresh metadata lets the gateway refresh short-lived access tokens and update provider records.
Backward compatibility Credential delivery still uses environment placeholders and proxy rewrite.

Enable Providers v2

Provider profile policy composition is controlled by the gateway-level providers_v2_enabled setting. Enable it on the active gateway:

openshell settings set --global --key providers_v2_enabled --value true

When the setting is disabled or unset, providers keep the existing credential-only behavior. Sandboxes still receive provider credential placeholders, but attached provider profiles do not add network policy entries to the effective policy.

To disable provider profile policy composition, delete the setting:

openshell settings delete --global --key providers_v2_enabled
The feature flag controls provider-derived policy layers. OpenShell still supports placeholder environment variables for provider credentials, and provider profiles can also declare dynamic token grants that the sandbox proxy resolves on demand for matching HTTP endpoints.

Available Features

Providers v2 currently includes these user-facing features:

  • Built-in provider profiles loaded by the gateway by default.
  • Gateway configuration can compose built-in, user-managed, and interceptor-vended profile sources. Selecting only an interceptor makes its catalog authoritative by omission.
  • openshell provider list-profiles with table, YAML, and JSON output.
  • openshell provider profile export, import, update, lint, and delete for custom profiles.
  • Provider instances created from built-in or imported profile IDs with openshell provider create --type <id>.
  • Profile-backed credential discovery for explicit openshell provider create --from-existing and openshell provider update --from-existing flows. The built-in google-vertex-ai profile also supplements discovery with Vertex config env vars such as VERTEX_AI_PROJECT_ID and VERTEX_AI_REGION.
  • Just-in-time effective policy composition from sandbox policy plus attached provider profiles.
  • Runtime sandbox provider lifecycle commands under openshell sandbox provider list|attach|detach.
  • Credential refresh configuration with openshell provider refresh status|configure|rotate|delete.
  • Credential expiry metadata with openshell provider update --credential-expires-at; values accept Unix epoch milliseconds or ISO/RFC3339 timestamps.
  • Dynamic token grants that use the sandbox's SPIFFE JWT-SVID as an OAuth2 client assertion and inject short-lived tokens into supported headers for matching profile endpoints.

Roadmap

The following Providers v2 design items are not part of the current behavior:

Roadmap item Current behavior
General profile-driven credential placement Static auth_style, header_name, query_param, and path_template placement metadata is stored and validated, but static credential injection still depends on environment placeholders generated from provider credentials. Dynamic token_grant credentials support bearer and header placement for matching HTTP endpoints.
Endpoint and binary scoped credential injection Provider profile endpoints and binaries affect policy composition. Dynamic token grants are endpoint-scoped. Static placeholder injection is not yet restricted by profile endpoint or binary metadata.
Credential verification on create openshell provider create does not yet probe provider verification endpoints or expose --no-verify.
Automatic credential scope extraction OpenShell does not yet inspect upstream provider responses to discover credential scopes.
Inference mounting from attached providers inference_capable is profile metadata. Attaching an inference-capable provider does not yet create inference.local routes.
Multi-provider inference routing Path-based routing such as inference.local/openai/... and inference.local/anthropic/... is not yet wired to provider profiles.
Policy prover integration OpenShell does not yet run the policy prover automatically on sandbox startup or block startup based on prover findings.
Refresh telemetry as OCSF events Credential refresh logs are secret-safe gateway logs. OCSF refresh events and metrics are future work.

Use Inference Routing for the current inference.local model.

Provider Profiles

A provider profile defines a provider type. It contains metadata, credential declarations, endpoint policy, binary policy, inference metadata, and optional credential refresh metadata.

List available profiles:

openshell provider list-profiles

By default the gateway lists built-in profiles plus custom profiles imported through the profile APIs. When a configured gateway interceptor vends an authoritative provider profile catalog, that catalog becomes the visible source of truth: list, export, provider creation, policy composition, and sandbox provider environment resolution use the interceptor-vended profiles instead of built-in or user-imported profiles.

Built-in Providers v2 profiles currently include:

Profile ID Category Credential environment variables
claude-code agent ANTHROPIC_API_KEY, CLAUDE_API_KEY
codex agent CODEX_AUTH_ACCESS_TOKEN, CODEX_AUTH_REFRESH_TOKEN, CODEX_AUTH_ACCOUNT_ID, CODEX_AUTH_ID_TOKEN
copilot agent COPILOT_GITHUB_TOKEN, GH_TOKEN, GITHUB_TOKEN
cursor agent None
deepinfra inference DEEPINFRA_API_KEY
github source_control GITHUB_TOKEN, GH_TOKEN
google-vertex-ai inference GOOGLE_SERVICE_ACCOUNT_KEY, GOOGLE_VERTEX_AI_SERVICE_ACCOUNT_TOKEN, VERTEX_AI_SERVICE_ACCOUNT_TOKEN, GOOGLE_VERTEX_AI_TOKEN, VERTEX_AI_TOKEN
nvidia inference NVIDIA_API_KEY
pypi data None
tars inference TARS_API_KEY, AGENTROUTER_API_KEY

Export a built-in profile as YAML:

openshell provider profile export github -o yaml > github-profile.yaml

Lint a profile before importing it:

openshell provider profile lint -f github-profile.yaml

Import one profile file:

openshell provider profile import -f github-profile.yaml

Import all non-recursive *.yaml, *.yml, and *.json files from a directory:

openshell provider profile import --from ./provider-profiles

Import is create-only. It fails if a custom profile with the same ID already exists.

Update an existing custom profile by exporting the current custom profile, editing the file, and submitting the edited file back:

openshell provider profile export github-profile -o yaml > github-profile.yaml
openshell provider profile update github-profile -f github-profile.yaml

Exported custom profiles include resource_version. OpenShell requires that version during update so stale files cannot silently overwrite newer profile definitions. The target ID in the command must match the profile ID in the file. Update accepts one file at a time. If an update would make dynamic token grants ambiguous for an attached sandbox, OpenShell rejects it before changing the profile.

Custom profile IDs must use lowercase kebab-case with a-z, 0-9, and -. Built-in profile IDs and legacy provider aliases are reserved. Built-in and interceptor-managed profiles are read-only through the profile APIs. OpenShell also rejects deleting a custom profile while a sandbox-attached provider uses it.

Category Enum

The category field controls how openshell provider list-profiles groups profiles. Use one of these canonical YAML values:

Value Use for
other Profiles that do not fit a more specific category. This is the default when omitted.
inference Model and inference API providers.
agent Agent CLIs and coding tools.
source_control Git hosting, repository, and source control providers.
messaging Chat, email, notification, and messaging APIs.
data Data storage, file, database, and document APIs.
knowledge Search, retrieval, and knowledge-base providers.

Profile Schema

Provider profile YAML and JSON use this shape. Treat this as a field map, not a profile to import verbatim. The endpoint and rule fields mirror the network policy schema used under network_policies. Refer to Policy Schema Reference for field semantics. Use annotations only for non-secret metadata such as source, signature, or governance markers. OpenShell preserves annotations through profile import, export, and interceptor-managed profile snapshots.

id: custom-api
# Present on exported custom profiles; preserve it when updating.
resource_version: 1
annotations:
  example.com/source: platform
display_name: Custom API
description: Custom API access for sandbox agents
category: data
inference_capable: false

credentials:
  - name: api_token
    description: API access token
    env_vars: [CUSTOM_API_TOKEN]
    required: true

    # Accepted values: basic, bearer, header, query, path.
    # These fields describe static credential placement.
    # Static runtime injection still uses env placeholder resolution.
    auth_style: bearer
    header_name: authorization
    query_param: api_key
    path_template: /v1/{credential}/resources

    refresh:
      # Accepted values:
      # static, external, oauth2_refresh_token,
      # oauth2_client_credentials, google_service_account_jwt.
      strategy: oauth2_client_credentials
      token_url: https://login.example.com/oauth2/token
      scopes: [api.read, api.write]
      refresh_before_seconds: 300
      max_lifetime_seconds: 3600
      material:
        - name: client_id
          description: OAuth client ID
          required: true
          secret: false
        - name: client_secret
          description: OAuth client secret
          required: true
          secret: true

    # Optional dynamic credential. The sandbox supervisor requests a
    # SPIFFE JWT-SVID, exchanges it at token_endpoint, caches the returned
    # access token, and injects it according to auth_style/header_name for
    # matching endpoint traffic.
    token_grant:
      token_endpoint: https://login.example.com/realms/custom/protocol/openid-connect/token
      audience: api://custom-api
      jwt_svid_audience: https://login.example.com/realms/custom
      client_assertion_type: urn:ietf:params:oauth:client-assertion-type:jwt-bearer
      scopes: [api.read, api.write]
      cache_ttl_seconds: 300
      audience_overrides:
        - host: api.example.com
          port: 443
          path: /v1/projects/**
          audience: api://custom-projects
          scopes: [projects.read]

discovery:
  credentials: [api_token]

endpoints:
  - host: api.example.com
    port: 443
    path: /v1/**
    protocol: rest
    tls: ""
    enforcement: enforce
    allowed_ips: []
    ports: []
    allow_encoded_slash: false
    websocket_credential_rewrite: false
    request_body_credential_rewrite: false
    persisted_queries: deny
    graphql_max_body_bytes: 65536
    rules:
      - allow:
          method: GET
          path: /v1/projects/**
          command: ""
          query:
            tag:
              any: ["prod-*", "staging-*"]
          operation_type: ""
          operation_name: ""
          fields: []
    deny_rules:
      - method: DELETE
        path: /v1/projects/**
        command: ""
        query: {}
        operation_type: ""
        operation_name: ""
        fields: []
    graphql_persisted_queries:
      # Key must match the request's persisted query hash or saved-query ID.
      9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08:
        operation_type: query
        operation_name: GetProject
        fields: [project]

binaries:
  - /usr/bin/curl
  - /usr/local/bin/custom-cli

Profile Sections

id, display_name, and description identify the profile. id is the value passed to openshell provider create --type.

category groups profiles in openshell provider list-profiles. Use one of the values in the category enum.

credentials declares the credential names, environment variables, auth metadata, optional refresh metadata, and optional dynamic token grant metadata for the provider type. The auth_style field accepts basic, bearer, header, query, or path. When auth_style is path, set path_template to a URL path containing the {credential} placeholder exactly once (for example, /v1/{credential}/resources). Static credentials are exposed as placeholder environment variables and resolved in outbound HTTP requests. Dynamic token grants are resolved by the sandbox proxy on demand for matching profile endpoints and support bearer or header placement. Credential environment variable names must not use the reserved v<digits>_ prefix, such as v10_GITHUB_TOKEN, because OpenShell uses that namespace for revision-scoped placeholders.

discovery controls what --from-existing scans when providers_v2_enabled=true. Each entry in discovery.credentials must name a credential declared under credentials. OpenShell scans the referenced credential's env_vars in order and stores the first non-empty local environment value under the actual environment variable key.

endpoints contains the same endpoint object shape as sandbox network policy. A profile can use access presets, protocol-specific allow rules, deny rules, WebSocket credential rewriting, request body credential rewriting, GraphQL fields, and SSRF IP allowlists.

binaries contains the executable paths allowed to reach the profile endpoints when the profile contributes policy to a sandbox.

inference_capable marks profiles that are intended to participate in inference workflows. It does not currently mount or configure inference.local.

Refresh Metadata

Credential refresh metadata belongs to one credential declaration. The profile defines allowed defaults, such as token URL, scopes, refresh lead time, maximum lifetime, and required material keys. The provider instance stores the actual refresh material.

Profile YAML can declare these refresh strategies:

Strategy Behavior
static Current credentials are updated through openshell provider update. The gateway does not mint a token.
external An external process updates current credentials through openshell provider update. The gateway does not mint a token.
oauth2_refresh_token The gateway exchanges a refresh token for a short-lived access token.
oauth2_client_credentials The gateway mints a short-lived access token with OAuth2 client credentials.
google_service_account_jwt The gateway signs a Google service account JWT and exchanges it for an access token.
aws_sts_assume_role The gateway calls sts:AssumeRole and mints AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN in one operation. Requires providers_v2_enabled=true.

openshell provider refresh configure accepts only gateway-mintable strategies: oauth2-refresh-token, oauth2-client-credentials, google-service-account-jwt, and aws-sts-assume-role. Use openshell provider update for static and external refresh patterns.

Gateway-managed refresh strategies use these material keys:

Strategy Material keys
oauth2_refresh_token client_id, refresh_token, optional client_secret.
oauth2_client_credentials client_id, client_secret, optional tenant_id for Microsoft Entra token URLs.
google_service_account_jwt client_email, private_key, optional subject or sub.
aws_sts_assume_role role_arn, optional session_name, external_id, aws_region, and optional long-lived aws_access_key_id / aws_secret_access_key for gateways without ambient AWS credentials.

OpenShell keeps token endpoints profile-owned. Refresh material cannot override token_url or token_uri during refresh configuration.

Additional Outputs

Most refresh strategies mint a single credential. aws_sts_assume_role mints three. A refresh declares the extra credentials it co-mints with additional_outputs, mapping each strategy-defined output id to a sibling credential whose env_vars receive the value:

credentials:
  - name: access_key_id
    env_vars: [AWS_ACCESS_KEY_ID]
    required: true
    refresh:
      strategy: aws_sts_assume_role
      additional_outputs:
        - output: secret_access_key
          credential: secret_access_key
        - output: session_token
          credential: session_token
  - name: secret_access_key
    env_vars: [AWS_SECRET_ACCESS_KEY]
    required: true
  - name: session_token
    env_vars: [AWS_SESSION_TOKEN]
    required: true

The refresh attaches to the primary credential (access_key_id). Each referenced sibling must exist, declare exactly one env var, and not carry its own refresh. Because a refresh's outputs are runtime-resolvable, a profile whose only credentials are STS-minted can be created with --runtime-credentials. The resolved output-to-env-key mapping is pinned when refresh is configured, so later profile edits do not silently redirect where minted values are written.

Dynamic Token Grants

token_grant belongs to one credential declaration. When a sandbox with the provider attached sends HTTP traffic to a matching profile endpoint, the supervisor requests a SPIFFE JWT-SVID from the local Workload API, exchanges it at token_endpoint, caches the returned access token, and injects it before forwarding the request upstream. Use auth_style: bearer to inject Authorization: Bearer <token>, or auth_style: header with header_name to inject the raw access token into a custom header. Token grants do not support query or path placement.

Create provider instances for token-grant-only profiles with --runtime-credentials. This records an empty provider instance and makes the runtime-resolved credential source explicit:

openshell provider create \
  --name spiffe-token-demo \
  --type spiffe-token-demo \
  --runtime-credentials

Token grant fields:

Field Required Behavior
token_endpoint Yes OAuth2 token endpoint that accepts a SPIFFE JWT-SVID client assertion. Use https:// unless the endpoint is loopback or a Kubernetes service DNS name such as token-issuer.default.svc.cluster.local.
audience No Resource audience requested from the token service.
jwt_svid_audience No Audience used when requesting the JWT-SVID. When omitted, OpenShell derives an issuer-style audience from Keycloak token endpoint paths or falls back to the full token endpoint URL.
client_assertion_type No OAuth2 client_assertion_type form value. Defaults to RFC 7523 urn:ietf:params:oauth:client-assertion-type:jwt-bearer. Set a provider-specific value, such as urn:ietf:params:oauth:client-assertion-type:jwt-spiffe, only when the token issuer explicitly requires it.
scopes No OAuth2 scopes sent as a space-separated scope parameter.
cache_ttl_seconds No Token cache TTL override. When omitted or 0, OpenShell uses the token response expires_in with a 30-second safety margin and one-hour cap, or five minutes minus the margin if the response does not include an expiry.
audience_overrides No Endpoint-specific audience and scopes overrides selected by host, port, and path.

Token grants require the sandbox supervisor to have access to a SPIFFE Workload API socket. They apply to HTTP traffic that the proxy can inspect. Endpoints with tls: skip bypass TLS termination and cannot receive dynamic token grant injection for HTTPS traffic. The token service must return a token value that is safe for HTTP header placement; malformed values are rejected before caching or header injection.

Provider Instances

A provider instance stores concrete credentials and config for a profile type. Built-in profile IDs and imported custom profile IDs are accepted by --type.

Create a GitHub provider from the built-in github profile:

openshell provider create \
  --name work-github \
  --type github \
  --credential GITHUB_TOKEN

Create a provider from local credentials discovered through the provider profile:

openshell provider create \
  --name work-claude \
  --type claude-code \
  --from-existing

When providers_v2_enabled=true, --from-existing uses the provider profile's discovery section. If no profile exists for the requested type, the command fails instead of falling back to the legacy provider registry. When providers_v2_enabled=false, --from-existing uses the legacy provider registry and ignores profile discovery metadata.

For example, with Providers v2 enabled, --type openai --from-existing requires an imported openai profile with a discovery section. Setting OPENAI_API_KEY alone is not enough for v2 profile discovery.

Create a provider from an imported custom profile:

openshell provider create \
  --name custom-api \
  --type custom-api \
  --credential CUSTOM_API_TOKEN

Provider profiles whose required credentials are fully runtime-resolvable through token_grant or gateway-managed refresh can be created without --credential.

Inspect the provider:

openshell provider get custom-api

Update provider credentials:

openshell provider update custom-api --credential CUSTOM_API_TOKEN

Set or clear credential expiry metadata:

openshell provider update custom-api \
  --credential CUSTOM_API_TOKEN="$CUSTOM_API_TOKEN" \
  --credential-expires-at CUSTOM_API_TOKEN=2026-01-01T00:00:00Z

Use an ISO/RFC3339 timestamp or Unix epoch milliseconds. Use 0 as the timestamp to clear expiry for a credential key.

OpenShell skips expired provider credentials when it builds a sandbox provider environment. Running sandboxes also reject expired retained credential generations during placeholder resolution, so stale placeholders fail closed instead of forwarding unresolved or expired credential material.

Configure Credential Refresh

Refresh configuration is stored separately from the current injectable credential value. The gateway refresh worker reads refresh state, mints a new short-lived token for supported strategies, writes the token back to the provider record, and updates credential expiry metadata.

For a complete Microsoft Graph OAuth2 refresh-token walkthrough, see Refresh Microsoft Graph Credentials with Providers v2.

The profile YAML strategy values use underscores, while the CLI --strategy values use kebab-case:

Profile YAML CLI
oauth2_refresh_token oauth2-refresh-token
oauth2_client_credentials oauth2-client-credentials
google_service_account_jwt google-service-account-jwt

Create the provider instance first:

openshell provider create \
  --name my-graph \
  --type microsoft-graph-mail \
  --credential MS_GRAPH_ACCESS_TOKEN

This example assumes you imported a custom profile with id: microsoft-graph-mail. Provider refresh can be configured only for provider types whose profile declares compatible credential refresh metadata.

Configure OAuth2 client credentials refresh:

openshell provider refresh configure my-graph \
  --credential-key MS_GRAPH_ACCESS_TOKEN \
  --strategy oauth2-client-credentials \
  --material tenant_id="$MS_TENANT_ID" \
  --material client_id="$MS_CLIENT_ID" \
  --material client_secret="$MS_CLIENT_SECRET" \
  --secret-material-key client_secret \
  --credential-expires-at 2026-01-01T00:00:00Z

Configure OAuth2 refresh-token refresh:

openshell provider refresh configure my-graph \
  --credential-key MS_GRAPH_ACCESS_TOKEN \
  --strategy oauth2-refresh-token \
  --material client_id="$MS_CLIENT_ID" \
  --material refresh_token="$MS_REFRESH_TOKEN" \
  --material client_secret="$MS_CLIENT_SECRET" \
  --secret-material-key refresh_token \
  --secret-material-key client_secret

Configure Google service account JWT refresh:

openshell provider create \
  --name drive-work \
  --type google-drive \
  --credential GOOGLE_DRIVE_ACCESS_TOKEN

openshell provider refresh configure drive-work \
  --credential-key GOOGLE_DRIVE_ACCESS_TOKEN \
  --strategy google-service-account-jwt \
  --material client_email="$GOOGLE_CLIENT_EMAIL" \
  --material private_key="$GOOGLE_PRIVATE_KEY" \
  --secret-material-key private_key

This example assumes you imported a custom profile with id: google-drive.

`--secret-material-key` takes the name of a `--material` key, not the secret value. For example, use `--material client_secret="$MS_CLIENT_SECRET"` with `--secret-material-key client_secret`. The key should match a material entry so OpenShell can record that material field as sensitive when it stores refresh state. The gateway uses the material values to mint future access tokens, but only the `--credential-key` value, such as `MS_GRAPH_ACCESS_TOKEN`, becomes the injectable provider credential. If a refresh response rotates an OAuth refresh token, OpenShell stores the new `refresh_token` material and marks `refresh_token` as secret automatically.

Use --credential-expires-at when the current provider credential already has a known expiry timestamp. For refresh-managed keys, the value can be Unix epoch milliseconds or an ISO/RFC3339 timestamp such as 2026-01-01T00:00:00Z or 2026-01-01T01:00:00+01:00. OpenShell stores that value as epoch milliseconds in both refresh state and provider credential metadata. Later gateway-managed refreshes replace it with the minted token expiry.

Force a refresh immediately:

openshell provider refresh rotate my-graph \
  --credential-key MS_GRAPH_ACCESS_TOKEN

Check refresh status:

openshell provider refresh status my-graph

The status table reports operational state without printing token values or refresh material:

PROVIDER                CREDENTIAL_KEY                STRATEGY                     STATUS              EXPIRES_AT            NEXT_REFRESH          LAST_REFRESH          LAST_ERROR
my-graph                MS_GRAPH_ACCESS_TOKEN         oauth2_refresh_token         refreshed           2026-06-01 00:00:00   2026-05-31 23:50:00   2026-05-31 23:00:00   -

When no refresh configuration exists, the CLI distinguishes whole-provider checks from credential-specific checks:

No refresh configurations found for provider 'my-graph'.
No refresh configuration found for provider 'my-graph' credential 'MS_GRAPH_ACCESS_TOKEN'.

Delete refresh state for one credential:

openshell provider refresh delete my-graph \
  --credential-key MS_GRAPH_ACCESS_TOKEN

Deleting refresh state clears the provider credential expiry only when that expiry came from the deleted refresh state. If you later set a different expiry manually with openshell provider update --credential-expires-at, OpenShell preserves the manual value.

Refresh Logs

The gateway emits secret-safe refresh logs during each worker sweep. Use these logs to check which credentials the gateway is watching, when the next refresh is due, and whether a credential is already refreshed.

2026-05-16T19:42:34.705768Z  INFO openshell_server::provider_refresh: provider credential refresh worker sweep watched_count=1 due_count=0 rotation_requested_count=0
2026-05-16T19:42:34.705905Z  INFO openshell_server::provider_refresh: provider credential refresh watch provider=outlook-email credential_key=MS_GRAPH_ACCESS_TOKEN strategy=oauth2_refresh_token status=refreshed expires_at_ms=1778961995456 seconds_until_expiry=1440 next_refresh_at_ms=1778961395456 last_refresh_at_ms=1778958395456 seconds_until_refresh=840 due=false rotation_requested=false

The sweep line summarizes how many credential refresh records the worker inspected. The watch line shows the provider, credential key, strategy, refresh status, expiry time, next refresh time, and whether refresh is due or manually requested. It does not include access-token values or refresh material.

Refresh updates the provider record. Sandboxes receive the updated credential through the same placeholder environment and proxy rewrite path as other provider credentials.

Launch Sandboxes with Providers

Attach providers when creating a sandbox with repeated --provider flags:

openshell sandbox create \
  --name provider-demo \
  --provider work-claude \
  --provider work-github \
  -- claude

When providers_v2_enabled=true, each attached provider with a matching profile contributes a provider policy layer to the sandbox effective policy. The base policy is the user-authored sandbox policy that you can edit and apply. The effective policy is the composed policy that the sandbox enforces: base policy plus provider policy layers. When the setting is disabled, the sandbox receives provider credentials but not provider-derived policy entries.

Updating a custom provider profile affects every provider instance whose type matches that profile ID. Provider instances are not rewritten, and sandbox-authored policies are not modified. Running sandboxes observe the updated provider-derived policy on their next config sync. If a gateway-global policy is active, provider-derived policy layers remain suppressed.

Providers v2 does not infer or auto-attach providers from the sandbox command. Attach providers explicitly with --provider during sandbox creation, or use openshell sandbox provider attach after creation.

List providers attached to a sandbox:

openshell sandbox provider list provider-demo

The list output includes provider name, provider type, credential key count, and config key count.

Policy Composition

OpenShell stores the base policy and provider attachments separately. When a sandbox asks for its effective policy, the gateway composes the current base policy with provider policy layers just in time.

For example, the built-in GitHub profile contains these endpoints and binaries:

id: github
display_name: GitHub
category: source_control
credentials:
  - name: api_token
    env_vars: [GITHUB_TOKEN, GH_TOKEN]
    required: true
    auth_style: bearer
    header_name: authorization
endpoints:
  - host: api.github.com
    port: 443
    protocol: rest
    access: read-only
    enforcement: enforce
  - host: api.github.com
    port: 443
    path: /graphql
    protocol: graphql
    access: read-only
    enforcement: enforce
  - host: github.com
    port: 443
    protocol: rest
    enforcement: enforce
    rules:
      - allow: { method: GET, path: "**" }
      - allow: { method: HEAD, path: "**" }
      - allow: { method: OPTIONS, path: "**" }
      - allow: { method: POST, path: "/**/git-upload-pack" }
binaries: [/usr/bin/gh, /usr/local/bin/gh, /usr/bin/git, /usr/local/bin/git]

The github.com git-transport endpoint uses explicit rules instead of the read-only preset so HTTPS clone and fetch work out of the box. Git smart HTTP performs a GET on */info/refs followed by a POST to */git-upload-pack; the read-only preset (GET/HEAD/OPTIONS) blocks that POST. The rules permit the read-only methods plus POST */git-upload-pack only, so clone and fetch succeed while push (git-receive-pack) and other API mutations stay denied. Enabling push requires an explicit policy proposal.

If a sandbox attaches a provider named work-github, the effective policy includes a generated provider rule:

network_policies:
  custom_pypi:
    name: custom_pypi
    endpoints:
      - host: pypi.org
        port: 443
        protocol: rest
        access: read-only
        enforcement: enforce
    binaries:
      - path: /usr/bin/python

  _provider_work_github:
    name: _provider_work_github
    endpoints:
      - host: api.github.com
        port: 443
        protocol: rest
        access: read-only
        enforcement: enforce
      - host: api.github.com
        port: 443
        path: /graphql
        protocol: graphql
        access: read-only
        enforcement: enforce
      - host: github.com
        port: 443
        protocol: rest
        enforcement: enforce
        rules:
          - allow: { method: GET, path: "**" }
          - allow: { method: HEAD, path: "**" }
          - allow: { method: OPTIONS, path: "**" }
          - allow: { method: POST, path: "/**/git-upload-pack" }
    binaries:
      - path: /usr/bin/gh
      - path: /usr/local/bin/gh
      - path: /usr/bin/git
      - path: /usr/local/bin/git

Inspect the effective policy:

openshell policy get provider-demo --full

Pull the round-trippable base policy without provider entries:

openshell policy get provider-demo --base

Composition follows these rules:

  • Provider policy entries use reserved _provider_* keys derived from provider instance names.
  • Provider policy entries are derived data. OpenShell does not persist them back into the base policy.
  • User-authored policies cannot define _provider_* network policy keys. The gateway rejects those keys on sandbox create and full policy replacement, and sandbox-originated policy sync strips them before persistence.
  • Provider and user rules are concatenated. Overlapping endpoints remain separate rules.
  • A gateway global policy override suppresses provider-derived policy layers.

Attach and Detach Providers

Attach an existing provider to a running sandbox:

openshell sandbox provider attach provider-demo work-github

Detach a provider:

openshell sandbox provider detach provider-demo work-github

Attach and detach are idempotent. Attach validates that the provider exists before mutating the sandbox, and provider deletion fails while the provider is attached to any sandbox.

Runtime Limitations

Provider attach and detach update the persisted sandbox provider list. Running sandboxes poll for provider environment revisions and effective policy changes.

The policy effect applies to future effective policy reads after the sandbox observes the update. The credential environment effect applies only to new process launches after the update is observed, such as later SSH, exec, or SFTP sessions.

Already-running processes keep the environment they started with. OpenShell does not mutate a live process environment after provider attach, detach, or credential update. If a long-running process needs a newly attached provider credential placeholder, restart that process or launch a new process after the sandbox has observed the provider update.

Detaching a provider removes its provider policy layer from future effective policy reads and removes its credential placeholders from future process environments. It does not remove environment variables from already-running processes.

OpenShell rejects provider updates and refresh configuration when they would make two providers attached to the same sandbox expose the same active credential environment key. It also rejects attached provider sets with ambiguous dynamic token grants at equal host/path specificity. Use provider-specific credential names and make one dynamic grant selector more specific when one sandbox needs multiple providers with overlapping upstream concepts.

Next Steps