Interface ISshClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

SSH relay sessions and tunnels.

public interface ISshClient

Methods

CreateSessionAsync(string, CancellationToken)

Creates an SSH session. The gateway response is validated against the proto contract before it is returned, because its fields end up in a ProxyCommand run by a local shell.

ValueTask<SshSession> CreateSessionAsync(string sandbox, CancellationToken cancellationToken = default)

Parameters

sandbox string

cancellationToken CancellationToken

Returns

ValueTask<SshSession>

RevokeSessionAsync(string, DeleteOptions?, CancellationToken)

Revokes a session token.

ValueTask<DeletionResult> RevokeSessionAsync(string token, DeleteOptions? options = null, CancellationToken cancellationToken = default)

Parameters

token string

options DeleteOptions

cancellationToken CancellationToken

Returns

ValueTask<DeletionResult>

TunnelAsync(string, TunnelOptions?, CancellationToken)

Opens a raw SSH relay stream to the sandbox. The session is created for the tunnel and revoked when the returned stream is disposed.

ValueTask<ForwardStream> TunnelAsync(string sandbox, TunnelOptions? options = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

options TunnelOptions

cancellationToken CancellationToken

Returns

ValueTask<ForwardStream>