Secure, Fast, and Extensible Sandbox runtime for AI agents.
// Copyright 2026 The OpenSandbox Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import type {
CredentialBindingMetadata,
CredentialMetadata,
CredentialVaultCreateRequest,
CredentialVaultPatchRequest,
CredentialVaultState,
NetworkPolicy,
NetworkRule,
} from "../models/sandboxes.js";
export interface CredentialVault {
/**
* Create the sandbox-local Credential Vault and activate its initial revision.
*/
create(request: CredentialVaultCreateRequest): Promise<CredentialVaultState>;
/**
* Get sanitized Credential Vault state.
*/
get(): Promise<CredentialVaultState>;
/**
* Atomically patch sandbox-local credentials and bindings.
*/
patch(request: CredentialVaultPatchRequest): Promise<CredentialVaultState>;
/**
* Delete the sandbox-local Credential Vault.
*/
delete(): Promise<void>;
/**
* List sanitized credential metadata.
*/
listCredentials(): Promise<CredentialMetadata[]>;
/**
* Get sanitized metadata for one credential.
*/
getCredential(name: string): Promise<CredentialMetadata>;
/**
* List sanitized binding metadata.
*/
listBindings(): Promise<CredentialBindingMetadata[]>;
/**
* Get sanitized metadata for one binding.
*/
getBinding(name: string): Promise<CredentialBindingMetadata>;
}
export interface Egress {
getPolicy(): Promise<NetworkPolicy>;
/**
* Patch egress rules with sidecar merge semantics.
*
* Incoming rules take priority over existing rules with the same target.
* Existing rules for other targets remain unchanged. Within one patch payload,
* the first rule for a target wins. The current defaultAction is preserved.
*/
patchRules(rules: NetworkRule[]): Promise<void>;
/**
* Delete egress rules by target.
*
* Each entry is a FQDN or wildcard domain. Matching rules are removed from
* the currently enforced policy. Targets not present in the policy are
* silently ignored (idempotent). The current defaultAction is preserved.
*/
deleteRules(targets: string[]): Promise<void>;
}