package handshaker

Import Path
	google.golang.org/grpc/credentials/alts/internal/handshaker (on go.dev)

Dependency Relation
	imports 13 packages, and imported by one package

Involved Source Files

	   d➜ handshaker.go
		Package handshaker provides ALTS handshaking functionality for GCP.
Package-Level Type Names (total 3, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type ClientHandshakerOptions (struct)
		ClientHandshakerOptions contains the client handshaker options that can
		provided by the caller.

		Fields (total 4, all are exported)
			ClientIdentity *altspb.Identity
				ClientIdentity is the handshaker client local identity.

			RPCVersions *altspb.RpcProtocolVersions
				RPCVersions specifies the gRPC versions accepted by the client.

			TargetName string
				TargetName is the server service account name for secure name
				checking.

			TargetServiceAccounts []string
				TargetServiceAccounts contains a list of expected target service
				accounts. One of these accounts should match one of the accounts in
				the handshaker results. Otherwise, the handshake fails.

		As Outputs Of (at least one exported)
			func DefaultClientHandshakerOptions() *ClientHandshakerOptions
		As Inputs Of (at least one exported)
			func NewClientHandshaker(ctx context.Context, conn *grpc.ClientConn, c net.Conn, opts *ClientHandshakerOptions) (core.Handshaker, error)

	 type ServerHandshakerOptions (struct)
		ServerHandshakerOptions contains the server handshaker options that can
		provided by the caller.

		Fields (only one, which is exported)
			RPCVersions *altspb.RpcProtocolVersions
				RPCVersions specifies the gRPC versions accepted by the server.

		As Outputs Of (at least one exported)
			func DefaultServerHandshakerOptions() *ServerHandshakerOptions
		As Inputs Of (at least one exported)
			func NewServerHandshaker(ctx context.Context, conn *grpc.ClientConn, c net.Conn, opts *ServerHandshakerOptions) (core.Handshaker, error)

	/* one unexported ... *//* one unexported: */
	 type altsHandshaker (struct)
		altsHandshaker is used to complete a ALTS handshaking between client and
		server. This handshaker talks to the ALTS handshaker service in the metadata
		server.

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			clientOpts *ClientHandshakerOptions
				client handshake options.

			conn net.Conn
				the connection to the peer.

			serverOpts *ServerHandshakerOptions
				server handshake options.

			side core.Side
				defines the side doing the handshake, client or server.

			stream altsgrpc.HandshakerService_DoHandshakeClient
				RPC stream used to access the ALTS Handshaker service.

		Methods (total 6, in which 3 are exported)
			(*T) ClientHandshake(ctx context.Context) (net.Conn, credentials.AuthInfo, error)
				ClientHandshake starts and completes a client ALTS handshaking for GCP. Once
				done, ClientHandshake returns a secure connection.

			(*T) Close()
				Close terminates the Handshaker. It should be called when the caller obtains
				the secure connection.

			(*T) ServerHandshake(ctx context.Context) (net.Conn, credentials.AuthInfo, error)
				ServerHandshake starts and completes a server ALTS handshaking for GCP. Once
				done, ServerHandshake returns a secure connection.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*T) accessHandshakerService(req *altspb.HandshakerReq) (*altspb.HandshakerResp, error)
			(*T) doHandshake(req *altspb.HandshakerReq) (net.Conn, *altspb.HandshakerResult, error)
			(*T) processUntilDone(resp *altspb.HandshakerResp, extra []byte) (*altspb.HandshakerResult, []byte, error)
				processUntilDone processes the handshake until the handshaker service returns
				the results. Handshaker service takes care of frame parsing, so we read
				whatever received from the network and send it to the handshaker service.

		Implements (at least one exported)
			*T : google.golang.org/grpc/credentials/alts/internal.Handshaker


Package-Level Functions (total 7, in which 4 are exported)

	 func DefaultClientHandshakerOptions() *ClientHandshakerOptions
		DefaultClientHandshakerOptions returns the default client handshaker options.

	 func DefaultServerHandshakerOptions() *ServerHandshakerOptions
		DefaultServerHandshakerOptions returns the default client handshaker options.

	 func NewClientHandshaker(ctx context.Context, conn *grpc.ClientConn, c net.Conn, opts *ClientHandshakerOptions) (core.Handshaker, error)
		NewClientHandshaker creates a ALTS handshaker for GCP which contains an RPC
		stub created using the passed conn and used to talk to the ALTS Handshaker
		service in the metadata server.

	 func NewServerHandshaker(ctx context.Context, conn *grpc.ClientConn, c net.Conn, opts *ServerHandshakerOptions) (core.Handshaker, error)
		NewServerHandshaker creates a ALTS handshaker for GCP which contains an RPC
		stub created using the passed conn and used to talk to the ALTS Handshaker
		service in the metadata server.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func acquire() bool
	 func init()
	 func release()
Package-Level Variables (total 9, none are exported)

	/* 9 unexporteds ... *//* 9 unexporteds: */
	  var altsRecordFuncs map[string]conn.ALTSRecordFunc
	  var appProtocols []string
	  var concurrentHandshakes int64
	  var errDropped error
		errDropped occurs when maxPendingHandshakes is reached.

	  var errOutOfBound error
		errOutOfBound occurs when the handshake service returns a consumed
		bytes value larger than the buffer that was passed to it originally.

	  var hsProtocol grpc_gcp.HandshakeProtocol
	  var keyLength map[string]int
	  var mu sync.Mutex
		control number of concurrent created (but not closed) handshakers.

	  var recordProtocols []string
Package-Level Constants (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	const frameLimit = 65536 // 64 KB
		The maximum byte size of receive frames.

	const maxPendingHandshakes = 100
		maxPendingHandshakes represents the maximum number of concurrent
		handshakes.

	const rekeyRecordProtocolName = "ALTSRP_GCM_AES128_REKEY"

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.