Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/landhb/portal
A Secure file transfer utility & library. The library utilizes SPAKE2 for key negotiation over an insecure channel, and ChaCha20Poly1305 Authenticated Encryption to encrypt the file with the derived shared symmetric key. This enables two peers to transfer a file over any channel without needing to trust the intermediary relay.
https://github.com/landhb/portal
chacha20-poly1305 file-sharing file-transfer rust spake2 wormhole
Last synced: 3 months ago
JSON representation
A Secure file transfer utility & library. The library utilizes SPAKE2 for key negotiation over an insecure channel, and ChaCha20Poly1305 Authenticated Encryption to encrypt the file with the derived shared symmetric key. This enables two peers to transfer a file over any channel without needing to trust the intermediary relay.
- Host: GitHub
- URL: https://github.com/landhb/portal
- Owner: landhb
- License: apache-2.0
- Created: 2020-09-18T20:49:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-14T23:36:07.000Z (over 1 year ago)
- Last Synced: 2024-10-13T08:27:33.719Z (4 months ago)
- Topics: chacha20-poly1305, file-sharing, file-transfer, rust, spake2, wormhole
- Language: Rust
- Homepage:
- Size: 1.84 MB
- Stars: 22
- Watchers: 6
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
## Portal
[![cargo-badge-lib][]][cargo-lib] [![docs-badge-lib][]][docs-lib] [![license-badge][]][license] [![rust-version-badge][]][rust-version] [![build][]][build-url] [![codecov][]][codecov-url]
Securely & quickly transport your files.
### Client Install
[![cargo-badge-client][]][cargo-client]
The client binary can be installed via Cargo:
```
cargo install portal-client
```
On the first run, a configuration file will be created in:
|Platform | Value | Example |
| ------- | ------------------------------------- | ---------------------------------------- |
| Linux | `$XDG_CONFIG_HOME` or `$HOME`/.config | /home/alice/.config/portal |
| macOS | `$HOME`/Library/Application Support | /Users/Alice/Library/Application Support/portal |
| Windows | `{FOLDERID_RoamingAppData}` | C:\Users\Alice\AppData\Roaming\portal |
Note: The default relay is `portal-relay.landhb.dev`. Your peer must connect to the same portal-relay as you. You can also host your own relay and change the value to any domain/IP address in your config.
To send a file:
```bash
portal send /path/to/file
```
To receive a file:
```bash
portal recv
```
### Relay Install
[![cargo-badge-relay][]][cargo-relay]
If you wish to run your own relay, you can install the binary on a server with:
```
cargo install portal-relay
```
Note: An example service file is included in the `relay/` directory.
### Development:
The repo is a cargo workspace with the following directory structure:
```
lib/ # implementation of the protocol
relay/ # relay server source
client/ # client source
```
You can run the binaries individually with:
```
# window 1
cargo run --bin portal-relay
# window 2
cargo run --bin portal -- recv
# window 3
cargo run --bin portal -- send [FILE]
```
### Acknowledgements:
This tool was a quick early pandemic project to learn rust, and has similar ideas/functionality to Wormhole written by [Brian Warner](https://github.com/warner), he actually also contributed a large amount to the [RustCrypto project's SPAKE2 implementation](https://github.com/RustCrypto/PAKEs/tree/master/spake2) that Portal uses.
[//]: # (badges)
[license-badge]: https://img.shields.io/badge/license-MIT/Apache--2.0-lightgray.svg?style=flat-square
[license]: #license
[rust-version-badge]: https://img.shields.io/badge/rust-latest%20stable-blue.svg?style=flat-square
[rust-version]: #rust-version-policy
[cargo-badge-relay]: https://img.shields.io/crates/v/portal-relay.svg?style=flat-square&label=portal-relay
[cargo-relay]: https://crates.io/crates/portal-relay
[cargo-badge-client]: https://img.shields.io/crates/v/portal-client.svg?style=flat-square&label=portal-client
[cargo-client]: https://crates.io/crates/portal-client
[cargo-badge-lib]: https://img.shields.io/crates/v/portal-lib.svg?style=flat-square&label=portal-lib
[cargo-lib]: https://crates.io/crates/portal-lib
[docs-badge-client]: https://docs.rs/portal-client/badge.svg?style=flat-square
[docs-client]: https://docs.rs/portal-client
[docs-badge-lib]: https://docs.rs/portal-lib/badge.svg?style=flat-square
[docs-lib]: https://docs.rs/portal-lib
[codecov]: https://img.shields.io/codecov/c/github/landhb/portal?style=flat-square
[codecov-url]: https://codecov.io/gh/landhb/portal
[build]: https://img.shields.io/github/actions/workflow/status/landhb/portal/build.yml?branch=main&style=flat-square
[build-url]: https://github.com/landhb/portal/actions?query=workflow%3ABuild