package grpc.gcp

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc DoHandshake (stream HandshakerReq, stream HandshakerResp)

  handshaker.proto:265

  Handshaker service accepts a stream of handshaker request, returning a stream of handshaker response. Client is expected to send exactly one message with either client_start or server_start followed by one or more messages with next. Each time client sends a request, the handshaker service expects to respond. Client does not have to wait for service's response before sending next request.

  message HandshakerReq

  handshaker.proto:183

  • oneof req_oneof

    • StartClientHandshakeReq client_start = 1

      The start client handshake request message.

    • StartServerHandshakeReq server_start = 2

      The start server handshake request message.

    • NextHandshakeMessageReq next = 3

      The next handshake request message.

  message HandshakerResp

  handshaker.proto:237

  • bytes out_frames = 1

    Frames to be given to the peer for the NextHandshakeMessageReq. May be empty if no out_frames have to be sent to the peer or if in_bytes in the HandshakerReq are incomplete. All the non-empty out frames must be sent to the peer even if the handshaker status is not OK as these frames may contain the alert frames.

  • uint32 bytes_consumed = 2

    Number of bytes in the in_bytes consumed by the handshaker. It is possible that part of in_bytes in HandshakerReq was unrelated to the handshake process.

  • optional HandshakerResult result = 3

    This is set iff the handshake was successful. out_frames may still be set to frames that needs to be forwarded to the peer.

  • optional HandshakerStatus status = 4

    Status of the handshaker.

• string application_protocol = 1

  The application protocol negotiated for this connection.

• string record_protocol = 2

  The record protocol negotiated for this connection.

• SecurityLevel security_level = 3

  The security level of the created secure channel.

• string peer_service_account = 4

  The peer service account.

• string local_service_account = 5

  The local service account.

• optional RpcProtocolVersions peer_rpc_versions = 6

  The RPC protocol versions supported by the peer.

• map<string, string> peer_attributes = 7

  Additional attributes of the peer.

Used in: StartClientHandshakeReq, StartServerHandshakeReq

• string ip_address = 1

  IP address. It should contain an IPv4 or IPv6 string literal, e.g. "192.168.0.1" or "2001:db8::1".

• int32 port = 2

  Port number.

• NetworkProtocol protocol = 3

  Network protocol (e.g., TCP, UDP) associated with this endpoint.

Used in: StartClientHandshakeReq

• HANDSHAKE_PROTOCOL_UNSPECIFIED = 0

  Default value.

• TLS = 1

  TLS handshake protocol.

• ALTS = 2

  Application Layer Transport Security handshake protocol.

Used in: HandshakerResp

• string application_protocol = 1

  The application protocol negotiated for this connection.

• string record_protocol = 2

  The record protocol negotiated for this connection.

• bytes key_data = 3

  Cryptographic key data. The key data may be more than the key length required for the record protocol, thus the client of the handshaker service needs to truncate the key data into the right key length.

• optional Identity peer_identity = 4

  The authenticated identity of the peer.

• optional Identity local_identity = 5

  The local identity used in the handshake.

• bool keep_channel_open = 6

  Indicate whether the handshaker service client should keep the channel between the handshaker service open, e.g., in order to handle post-handshake messages in the future.

• optional RpcProtocolVersions peer_rpc_versions = 7

  The RPC protocol versions supported by the peer.

• uint32 max_frame_size = 8

  The maximum frame size of the peer.

• optional NegotiatedTransportProtocol transport_protocol = 9

  (Optional) The transport protocol negotiated for this connection.

Used in: HandshakerResp

• uint32 code = 1

  The status code. This could be the gRPC status code.

• string details = 2

  The status details.

Used in: HandshakerResult, ServerHandshakeParameters, StartClientHandshakeReq

• oneof identity_oneof

  • string service_account = 1

    Service account of a connection endpoint.

  • string hostname = 2

    Hostname of a connection endpoint.

• map<string, string> attributes = 3

  Additional attributes of the identity.

The negotiated transport protocol.

Used in: HandshakerResult

• string transport_protocol = 1

Used in: Endpoint

• NETWORK_PROTOCOL_UNSPECIFIED = 0

• TCP = 1

• UDP = 2

Used in: HandshakerReq

• bytes in_bytes = 1

  Bytes in out_frames returned from the peer's HandshakerResp. It is possible that the peer's out_frames are split into multiple NextHandshakerMessageReq messages.

