router

package
v0.0.0-...-3cc7b38 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 14, 2014 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Overview

Let peer names be MACs...

MACs need to be unique across our network, or bad things will happen anyway. So they make pretty good candidates for peer names. And doing so is pretty efficient both computationally and network overhead wise.

Note that we do not mandate *what* MAC should be used as the peer name. In particular it doesn't actually have to be the MAC of, say, the network interface the peer is sniffing on.

Index

Constants

View Source 
const (
	CSendTCP          = iota
	CSetEstablished   = iota
	CSetRemoteUDPAddr = iota
	CShutdown         = iota
)
View Source 
const (
	InitialInterval = 5 * time.Second
	MaxInterval     = 10 * time.Minute
)
View Source 
const (
	CMInitiate   = iota
	CMTerminated = iota
	CMRefresh    = iota
	CMStatus     = iota
)
View Source 
const (
	Protocol           = "weave"
	ProtocolVersion    = 8
	EthernetOverhead   = 14
	UDPOverhead        = 28 // 20 bytes for IPv4, 8 bytes for UDP
	Port               = 6783
	HttpPort           = Port + 1
	DefaultPMTU        = 65535
	MaxUDPPacketSize   = 65536
	ChannelSize        = 16
	UDPNonceSendAt     = 8192
	FragTestSize       = 60001
	PMTUDiscoverySize  = 60000
	FastHeartbeat      = 500 * time.Millisecond
	SlowHeartbeat      = 10 * time.Second
	FetchAllInterval   = 30 * time.Second
	FragTestInterval   = 5 * time.Minute
	PMTUVerifyAttempts = 8
	PMTUVerifyTimeout  = 10 * time.Millisecond // gets doubled with every attempt
	MaxDuration        = time.Duration(math.MaxInt64)
)
View Source 
const (
	ProtocolConnectionEstablished  = iota
	ProtocolFragmentationReceived  = iota
	ProtocolStartFragmentationTest = iota
	ProtocolNonce                  = iota
	ProtocolFetchAll               = iota
	ProtocolUpdate                 = iota
	ProtocolPMTUVerified           = iota
)
View Source 
const (
	PAddConnection         = iota
	PBroadcastTCP          = iota
	PDeleteConnection      = iota
	PConnectionEstablished = iota
)
View Source 
const (
	PeerNameFlavour = "mac"
	NameSize        = 6
	UnknownPeerName = PeerName(0)
)
View Source 
const (
	TFetchAll      = iota
	TRebuildRoutes = iota
)

Variables

View Source 
var (
	FragTest                           = make([]byte, FragTestSize)
	PMTUDiscovery                      = make([]byte, PMTUDiscoverySize)
	ProtocolConnectionEstablishedByte  = []byte{ProtocolConnectionEstablished}
	ProtocolFragmentationReceivedByte  = []byte{ProtocolFragmentationReceived}
	ProtocolStartFragmentationTestByte = []byte{ProtocolStartFragmentationTest}
	ProtocolNonceByte                  = []byte{ProtocolNonce}
	ProtocolFetchAllByte               = []byte{ProtocolFetchAll}
	ProtocolUpdateByte                 = []byte{ProtocolUpdate}
	ProtocolPMTUVerifiedByte           = []byte{ProtocolPMTUVerified}
)

Functions

func Concat 

func Concat(elems ...[]byte) []byte

func DecodeNonce 

func DecodeNonce(msg []byte) (bool, *[24]byte)

func DecryptPrefixNonce 

func DecryptPrefixNonce(ciphertxt []byte, secret *[32]byte) ([]byte, bool)

func EncodeNonce 

func EncodeNonce(df bool) (*[24]byte, []byte, error)

func EncodePeers 

func EncodePeers(peers ...*Peer) []byte

func EncryptPrefixNonce 

func EncryptPrefixNonce(plaintxt []byte, nonce *[24]byte, secret *[32]byte) []byte

