core

Documentation

Overview

Package core contains common core functionality for ALTS. Disclaimer: users should NEVER reference this package directly.

Index

• Variables
• type Handshaker
• type Side

Variables

var PeerNotRespondingError = &peerNotRespondingError{}

PeerNotRespondingError is returned when a peer server is not responding after a channel has been established. It is treated as a temporary connection error and re-connection to the server should be attempted.

Types

type Handshaker

type Handshaker interface {
	// ClientHandshake starts and completes a client-side handshaking and
	// returns a secure connection and corresponding auth information.
	ClientHandshake(ctx context.Context) (net.Conn, credentials.AuthInfo, error)
	// ServerHandshake starts and completes a server-side handshaking and
	// returns a secure connection and corresponding auth information.
	ServerHandshake(ctx context.Context) (net.Conn, credentials.AuthInfo, error)
	// Close terminates the Handshaker. It should be called when the caller
	// obtains the secure connection.
	Close()
}

Handshaker defines a ALTS handshaker interface.

type Side

type Side int

Side identifies the party's role: client or server.

const (
	// ClientSide identifies the client in this communication.
	ClientSide Side = iota
	// ServerSide identifies the server in this communication.
	ServerSide
)