Class CreateSshSessionResponse

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Create SSH session response.

Fields are interpolated into an SSH ProxyCommand string that OpenSSH executes through /bin/sh -c on the caller's workstation. Servers MUST uphold the charset contract below; clients MUST reject responses that violate it. The client's own escaping provides defense-in-depth, but narrow charsets close injection vectors at the trust boundary.

public sealed class CreateSshSessionResponse : IMessage<CreateSshSessionResponse>, IEquatable<CreateSshSessionResponse>, IDeepCloneable<CreateSshSessionResponse>, IBufferMessage, IMessage

Inheritance

object

CreateSshSessionResponse

Implements

IMessage<CreateSshSessionResponse>

IEquatable<CreateSshSessionResponse>

IDeepCloneable<CreateSshSessionResponse>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

CreateSshSessionResponse()

public CreateSshSessionResponse()

CreateSshSessionResponse(CreateSshSessionResponse)

public CreateSshSessionResponse(CreateSshSessionResponse other)

Parameters

other CreateSshSessionResponse

Fields

ExpirationTimeFieldNumber

Field number for the "expiration_time" field.

public const int ExpirationTimeFieldNumber = 108

Field Value

int

GatewayHostFieldNumber

Field number for the "gateway_host" field.

public const int GatewayHostFieldNumber = 3

Field Value

int

GatewayPortFieldNumber

Field number for the "gateway_port" field.

public const int GatewayPortFieldNumber = 4

Field Value

int

GatewaySchemeFieldNumber

Field number for the "gateway_scheme" field.

public const int GatewaySchemeFieldNumber = 5

Field Value

int

HostKeyFingerprintFieldNumber

Field number for the "host_key_fingerprint" field.

public const int HostKeyFingerprintFieldNumber = 7

Field Value

int

SandboxIdFieldNumber

Field number for the "sandbox_id" field.

public const int SandboxIdFieldNumber = 1

Field Value

int

TokenFieldNumber

Field number for the "token" field.

public const int TokenFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ExpirationTime

Absolute expiry. Absence means no expiry.

public Timestamp ExpirationTime { get; set; }

Property Value

Timestamp

GatewayHost

Gateway host for SSH proxy connection. IPv4 address, bracketed IPv6 address, or DNS hostname (Punycode-encoded for IDN). Alphanumeric plus .-:[] only, up to 253 bytes.

public string GatewayHost { get; set; }

Property Value

string

GatewayPort

Gateway port for SSH proxy connection. Must be in range 1..=65535.

public uint GatewayPort { get; set; }

Property Value

uint

GatewayScheme

Gateway scheme. Must be exactly "http" or "https".

public string GatewayScheme { get; set; }

Property Value

string

HostKeyFingerprint

Expected sandbox SSH host identity in OpenSSH SHA256:<base64> form. Stable for the sandbox's lifetime. Empty only for legacy runtimes.

public string HostKeyFingerprint { get; set; }

Property Value

string

Parser

public static MessageParser<CreateSshSessionResponse> Parser { get; }

Property Value

MessageParser<CreateSshSessionResponse>

SandboxId

Sandbox id. [A-Za-z0-9._-]{1,128}.

public string SandboxId { get; set; }

Property Value

string

Token

Session token for the gateway tunnel. URL-safe ASCII ([A-Za-z0-9._~+/=-]) up to 4096 bytes. No shell metacharacters or whitespace.

public string Token { get; set; }

Property Value

string

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public CreateSshSessionResponse Clone()

Returns

CreateSshSessionResponse

A deep clone of this object.

Equals(CreateSshSessionResponse)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(CreateSshSessionResponse other)

Parameters

other CreateSshSessionResponse

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(CreateSshSessionResponse)

Merges the given message into this one.

public void MergeFrom(CreateSshSessionResponse other)

Parameters

other CreateSshSessionResponse

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.