func FormSessionKey 

func FormSessionKey(remotePublicKey, localPrivateKey *[32]byte, secretKey *[]byte) *[32]byte

func GenerateKeyPair 

func GenerateKeyPair() (publicKey, privateKey *[32]byte, err error)

func GenerateRandomNonce 

func GenerateRandomNonce() ([24]byte, error)

func NewLocalConnection 

func NewLocalConnection(connRemote *RemoteConnection, acceptNewPeer bool, tcpConn *net.TCPConn, udpAddr *net.UDPAddr, router *Router)

Async. Does not return anything. If the connection is successful, it will end up in the local peer's connections map.

func NormalisePeerAddr 

func NormalisePeerAddr(peerAddr string) string

given an address like '1.2.3.4:567', return the address if it has a port, otherwise return the address with weave's standard port number

func PosixError 

func PosixError(err error) error

func SetNonceLow15Bits 

func SetNonceLow15Bits(nonce *[24]byte, offset uint16)

Types

type Connection 

type Connection interface {
	Local() *Peer
	Remote() *Peer
	RemoteTCPAddr() string
	Established() bool
	Shutdown()
}

type ConnectionInteraction 

type ConnectionInteraction struct {
	Interaction
	// contains filtered or unexported fields
}

type ConnectionMaker 

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

func StartConnectionMaker 

func StartConnectionMaker(router *Router) *ConnectionMaker

func (*ConnectionMaker) ConnectionTerminated 

func (cm *ConnectionMaker) ConnectionTerminated(address string)

func (*ConnectionMaker) InitiateConnection 

func (cm *ConnectionMaker) InitiateConnection(address string)

func (*ConnectionMaker) Refresh 

func (cm *ConnectionMaker) Refresh()

func (*ConnectionMaker) String 

func (cm *ConnectionMaker) String() string

type ConnectionMakerInteraction 

type ConnectionMakerInteraction struct {
	Interaction
	// contains filtered or unexported fields
}

type ConnectionState 

type ConnectionState int

type Decryptor 

type Decryptor interface {
	IterateFrames(FrameConsumer, *UDPPacket) error
	ReceiveNonce([]byte)
	Shutdown()
}

type EncryptedTCPMessage 

type EncryptedTCPMessage struct {
	Number int
	Body   []byte
}

type EncryptedTCPReceiver 

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

func NewEncryptedTCPReceiver 

func NewEncryptedTCPReceiver(conn *LocalConnection) *EncryptedTCPReceiver

func (*EncryptedTCPReceiver) Decode 

func (receiver *EncryptedTCPReceiver) Decode(msg []byte) ([]byte, error)

type EncryptedTCPSender 

type EncryptedTCPSender struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewEncryptedTCPSender 

func NewEncryptedTCPSender(encoder *gob.Encoder, conn *LocalConnection) *EncryptedTCPSender

func (*EncryptedTCPSender) Send 

func (sender *EncryptedTCPSender) Send(msg []byte) error

type Encryptor 

type Encryptor interface {
	FrameOverhead() int
	PacketOverhead() int
	IsEmpty() bool
	Bytes() []byte
	AppendFrame(*ForwardedFrame)
	TotalLen() int
}

type EthernetDecoder 

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

func NewEthernetDecoder 

func NewEthernetDecoder() *EthernetDecoder

func (*EthernetDecoder) CheckFrameTooBig 

func (dec *EthernetDecoder) CheckFrameTooBig(err error, sendFrame func([]byte) error) error

func (*EthernetDecoder) DecodeLayers 

func (dec *EthernetDecoder) DecodeLayers(data []byte) error

func (*EthernetDecoder) DropFrame 

func (dec *EthernetDecoder) DropFrame() bool

func (*EthernetDecoder) IsPMTUVerify 

func (dec *EthernetDecoder) IsPMTUVerify() bool

type ForwardedFrame 

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

type Forwarder 

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

