package Proxy

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Proxy (stream ProxyRequest, stream ProxyReply)

  proxy.proto:30

  Proxy represents a bidirectional stream of requests from a sanshell client to one or more target sanshell instances reachable from the proxy server.

  message ProxyRequest

  proxy.proto:33

  • oneof request

    • StartStream start_stream = 1

      A request to open a new stream to a target.

    • StreamData stream_data = 2

      Additional client data for one or more established streams.

    • ClientClose client_close = 3

      A ClientClose indicates that no more data will be sent for one or more established streams.

    • ClientCancel client_cancel = 4

      A ClientCancel indicates that the client wants to cancel one or more established streams.

  message ProxyReply

  proxy.proto:51

  • oneof reply

    • StartStreamReply start_stream_reply = 1

      A reply to a request to initiate a stream.

    • StreamData stream_data = 2

      Additional server data for one or more established streams.

    • ServerClose server_close = 3

      An end of stream message for one or more established streams.

ClientCancel is sent by the proxy client to request cancellation of the given stream(s).

Used in: ProxyRequest

• repeated uint64 stream_ids = 1

  The server-assigned stream id(s) to cancel.

ClientClose is sent by the proxy client to indicate that no more messages will be sent to the given stream(s) Note that clients do not need to send a ClientClose for streams where client_streams is false.

Used in: ProxyRequest

• repeated uint64 stream_ids = 1

  The server-asssigned stream id(s) to close.

A server end-of-stream response, containing the final status of the stream.

Used in: ProxyReply

• repeated uint64 stream_ids = 1

  The stream identifier, as returned in StartStreamReply This can be repeated, to indicate that the same status is applicable to multiple streams.

• optional Status status = 2

  The final status of the stream.

A request to start a stream to a target host. The supplied `nonce` is an arbitrary client-chosen value that will be echoed in the returned reply to allow clients to correlate this request with the associated stream id.

Used in: ProxyRequest

• string target = 1

  The stream target, as accepted by grpc.Dial.

• string method_name = 2

  The fully-qualified method name (e.g. "/Package.Service/Method")

• uint32 nonce = 3

  A nonce value which will be echoed in the reply to allow the client to correlate this stream request with the server-assigned stream ID.

• optional google.protobuf.Duration dial_timeout = 4

  A dial timeout will bound how long to wait to connect to the remote target. By default in grpc for Go for instance this is 20s and handled asychronously when creating the actual connection. Setting a timeout here will block the Dial() call to that timeout before proceeding. Each Dial() happens in their own routine so this will not block the overall progress for a stream.

• bool authz_dry_run = 5

  Perform authz dry run instead actual execution.

Used in: ProxyReply

• string target = 1

  The target string originally supplied to StartStream

• uint32 nonce = 2

  The nonce value supplied by the client in StartStream.

• oneof reply

  • uint64 stream_id = 3

    The server-assigned stream identifier, which should be included in all future messages for this stream. stream_ids are only guaranteed to be unique within the context of a single proxy stream.

  • Status error_status = 4

    Status carries an error if the stream could not be established.

A wire-compatible version of google.rpc.Status

Used in: ServerClose, StartStreamReply

• int32 code = 1

  The status code (one of google.rpc.Code)

• string message = 2

  A developer-targeted error message.

• repeated google.protobuf.Any details = 3

  List of messages carrying error details.

StreamData is used by both clients and servers to transmit data for an established stream.

Used in: ProxyReply, ProxyRequest

• repeated uint64 stream_ids = 1

  The stream identifier, as returned in StartStreamReply This can be repeated, to indicate that the same data is relevant to multiple established streams.

• optional google.protobuf.Any payload = 2

  The message payload