Documentation ¶
Index ¶
- Variables
- func RegisterHandshakerServiceServer(s *grpc.Server, srv HandshakerServiceServer)
- type AltsContext
- func (*AltsContext) Descriptor() ([]byte, []int)deprecated
- func (x *AltsContext) GetApplicationProtocol() string
- func (x *AltsContext) GetLocalServiceAccount() string
- func (x *AltsContext) GetPeerAttributes() map[string]string
- func (x *AltsContext) GetPeerRpcVersions() *RpcProtocolVersions
- func (x *AltsContext) GetPeerServiceAccount() string
- func (x *AltsContext) GetRecordProtocol() string
- func (x *AltsContext) GetSecurityLevel() SecurityLevel
- func (*AltsContext) ProtoMessage()
- func (x *AltsContext) ProtoReflect() protoreflect.Message
- func (x *AltsContext) Reset()
- func (x *AltsContext) String() string
- type Endpoint
- func (*Endpoint) Descriptor() ([]byte, []int)deprecated
- func (x *Endpoint) GetIpAddress() string
- func (x *Endpoint) GetPort() int32
- func (x *Endpoint) GetProtocol() NetworkProtocol
- func (*Endpoint) ProtoMessage()
- func (x *Endpoint) ProtoReflect() protoreflect.Message
- func (x *Endpoint) Reset()
- func (x *Endpoint) String() string
- type HandshakeProtocol
- func (HandshakeProtocol) Descriptor() protoreflect.EnumDescriptor
- func (x HandshakeProtocol) Enum() *HandshakeProtocol
- func (HandshakeProtocol) EnumDescriptor() ([]byte, []int)deprecated
- func (x HandshakeProtocol) Number() protoreflect.EnumNumber
- func (x HandshakeProtocol) String() string
- func (HandshakeProtocol) Type() protoreflect.EnumType
- type HandshakerReq
- func (*HandshakerReq) Descriptor() ([]byte, []int)deprecated
- func (x *HandshakerReq) GetClientStart() *StartClientHandshakeReq
- func (x *HandshakerReq) GetNext() *NextHandshakeMessageReq
- func (m *HandshakerReq) GetReqOneof() isHandshakerReq_ReqOneof
- func (x *HandshakerReq) GetServerStart() *StartServerHandshakeReq
- func (*HandshakerReq) ProtoMessage()
- func (x *HandshakerReq) ProtoReflect() protoreflect.Message
- func (x *HandshakerReq) Reset()
- func (x *HandshakerReq) String() string
- type HandshakerReq_ClientStart
- type HandshakerReq_Next
- type HandshakerReq_ServerStart
- type HandshakerResp
- func (*HandshakerResp) Descriptor() ([]byte, []int)deprecated
- func (x *HandshakerResp) GetBytesConsumed() uint32
- func (x *HandshakerResp) GetOutFrames() []byte
- func (x *HandshakerResp) GetResult() *HandshakerResult
- func (x *HandshakerResp) GetStatus() *HandshakerStatus
- func (*HandshakerResp) ProtoMessage()
- func (x *HandshakerResp) ProtoReflect() protoreflect.Message
- func (x *HandshakerResp) Reset()
- func (x *HandshakerResp) String() string
- type HandshakerResult
- func (*HandshakerResult) Descriptor() ([]byte, []int)deprecated
- func (x *HandshakerResult) GetApplicationProtocol() string
- func (x *HandshakerResult) GetKeepChannelOpen() bool
- func (x *HandshakerResult) GetKeyData() []byte
- func (x *HandshakerResult) GetLocalIdentity() *Identity
- func (x *HandshakerResult) GetMaxFrameSize() uint32
- func (x *HandshakerResult) GetPeerIdentity() *Identity
- func (x *HandshakerResult) GetPeerRpcVersions() *RpcProtocolVersions
- func (x *HandshakerResult) GetRecordProtocol() string
- func (*HandshakerResult) ProtoMessage()
- func (x *HandshakerResult) ProtoReflect() protoreflect.Message
- func (x *HandshakerResult) Reset()
- func (x *HandshakerResult) String() string
- type HandshakerServiceClient
- type HandshakerServiceServer
- type HandshakerService_DoHandshakeClient
- type HandshakerService_DoHandshakeServer
- type HandshakerStatus
- func (*HandshakerStatus) Descriptor() ([]byte, []int)deprecated
- func (x *HandshakerStatus) GetCode() uint32
- func (x *HandshakerStatus) GetDetails() string
- func (*HandshakerStatus) ProtoMessage()
- func (x *HandshakerStatus) ProtoReflect() protoreflect.Message
- func (x *HandshakerStatus) Reset()
- func (x *HandshakerStatus) String() string
- type Identity
- func (*Identity) Descriptor() ([]byte, []int)deprecated
- func (x *Identity) GetAttributes() map[string]string
- func (x *Identity) GetHostname() string
- func (m *Identity) GetIdentityOneof() isIdentity_IdentityOneof
- func (x *Identity) GetServiceAccount() string
- func (*Identity) ProtoMessage()
- func (x *Identity) ProtoReflect() protoreflect.Message
- func (x *Identity) Reset()
- func (x *Identity) String() string
- type Identity_Hostname
- type Identity_ServiceAccount
- type NetworkProtocol
- func (NetworkProtocol) Descriptor() protoreflect.EnumDescriptor
- func (x NetworkProtocol) Enum() *NetworkProtocol
- func (NetworkProtocol) EnumDescriptor() ([]byte, []int)deprecated
- func (x NetworkProtocol) Number() protoreflect.EnumNumber
- func (x NetworkProtocol) String() string
- func (NetworkProtocol) Type() protoreflect.EnumType
- type NextHandshakeMessageReq
- func (*NextHandshakeMessageReq) Descriptor() ([]byte, []int)deprecated
- func (x *NextHandshakeMessageReq) GetInBytes() []byte
- func (*NextHandshakeMessageReq) ProtoMessage()
- func (x *NextHandshakeMessageReq) ProtoReflect() protoreflect.Message
- func (x *NextHandshakeMessageReq) Reset()
- func (x *NextHandshakeMessageReq) String() string
- type RpcProtocolVersions
- func (*RpcProtocolVersions) Descriptor() ([]byte, []int)deprecated
- func (x *RpcProtocolVersions) GetMaxRpcVersion() *RpcProtocolVersions_Version
- func (x *RpcProtocolVersions) GetMinRpcVersion() *RpcProtocolVersions_Version
- func (*RpcProtocolVersions) ProtoMessage()
- func (x *RpcProtocolVersions) ProtoReflect() protoreflect.Message
- func (x *RpcProtocolVersions) Reset()
- func (x *RpcProtocolVersions) String() string
- type RpcProtocolVersions_Version
- func (*RpcProtocolVersions_Version) Descriptor() ([]byte, []int)deprecated
- func (x *RpcProtocolVersions_Version) GetMajor() uint32
- func (x *RpcProtocolVersions_Version) GetMinor() uint32
- func (*RpcProtocolVersions_Version) ProtoMessage()
- func (x *RpcProtocolVersions_Version) ProtoReflect() protoreflect.Message
- func (x *RpcProtocolVersions_Version) Reset()
- func (x *RpcProtocolVersions_Version) String() string
- type SecurityLevel
- func (SecurityLevel) Descriptor() protoreflect.EnumDescriptor
- func (x SecurityLevel) Enum() *SecurityLevel
- func (SecurityLevel) EnumDescriptor() ([]byte, []int)deprecated
- func (x SecurityLevel) Number() protoreflect.EnumNumber
- func (x SecurityLevel) String() string
- func (SecurityLevel) Type() protoreflect.EnumType
- type ServerHandshakeParameters
- func (*ServerHandshakeParameters) Descriptor() ([]byte, []int)deprecated
- func (x *ServerHandshakeParameters) GetLocalIdentities() []*Identity
- func (x *ServerHandshakeParameters) GetRecordProtocols() []string
- func (*ServerHandshakeParameters) ProtoMessage()
- func (x *ServerHandshakeParameters) ProtoReflect() protoreflect.Message
- func (x *ServerHandshakeParameters) Reset()
- func (x *ServerHandshakeParameters) String() string
- type StartClientHandshakeReq
- func (*StartClientHandshakeReq) Descriptor() ([]byte, []int)deprecated
- func (x *StartClientHandshakeReq) GetApplicationProtocols() []string
- func (x *StartClientHandshakeReq) GetHandshakeSecurityProtocol() HandshakeProtocol
- func (x *StartClientHandshakeReq) GetLocalEndpoint() *Endpoint
- func (x *StartClientHandshakeReq) GetLocalIdentity() *Identity
- func (x *StartClientHandshakeReq) GetMaxFrameSize() uint32
- func (x *StartClientHandshakeReq) GetRecordProtocols() []string
- func (x *StartClientHandshakeReq) GetRemoteEndpoint() *Endpoint
- func (x *StartClientHandshakeReq) GetRpcVersions() *RpcProtocolVersions
- func (x *StartClientHandshakeReq) GetTargetIdentities() []*Identity
- func (x *StartClientHandshakeReq) GetTargetName() string
- func (*StartClientHandshakeReq) ProtoMessage()
- func (x *StartClientHandshakeReq) ProtoReflect() protoreflect.Message
- func (x *StartClientHandshakeReq) Reset()
- func (x *StartClientHandshakeReq) String() string
- type StartServerHandshakeReq
- func (*StartServerHandshakeReq) Descriptor() ([]byte, []int)deprecated
- func (x *StartServerHandshakeReq) GetApplicationProtocols() []string
- func (x *StartServerHandshakeReq) GetHandshakeParameters() map[int32]*ServerHandshakeParameters
- func (x *StartServerHandshakeReq) GetInBytes() []byte
- func (x *StartServerHandshakeReq) GetLocalEndpoint() *Endpoint
- func (x *StartServerHandshakeReq) GetMaxFrameSize() uint32
- func (x *StartServerHandshakeReq) GetRemoteEndpoint() *Endpoint
- func (x *StartServerHandshakeReq) GetRpcVersions() *RpcProtocolVersions
- func (*StartServerHandshakeReq) ProtoMessage()
- func (x *StartServerHandshakeReq) ProtoReflect() protoreflect.Message
- func (x *StartServerHandshakeReq) Reset()
- func (x *StartServerHandshakeReq) String() string
- type UnimplementedHandshakerServiceServer
- type UnsafeHandshakerServiceServer
Constants ¶
This section is empty.
Variables ¶
var ( HandshakeProtocol_name = map[int32]string{ 0: "HANDSHAKE_PROTOCOL_UNSPECIFIED", 1: "TLS", 2: "ALTS", } HandshakeProtocol_value = map[string]int32{ "HANDSHAKE_PROTOCOL_UNSPECIFIED": 0, "TLS": 1, "ALTS": 2, } )
Enum value maps for HandshakeProtocol.
var ( NetworkProtocol_name = map[int32]string{ 0: "NETWORK_PROTOCOL_UNSPECIFIED", 1: "TCP", 2: "UDP", } NetworkProtocol_value = map[string]int32{ "NETWORK_PROTOCOL_UNSPECIFIED": 0, "TCP": 1, "UDP": 2, } )
Enum value maps for NetworkProtocol.
var ( SecurityLevel_name = map[int32]string{ 0: "SECURITY_NONE", 1: "INTEGRITY_ONLY", 2: "INTEGRITY_AND_PRIVACY", } SecurityLevel_value = map[string]int32{ "SECURITY_NONE": 0, "INTEGRITY_ONLY": 1, "INTEGRITY_AND_PRIVACY": 2, } )
Enum value maps for SecurityLevel.
var File_grpc_gcp_altscontext_proto protoreflect.FileDescriptor
var File_grpc_gcp_handshaker_proto protoreflect.FileDescriptor
var File_grpc_gcp_transport_security_common_proto protoreflect.FileDescriptor
Functions ¶
func RegisterHandshakerServiceServer ¶
func RegisterHandshakerServiceServer(s *grpc.Server, srv HandshakerServiceServer)
Types ¶
type AltsContext ¶
type AltsContext struct { // The application protocol negotiated for this connection. ApplicationProtocol string `protobuf:"bytes,1,opt,name=application_protocol,json=applicationProtocol,proto3" json:"application_protocol,omitempty"` // The record protocol negotiated for this connection. RecordProtocol string `protobuf:"bytes,2,opt,name=record_protocol,json=recordProtocol,proto3" json:"record_protocol,omitempty"` // The security level of the created secure channel. SecurityLevel SecurityLevel `` /* 129-byte string literal not displayed */ // The peer service account. PeerServiceAccount string `protobuf:"bytes,4,opt,name=peer_service_account,json=peerServiceAccount,proto3" json:"peer_service_account,omitempty"` // The local service account. LocalServiceAccount string `protobuf:"bytes,5,opt,name=local_service_account,json=localServiceAccount,proto3" json:"local_service_account,omitempty"` // The RPC protocol versions supported by the peer. PeerRpcVersions *RpcProtocolVersions `protobuf:"bytes,6,opt,name=peer_rpc_versions,json=peerRpcVersions,proto3" json:"peer_rpc_versions,omitempty"` // Additional attributes of the peer. PeerAttributes map[string]string `` /* 191-byte string literal not displayed */ // contains filtered or unexported fields }
func (*AltsContext) Descriptor
deprecated
func (*AltsContext) Descriptor() ([]byte, []int)
Deprecated: Use AltsContext.ProtoReflect.Descriptor instead.
func (*AltsContext) GetApplicationProtocol ¶
func (x *AltsContext) GetApplicationProtocol() string
func (*AltsContext) GetLocalServiceAccount ¶
func (x *AltsContext) GetLocalServiceAccount() string
func (*AltsContext) GetPeerAttributes ¶ added in v1.16.0
func (x *AltsContext) GetPeerAttributes() map[string]string
func (*AltsContext) GetPeerRpcVersions ¶
func (x *AltsContext) GetPeerRpcVersions() *RpcProtocolVersions
func (*AltsContext) GetPeerServiceAccount ¶
func (x *AltsContext) GetPeerServiceAccount() string
func (*AltsContext) GetRecordProtocol ¶
func (x *AltsContext) GetRecordProtocol() string
func (*AltsContext) GetSecurityLevel ¶
func (x *AltsContext) GetSecurityLevel() SecurityLevel
func (*AltsContext) ProtoMessage ¶
func (*AltsContext) ProtoMessage()
func (*AltsContext) ProtoReflect ¶ added in v1.33.2
func (x *AltsContext) ProtoReflect() protoreflect.Message
func (*AltsContext) Reset ¶
func (x *AltsContext) Reset()
func (*AltsContext) String ¶
func (x *AltsContext) String() string
type Endpoint ¶
type Endpoint struct { // IP address. It should contain an IPv4 or IPv6 string literal, e.g. // "192.168.0.1" or "2001:db8::1". IpAddress string `protobuf:"bytes,1,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"` // Port number. Port int32 `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"` // Network protocol (e.g., TCP, UDP) associated with this endpoint. Protocol NetworkProtocol `protobuf:"varint,3,opt,name=protocol,proto3,enum=grpc.gcp.NetworkProtocol" json:"protocol,omitempty"` // contains filtered or unexported fields }
func (*Endpoint) Descriptor
deprecated
func (*Endpoint) GetIpAddress ¶
func (*Endpoint) GetProtocol ¶
func (x *Endpoint) GetProtocol() NetworkProtocol
func (*Endpoint) ProtoMessage ¶
func (*Endpoint) ProtoMessage()
func (*Endpoint) ProtoReflect ¶ added in v1.33.2
func (x *Endpoint) ProtoReflect() protoreflect.Message
type HandshakeProtocol ¶
type HandshakeProtocol int32
const ( // Default value. HandshakeProtocol_HANDSHAKE_PROTOCOL_UNSPECIFIED HandshakeProtocol = 0 // TLS handshake protocol. HandshakeProtocol_TLS HandshakeProtocol = 1 // Application Layer Transport Security handshake protocol. HandshakeProtocol_ALTS HandshakeProtocol = 2 )
func (HandshakeProtocol) Descriptor ¶ added in v1.33.2
func (HandshakeProtocol) Descriptor() protoreflect.EnumDescriptor
func (HandshakeProtocol) Enum ¶ added in v1.33.2
func (x HandshakeProtocol) Enum() *HandshakeProtocol
func (HandshakeProtocol) EnumDescriptor
deprecated
func (HandshakeProtocol) EnumDescriptor() ([]byte, []int)
Deprecated: Use HandshakeProtocol.Descriptor instead.
func (HandshakeProtocol) Number ¶ added in v1.33.2
func (x HandshakeProtocol) Number() protoreflect.EnumNumber
func (HandshakeProtocol) String ¶
func (x HandshakeProtocol) String() string
func (HandshakeProtocol) Type ¶ added in v1.33.2
func (HandshakeProtocol) Type() protoreflect.EnumType
type HandshakerReq ¶
type HandshakerReq struct { // Types that are assignable to ReqOneof: // *HandshakerReq_ClientStart // *HandshakerReq_ServerStart // *HandshakerReq_Next ReqOneof isHandshakerReq_ReqOneof `protobuf_oneof:"req_oneof"` // contains filtered or unexported fields }
func (*HandshakerReq) Descriptor
deprecated
func (*HandshakerReq) Descriptor() ([]byte, []int)
Deprecated: Use HandshakerReq.ProtoReflect.Descriptor instead.
func (*HandshakerReq) GetClientStart ¶
func (x *HandshakerReq) GetClientStart() *StartClientHandshakeReq
func (*HandshakerReq) GetNext ¶
func (x *HandshakerReq) GetNext() *NextHandshakeMessageReq
func (*HandshakerReq) GetReqOneof ¶
func (m *HandshakerReq) GetReqOneof() isHandshakerReq_ReqOneof
func (*HandshakerReq) GetServerStart ¶
func (x *HandshakerReq) GetServerStart() *StartServerHandshakeReq
func (*HandshakerReq) ProtoMessage ¶
func (*HandshakerReq) ProtoMessage()
func (*HandshakerReq) ProtoReflect ¶ added in v1.33.2
func (x *HandshakerReq) ProtoReflect() protoreflect.Message
func (*HandshakerReq) Reset ¶
func (x *HandshakerReq) Reset()
func (*HandshakerReq) String ¶
func (x *HandshakerReq) String() string
type HandshakerReq_ClientStart ¶
type HandshakerReq_ClientStart struct { // The start client handshake request message. ClientStart *StartClientHandshakeReq `protobuf:"bytes,1,opt,name=client_start,json=clientStart,proto3,oneof"` }
type HandshakerReq_Next ¶
type HandshakerReq_Next struct { // The next handshake request message. Next *NextHandshakeMessageReq `protobuf:"bytes,3,opt,name=next,proto3,oneof"` }
type HandshakerReq_ServerStart ¶
type HandshakerReq_ServerStart struct { // The start server handshake request message. ServerStart *StartServerHandshakeReq `protobuf:"bytes,2,opt,name=server_start,json=serverStart,proto3,oneof"` }
type HandshakerResp ¶
type HandshakerResp struct { // 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. OutFrames []byte `protobuf:"bytes,1,opt,name=out_frames,json=outFrames,proto3" json:"out_frames,omitempty"` // 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. BytesConsumed uint32 `protobuf:"varint,2,opt,name=bytes_consumed,json=bytesConsumed,proto3" json:"bytes_consumed,omitempty"` // This is set iff the handshake was successful. out_frames may still be set // to frames that needs to be forwarded to the peer. Result *HandshakerResult `protobuf:"bytes,3,opt,name=result,proto3" json:"result,omitempty"` // Status of the handshaker. Status *HandshakerStatus `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"` // contains filtered or unexported fields }
func (*HandshakerResp) Descriptor
deprecated
func (*HandshakerResp) Descriptor() ([]byte, []int)
Deprecated: Use HandshakerResp.ProtoReflect.Descriptor instead.
func (*HandshakerResp) GetBytesConsumed ¶
func (x *HandshakerResp) GetBytesConsumed() uint32
func (*HandshakerResp) GetOutFrames ¶
func (x *HandshakerResp) GetOutFrames() []byte
func (*HandshakerResp) GetResult ¶
func (x *HandshakerResp) GetResult() *HandshakerResult
func (*HandshakerResp) GetStatus ¶
func (x *HandshakerResp) GetStatus() *HandshakerStatus
func (*HandshakerResp) ProtoMessage ¶
func (*HandshakerResp) ProtoMessage()
func (*HandshakerResp) ProtoReflect ¶ added in v1.33.2
func (x *HandshakerResp) ProtoReflect() protoreflect.Message
func (*HandshakerResp) Reset ¶
func (x *HandshakerResp) Reset()
func (*HandshakerResp) String ¶
func (x *HandshakerResp) String() string
type HandshakerResult ¶
type HandshakerResult struct { // The application protocol negotiated for this connection. ApplicationProtocol string `protobuf:"bytes,1,opt,name=application_protocol,json=applicationProtocol,proto3" json:"application_protocol,omitempty"` // The record protocol negotiated for this connection. RecordProtocol string `protobuf:"bytes,2,opt,name=record_protocol,json=recordProtocol,proto3" json:"record_protocol,omitempty"` // 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. KeyData []byte `protobuf:"bytes,3,opt,name=key_data,json=keyData,proto3" json:"key_data,omitempty"` // The authenticated identity of the peer. PeerIdentity *Identity `protobuf:"bytes,4,opt,name=peer_identity,json=peerIdentity,proto3" json:"peer_identity,omitempty"` // The local identity used in the handshake. LocalIdentity *Identity `protobuf:"bytes,5,opt,name=local_identity,json=localIdentity,proto3" json:"local_identity,omitempty"` // 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. KeepChannelOpen bool `protobuf:"varint,6,opt,name=keep_channel_open,json=keepChannelOpen,proto3" json:"keep_channel_open,omitempty"` // The RPC protocol versions supported by the peer. PeerRpcVersions *RpcProtocolVersions `protobuf:"bytes,7,opt,name=peer_rpc_versions,json=peerRpcVersions,proto3" json:"peer_rpc_versions,omitempty"` // The maximum frame size of the peer. MaxFrameSize uint32 `protobuf:"varint,8,opt,name=max_frame_size,json=maxFrameSize,proto3" json:"max_frame_size,omitempty"` // contains filtered or unexported fields }
func (*HandshakerResult) Descriptor
deprecated
func (*HandshakerResult) Descriptor() ([]byte, []int)
Deprecated: Use HandshakerResult.ProtoReflect.Descriptor instead.
func (*HandshakerResult) GetApplicationProtocol ¶
func (x *HandshakerResult) GetApplicationProtocol() string
func (*HandshakerResult) GetKeepChannelOpen ¶
func (x *HandshakerResult) GetKeepChannelOpen() bool
func (*HandshakerResult) GetKeyData ¶
func (x *HandshakerResult) GetKeyData() []byte
func (*HandshakerResult) GetLocalIdentity ¶
func (x *HandshakerResult) GetLocalIdentity() *Identity
func (*HandshakerResult) GetMaxFrameSize ¶ added in v1.26.0
func (x *HandshakerResult) GetMaxFrameSize() uint32
func (*HandshakerResult) GetPeerIdentity ¶
func (x *HandshakerResult) GetPeerIdentity() *Identity
func (*HandshakerResult) GetPeerRpcVersions ¶
func (x *HandshakerResult) GetPeerRpcVersions() *RpcProtocolVersions
func (*HandshakerResult) GetRecordProtocol ¶
func (x *HandshakerResult) GetRecordProtocol() string
func (*HandshakerResult) ProtoMessage ¶
func (*HandshakerResult) ProtoMessage()
func (*HandshakerResult) ProtoReflect ¶ added in v1.33.2
func (x *HandshakerResult) ProtoReflect() protoreflect.Message
func (*HandshakerResult) Reset ¶
func (x *HandshakerResult) Reset()
func (*HandshakerResult) String ¶
func (x *HandshakerResult) String() string
type HandshakerServiceClient ¶
type HandshakerServiceClient interface { // 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. DoHandshake(ctx context.Context, opts ...grpc.CallOption) (HandshakerService_DoHandshakeClient, error) }
HandshakerServiceClient is the client API for HandshakerService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewHandshakerServiceClient ¶
func NewHandshakerServiceClient(cc grpc.ClientConnInterface) HandshakerServiceClient
type HandshakerServiceServer ¶
type HandshakerServiceServer interface { // 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. DoHandshake(HandshakerService_DoHandshakeServer) error // contains filtered or unexported methods }
HandshakerServiceServer is the server API for HandshakerService service. All implementations must embed UnimplementedHandshakerServiceServer for forward compatibility
type HandshakerService_DoHandshakeClient ¶
type HandshakerService_DoHandshakeClient interface { Send(*HandshakerReq) error Recv() (*HandshakerResp, error) grpc.ClientStream }
type HandshakerService_DoHandshakeServer ¶
type HandshakerService_DoHandshakeServer interface { Send(*HandshakerResp) error Recv() (*HandshakerReq, error) grpc.ServerStream }
type HandshakerStatus ¶
type HandshakerStatus struct { // The status code. This could be the gRPC status code. Code uint32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"` // The status details. Details string `protobuf:"bytes,2,opt,name=details,proto3" json:"details,omitempty"` // contains filtered or unexported fields }
func (*HandshakerStatus) Descriptor
deprecated
func (*HandshakerStatus) Descriptor() ([]byte, []int)
Deprecated: Use HandshakerStatus.ProtoReflect.Descriptor instead.
func (*HandshakerStatus) GetCode ¶
func (x *HandshakerStatus) GetCode() uint32
func (*HandshakerStatus) GetDetails ¶
func (x *HandshakerStatus) GetDetails() string
func (*HandshakerStatus) ProtoMessage ¶
func (*HandshakerStatus) ProtoMessage()
func (*HandshakerStatus) ProtoReflect ¶ added in v1.33.2
func (x *HandshakerStatus) ProtoReflect() protoreflect.Message
func (*HandshakerStatus) Reset ¶
func (x *HandshakerStatus) Reset()
func (*HandshakerStatus) String ¶
func (x *HandshakerStatus) String() string
type Identity ¶
type Identity struct { // Types that are assignable to IdentityOneof: // *Identity_ServiceAccount // *Identity_Hostname IdentityOneof isIdentity_IdentityOneof `protobuf_oneof:"identity_oneof"` // Additional attributes of the identity. Attributes map[string]string `` /* 161-byte string literal not displayed */ // contains filtered or unexported fields }
func (*Identity) Descriptor
deprecated
func (*Identity) GetAttributes ¶ added in v1.16.0
func (*Identity) GetHostname ¶
func (*Identity) GetIdentityOneof ¶
func (m *Identity) GetIdentityOneof() isIdentity_IdentityOneof
func (*Identity) GetServiceAccount ¶
func (*Identity) ProtoMessage ¶
func (*Identity) ProtoMessage()
func (*Identity) ProtoReflect ¶ added in v1.33.2
func (x *Identity) ProtoReflect() protoreflect.Message
type Identity_Hostname ¶
type Identity_Hostname struct { // Hostname of a connection endpoint. Hostname string `protobuf:"bytes,2,opt,name=hostname,proto3,oneof"` }
type Identity_ServiceAccount ¶
type Identity_ServiceAccount struct { // Service account of a connection endpoint. ServiceAccount string `protobuf:"bytes,1,opt,name=service_account,json=serviceAccount,proto3,oneof"` }
type NetworkProtocol ¶
type NetworkProtocol int32
const ( NetworkProtocol_NETWORK_PROTOCOL_UNSPECIFIED NetworkProtocol = 0 NetworkProtocol_TCP NetworkProtocol = 1 NetworkProtocol_UDP NetworkProtocol = 2 )
func (NetworkProtocol) Descriptor ¶ added in v1.33.2
func (NetworkProtocol) Descriptor() protoreflect.EnumDescriptor
func (NetworkProtocol) Enum ¶ added in v1.33.2
func (x NetworkProtocol) Enum() *NetworkProtocol
func (NetworkProtocol) EnumDescriptor
deprecated
func (NetworkProtocol) EnumDescriptor() ([]byte, []int)
Deprecated: Use NetworkProtocol.Descriptor instead.
func (NetworkProtocol) Number ¶ added in v1.33.2
func (x NetworkProtocol) Number() protoreflect.EnumNumber
func (NetworkProtocol) String ¶
func (x NetworkProtocol) String() string
func (NetworkProtocol) Type ¶ added in v1.33.2
func (NetworkProtocol) Type() protoreflect.EnumType
type NextHandshakeMessageReq ¶
type NextHandshakeMessageReq struct { // 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. InBytes []byte `protobuf:"bytes,1,opt,name=in_bytes,json=inBytes,proto3" json:"in_bytes,omitempty"` // contains filtered or unexported fields }
func (*NextHandshakeMessageReq) Descriptor
deprecated
func (*NextHandshakeMessageReq) Descriptor() ([]byte, []int)
Deprecated: Use NextHandshakeMessageReq.ProtoReflect.Descriptor instead.
func (*NextHandshakeMessageReq) GetInBytes ¶
func (x *NextHandshakeMessageReq) GetInBytes() []byte
func (*NextHandshakeMessageReq) ProtoMessage ¶
func (*NextHandshakeMessageReq) ProtoMessage()
func (*NextHandshakeMessageReq) ProtoReflect ¶ added in v1.33.2
func (x *NextHandshakeMessageReq) ProtoReflect() protoreflect.Message
func (*NextHandshakeMessageReq) Reset ¶
func (x *NextHandshakeMessageReq) Reset()
func (*NextHandshakeMessageReq) String ¶
func (x *NextHandshakeMessageReq) String() string
type RpcProtocolVersions ¶
type RpcProtocolVersions struct { // Maximum supported RPC version. MaxRpcVersion *RpcProtocolVersions_Version `protobuf:"bytes,1,opt,name=max_rpc_version,json=maxRpcVersion,proto3" json:"max_rpc_version,omitempty"` // Minimum supported RPC version. MinRpcVersion *RpcProtocolVersions_Version `protobuf:"bytes,2,opt,name=min_rpc_version,json=minRpcVersion,proto3" json:"min_rpc_version,omitempty"` // contains filtered or unexported fields }
Max and min supported RPC protocol versions.
func (*RpcProtocolVersions) Descriptor
deprecated
func (*RpcProtocolVersions) Descriptor() ([]byte, []int)
Deprecated: Use RpcProtocolVersions.ProtoReflect.Descriptor instead.
func (*RpcProtocolVersions) GetMaxRpcVersion ¶
func (x *RpcProtocolVersions) GetMaxRpcVersion() *RpcProtocolVersions_Version
func (*RpcProtocolVersions) GetMinRpcVersion ¶
func (x *RpcProtocolVersions) GetMinRpcVersion() *RpcProtocolVersions_Version
func (*RpcProtocolVersions) ProtoMessage ¶
func (*RpcProtocolVersions) ProtoMessage()
func (*RpcProtocolVersions) ProtoReflect ¶ added in v1.33.2
func (x *RpcProtocolVersions) ProtoReflect() protoreflect.Message
func (*RpcProtocolVersions) Reset ¶
func (x *RpcProtocolVersions) Reset()
func (*RpcProtocolVersions) String ¶
func (x *RpcProtocolVersions) String() string
type RpcProtocolVersions_Version ¶
type RpcProtocolVersions_Version struct { Major uint32 `protobuf:"varint,1,opt,name=major,proto3" json:"major,omitempty"` Minor uint32 `protobuf:"varint,2,opt,name=minor,proto3" json:"minor,omitempty"` // contains filtered or unexported fields }
RPC version contains a major version and a minor version.
func (*RpcProtocolVersions_Version) Descriptor
deprecated
func (*RpcProtocolVersions_Version) Descriptor() ([]byte, []int)
Deprecated: Use RpcProtocolVersions_Version.ProtoReflect.Descriptor instead.
func (*RpcProtocolVersions_Version) GetMajor ¶
func (x *RpcProtocolVersions_Version) GetMajor() uint32
func (*RpcProtocolVersions_Version) GetMinor ¶
func (x *RpcProtocolVersions_Version) GetMinor() uint32
func (*RpcProtocolVersions_Version) ProtoMessage ¶
func (*RpcProtocolVersions_Version) ProtoMessage()
func (*RpcProtocolVersions_Version) ProtoReflect ¶ added in v1.33.2
func (x *RpcProtocolVersions_Version) ProtoReflect() protoreflect.Message
func (*RpcProtocolVersions_Version) Reset ¶
func (x *RpcProtocolVersions_Version) Reset()
func (*RpcProtocolVersions_Version) String ¶
func (x *RpcProtocolVersions_Version) String() string
type SecurityLevel ¶
type SecurityLevel int32
The security level of the created channel. The list is sorted in increasing level of security. This order must always be maintained.
const ( SecurityLevel_SECURITY_NONE SecurityLevel = 0 SecurityLevel_INTEGRITY_ONLY SecurityLevel = 1 SecurityLevel_INTEGRITY_AND_PRIVACY SecurityLevel = 2 )
func (SecurityLevel) Descriptor ¶ added in v1.33.2
func (SecurityLevel) Descriptor() protoreflect.EnumDescriptor
func (SecurityLevel) Enum ¶ added in v1.33.2
func (x SecurityLevel) Enum() *SecurityLevel
func (SecurityLevel) EnumDescriptor
deprecated
func (SecurityLevel) EnumDescriptor() ([]byte, []int)
Deprecated: Use SecurityLevel.Descriptor instead.
func (SecurityLevel) Number ¶ added in v1.33.2
func (x SecurityLevel) Number() protoreflect.EnumNumber
func (SecurityLevel) String ¶
func (x SecurityLevel) String() string
func (SecurityLevel) Type ¶ added in v1.33.2
func (SecurityLevel) Type() protoreflect.EnumType
type ServerHandshakeParameters ¶
type ServerHandshakeParameters struct { // The record protocols supported by the server, e.g., // "ALTSRP_GCM_AES128". RecordProtocols []string `protobuf:"bytes,1,rep,name=record_protocols,json=recordProtocols,proto3" json:"record_protocols,omitempty"` // (Optional) A list of local identities supported by the server, if // specified. Otherwise, the handshaker chooses a default local identity. LocalIdentities []*Identity `protobuf:"bytes,2,rep,name=local_identities,json=localIdentities,proto3" json:"local_identities,omitempty"` // contains filtered or unexported fields }
func (*ServerHandshakeParameters) Descriptor
deprecated
func (*ServerHandshakeParameters) Descriptor() ([]byte, []int)
Deprecated: Use ServerHandshakeParameters.ProtoReflect.Descriptor instead.
func (*ServerHandshakeParameters) GetLocalIdentities ¶
func (x *ServerHandshakeParameters) GetLocalIdentities() []*Identity
func (*ServerHandshakeParameters) GetRecordProtocols ¶
func (x *ServerHandshakeParameters) GetRecordProtocols() []string
func (*ServerHandshakeParameters) ProtoMessage ¶
func (*ServerHandshakeParameters) ProtoMessage()
func (*ServerHandshakeParameters) ProtoReflect ¶ added in v1.33.2
func (x *ServerHandshakeParameters) ProtoReflect() protoreflect.Message
func (*ServerHandshakeParameters) Reset ¶
func (x *ServerHandshakeParameters) Reset()
func (*ServerHandshakeParameters) String ¶
func (x *ServerHandshakeParameters) String() string
type StartClientHandshakeReq ¶
type StartClientHandshakeReq struct { // Handshake security protocol requested by the client. HandshakeSecurityProtocol HandshakeProtocol `` /* 171-byte string literal not displayed */ // The application protocols supported by the client, e.g., "h2" (for http2), // "grpc". ApplicationProtocols []string `protobuf:"bytes,2,rep,name=application_protocols,json=applicationProtocols,proto3" json:"application_protocols,omitempty"` // The record protocols supported by the client, e.g., // "ALTSRP_GCM_AES128". RecordProtocols []string `protobuf:"bytes,3,rep,name=record_protocols,json=recordProtocols,proto3" json:"record_protocols,omitempty"` // (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. TargetIdentities []*Identity `protobuf:"bytes,4,rep,name=target_identities,json=targetIdentities,proto3" json:"target_identities,omitempty"` // (Optional) Application may specify a local identity. Otherwise, the // handshaker chooses a default local identity. LocalIdentity *Identity `protobuf:"bytes,5,opt,name=local_identity,json=localIdentity,proto3" json:"local_identity,omitempty"` // (Optional) Local endpoint information of the connection to the server, // such as local IP address, port number, and network protocol. LocalEndpoint *Endpoint `protobuf:"bytes,6,opt,name=local_endpoint,json=localEndpoint,proto3" json:"local_endpoint,omitempty"` // (Optional) Endpoint information of the remote server, such as IP address, // port number, and network protocol. RemoteEndpoint *Endpoint `protobuf:"bytes,7,opt,name=remote_endpoint,json=remoteEndpoint,proto3" json:"remote_endpoint,omitempty"` // (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. TargetName string `protobuf:"bytes,8,opt,name=target_name,json=targetName,proto3" json:"target_name,omitempty"` // (Optional) RPC protocol versions supported by the client. RpcVersions *RpcProtocolVersions `protobuf:"bytes,9,opt,name=rpc_versions,json=rpcVersions,proto3" json:"rpc_versions,omitempty"` // (Optional) Maximum frame size supported by the client. MaxFrameSize uint32 `protobuf:"varint,10,opt,name=max_frame_size,json=maxFrameSize,proto3" json:"max_frame_size,omitempty"` // contains filtered or unexported fields }
func (*StartClientHandshakeReq) Descriptor
deprecated
func (*StartClientHandshakeReq) Descriptor() ([]byte, []int)
Deprecated: Use StartClientHandshakeReq.ProtoReflect.Descriptor instead.
func (*StartClientHandshakeReq) GetApplicationProtocols ¶
func (x *StartClientHandshakeReq) GetApplicationProtocols() []string
func (*StartClientHandshakeReq) GetHandshakeSecurityProtocol ¶
func (x *StartClientHandshakeReq) GetHandshakeSecurityProtocol() HandshakeProtocol
func (*StartClientHandshakeReq) GetLocalEndpoint ¶
func (x *StartClientHandshakeReq) GetLocalEndpoint() *Endpoint
func (*StartClientHandshakeReq) GetLocalIdentity ¶
func (x *StartClientHandshakeReq) GetLocalIdentity() *Identity
func (*StartClientHandshakeReq) GetMaxFrameSize ¶ added in v1.26.0
func (x *StartClientHandshakeReq) GetMaxFrameSize() uint32
func (*StartClientHandshakeReq) GetRecordProtocols ¶
func (x *StartClientHandshakeReq) GetRecordProtocols() []string
func (*StartClientHandshakeReq) GetRemoteEndpoint ¶
func (x *StartClientHandshakeReq) GetRemoteEndpoint() *Endpoint
func (*StartClientHandshakeReq) GetRpcVersions ¶
func (x *StartClientHandshakeReq) GetRpcVersions() *RpcProtocolVersions
func (*StartClientHandshakeReq) GetTargetIdentities ¶
func (x *StartClientHandshakeReq) GetTargetIdentities() []*Identity
func (*StartClientHandshakeReq) GetTargetName ¶
func (x *StartClientHandshakeReq) GetTargetName() string
func (*StartClientHandshakeReq) ProtoMessage ¶
func (*StartClientHandshakeReq) ProtoMessage()
func (*StartClientHandshakeReq) ProtoReflect ¶ added in v1.33.2
func (x *StartClientHandshakeReq) ProtoReflect() protoreflect.Message
func (*StartClientHandshakeReq) Reset ¶
func (x *StartClientHandshakeReq) Reset()
func (*StartClientHandshakeReq) String ¶
func (x *StartClientHandshakeReq) String() string
type StartServerHandshakeReq ¶
type StartServerHandshakeReq struct { // The application protocols supported by the server, e.g., "h2" (for http2), // "grpc". ApplicationProtocols []string `protobuf:"bytes,1,rep,name=application_protocols,json=applicationProtocols,proto3" json:"application_protocols,omitempty"` // 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. HandshakeParameters map[int32]*ServerHandshakeParameters `` /* 207-byte string literal not displayed */ // 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. InBytes []byte `protobuf:"bytes,3,opt,name=in_bytes,json=inBytes,proto3" json:"in_bytes,omitempty"` // (Optional) Local endpoint information of the connection to the client, // such as local IP address, port number, and network protocol. LocalEndpoint *Endpoint `protobuf:"bytes,4,opt,name=local_endpoint,json=localEndpoint,proto3" json:"local_endpoint,omitempty"` // (Optional) Endpoint information of the remote client, such as IP address, // port number, and network protocol. RemoteEndpoint *Endpoint `protobuf:"bytes,5,opt,name=remote_endpoint,json=remoteEndpoint,proto3" json:"remote_endpoint,omitempty"` // (Optional) RPC protocol versions supported by the server. RpcVersions *RpcProtocolVersions `protobuf:"bytes,6,opt,name=rpc_versions,json=rpcVersions,proto3" json:"rpc_versions,omitempty"` // (Optional) Maximum frame size supported by the server. MaxFrameSize uint32 `protobuf:"varint,7,opt,name=max_frame_size,json=maxFrameSize,proto3" json:"max_frame_size,omitempty"` // contains filtered or unexported fields }
func (*StartServerHandshakeReq) Descriptor
deprecated
func (*StartServerHandshakeReq) Descriptor() ([]byte, []int)
Deprecated: Use StartServerHandshakeReq.ProtoReflect.Descriptor instead.
func (*StartServerHandshakeReq) GetApplicationProtocols ¶
func (x *StartServerHandshakeReq) GetApplicationProtocols() []string
func (*StartServerHandshakeReq) GetHandshakeParameters ¶
func (x *StartServerHandshakeReq) GetHandshakeParameters() map[int32]*ServerHandshakeParameters
func (*StartServerHandshakeReq) GetInBytes ¶
func (x *StartServerHandshakeReq) GetInBytes() []byte
func (*StartServerHandshakeReq) GetLocalEndpoint ¶
func (x *StartServerHandshakeReq) GetLocalEndpoint() *Endpoint
func (*StartServerHandshakeReq) GetMaxFrameSize ¶ added in v1.26.0
func (x *StartServerHandshakeReq) GetMaxFrameSize() uint32
func (*StartServerHandshakeReq) GetRemoteEndpoint ¶
func (x *StartServerHandshakeReq) GetRemoteEndpoint() *Endpoint
func (*StartServerHandshakeReq) GetRpcVersions ¶
func (x *StartServerHandshakeReq) GetRpcVersions() *RpcProtocolVersions
func (*StartServerHandshakeReq) ProtoMessage ¶
func (*StartServerHandshakeReq) ProtoMessage()
func (*StartServerHandshakeReq) ProtoReflect ¶ added in v1.33.2
func (x *StartServerHandshakeReq) ProtoReflect() protoreflect.Message
func (*StartServerHandshakeReq) Reset ¶
func (x *StartServerHandshakeReq) Reset()
func (*StartServerHandshakeReq) String ¶
func (x *StartServerHandshakeReq) String() string
type UnimplementedHandshakerServiceServer ¶ added in v1.24.0
type UnimplementedHandshakerServiceServer struct { }
UnimplementedHandshakerServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedHandshakerServiceServer) DoHandshake ¶ added in v1.24.0
func (UnimplementedHandshakerServiceServer) DoHandshake(HandshakerService_DoHandshakeServer) error
type UnsafeHandshakerServiceServer ¶ added in v1.33.0
type UnsafeHandshakerServiceServer interface {
// contains filtered or unexported methods
}
UnsafeHandshakerServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HandshakerServiceServer will result in compilation errors.