aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 8790efda89e710d27b2358405f25c9e32b85adb3 (plain) (blame)
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
Tweetpipe
=======

A fork of the dum^H^H^Hsimplest encryption tool in the world,
[encpipe](https://github.com/jedisct1/encpipe), but with the crypto replaced by
tweetnacl. Password hashing is implemented by a custom tweet-like version of
pbkdf2hmacsha512.

# Usage

Encrypt a file using a password:

```sh
tweetpipe -e -p password -i inputfile -o outputfile
```

Decrypt a file using a password:

```sh
tweetpipe -d -p password -i inputfile -o outputfile
```

`-i` and `-o` can be set to `-` or omitted to read/write from the
standard input/output.

`-P password_file` can be used to read the password, or an arbitrary
long key (that doesn't have to be text) from a file.

If you don't feel inspired, `-G` prints a random password.

Example - encrypted file transfer:

```sh
nc -l 6666 | tweetpipe -d -p password
tweetpipe -e -p password -i /etc/passwd | nc 127.0.0.1 6666
```

Example - compressed, encrypted archives:

```sh
zstd -5 -v -c "$FILE" | tweetpipe -e -p "$PASSWD" -o "${FILE}.zst.tweetpipe"
```

# Dependencies

None. It includes [tweetnacl](https://tweetnacl.cr.yp.to/). There is nothing to
install.

# Installation

```sh
make
sudo make install
```

# Why

Because I could.