handshake

Documentation

Index

• Variables
• func IncomingProtoHandshake(ctx context.Context, conn net.Conn, pt ProtoChecker) (*handshakeproto.Proto, error)
• func OutgoingProtoHandshake(ctx context.Context, conn net.Conn, proto *handshakeproto.Proto) (remoteProto *handshakeproto.Proto, err error)
• type CredentialChecker
• type HandshakeError
  • func (he HandshakeError) Error() string
• type ProtoChecker
• type Result
  • func IncomingHandshake(ctx context.Context, conn io.ReadWriteCloser, peerId string, ...) (result Result, err error)
  • func OutgoingHandshake(ctx context.Context, conn io.ReadWriteCloser, peerId string, ...) (result Result, err error)

Variables

var (
	ErrUnexpectedPayload       = HandshakeError{/* contains filtered or unexported fields */}
	ErrDeadlineExceeded        = HandshakeError{/* contains filtered or unexported fields */}
	ErrInvalidCredentials      = HandshakeError{/* contains filtered or unexported fields */}
	ErrPeerDeclinedCredentials = HandshakeError{Err: errors.New("remote peer declined the credentials")}
	ErrSkipVerifyNotAllowed    = HandshakeError{/* contains filtered or unexported fields */}
	ErrUnexpected              = HandshakeError{/* contains filtered or unexported fields */}

	ErrIncompatibleVersion     = HandshakeError{/* contains filtered or unexported fields */}
	ErrIncompatibleProto       = HandshakeError{/* contains filtered or unexported fields */}
	ErrRemoteIncompatibleProto = HandshakeError{Err: errors.New("remote peer declined the proto")}

	ErrGotUnexpectedMessage = errors.New("go not a handshake message")
)

Functions

func IncomingProtoHandshake

func IncomingProtoHandshake(ctx context.Context, conn net.Conn, pt ProtoChecker) (*handshakeproto.Proto, error)

func OutgoingProtoHandshake

func OutgoingProtoHandshake(ctx context.Context, conn net.Conn, proto *handshakeproto.Proto) (remoteProto *handshakeproto.Proto, err error)

Types

type CredentialChecker

type CredentialChecker interface {
	MakeCredentials(remotePeerId string) *handshakeproto.Credentials
	CheckCredential(remotePeerId string, cred *handshakeproto.Credentials) (result Result, err error)
}

type HandshakeError

type HandshakeError struct {
	Err error
	// contains filtered or unexported fields
}

func (HandshakeError) Error

func (he HandshakeError) Error() string

type ProtoChecker

type ProtoChecker struct {
	AllowedProtoTypes  []handshakeproto.ProtoType
	SupportedEncodings []handshakeproto.Encoding
}

type Result

type Result struct {
	Identity      []byte
	ProtoVersion  uint32
	ClientVersion string
}

func IncomingHandshake

func IncomingHandshake(ctx context.Context, conn io.ReadWriteCloser, peerId string, cc CredentialChecker) (result Result, err error)

func OutgoingHandshake

func OutgoingHandshake(ctx context.Context, conn io.ReadWriteCloser, peerId string, cc CredentialChecker) (result Result, err error)