Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skewthreads/QR-secret-sharing
:lock: Create QR codes to secret-share a message. Ideal for cryptocurrency wallet recovery keys and passwords.
https://github.com/skewthreads/QR-secret-sharing
qr-code qr-secrets qrcode recovery recovery-key secret-sharing secrets shamir-secret-sharing
Last synced: about 1 month ago
JSON representation
:lock: Create QR codes to secret-share a message. Ideal for cryptocurrency wallet recovery keys and passwords.
- Host: GitHub
- URL: https://github.com/skewthreads/QR-secret-sharing
- Owner: skewthreads
- License: mit
- Created: 2017-12-18T17:08:00.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-11-16T01:35:57.000Z (over 1 year ago)
- Last Synced: 2024-02-19T19:54:37.793Z (5 months ago)
- Topics: qr-code, qr-secrets, qrcode, recovery, recovery-key, secret-sharing, secrets, shamir-secret-sharing
- Language: Python
- Homepage: https://skewthreads.github.io/QR-secret-sharing/
- Size: 787 KB
- Stars: 112
- Watchers: 10
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- my-awesome-stars - QR-secret-sharing - share a message. Ideal for cryptocurrency wallet recovery keys and passwords. | skewthreads | 102 | (Python)
- awesome-stars - skewthreads/QR-secret-sharing - :lock: Create QR codes to secret-share a message. Ideal for cryptocurrency wallet recovery keys and passwords. (others)
README
# ![alt text][lock] QR Secret Sharing [](https://github.com/skewthreads/QR-secret-sharing/blob/master/LICENSE)
![alt text][flow]
## Description
Create QR codes to secret share a message using [Shamir's secret sharing algorithm](https://dl.acm.org/citation.cfm?id=359176). Ideal for cryptocurrency wallet recovery keys, passwords, etc. Protect your message by sharing it to secrets. Print the created QR codes and store them separately somewhere safe.
Shares are not parts of the message. Each share does not reveal any information about the initial message itself. Restoring the initial message needs all shares combined, or a specified minimum amount (default threshold is equal to the number of shares). For more information read [Shamir's secret sharing](https://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing) algorithm, or [similar work](https://en.wikipedia.org/wiki/Secret_sharing).
## Demonstration
### Sharing
`python share.py`
Share 1 | Share 2 | Share 3
:------------------:|:-------------------:|:-------------------:
 |  | 
### Recovering
`python recover.py`
## Installation
```
git clone https://github.com/skewthreads/QR-secret-sharing.git
cd QR-secret-sharing
pip install -r ./requirements.txt
```
## Suggested Usage
Suggested usage is to create 3 or more shares of your message, print the corresponding QR codes and store them in separate physical locations. In case you need to recover your original message, scan the qr codes, and input the shares in the recovery script.
You can specify the number of shares that will be sufficient to recover the original message. This threshold must obviously be greater than 2. The most secure practice is to set that threshold equal to the number of shares. If you set it to a number less than the number of shares, then you can recover your secret using less shares. For example, you can split your message into 4 shares and set your recovering threshold to 3, you can get the original message using any 3 of the 4 shares, in case that a share gets destroyed. But beware, an adversary can recover your secret using only 3 shares as well. Use this security/usability trade-off with caution.
## Credits
- [inquirer](https://github.com/magmax/python-inquirer)
- [secretsharing](https://github.com/blockstack/secret-sharing)
- [PyQRCode](https://github.com/mnooner256/pyqrcode)
- [pypng](https://github.com/drj11/pypng)
- [animation](https://github.com/bprinty/animation)
## Caution
**Always** check that you can recover your message before destroying the original.
### ![alt text][skew-threads] An open-source project by Skew Threads
[lock]: ./images/lock-small.png
[flow]: ./images/QR-Secret-Sharing-flow.png
[skew-threads]: ./images/skew-threads.png