History

Adam Gibson cd7f40422f Fix trivial comment errors in noise.go		2018-01-11 16:49:38 +02:00
..
conn.go	brontide: set read deadlines on socket during initial handshake	2017-10-04 14:58:20 -07:00
listener.go	brontide: set read deadlines on socket during initial handshake	2017-10-04 14:58:20 -07:00
noise_test.go	brontide: within tests, listen on localhost rather than all interfaces	2017-11-01 15:30:57 -07:00
noise.go	Fix trivial comment errors in noise.go	2018-01-11 16:49:38 +02:00
README.md	multi: fix formatting issues in packge README's	2017-03-27 16:25:25 -07:00

README.md

brontide

The brontide package implements a secure crypto messaging protocol based off of the Noise Protocol Framework. The package exposes the raw state machine that handles the handshake and subsequent message encryption/decryption scheme. Additionally, the package exposes a net.Conn and a net.Listener interface implementation which allows the encrypted transport to be seamlessly integrated into a codebase.

The secure messaging scheme implemented within this package is described in detail in BOLT #8 of the Lightning Network specifications.

This package has intentionally been designed so it can be used as a standalone package for any projects needing secure encrypted+authenticated communications between network enabled programs.

Installation and Updating

$ go get -u github.com/lightningnetwork/lnd/brontide