Class ServerSandboxProxyCaApi

java.lang.Object

com.github.copilot.generated.rpc.ServerSandboxProxyCaApi

@Generated("copilot-sdk-codegen")
public final class ServerSandboxProxyCaApi
extends Object

API methods for the sandbox.proxyCa namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Boolean>	checkInstallationSupport()	Reports whether this runtime process can offer installing the sandbox credential-proxy certificate authority into OS trust.
CompletableFuture<Boolean>	checkRelevance(SandboxProxyCaCheckRelevanceParams params)	Reports whether this sandbox configuration uses the credential proxy and can need certificate-authority setup.
CompletableFuture<SandboxProxyCaCreateResult>	create(SandboxProxyCaCreateParams params)	Creates the persistent certificate authority of the sandbox credential proxy if none is stored, without changing OS trust, and returns the path of its public certificate.
CompletableFuture<SandboxProxyCaGetStatusResult>	getStatus(SandboxProxyCaGetStatusParams params)	Reports whether the persistent certificate authority of the sandbox credential proxy exists, whether OS trust includes it, and whether it must be rotated.
CompletableFuture<SandboxProxyCaRemoveResult>	remove()	Removes the persistent certificate authority of the sandbox credential proxy from OS trust.
CompletableFuture<SandboxProxyCaRotateResult>	rotate(SandboxProxyCaRotateParams params)	Replaces the persistent certificate authority of the sandbox credential proxy with a new one for the current credential hosts.
CompletableFuture<SandboxProxyCaTrustResult>	trust(SandboxProxyCaTrustParams params)	Adds the persistent certificate authority of the sandbox credential proxy to OS trust, so sandboxed clients that read only OS trust accept the proxy.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

checkInstallationSupport

@CopilotExperimental
public CompletableFuture<Boolean> checkInstallationSupport()

Reports whether this runtime process can offer installing the sandbox credential-proxy certificate authority into OS trust.

Since:

1.0.0

checkRelevance

@CopilotExperimental
public CompletableFuture<Boolean> checkRelevance(SandboxProxyCaCheckRelevanceParams params)

Reports whether this sandbox configuration uses the credential proxy and can need certificate-authority setup.

Since:

1.0.0

getStatus

@CopilotExperimental
public CompletableFuture<SandboxProxyCaGetStatusResult> getStatus(SandboxProxyCaGetStatusParams params)

Reports whether the persistent certificate authority of the sandbox credential proxy exists, whether OS trust includes it, and whether it must be rotated. Changes nothing.

Since:

1.0.0

create

@CopilotExperimental
public CompletableFuture<SandboxProxyCaCreateResult> create(SandboxProxyCaCreateParams params)

Creates the persistent certificate authority of the sandbox credential proxy if none is stored, without changing OS trust, and returns the path of its public certificate. Keeps an existing certificate authority, even one that must be rotated. Fails where OS trust is unsupported. Trust it with sandbox.proxyCa.trust: the CLI trusts only the hosts in the saved user settings, so it refuses a certificate authority that also covers hosts from sandboxConfig.

Since:

1.0.0

rotate

@CopilotExperimental
public CompletableFuture<SandboxProxyCaRotateResult> rotate(SandboxProxyCaRotateParams params)

Replaces the persistent certificate authority of the sandbox credential proxy with a new one for the current credential hosts. If OS trust included the old one, removes it and trusts the new one, which can show an OS authentication prompt. Running sandboxed tools keep the old certificate authority until they restart.

Since:

1.0.0

trust

@CopilotExperimental
public CompletableFuture<SandboxProxyCaTrustResult> trust(SandboxProxyCaTrustParams params)

Adds the persistent certificate authority of the sandbox credential proxy to OS trust, so sandboxed clients that read only OS trust accept the proxy. Call create first. Refuses a certificate authority that is not constrained to the current credential hosts. Can show an OS authentication prompt.

Since:

1.0.0

remove

@CopilotExperimental
public CompletableFuture<SandboxProxyCaRemoveResult> remove()

Removes the persistent certificate authority of the sandbox credential proxy from OS trust. Keeps the stored certificate authority. Can show an OS authentication prompt. Sandboxed clients that read only OS trust then reject the proxy; clients that read the per-process certificate bundle continue to work.

Since:

1.0.0