github.com/decred/dcrlnd@v0.7.6/brontide/README.md (about)

     1  brontide
     2  ==========
     3  
     4  [![Build Status](http://img.shields.io/travis/decred/dcrlnd.svg)](https://travis-ci.org/decred/dcrlnd) 
     5  [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/decred/dcrlnd/blob/master/LICENSE)
     6  [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/decred/dcrlnd/brontide)
     7  
     8  The brontide package implements a secure crypto messaging protocol based off of
     9  the [Noise Protocol Framework](http://noiseprotocol.org/noise.html). The
    10  package exposes the raw state machine that handles the handshake and subsequent
    11  message encryption/decryption scheme. Additionally, the package exposes a
    12  [net.Conn](https://golang.org/pkg/net/#Conn) and a
    13  [net.Listener](https://golang.org/pkg/net/#Listener) interface implementation
    14  which allows the encrypted transport to be seamlessly integrated into a
    15  codebase.
    16  
    17  The secure messaging scheme implemented within this package is described in
    18  detail in [BOLT #8 of the Lightning Network specifications](https://github.com/lightningnetwork/lightning-rfc/blob/master/08-transport.md).
    19  
    20  This package has intentionally been designed so it can be used as a standalone
    21  package for any projects needing secure encrypted+authenticated communications
    22  between network enabled programs.
    23  
    24  ## Installation and Updating
    25  
    26  ```bash
    27  $ go get -u github.com/decred/dcrlnd/brontide
    28  ```