niaucchi4

package
v0.22.5 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2020 License: GPL-3.0 Imports: 31 Imported by: 0

README

niaucchi4: the 3rd generation Geph obfuscation protocol

Architecture

Unlike previous iterations, niaucchi4 presents an unreliable transport to upper layers. This allows it to work around environments where TCP sessions are unreliable (mobile network switching etc), letting hours-long upper-layer sessions become practical. It can also use multiple UDP sessions, automatically converging on the best path.

[Authentication, encryption]
[        niaucchi4         ]
[  UDP  ][  UDP   ][  UDP  ]

Like previous versions, though, intermediate hosts are still identified by host:port and cookie.

Opening a tunnel

To open a new tunnel the client sends the intermediary a packet like the following from a fresh source port:

[32-byte nonce][encrypted pubkey || rhost:rport][arbitrary garbage]

The ed25519 pubkey can either be encrypted with chacha20-poly1305 or aes256-gcm. In either case the encryption nonce is null, the tag precedes the ciphertext, and the key is HMAC-SHA256(cookie, nonce).

The server should respond with a similar message. A shared secret sharedsec is derived.

Tunnel wire format

The tunnel wire format is simply RLP:

[body padding]

encrypted with HMAC-SHA256(sharedsec, "up") or "down" depending on the direction. Undecodeable packets should be silently discarded and can be used as padding.

An empty-padding packet is to be considered a ping packet, and should be returned to the sender unchanged. This allows measuring latency. Ping packets should be created at a randomly sampled size.

Rekeying

Every 2^16 packets we send, we rekey by setting sharedsec = SHA256(sharedsec) and recompute the sending key. This ensures that we can safely use AEADs with short nonces. When receivers get an undecryptable packet, they try to decode it with the "next" key too.

What does the intermediary do

The intermediary keeps a NAT-like table of incoming tunnels by host:port of the client, mapping them to tunnel state structures and outgoing UDP sockets. The tunnels are cleared only under memory pressure and should not be timed out unless absolutely necessary.

End-to-end wire format

The end-to-end format is simply a 64-bit sessid and then the body.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DialKCP added in v0.12.0 

func DialKCP(addr string, cookie []byte) (conn net.Conn, err error)

DialKCP dials KCP over obfs in one function.

Types

type E2EConn added in v0.13.0 

type E2EConn struct {
	Closed bool
	// contains filtered or unexported fields
}

E2EConn is a PacketConn implementing the E2E protocol.

func NewE2EConn added in v0.13.0 

func NewE2EConn(wire net.PacketConn) *E2EConn

NewE2EConn creates a new e2e connection.

func (*E2EConn) Close added in v0.13.0 

func (e2e *E2EConn) Close() error

Close closes the underlying socket.

func (*E2EConn) DebugInfo added in v0.13.0 

func (e2e *E2EConn) DebugInfo() [][]LinkInfo

func (*E2EConn) LocalAddr added in v0.13.0 

func (e2e *E2EConn) LocalAddr() net.Addr

LocalAddr returns the local address.

func (*E2EConn) ReadFrom added in v0.13.0 

func (e2e *E2EConn) ReadFrom(p []byte) (n int, from net.Addr, err error)

ReadFrom implements PacketConn.

func (*E2EConn) SetDeadline added in v0.13.0 

func (e2e *E2EConn) SetDeadline(t time.Time) error

SetDeadline lala

func (*E2EConn) SetReadDeadline added in v0.13.0 

func (e2e *E2EConn) SetReadDeadline(t time.Time) error

SetReadDeadline lala

func (*E2EConn) SetSessPath added in v0.13.0 

func (e2e *E2EConn) SetSessPath(sid SessionAddr, host net.Addr)

SetSessPath is used by clients to have certain sessions go along certain paths.

func (*E2EConn) SetWriteDeadline added in v0.13.0 

func (e2e *E2EConn) SetWriteDeadline(t time.Time) error

SetWriteDeadline lala

func (*E2EConn) UnderlyingLoss added in v0.18.0 

func (e2e *E2EConn) UnderlyingLoss(destAddr net.Addr) (frac float64)

UnderlyingLoss returns the underlying loss.

func (*E2EConn) WriteTo added in v0.13.0 

func (e2e *E2EConn) WriteTo(p []byte, addr net.Addr) (n int, err error)

WriteTo implements PacketConn.

type KCPListener added in v0.12.0 

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

KCPListener operates KCP over obfs. Standard caveats about KCP not having proper open and close signaling apply.

func ListenKCP added in v0.12.0 

func ListenKCP(sock net.PacketConn) *KCPListener

ListenKCP creates a new listener.

