handshake

Documentation

Index

• Variables
• type Filter
• type GCMSession
  • func (session GCMSession) Decrypt(p []byte) ([]byte, error)
  • func (session GCMSession) Encrypt(p []byte) ([]byte, error)
  • func (session GCMSession) RemoteSignatory() id.Signatory
• type Handshaker
  • func NewECDSA(opts Options) Handshaker
  • func NewInsecure(opts Options) Handshaker
• type Options
  • func DefaultOptions() Options
  • func (opts Options) WithFilter(filter Filter) Options
  • func (opts Options) WithLogger(logger *zap.Logger) Options
  • func (opts Options) WithPrivKey(privKey *id.PrivKey) Options
  • func (opts Options) WithTimeout(timeout time.Duration) Options
• type Session
  • func NewGCMSession(key []byte, other id.Signatory) (Session, error)

Variables

var (
	DefaultTimeout = 30 * time.Second
	DefaultFilter  = Filter(nil)
)

Types

type Filter

type Filter interface {
	Filter(id.Signatory) bool
}

A Filter for identities that are established during a handshake. Although the handshake may be successful, the actual identity may want to be rejected because of some application-level logic. Filters are a hook for implementing such logic.

type GCMSession

type GCMSession struct {
	// contains filtered or unexported fields
}

func (GCMSession) Decrypt

func (session GCMSession) Decrypt(p []byte) ([]byte, error)

func (GCMSession) Encrypt

func (session GCMSession) Encrypt(p []byte) ([]byte, error)

func (GCMSession) RemoteSignatory

func (session GCMSession) RemoteSignatory() id.Signatory

type Handshaker

type Handshaker interface {
	// Handshake with a remote server by initiating, and then interactively
	// completing, a handshake protocol. The remote server is accessed by
	// reading/writing to the `io.ReaderWriter`.
	Handshake(ctx context.Context, c net.Conn) (Session, error)

	// AcceptHandshake from a remote client by waiting for the initiation of,
	// and then interactively completing, a handshake protocol. The remote
	// client is accessed by reading/writing to the `io.ReaderWriter`.
	AcceptHandshake(ctx context.Context, c net.Conn) (Session, error)
}

func NewECDSA

func NewECDSA(opts Options) Handshaker

NewECDSA returns a new Handshaker that uses ECDSA to establish a connection that is authenticated and encrypted using GCM.

func NewInsecure

func NewInsecure(opts Options) Handshaker

NewInsecure returns a new Handshaker that implements no authentication, encryption, or restrictions on connections.

type Options

type Options struct {
	Logger  *zap.Logger
	PrivKey *id.PrivKey
	Timeout time.Duration
	Filter  Filter
}

func DefaultOptions

func DefaultOptions() Options

func (Options) WithFilter

func (opts Options) WithFilter(filter Filter) Options

func (Options) WithLogger

func (opts Options) WithLogger(logger *zap.Logger) Options

func (Options) WithPrivKey

func (opts Options) WithPrivKey(privKey *id.PrivKey) Options

func (Options) WithTimeout

func (opts Options) WithTimeout(timeout time.Duration) Options

type Session

type Session interface {
	// Encrypt data for the other Signatory.
	Encrypt([]byte) ([]byte, error)
	// Decrypt data from the other Signatory.
	Decrypt([]byte) ([]byte, error)
	// RemoteSignatory returns the pubkey hash of the Signatory that is on the
	// remote end of the Session.
	RemoteSignatory() id.Signatory
}

func NewGCMSession

func NewGCMSession(key []byte, other id.Signatory) (Session, error)