secio

Documentation

Overview

Package secio is used to encrypt `go-libp2p-conn` connections. Connections wrapped by secio use secure sessions provided by this package to encrypt all traffic. A TLS-like handshake is used to setup the communication channel.

Index

• Constants
• Variables
• func NewETMReader(r io.Reader, s cipher.Stream, mac HMAC) msgio.ReadCloser
• func NewETMWriter(w io.Writer, s cipher.Stream, mac HMAC) msgio.WriteCloser
• type HMAC
• type Transport
  • func New(sk ci.PrivKey) (*Transport, error)
  • func (sg *Transport) SecureInbound(ctx context.Context, insecure net.Conn) (sec.SecureConn, error)
  • func (sg *Transport) SecureOutbound(ctx context.Context, insecure net.Conn, p peer.ID) (sec.SecureConn, error)

Constants

const DefaultSupportedCiphers = "AES-256,AES-128"

DefaultSupportedCiphers are th edefault ciphers we support

const DefaultSupportedExchanges = "P-256,P-384,P-521"

DefaultSupportedExchanges are the default support key exchange algorithms

const DefaultSupportedHashes = "SHA256,SHA512"

DefaultSupportedHashes are the default supported hashes

const ID = "/secio/1.0.0"

ID is secio's protocol ID (used when negotiating with multistream)

Variables

var ErrBadSig = errors.New("bad signature")

ErrBadSig signals that the peer sent us a handshake packet with a bad signature.

var ErrClosed = errors.New("connection closed")

ErrClosed signals the closing of a connection.

var ErrEcho = errors.New("same keys and nonces. one side talking to self")

ErrEcho is returned when we're attempting to handshake with the same keys and nonces.

var ErrMACInvalid = errors.New("MAC verification failed")

ErrMACInvalid signals that a MAC verification failed

var ErrUnsupportedKeyType = errors.New("unsupported key type")

ErrUnsupportedKeyType is returned when a private key cast/type switch fails.

var ErrWrongPeer = errors.New("connected to wrong peer")

ErrWrongPeer is returned when we attempt to handshake with the wrong peer.

var HandshakeTimeout = time.Second * 30

HandshakeTimeout governs how long the handshake will be allowed to take place for. Making this number large means there could be many bogus connections waiting to timeout in flight. Typical handshakes take ~3RTTs, so it should be completed within seconds across a typical planet in the solar system.

var SupportedCiphers = DefaultSupportedCiphers

SupportedCiphers is the list of supported Ciphers

var SupportedExchanges = DefaultSupportedExchanges

SupportedExchanges is the list of supported ECDH curves

var SupportedHashes = DefaultSupportedHashes

SupportedHashes is the list of supported Hashes

Functions

func NewETMReader

func NewETMReader(r io.Reader, s cipher.Stream, mac HMAC) msgio.ReadCloser

NewETMReader Encrypt-Then-MAC

func NewETMWriter

func NewETMWriter(w io.Writer, s cipher.Stream, mac HMAC) msgio.WriteCloser

NewETMWriter Encrypt-Then-MAC

Types

type HMAC

type HMAC struct {
	hash.Hash
	// contains filtered or unexported fields
}

HMAC carries a hash and its size

type Transport

type Transport struct {
	LocalID    peer.ID
	PrivateKey ci.PrivKey
}

Transport constructs secure communication sessions for a peer.

func New

func New(sk ci.PrivKey) (*Transport, error)

New returns a new SecIO transport

func (*Transport) SecureInbound

func (sg *Transport) SecureInbound(ctx context.Context, insecure net.Conn) (sec.SecureConn, error)

SecureInbound secures the inbound connection

func (*Transport) SecureOutbound

func (sg *Transport) SecureOutbound(ctx context.Context, insecure net.Conn, p peer.ID) (sec.SecureConn, error)

SecureOutbound secures the outbound connection