horcrux/README.md

62 lines
2.6 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-05 06:21:54 +01:00
![](https://i.imgur.com/TijN4YP.png)
2020-01-02 08:04:23 +01:00
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
```
2020-01-03 06:57:54 +01:00
and it will prompt me for how many horcruxes I want, and how many will be needed to resurrect the original file. For example I might want 5 horcruxes with the ability to resurrect the file if I have any 3. The horcrux files will be created like so:
2020-01-02 07:49:52 +01:00
```
diary_1_of_5.horcrux
diary_2_of_5.horcrux
...
```
2020-01-02 08:20:08 +01:00
Now you just need to disperse the horcruxes around the house on various USBs or online locations and hope you can recall where they all are!
2020-01-02 07:49:52 +01:00
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
```
2020-01-02 08:13:56 +01:00
via [binary release](https://github.com/jesseduffield/horcrux/releases)
2020-01-02 08:13:13 +01:00
2020-01-02 07:50:07 +01:00
## Who this is for:
2020-01-03 06:57:54 +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 their horcruxes)
* People who want to transmit files across multiple channels to substantially reduce the ability for an attacker to intercept
2020-01-02 07:49:52 +01:00
* People named Tom Riddle
2020-01-03 06:57:54 +01:00
## FAQ
Q) This isn't really in line with how horcruxes work in the harry potter universe!
A) It's pretty close! You can't allow any one horcrux to be used to resurrect the original file (and why would you that would be useless) but you can allow two horcruxes to do it (so only off by one). Checkmate HP fans.
Q) How does this work?
2020-07-19 07:40:47 +02:00
A) This uses the [Shamir Secret Sharing Scheme](https://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing) to break an encryption key into parts that can be recombined to create the original key, but only requiring a certain threshold to do so. I've adapted Hashicorp's implementation from their [vault repo](https://github.com/hashicorp/vault)
2020-01-03 06:57:54 +01:00
## Alternatives
2020-07-19 07:40:47 +02:00
* [ssss](http://point-at-infinity.org/ssss/). Works for keys but (as far as I know) not files themselves.
* [horcrux](https://github.com/kndyry/horcrux). Looks like somebody beat me to both the name and concept, however this repo doesn't support thresholds of horcruxes
* [Haystack](https://github.com/henrysdev/Haystack). Implements another file sharding and reassembly algorithm inspired by SSSS, but requires a password for reassembly and does not support thresholds of horcruxes.