horcrux/README.md

51 lines
1.5 KiB
Markdown
Raw Normal View History

2020-01-02 07:39:02 +01:00
# horcrux
Split your file into encrypted horcruxes so that you don't need to remember a passcode
2020-01-02 07:49:52 +01:00
2020-01-02 08:04:23 +01:00
![](https://i.imgur.com/k48QVkF.png)
2020-01-02 07:50:07 +01:00
## How it works
2020-01-02 07:49:52 +01:00
`horcrux` has two commands, `split` and `bind`.
2020-01-02 07:50:07 +01:00
### Splitting
2020-01-02 07:49:52 +01:00
If I have a file called `diary.txt` in my current directory I can call
```
horcrux split diary.txt
```
and it will prompt me for how many horcruxes I want. If I want 5 horcruxes, it will encrypt my `diary.txt` file with 5 different secret keys, and then split the encrypted result into 5 equal parts to be stored in `.horcrux` files along with the 5 secret keys. This means that you will need all five horcruxes to put the thing back together again and decrypt it. The horcrux files will be created like so:
```
diary_1_of_5.horcrux
diary_2_of_5.horcrux
...
```
2020-01-02 07:50:07 +01:00
### Binding
2020-01-02 07:49:52 +01:00
To bind the horcruxes back into the original file just call
```
horcrux bind
```
in the directory containing the horcruxes (or pass the directory as an argument).
2020-01-02 08:13:13 +01:00
## Installation
via homebrew:
```
brew install jesseduffield/horcrux/horcrux
```
via binary release
```
```
2020-01-02 07:50:07 +01:00
## Who this is for:
2020-01-02 07:49:52 +01:00
* People who need to encrypt a big sensitive file like a diary and don't expect to remember any passwords years from now (but who paradoxically will be capable of remembering where they've hidden each horcrux)
* People named Tom Riddle
I have no idea if this program actually has practical use but it's a fun concept that I wanted to implement.
2020-01-02 07:55:35 +01:00
I am aware this isn't quite 1:1 with how horcruxes work in the Harry Potter universe but I think it's close enough.