aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 546550cd27e7cc9abb22169490edf4396e6561d8 (plain)
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
# lockchain

A modern, cross-platform and extendable secrets manager.

## To own the libs

This library ecosystem is made of three main parts.

 - `lockchain-core` Common types shared between both `secret` and `default` operation modes.
 - `lockchain-files` load vaults, decode files and work with encrypted streams.
 - `lockchain-crypto` attach crypto handlers to vaults as a middleware to decrypt data.

This enables a few different configurations.

- `lockchain-server` uses `lockchain-core` and `lockchain-files` to serve encrypted files to various front-ends (maybe even on the same machine)
- `lockchain-client` uses `lockchain-core` and `lockchain-crypto` to decrypt received data from a server and use it in a front-end application.

Additionally there is `lockchain-http` which provides an easy to use RESTful API to use for browser extentions or client-side logic which can't rely on local cryptography. 

**There are some graphical representations below**

![](./assets/lockchain-simple.png)

---

**A full application stack**

![](./assets/lockchain-complete.png)


## Security notice

The cryptography in this crate has not undergone any formal review or verification. While stability and data integrity can be thoroughly tested, the security of this crate can not be guaranteed. **Use it at your own risk!**