https://github.com/skystar-p/hako
Simple file sharing with client-side encryption, powered by Rust and WebAssembly
https://github.com/skystar-p/hako
client-side-encryption encryption rust webassembly
Last synced: 11 months ago
JSON representation
Simple file sharing with client-side encryption, powered by Rust and WebAssembly
- Host: GitHub
- URL: https://github.com/skystar-p/hako
- Owner: skystar-p
- License: gpl-3.0
- Created: 2021-10-02T12:46:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T06:32:28.000Z (over 1 year ago)
- Last Synced: 2025-04-23T15:03:03.824Z (about 1 year ago)
- Topics: client-side-encryption, encryption, rust, webassembly
- Language: Rust
- Homepage: https://hako.skystar.dev
- Size: 247 KB
- Stars: 32
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hako
Simple file sharing with client-side encryption, powered by Rust and WebAssembly
Not feature-packed, but basic functionalities are just working. Feature requests and PR are very welcome.
## Features
* No external database setup and file-serving proxy needed. (Hako uses SQLite and bundles all frontend assets in its binary)
* Handy file sharing
* Handy text-snippet sharing
* Client-side encryption using `XChacha20Poly1305`
* Fast and safe implementations thanks to [Rust](https://www.rust-lang.org/)
* Neat Web UI built with WebAssembly
* Asynchronous upload, encryption, download, and decryption on your browser.
## Why?
Sharing file safely between two devices is quite annoying. Hardware mediums(like USB flash memory) can be useful, but sharing file between mobile devices or different operating systems are frustrating.
You can go with third-party file hosting server or E-mail, but those are not safe and not good for your privacy.
Hako is web application, which gives you great compatibility among various devices and operating systems. Also, Hako uses client-side encryption, so no one can see your original file, even the Hako server.
## Build
For simplicity, Hako bundles frontend dist files into server binary statically. So you **MUST** build frontend web application first, and then build server application.
### Frontend
You need two additional tools: [`trunk`](https://trunkrs.dev/) and [`tailwindcss`](https://tailwindcss.com/).
```sh
# To install trunk, use:
cargo install --locked trunk
# To install tailwindcss, use:
yarn global add tailwindcss
```
And build your WASM application.
```sh
cd ./webapp
rm -rf dist
trunk build --release
```
### Server
You need `cargo` to build server. If you don't have it, follow the instructions in [here](https://www.rust-lang.org/tools/install).
```sh
cd ./server
cargo build --release
```
Hako uses simple SQLite database to store your encrypted files and metadata. So no external database setting is required, but you may give database file path by argument or environment variable. See [here](https://github.com/skystar-p/hako/blob/b8bed17019232452d8ca98ff9a0ae20521af02e1/server/src/config.rs#L9).
## Run
Serving Hako application is dead simple. No additional file-serving proxy and external database setup is needed. Just run your Hako server binary behind of HTTP proxy to take advantage of TLS.
You can check configuration info by running:
```sh
./hako --help
```
Running Hako application is just simple as:
```sh
./hako
# ... and open http://localhost:12321/ on your browser.
```
If you want to serve Hako in public, serving behind of reverse-proxy with TLS is strongly recommended.
You can use [Caddy](https://caddyserver.com/) for easy TLS configuration. Example Caddy configuration:
```
your-domain.com {
handle * {
reverse_proxy localhost:12321
}
}
```
## To-dos
* Authentication
* WebAuthn
* or just plain username-password pair
* CLI tool
* WASM can provide compatibility among various environment, and CLI downloader will provide good performance