vial-shared 0.1.0

Shared request / response types for Vial
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

<div align="center"><h1>Vial</h1></div>
<div align="center">
<a href="https://wakatime.com/@RustyPickle"><img src="https://wakatime.com/badge/github/TheRustyPickle/Vial.svg" alt="wakatime"></a>
</div>

Vial is a small Rust project for end-to-end encrypted secret sharing.

Secrets are encrypted on the client, sent to a server as ciphertext, and decrypted only by the recipient.
The server never knows the decryption key or the contents of a secret.

The primary tool is a CLI. A web UI is provided as an optional way to view secrets.

## What It Does

- Create encrypted secrets (text or files) using a password or a random key
- Upload encrypted payloads to a server
- Fetch and decrypt secrets locally
- Enforce expiration and view limits on the server
- Self-hostable server or reusable server library

## Workspace Members

| Crate      | Description                                                    |
|------------|------------                                                    |
| [cli](cli)        | CLI binary (secret creation & consumption)              |
| [core](cli)       | Cryptography primitives (encryption / decryption)       |
| [shared](shared)     | Shared request / response types                      |
| [srv-lib](srv-lib)    | Framework-agnostic server logic (DB, rules, limits) |
| [server](server)     | Actix-web server binary using srv-lib                |

## Installation

**1. Run from Source Code:**

- Clone the repository `git clone https://github.com/TheRustyPickle/Vial`
- To run the CLI with Cargo `cargo run --release --bin vial`
- To run the server with Cargo `cargo run --release --bin vial-server`

**2. Run the latest Release:**

- Download the latest executable from [Releases](https://github.com/TheRustyPickle/Vial/releases/latest).
- Unzip the executable and run via terminal

**3. Install using Cargo:**

Coming soon

## Web UI

[A web UI is available](https://rustypickle.onrender.com/) with [source code](https://github.com/TheRustyPickle/My-Site/blob/main/app/src/secrets.rs) and is used as the default URL in the CLI. The site uses the same `srv-lib` and can only perform decryption on the client.

## Project Status & Disclaimer

This project:

- Has not been security audited
- Comes with no guarantees or warranties

Use at your own risk. Do not rely on it for high-value or high-risk secrets.

## License

[MIT License](LICENSE).