Type Members

1.  final case class Endpoint(ipAddress: String = "", port: Int = 0, protocol: NetworkProtocol = io.grpc.alts.internal.handshaker.NetworkProtocol.NETWORK_PROTOCOL_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Endpoint] with Product with Serializable
   ipAddress

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

   port

   Port number.

   protocol

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

   Annotations

   @SerialVersionUID()

2.  sealed abstract class HandshakeProtocol extends GeneratedEnum
3.  final case class HandshakerReq(reqOneof: ReqOneof = io.grpc.alts.internal.handshaker.HandshakerReq.ReqOneof.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HandshakerReq] with Product with Serializable

   Annotations

   @SerialVersionUID()

4.  final case class HandshakerResp(outFrames: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, bytesConsumed: Int = 0, result: Option[HandshakerResult] = _root_.scala.None, status: Option[HandshakerStatus] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HandshakerResp] with Product with Serializable
   outFrames

   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.

   bytesConsumed

   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.

   result

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

   status

   Status of the handshaker.

   Annotations

   @SerialVersionUID()

5.  final case class HandshakerResult(applicationProtocol: String = "", recordProtocol: String = "", keyData: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, peerIdentity: Option[Identity] = _root_.scala.None, localIdentity: Option[Identity] = _root_.scala.None, keepChannelOpen: Boolean = false, peerRpcVersions: Option[transport_security_common.RpcProtocolVersions] = _root_.scala.None, maxFrameSize: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HandshakerResult] with Product with Serializable
   applicationProtocol

   The application protocol negotiated for this connection.

   recordProtocol

   The record protocol negotiated for this connection.

   keyData

   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.

   peerIdentity

   The authenticated identity of the peer.

   localIdentity

   The local identity used in the handshake.

   keepChannelOpen

   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.

   peerRpcVersions

   The RPC protocol versions supported by the peer.

   maxFrameSize

   The maximum frame size of the peer.

   Annotations

   @SerialVersionUID()

6.  trait HandshakerService extends AnyRef

   Annotations

   @PekkoGrpcGenerated()

7.  trait HandshakerServiceClient extends HandshakerService with HandshakerServiceClientPowerApi with PekkoGrpcClient

   Annotations

   @PekkoGrpcGenerated()

8.  trait HandshakerServiceClientPowerApi extends AnyRef

   Annotations

   @PekkoGrpcGenerated()

9.  final case class HandshakerStatus(code: Int = 0, details: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HandshakerStatus] with Product with Serializable
   code

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

   details

   The status details.

   Annotations

   @SerialVersionUID()

10.  final case class Identity(identityOneof: IdentityOneof = io.grpc.alts.internal.handshaker.Identity.IdentityOneof.Empty, attributes: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Identity] with Product with Serializable
    attributes

    Additional attributes of the identity.

    Annotations

    @SerialVersionUID()

11.  sealed abstract class NetworkProtocol extends GeneratedEnum
12.  final case class NextHandshakeMessageReq(inBytes: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NextHandshakeMessageReq] with Product with Serializable
    inBytes

    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.

    Annotations

    @SerialVersionUID()

13.  final case class ServerHandshakeParameters(recordProtocols: Seq[String] = _root_.scala.Seq.empty, localIdentities: Seq[Identity] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ServerHandshakeParameters] with Product with Serializable
    recordProtocols

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

    localIdentities

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

    Annotations

    @SerialVersionUID()

14.  final case class StartClientHandshakeReq(handshakeSecurityProtocol: HandshakeProtocol = io.grpc.alts.internal.handshaker.HandshakeProtocol.HANDSHAKE_PROTOCOL_UNSPECIFIED, applicationProtocols: Seq[String] = _root_.scala.Seq.empty, recordProtocols: Seq[String] = _root_.scala.Seq.empty, targetIdentities: Seq[Identity] = _root_.scala.Seq.empty, localIdentity: Option[Identity] = _root_.scala.None, localEndpoint: Option[Endpoint] = _root_.scala.None, remoteEndpoint: Option[Endpoint] = _root_.scala.None, targetName: String = "", rpcVersions: Option[transport_security_common.RpcProtocolVersions] = _root_.scala.None, maxFrameSize: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[StartClientHandshakeReq] with Product with Serializable
    handshakeSecurityProtocol

    Handshake security protocol requested by the client.

    applicationProtocols

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

    recordProtocols

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

    targetIdentities

    (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.

    localIdentity

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

    localEndpoint

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

    remoteEndpoint

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

    targetName

    (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.

    rpcVersions

    (Optional) RPC protocol versions supported by the client.

    maxFrameSize

    (Optional) Maximum frame size supported by the client.

    Annotations

    @SerialVersionUID()

15.  final case class StartServerHandshakeReq(applicationProtocols: Seq[String] = _root_.scala.Seq.empty, handshakeParameters: Map[Int, ServerHandshakeParameters] = _root_.scala.collection.immutable.Map.empty, inBytes: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, localEndpoint: Option[Endpoint] = _root_.scala.None, remoteEndpoint: Option[Endpoint] = _root_.scala.None, rpcVersions: Option[transport_security_common.RpcProtocolVersions] = _root_.scala.None, maxFrameSize: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[StartServerHandshakeReq] with Product with Serializable
    applicationProtocols

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

    handshakeParameters

    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.

    inBytes

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

    localEndpoint

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

    remoteEndpoint

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

    rpcVersions

    (Optional) RPC protocol versions supported by the server.

    maxFrameSize

    (Optional) Maximum frame size supported by the server.

    Annotations

    @SerialVersionUID()