func NewForwarder 

func NewForwarder(conn *LocalConnection, ch <-chan *ForwardedFrame, stop <-chan interface{}, verifyPMTU <-chan int, enc Encryptor, udpSender UDPSender, pmtu int) *Forwarder

func (*Forwarder) Run 

func (fwd *Forwarder) Run()

type FrameConsumer 

type FrameConsumer func(*LocalConnection, *net.UDPAddr, []byte, []byte, uint16, []byte) error

type FrameTooBigError 

type FrameTooBigError struct {
	EPMTU int // effective pmtu, i.e. what we tell packet senders
}

func (FrameTooBigError) Error 

func (ftbe FrameTooBigError) Error() string

type Interaction 

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

type ListOfPeers 

type ListOfPeers []*Peer

func (ListOfPeers) Len 

func (lop ListOfPeers) Len() int

func (ListOfPeers) Less 

func (lop ListOfPeers) Less(i, j int) bool

func (ListOfPeers) Swap 

func (lop ListOfPeers) Swap(i, j int)

type LocalAddress 

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

type LocalConnection 

type LocalConnection struct {
	sync.RWMutex
	RemoteConnection
	TCPConn *net.TCPConn

	SessionKey *[32]byte

	Decryptor Decryptor
	Router    *Router
	UID       uint64
	// contains filtered or unexported fields
}

func (*LocalConnection) CheckFatal 

func (conn *LocalConnection) CheckFatal(err error) error

Called by the forwarder processes in a few places (including crypto), but the connection TCP receiver process, and by the local peer actor process. Do not call this from the connection's actor process itself.

func (*LocalConnection) Established 

func (conn *LocalConnection) Established() bool

func (*LocalConnection) Forward 

func (conn *LocalConnection) Forward(df bool, frame *ForwardedFrame, dec *EthernetDecoder) error

Called from peer.Relay[Broadcast] which is itself invoked from router (both UDP listener process and sniffer process). Also called from connection's heartbeat process, and from the connection's TCP receiver process.

func (*LocalConnection) RemoteUDPAddr 

func (conn *LocalConnection) RemoteUDPAddr() *net.UDPAddr

Read by the forwarder processes when in the UDP senders

func (*LocalConnection) SendTCP 

func (conn *LocalConnection) SendTCP(msg []byte)

Async

func (*LocalConnection) SetEstablished 

func (conn *LocalConnection) SetEstablished()

Async

func (*LocalConnection) SetRemoteUDPAddr 

func (conn *LocalConnection) SetRemoteUDPAddr(remoteUDPAddr *net.UDPAddr)

Async

func (*LocalConnection) Shutdown 

func (conn *LocalConnection) Shutdown()

Async

type MacCache 

type MacCache struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewMacCache 

func NewMacCache(maxAge time.Duration, onExpiry func(net.HardwareAddr, *Peer)) *MacCache

func (*MacCache) Delete 

func (cache *MacCache) Delete(peer *Peer) bool

func (*MacCache) Enter 

func (cache *MacCache) Enter(mac net.HardwareAddr, peer *Peer) bool

func (*MacCache) Lookup 

func (cache *MacCache) Lookup(mac net.HardwareAddr) (*Peer, bool)

func (*MacCache) String 

func (cache *MacCache) String() string

type MacCacheEntry 

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

type MsgTooBigError 

type MsgTooBigError struct {
	PMTU int // actual pmtu, i.e. what the kernel told us
}

func (MsgTooBigError) Error 

func (mtbe MsgTooBigError) Error() string

type NaClDecryptor 

type NaClDecryptor struct {
	NonDecryptor
	// contains filtered or unexported fields
}

func NewNaClDecryptor 

func NewNaClDecryptor(conn *LocalConnection) *NaClDecryptor

func (*NaClDecryptor) IterateFrames 

func (nd *NaClDecryptor) IterateFrames(fun FrameConsumer, packet *UDPPacket) error

func (*NaClDecryptor) ReceiveNonce 

func (nd *NaClDecryptor) ReceiveNonce(msg []byte)

func (*NaClDecryptor) Shutdown 

func (nd *NaClDecryptor) Shutdown()

type NaClDecryptorInstance 

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

type NaClEncryptor 

type NaClEncryptor struct {
	NonEncryptor
	// contains filtered or unexported fields
}

func NewNaClEncryptor 

func NewNaClEncryptor(prefix []byte, conn *LocalConnection, df bool) *NaClEncryptor

func (*NaClEncryptor) Bytes 

func (ne *NaClEncryptor) Bytes() []byte

func (*NaClEncryptor) PacketOverhead 

func (ne *NaClEncryptor) PacketOverhead() int

func (*NaClEncryptor) TotalLen 

func (ne *NaClEncryptor) TotalLen() int

type NameCollisionError 

type NameCollisionError struct {
	Name PeerName
}

func (NameCollisionError) Error 

func (nce NameCollisionError) Error() string

type NonDecryptor 

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

func NewNonDecryptor 

func NewNonDecryptor(conn *LocalConnection) *NonDecryptor

func (*NonDecryptor) IterateFrames 

func (nd *NonDecryptor) IterateFrames(fun FrameConsumer, packet *UDPPacket) error

func (*NonDecryptor) ReceiveNonce 

func (nd *NonDecryptor) ReceiveNonce(msg []byte)

func (*NonDecryptor) Shutdown 

func (nd *NonDecryptor) Shutdown()

type NonEncryptor 

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

func NewNonEncryptor 

func NewNonEncryptor(prefix []byte) *NonEncryptor

func (*NonEncryptor) AppendFrame 

func (ne *NonEncryptor) AppendFrame(frame *ForwardedFrame)

func (*NonEncryptor) Bytes 

func (ne *NonEncryptor) Bytes() []byte

func (*NonEncryptor) FrameOverhead 

func (ne *NonEncryptor) FrameOverhead() int

func (*NonEncryptor) IsEmpty 

func (ne *NonEncryptor) IsEmpty() bool

func (*NonEncryptor) PacketOverhead 

func (ne *NonEncryptor) PacketOverhead() int

func (*NonEncryptor) TotalLen 

func (ne *NonEncryptor) TotalLen() int

type PacketDecodingError 

type PacketDecodingError struct {
	Desc string
}

func (PacketDecodingError) Error 

func (pde PacketDecodingError) Error() string

type PacketSink 

type PacketSink interface {
	WritePacket([]byte) error
}

func NewPcapO 

func NewPcapO(ifName string) (po PacketSink, err error)

type PacketSource 

type PacketSource interface {
	ReadPacket() ([]byte, error)
}

type PacketSourceSink 

type PacketSourceSink interface {
	PacketSource
	PacketSink
}

func NewPcapIO 

func NewPcapIO(ifName string, bufSz int) (PacketSourceSink, error)

type PcapIO 

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

func (*PcapIO) ReadPacket 

func (pi *PcapIO) ReadPacket() (data []byte, err error)

func (*PcapIO) WritePacket 

func (po *PcapIO) WritePacket(data []byte) error

type Peer 

type Peer struct {
	sync.RWMutex
	Name     PeerName
	NameByte []byte

	UID    uint64
	Router *Router
	// contains filtered or unexported fields
}

func NewPeer 

func NewPeer(name PeerName, uid uint64, version uint64, router *Router) *Peer

func (*Peer) AddConnection 

func (peer *Peer) AddConnection(conn *LocalConnection)

Async: rely on the peer to shut us down if we shouldn't be adding ourselves, so therefore this can be async

func (*Peer) Broadcast 

func (peer *Peer) Broadcast(df bool, frame []byte, dec *EthernetDecoder) error

func (*Peer) BroadcastTCP 

func (peer *Peer) BroadcastTCP(msg []byte)

