byoki

command module
v0.0.0-...-04dd476 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2023 License: MIT Imports: 7 Imported by: 0

README

Byoki

Byoki is a CLI tool that combines PGP asymetric encryption with the concept of Shamir Split Secrets for decryption.

Example usecase

I need to make automated and encrypted backups for a database (it could be anything, really), but I need to make sure that only one person is not enough to decrypt it. That's when Shamir Split Secrets becomes useful, it allows us to choose a total number of secret keys and to set a threshold to allow decryption. Each trusted user is given a personnal key, but they will have to work together in order to unlock the archive.

How to use

  1. Create a JSON keys file (it will contain a public key, an encrypted private key, as well as some useful metadata)
./byoki genkeys -m [shamir threshold, ex: 2] -t [shamir total shares, ex: 4] -o [path to output file, ex: keys.json]
  1. Encrypt a file or an archive with our newly created key
./byoki encrypt -k [path to our keys file, ex: keys.json] -k [path to the file to encrypt, ex: archive.zip]
  1. Decrypt our archive with the threshold amount of Shamir secrets
./byoki decrypt -a [path to the encrypted archive, ex: archive-xyz.byoki]

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL