sec

Documentation

Overview

Package sec provides secure connection and transport interfaces for libp2p.

Index

• type ErrPeerIDMismatch
  • func (e ErrPeerIDMismatch) Error() string
• type SecureConn
• type SecureTransport

Types

type ErrPeerIDMismatch

type ErrPeerIDMismatch struct {
	Expected peer.ID
	Actual   peer.ID
}

func (ErrPeerIDMismatch) Error

func (e ErrPeerIDMismatch) Error() string

type SecureConn

type SecureConn interface {
	net.Conn
	network.ConnSecurity
}

SecureConn is an authenticated, encrypted connection.

type SecureTransport

type SecureTransport interface {
	// SecureInbound secures an inbound connection.
	// If p is empty, connections from any peer are accepted.
	SecureInbound(ctx context.Context, insecure net.Conn, p peer.ID) (SecureConn, error)

	// SecureOutbound secures an outbound connection.
	SecureOutbound(ctx context.Context, insecure net.Conn, p peer.ID) (SecureConn, error)

	// ID is the protocol ID of the security protocol.
	ID() protocol.ID
}

A SecureTransport turns inbound and outbound unauthenticated, plain-text, native connections into authenticated, encrypted connections.