Async.

func (*Peer) ConnectionCount 

func (peer *Peer) ConnectionCount() int

func (*Peer) ConnectionEstablished 

func (peer *Peer) ConnectionEstablished(conn *LocalConnection)

Async.

func (*Peer) ConnectionTo 

func (peer *Peer) ConnectionTo(name PeerName) (Connection, bool)

func (*Peer) CreateConnection 

func (peer *Peer) CreateConnection(peerAddr string, acceptNewPeer bool) error

func (*Peer) DecrementLocalRefCount 

func (peer *Peer) DecrementLocalRefCount()

func (*Peer) DeleteConnection 

func (peer *Peer) DeleteConnection(conn *LocalConnection)

Sync.

func (*Peer) ForEachConnection 

func (peer *Peer) ForEachConnection(fun func(PeerName, Connection))

func (*Peer) Forward 

func (peer *Peer) Forward(dstPeer *Peer, df bool, frame []byte, dec *EthernetDecoder) error

func (*Peer) HasPathTo 

func (peer *Peer) HasPathTo(target *Peer, symmetric bool) (bool, map[PeerName]bool)

func (*Peer) IncrementLocalRefCount 

func (peer *Peer) IncrementLocalRefCount()

func (*Peer) IsLocallyReferenced 

func (peer *Peer) IsLocallyReferenced() bool

func (*Peer) Relay 

func (peer *Peer) Relay(srcPeer, dstPeer *Peer, df bool, frame []byte, dec *EthernetDecoder) error

func (*Peer) RelayBroadcast 

func (peer *Peer) RelayBroadcast(srcPeer *Peer, df bool, frame []byte, dec *EthernetDecoder) error

func (*Peer) SetVersionAndConnections 

func (peer *Peer) SetVersionAndConnections(version uint64, connections map[PeerName]Connection)

func (*Peer) StartLocalPeer 

func (peer *Peer) StartLocalPeer()

func (*Peer) String 

func (peer *Peer) String() string

func (*Peer) Version 

func (peer *Peer) Version() uint64

type PeerCache 

type PeerCache struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewPeerCache 

func NewPeerCache(onGC func(*Peer)) *PeerCache

func (*PeerCache) ApplyUpdate 

func (cache *PeerCache) ApplyUpdate(update []byte, router *Router) ([]byte, error)

func (*PeerCache) EncodeAllPeers 

func (cache *PeerCache) EncodeAllPeers() []byte

func (*PeerCache) Fetch 

func (cache *PeerCache) Fetch(name PeerName) (*Peer, bool)

func (*PeerCache) FetchWithDefault 

func (cache *PeerCache) FetchWithDefault(peer *Peer) *Peer

func (*PeerCache) ForEach 

func (cache *PeerCache) ForEach(fun func(PeerName, *Peer))

func (*PeerCache) GarbageCollect 

func (cache *PeerCache) GarbageCollect(router *Router) []*Peer

func (*PeerCache) String 

func (cache *PeerCache) String() string

type PeerInteraction 

type PeerInteraction struct {
	Interaction
	// contains filtered or unexported fields
}

type PeerName 

type PeerName uint64

PeerName is used as a map key. Since net.HardwareAddr isn't suitable for that - it's a slice, and slices can't be map keys - we convert that to/from uint64.

func PeerNameFromBin 

func PeerNameFromBin(nameByte []byte) PeerName

func PeerNameFromString 

func PeerNameFromString(nameStr string) (PeerName, error)

func PeerNameFromUserInput 

func PeerNameFromUserInput(userInput string) (PeerName, error)

func (PeerName) Bin 

func (name PeerName) Bin() []byte

func (PeerName) String 

func (name PeerName) String() string

type RawUDPSender 

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

func NewRawUDPSender 

func NewRawUDPSender(conn *LocalConnection) (*RawUDPSender, error)

func (*RawUDPSender) Send 

