https://github.com/swift-libp2p/swift-libp2p-noise
A LibP2P Stream Security protocol
https://github.com/swift-libp2p/swift-libp2p-noise
libp2p libp2p-security swift
Last synced: 30 days ago
JSON representation
A LibP2P Stream Security protocol
- Host: GitHub
- URL: https://github.com/swift-libp2p/swift-libp2p-noise
- Owner: swift-libp2p
- License: mit
- Created: 2022-05-02T07:38:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-06T22:14:28.000Z (3 months ago)
- Last Synced: 2025-03-31T16:24:28.674Z (2 months ago)
- Topics: libp2p, libp2p-security, swift
- Language: Swift
- Homepage:
- Size: 55.7 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LibP2PNoise
[](https://breth.app)
[](http://libp2p.io/)
[](https://github.com/apple/swift-package-manager)
> A LibP2P Stream Security protocol
## Table of Contents
- [Overview](#overview)
- [Install](#install)
- [Usage](#usage)
- [Example](#example)
- [API](#api)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Overview
Noise is a connection security protocol. It provides a secure transport channel for swift-libp2p based on the Noise Protocol Framework. Following an initial plaintext handshake, all data exchanged between peers using swift-libp2p-noise is encrypted and protected from eavesdropping.
### ⚠️ Warning
This package has **NOT** been extensively tested in real world applications and **should NOT be used in production environments**. Although the actual cryptography is handled by swift-crypto, the handshake logic could, and probably does, contain a myriad of bugs. Please feel free to look over the code and submit improvements where you see fit.
#### Note:
- For more information check out the [LibP2P Noise Spec](https://github.com/libp2p/specs/tree/master/noise)
- For more information check out the [Noise Protocol Spec](https://noiseprotocol.org/noise.html)
## Install
Include the following dependency in your Package.swift file
``` swift
let package = Package(
...
dependencies: [
...
.package(name: "LibP2PNoise", url: "https://github.com/swift-libp2p/swift-libp2p-noise.git", .upToNextMajor(from: "0.1.0"))
],
...
.target(
...
dependencies: [
...
.product(name: "LibP2PNoise", package: "swift-libp2p-noise"),
]),
...
)
```
## Usage
### Example
``` swift
import LibP2PNoise
/// Tell libp2p that it can use noise to secure connections...
app.security.use( .noise )
```
### API
``` swift
Not Applicable
```
## Contributing
Contributions are welcomed! This code is very much a proof of concept. I can guarantee you there's a better / safer way to accomplish the same results. Any suggestions, improvements, or even just critiques, are welcome!
Let's make this code better together! 🤝
## Credits
- [LibP2P Noise Spec](https://github.com/libp2p/specs/tree/master/noise)
## License
[MIT](LICENSE) © 2022 Breth Inc.