func (*KCPListener) Accept added in v0.12.0 

func (l *KCPListener) Accept() (c *kcp.UDPSession, err error)

Accept accepts a new connection.

func (*KCPListener) Close added in v0.17.0 

func (l *KCPListener) Close() error

Close closes the thing.

type LinkInfo added in v0.14.0 

type LinkInfo struct {
	RemoteIP      string
	RecvCnt       int
	Ping          int
	LossPct       float64
	RecentLossPct float64
	Score         float64
}

LinkInfo describes info for a link.

type ObfsSocket 

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

ObfsSocket represents an obfuscated PacketConn.

func ObfsListen 

func ObfsListen(cookie []byte, wire net.PacketConn, replayProtection bool) *ObfsSocket

ObfsListen opens a new obfuscated PacketConn.

func (*ObfsSocket) AddCookieException added in v0.17.0 

func (os *ObfsSocket) AddCookieException(addr net.Addr, cookie []byte)

AddCookieException adds a cookie exception to a particular destination.

func (*ObfsSocket) Close 

func (os *ObfsSocket) Close() error

func (*ObfsSocket) LocalAddr 

func (os *ObfsSocket) LocalAddr() net.Addr

func (*ObfsSocket) ReadFrom 

func (os *ObfsSocket) ReadFrom(b []byte) (n int, addr net.Addr, err error)

func (*ObfsSocket) SetDeadline 

func (os *ObfsSocket) SetDeadline(t time.Time) error

func (*ObfsSocket) SetReadDeadline 

func (os *ObfsSocket) SetReadDeadline(t time.Time) error

func (*ObfsSocket) SetWriteDeadline 

func (os *ObfsSocket) SetWriteDeadline(t time.Time) error

func (*ObfsSocket) WriteTo 

func (os *ObfsSocket) WriteTo(b []byte, addr net.Addr) (int, error)

type ObfsStream added in v0.12.0 

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

func NewObfsStream added in v0.12.0 

func NewObfsStream(wire net.Conn, key []byte, isServ bool) *ObfsStream

func (*ObfsStream) Close added in v0.12.0 

func (os *ObfsStream) Close() error

func (*ObfsStream) LocalAddr added in v0.12.0 

func (os *ObfsStream) LocalAddr() net.Addr

func (*ObfsStream) Read added in v0.12.0 

func (os *ObfsStream) Read(p []byte) (n int, err error)

func (*ObfsStream) RemoteAddr added in v0.12.0 

func (os *ObfsStream) RemoteAddr() net.Addr

func (*ObfsStream) SetDeadline added in v0.12.0 

func (os *ObfsStream) SetDeadline(t time.Time) error

func (*ObfsStream) SetReadDeadline added in v0.12.0 

func (os *ObfsStream) SetReadDeadline(t time.Time) error

func (*ObfsStream) SetWriteDeadline added in v0.12.0 

func (os *ObfsStream) SetWriteDeadline(t time.Time) error

func (*ObfsStream) Write added in v0.12.0 

func (os *ObfsStream) Write(p []byte) (n int, err error)

type SessionAddr added in v0.13.0 

type SessionAddr [16]byte

SessionAddr is a net.Addr that represents the ultimate counterparty in an e2e session.

func NewSessAddr added in v0.13.0 

func NewSessAddr() SessionAddr

NewSessAddr generates a new random sess addr

func (SessionAddr) Network added in v0.13.0 

func (sa SessionAddr) Network() string

Network fulfills net.Addr

func (SessionAddr) String added in v0.13.0 

func (sa SessionAddr) String() string

type Wrapper 

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

Wrapper is a PacketConn that can be hot-replaced by other PacketConns on I/O failure or manually. It squelches any errors bubbling up.

func Wrap 

func Wrap(getConn func() net.PacketConn) *Wrapper

Wrap creates a new Wrapper instance.

func (*Wrapper) Close 

func (w *Wrapper) Close() error

func (*Wrapper) LocalAddr 

func (w *Wrapper) LocalAddr() net.Addr

func (*Wrapper) ReadFrom 

func (w *Wrapper) ReadFrom(p []byte) (n int, addr net.Addr, err error)

func (*Wrapper) SetDeadline 

func (w *Wrapper) SetDeadline(t time.Time) error

func (*Wrapper) SetReadDeadline 

func (w *Wrapper) SetReadDeadline(t time.Time) error

func (*Wrapper) SetWriteDeadline 

func (w *Wrapper) SetWriteDeadline(t time.Time) error

func (*Wrapper) WriteTo 

func (w *Wrapper) WriteTo(b []byte, addr net.Addr) (int, error)

Source Files

View all Source files

Directories

Path Synopsis

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.