func (sender *RawUDPSender) Send(msg []byte) error

func (*RawUDPSender) Shutdown 

func (sender *RawUDPSender) Shutdown() error

type RemoteConnection 

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

func NewRemoteConnection 

func NewRemoteConnection(from, to *Peer, tcpAddr string) *RemoteConnection

func (*RemoteConnection) Established 

func (conn *RemoteConnection) Established() bool

func (*RemoteConnection) Local 

func (conn *RemoteConnection) Local() *Peer

func (*RemoteConnection) Remote 

func (conn *RemoteConnection) Remote() *Peer

func (*RemoteConnection) RemoteTCPAddr 

func (conn *RemoteConnection) RemoteTCPAddr() string

func (*RemoteConnection) Shutdown 

func (conn *RemoteConnection) Shutdown()

func (*RemoteConnection) String 

func (conn *RemoteConnection) String() string

type Router 

type Router struct {
	Ourself            *Peer
	Iface              *net.Interface
	PeersSubscribeChan chan<- chan<- map[string]Peer
	Macs               *MacCache
	Peers              *PeerCache
	UDPListener        *net.UDPConn
	Topology           *Topology
	ConnectionMaker    *ConnectionMaker
	Password           *[]byte
	ConnLimit          int
	BufSz              int
	LogFrame           func(string, []byte, *layers.Ethernet)
}

func NewRouter 

func NewRouter(iface *net.Interface, name PeerName, password []byte, connLimit int, bufSz int, logFrame func(string, []byte, *layers.Ethernet)) *Router

func (*Router) Start 

func (router *Router) Start()

func (*Router) Status 

func (router *Router) Status() string

func (*Router) UsingPassword 

func (router *Router) UsingPassword() bool

type SimpleTCPReceiver 

type SimpleTCPReceiver struct {
}

func NewSimpleTCPReceiver 

func NewSimpleTCPReceiver() *SimpleTCPReceiver

func (*SimpleTCPReceiver) Decode 

func (receiver *SimpleTCPReceiver) Decode(msg []byte) ([]byte, error)

type SimpleTCPSender 

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

func NewSimpleTCPSender 

func NewSimpleTCPSender(encoder *gob.Encoder) *SimpleTCPSender

func (*SimpleTCPSender) Send 

func (sender *SimpleTCPSender) Send(msg []byte) error

type SimpleUDPSender 

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

func NewSimpleUDPSender 

func NewSimpleUDPSender(conn *LocalConnection) *SimpleUDPSender

func (*SimpleUDPSender) Send 

func (sender *SimpleUDPSender) Send(msg []byte) error

func (*SimpleUDPSender) Shutdown 

func (sender *SimpleUDPSender) Shutdown() error

type TCPReceiver 

type TCPReceiver interface {
	Decode([]byte) ([]byte, error)
}

type TCPSender 

type TCPSender interface {
	Send([]byte) error
}

type Target 

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

Information about an address where we may find a peer

type Topology 

type Topology struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func StartTopology 

func StartTopology(router *Router) *Topology

func (*Topology) Broadcast 

func (topo *Topology) Broadcast(name PeerName) []PeerName

func (*Topology) FetchAll 

func (topo *Topology) FetchAll() []byte

func (*Topology) RebuildRoutes 

func (topo *Topology) RebuildRoutes()

Async.

func (*Topology) String 

func (topo *Topology) String() string

func (*Topology) Unicast 

func (topo *Topology) Unicast(name PeerName) (PeerName, bool)

type UDPPacket 

type UDPPacket struct {
	Name   PeerName
	Packet []byte
	Sender *net.UDPAddr
}

func (UDPPacket) String 

func (packet UDPPacket) String() string

type UDPSender 

type UDPSender interface {
	Send([]byte) error
	Shutdown() error
}

type UnknownPeersError 

type UnknownPeersError struct {
}

func (UnknownPeersError) Error 

func (upe UnknownPeersError) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.