https://github.com/geolffreym/p2p-noise
Peer to Peer Library based on Noise Secure Handshake
https://github.com/geolffreym/p2p-noise
go golang
Last synced: about 2 months ago
JSON representation
Peer to Peer Library based on Noise Secure Handshake
- Host: GitHub
- URL: https://github.com/geolffreym/p2p-noise
- Owner: geolffreym
- License: agpl-3.0
- Created: 2022-04-19T19:20:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T13:47:59.000Z (about 1 year ago)
- Last Synced: 2025-03-29T07:33:52.361Z (3 months ago)
- Topics: go, golang
- Language: Go
- Homepage:
- Size: 6.33 MB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# P2P Noise
[](https://github.com/geolffreym/p2p-noise/actions/workflows/go.yml)
[](https://pkg.go.dev/github.com/geolffreym/p2p-noise)
[](https://goreportcard.com/report/github.com/geolffreym/p2p-noise)
[](https://codecov.io/gh/geolffreym/p2p-noise)
P2P Noise library aims to serve as a tool to create secure P2P networks based on the Noise Framework.
* Small and secure.
* Simplistic and lightweight.
* Quick creation of custom P2P networks.
* Modern Crypto Stack:
* [Blake2 Hash](https://www.blake2.net/)
* [ED25519 Signature](https://ed25519.cr.yp.to/)
* [ChaCha20-Poly1305 Cypher]( https://en.wikipedia.org/wiki/ChaCha20-Poly1305)
* [Diffie-Hellman Curve25519 Key Exchange](https://en.wikipedia.org/wiki/Curve25519)
## Features
> [Noise Secure Handshake](http://www.noiseprotocol.org/):
Noise is a framework for building crypto protocols. Noise protocols support mutual and optional authentication, identity hiding, forward secrecy, zero round-trip encryption, and other advanced features.
> [Adaptive Lookup for Unstructured Peer-to-Peer Overlays](https://arxiv.org/pdf/1509.04417.pdf):
Most of the unstructured peer-to-peer overlays do not provide any performance guarantee. "Adaptive Lookup" propose a novel Quality of Service enabled lookup for unstructured peer-to-peer overlays that will allow the user’s query to traverse only those overlay links which satisfy the given constraints.
## Install
```
go get github.com/geolffreym/p2p-noise
```
## Basic usage
```package main
import (
noise "github.com/geolffreym/p2p-noise"
"github.com/geolffreym/p2p-noise/config"
)
func main() {
// Create configuration from params and write in configuration reference
configuration := config.New()
configuration.Write(
config.SetMaxPeersConnected(10),
config.SetPeerDeadline(1800),
)
// Node factory
node := noise.New(configuration)
// Network events channel
signals, cancel := node.Signals()
go func() {
for signal := range signals {
// Here could be handled events
if signal.Type() == noise.NewPeerDetected {
cancel()
}
}
}()
// ... some code here
// node.Dial("192.168.1.1:4008")
// node.Close()
// ... more code here
node.Listen()
}
```
## Benchmarking
### Handshake Benchmark
Using [perflock](https://github.com/aclements/perflock) to prevent our benchmarks from using too much CPU at once.
```text
perflock -governor=80% go test -benchmem -run=^$ -benchtime 1s -bench=. -cpu 1,2,4,8 -count=1
goos: linux
goarch: amd64
pkg: github.com/geolffreym/p2p-noise
cpu: Intel(R) Xeon(R) CPU E3-1505M v5 @ 2.80GHz
BenchmarkHandshakeProfile 726 1575256 ns/op 46959 B/op 363 allocs/op
BenchmarkHandshakeProfile-2 1548 1037351 ns/op 47100 B/op 364 allocs/op
BenchmarkHandshakeProfile-4 2460 908573 ns/op 49885 B/op 383 allocs/op
BenchmarkHandshakeProfile-8 2127 736442 ns/op 60454 B/op 457 allocs/op
BenchmarkNodesSecureMessageExchange 29032570 35.03 ns/op 0 B/op 0 allocs/op
BenchmarkNodesSecureMessageExchange-2 59745247 16.78 ns/op 0 B/op 0 allocs/op
BenchmarkNodesSecureMessageExchange-4 124446950 9.454 ns/op 0 B/op 0 allocs/op
BenchmarkNodesSecureMessageExchange-8 151214516 7.088 ns/op 0 B/op 0 allocs/op
PASS
ok github.com/geolffreym/p2p-noise 18.865s
```
## Development
Some available capabilities for dev support:
* **Run Tests**: `make test`
* **Build**: `make build`
* **Test Coverage**: `make coverage`
* **Benchmark**: `make benchmark`
* **Profiling**: `make profiling`
* **Code check**: `make check`
* **Code format**: `make format`
* **Flush cache**: `make clean`
* **Build**: `make build`
Note: Run `make help` to check for more capabilities.
## More info
* Chat with us joining to our [matrix room](https://matrix.to/#/!XgrTEPPGsKCPvdtDeC:matrix.org?via=matrix.org).
* [Examples](https://github.com/geolffreym/p2p-noise/examples) directory contains advanced examples of usage.
* For help or bugs please [create an issue](https://github.com/geolffreym/p2p-noise/issues).