mirror of https://github.com/chipsenkbeil/distant
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
81 lines
2.8 KiB
Markdown
81 lines
2.8 KiB
Markdown
# distant core
|
|
|
|
[![Crates.io][distant_crates_img]][distant_crates_lnk] [![Docs.rs][distant_doc_img]][distant_doc_lnk] [![Rustc 1.51.0][distant_rustc_img]][distant_rustc_lnk]
|
|
|
|
[distant_crates_img]: https://img.shields.io/crates/v/distant-core.svg
|
|
[distant_crates_lnk]: https://crates.io/crates/distant-core
|
|
[distant_doc_img]: https://docs.rs/distant-core/badge.svg
|
|
[distant_doc_lnk]: https://docs.rs/distant-core
|
|
[distant_rustc_img]: https://img.shields.io/badge/distant_core-rustc_1.51+-lightgray.svg
|
|
[distant_rustc_lnk]: https://blog.rust-lang.org/2021/03/25/Rust-1.51.0.html
|
|
|
|
Library that powers the [`distant`](https://github.com/chipsenkbeil/distant)
|
|
binary.
|
|
|
|
🚧 **(Alpha stage software) This library is in rapid development and may break or change frequently!** 🚧
|
|
|
|
## Details
|
|
|
|
The `distant` library supplies a mixture of functionality and data to run
|
|
servers that operate on remote machines and clients that talk to them.
|
|
|
|
- Asynchronous in nature, powered by [`tokio`](https://tokio.rs/)
|
|
- Data is serialized to send across the wire via [`CBOR`](https://cbor.io/)
|
|
- Encryption & authentication are handled via
|
|
[XChaCha20Poly1305](https://tools.ietf.org/html/rfc8439) for an authenticated
|
|
encryption scheme via
|
|
[RustCrypto/ChaCha20Poly1305](https://github.com/RustCrypto/AEADs/tree/master/chacha20poly1305)
|
|
|
|
## Installation
|
|
|
|
You can import the dependency by adding the following to your `Cargo.toml`:
|
|
|
|
```toml
|
|
[dependencies]
|
|
distant-core = "0.16"
|
|
```
|
|
|
|
## Features
|
|
|
|
Currently, the library supports the following features:
|
|
|
|
- `structopt`: generates [`StructOpt`](https://github.com/TeXitoi/structopt)
|
|
bindings for `RequestData` (used by cli to expose request actions)
|
|
|
|
By default, no features are enabled on the library.
|
|
|
|
## Examples
|
|
|
|
Below is an example of connecting to a distant server over TCP:
|
|
|
|
```rust
|
|
use distant_core::{Session, SessionChannelExt, SecretKey32, XChaCha20Poly1305Codec};
|
|
use std::net::SocketAddr;
|
|
|
|
// 32-byte secret key paresd from hex, used for a specific codec
|
|
let key: SecretKey32 = "DEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEF".parse().unwrap();
|
|
let codec = XChaCha20Poly1305Codec::from(key);
|
|
|
|
let addr: SocketAddr = "example.com:8080".parse().unwrap();
|
|
let mut session = Session::tcp_connect(addr, codec).await.unwrap();
|
|
|
|
// Append text to a file, representing request as <tenant>
|
|
// NOTE: This method comes from SessionChannelExt
|
|
session.append_file_text(
|
|
"<tenant>",
|
|
"path/to/file.txt".to_string(),
|
|
"new contents"
|
|
).await.expect("Failed to append to file");
|
|
```
|
|
|
|
## License
|
|
|
|
This project is licensed under either of
|
|
|
|
Apache License, Version 2.0, (LICENSE-APACHE or
|
|
[apache-license][apache-license]) MIT license (LICENSE-MIT or
|
|
[mit-license][mit-license]) at your option.
|
|
|
|
[apache-license]: http://www.apache.org/licenses/LICENSE-2.0
|
|
[mit-license]: http://opensource.org/licenses/MIT
|