History

Oliver Gugger 02267565fe multi: unify code blocks in READMEs		2021-01-22 09:14:11 +01:00
..
conn.go	brontide: fix typo	2020-12-04 23:07:53 +08:00
listener.go	brontide: fix typo	2020-12-04 23:07:53 +08:00
noise_test.go	brontide test: fix go 1.15 vet check	2020-09-24 11:20:48 +02:00
noise.go	brontide: fix typo	2020-12-04 23:07:53 +08:00
README.md	multi: unify code blocks in READMEs	2021-01-22 09:14:11 +01: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