@@ -5,6 +5,9 @@ passwords/passphrases. Uses [Protocol Buffers] for the serialization of the
5
5
encryption metadata (salts, nonces, etc.) and is based on the [ ring] Rust crate
6
6
for the cryptographic primitives.
7
7
8
+ [ ![ Crates.io] ( https://img.shields.io/crates/v/tindercrypt.svg )] ( https://crates.io/crates/tindercrypt )
9
+ [ ![ Docs.rs] ( https://docs.rs/tindercrypt/badge.svg )] ( https://docs.rs/tindercrypt )
10
+
8
11
## Overview
9
12
10
13
Tindercrypt's main goal is to provide a safe and easy API for data
@@ -29,6 +32,8 @@ Features:
29
32
* Offers a simple, multi-platform CLI tool that encrypts files with a
30
33
passphrase.
31
34
35
+ For a design overview, see the docs section on [ Tindercrypt metadata] .
36
+
32
37
## Examples
33
38
34
39
You can encrypt (seal) a data buffer with a passphrase as follows:
@@ -45,6 +50,8 @@ let plaintext2 = cryptor.open(pass, &ciphertext)?;
45
50
assert_eq! (plaintext2 , plaintext );
46
51
```
47
52
53
+ You can find more examples in the docs section on [ Tindercrypt's ` RingCryptor ` ] .
54
+
48
55
The equivalent operation in the CLI tool is the following:
49
56
50
57
```
@@ -55,8 +62,15 @@ $ tindercrypt decrypt -i ciphertext
55
62
The cake is a lie
56
63
```
57
64
65
+ ## Documentation
66
+
67
+ You can read the latest docs in https://docs.rs/tindercrypt .
68
+
58
69
## Installation
59
70
71
+ You can run Tindercrypt using one of the binaries in the [ Releases page] of this
72
+ repo. Alternatively, you can install it with one of the following methods:
73
+
60
74
* From cargo:
61
75
62
76
```
@@ -94,15 +108,17 @@ Finally, read the [`NOTICE.md`] file for the legal status of the project.
94
108
Licensed under MPL-2.0. Please read the [ ` NOTICE.md ` ] and [ ` LICENSE ` ] files for
95
109
the full copyright and license information. If you feel like putting your
96
110
mental stability to a test, feel free to read the [ ` LEGAL.md ` ] file for a foray
97
- into the waters of copyright law, and a glimpse of how they can be boring and
98
- dangerous at the same time.
111
+ into the waters of copyright law, and a glimpse of how they can be both boring
112
+ and dangerous at the same time.
99
113
100
114
[ ring ] : https://github.com/briansmith/ring
101
- <!-- [protobuf]: https://github.com/stepancheg/rust-protobuf-->
102
115
[ Protocol Buffers ] : https://developers.google.com/protocol-buffers/
103
116
[ PBKDF2 ] : https://en.wikipedia.org/wiki/PBKDF2
104
117
[ AES256-GCM ] : https://en.wikipedia.org/wiki/Galois/Counter_Mode
105
118
[ ChaCha20-Poly1305 ] : https://tools.ietf.org/html/rfc7539
119
+ [ Tindercrypt metadata ] : https://docs.rs/tindercrypt/latest/tindercrypt/metadata/index.html
120
+ [ Tindercrypt's `RingCryptor` ] : https://docs.rs/tindercrypt/latest/tindercrypt/cryptors/struct.RingCryptor.html
121
+ [ Releases page ] : https://github.com/apyrgio/tindercrypt/releases
106
122
[ `prototool` ] : https://github.com/uber/prototool
107
123
[ `NOTICE.md` ] : /NOTICE.md
108
124
[ `LICENSE` ] : /LICENSE
0 commit comments