• uint32 network_latency_ms = 2

  Number of milliseconds between when the application send the last handshake message to the peer and when the application received the current handshake message (in the in_bytes field) from the peer.

Max and min supported RPC protocol versions.

Used in: AltsContext, HandshakerResult, StartClientHandshakeReq, StartServerHandshakeReq

• optional RpcProtocolVersions.Version max_rpc_version = 1

  Maximum supported RPC version.

• optional RpcProtocolVersions.Version min_rpc_version = 2

  Minimum supported RPC version.

RPC version contains a major version and a minor version.

Used in: RpcProtocolVersions

• uint32 major = 1

• uint32 minor = 2

The security level of the created channel. The list is sorted in increasing level of security. This order must always be maintained.

Used in: AltsContext

• SECURITY_NONE = 0

• INTEGRITY_ONLY = 1

• INTEGRITY_AND_PRIVACY = 2

Used in: StartServerHandshakeReq

• repeated string record_protocols = 1

  The record protocols supported by the server, e.g., "ALTSRP_GCM_AES128".

• repeated Identity local_identities = 2

  (Optional) A list of local identities supported by the server, if specified. Otherwise, the handshaker chooses a default local identity.

• optional string token = 3

  A token created by the caller only intended for use in ALTS connections. The token should be used to authenticate to the peer. The token MUST be strongly bound to the ALTS credentials used to establish the connection that the token is sent over.

Used in: HandshakerReq

• HandshakeProtocol handshake_security_protocol = 1

  Handshake security protocol requested by the client.

• repeated string application_protocols = 2

  The application protocols supported by the client, e.g., "h2" (for http2), "grpc".

• repeated string record_protocols = 3

  The record protocols supported by the client, e.g., "ALTSRP_GCM_AES128".

• repeated Identity target_identities = 4

  (Optional) Describes which server identities are acceptable by the client. If target identities are provided and none of them matches the peer identity of the server, handshake will fail.

• optional Identity local_identity = 5

  (Optional) Application may specify a local identity. Otherwise, the handshaker chooses a default local identity.

• optional Endpoint local_endpoint = 6

  (Optional) Local endpoint information of the connection to the server, such as local IP address, port number, and network protocol.

• optional Endpoint remote_endpoint = 7

  (Optional) Endpoint information of the remote server, such as IP address, port number, and network protocol.

• string target_name = 8

  (Optional) If target name is provided, a secure naming check is performed to verify that the peer authenticated identity is indeed authorized to run the target name.

• optional RpcProtocolVersions rpc_versions = 9

  (Optional) RPC protocol versions supported by the client.

• uint32 max_frame_size = 10

  (Optional) Maximum frame size supported by the client.

• string access_token = 11

  (Optional) An access token created by the caller only intended for use in ALTS connections. The access token that should be used to authenticate to the peer. The access token MUST be strongly bound to the ALTS credentials used to establish the connection that the token is sent over.

• optional TransportProtocolPreferences transport_protocol_preferences = 12

  (Optional) Ordered transport protocol preferences supported by the client.

Used in: HandshakerReq

• repeated string application_protocols = 1

  The application protocols supported by the server, e.g., "h2" (for http2), "grpc".

• map<int32, ServerHandshakeParameters> handshake_parameters = 2

  Handshake parameters (record protocols and local identities supported by the server) mapped by the handshake protocol. Each handshake security protocol (e.g., TLS or ALTS) has its own set of record protocols and local identities. Since protobuf does not support enum as key to the map, the key to handshake_parameters is the integer value of HandshakeProtocol enum.

• bytes in_bytes = 3

  Bytes in out_frames returned from the peer's HandshakerResp. It is possible that the peer's out_frames are split into multiple HandshakeReq messages.

• optional Endpoint local_endpoint = 4

  (Optional) Local endpoint information of the connection to the client, such as local IP address, port number, and network protocol.

• optional Endpoint remote_endpoint = 5

  (Optional) Endpoint information of the remote client, such as IP address, port number, and network protocol.

• optional RpcProtocolVersions rpc_versions = 6

  (Optional) RPC protocol versions supported by the server.

• uint32 max_frame_size = 7

  (Optional) Maximum frame size supported by the server.

• optional TransportProtocolPreferences transport_protocol_preferences = 8

  (Optional) Transport protocol preferences supported by the server.

The ordered list of protocols that the client wishes to use, or the set that the server supports.

Used in: StartClientHandshakeReq, StartServerHandshakeReq

• repeated string transport_protocol = 1