groupenc: Group Encryption Utilities
Project description
groupenc: Group Encryption Utilities
Group Encryption utilities in Python, with a CLI.
Installation
pip install groupenc
Usage
Bootstrap
To Bootstrap a vault, use:
groupenc bootstrap
It would typically create a file called .groupenc.json
and a private key
/public key pair in ~/.groupenc_private
and ~/.groupenc_public
.
You can share your own identity with other people, so they can induct you later:
groupenc id
It typically displays your public key.
Secrets
To add a secret, use:
groupenc secret add --key password --value changeMe
To add a secret from a file, use:
groupenc secret add --key id_rsa_server --value @~/.ssh/id_rsa
To list secrets, use:
groupenc secret list
password
id_rsa_server
To display a secret, use:
groupenc secret show --key password
changeMe
To remove a secret, use:
groupenc secret remove --key password
Induction
When you add someone else to the vault file, this process allows them to view secrets. To do that, an existing user inducts them into the system.
groupenc induct --identity @~/other_id_rsa.pub
and then you transmit the new file across. They should be able to decode and view the secrets.
Rotation
Sometimes, it is a good practice to rotate the encryption keys so people can't view updated secrets.
groupenc rotate
Remove
When you want to remove people from a group, you simply remove them with a known public key, then rotate:
groupenc disown --identity @~/other_id_rsa.pub
groupenc rotate
Note that the secrets that they already have access to cannot be unshared/forgotten, so you should manually revoke their accesses from any services. It is a good practice to share multiple vault files and induct people based on their actual role/need to access.
Running Unit Tests
pip install tox
tox
Call for Testing Volunteers
The code was tested on Python 2.7, 3.8.
Please volunteer to test it and send in your patches (or) bug reports. Design feedback always welcome.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file groupenc-0.3.0.tar.gz
.
File metadata
- Download URL: groupenc-0.3.0.tar.gz
- Upload date:
- Size: 15.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83bd0818c6500a7a8b5c4e27e34ddadb344db99eadd2afec2d67e2a8f78567cc |
|
MD5 | fc059dcb7052ea9e0014a8c1efc4fd9b |
|
BLAKE2b-256 | 29fd74d2d252909c8dd1e2cdd79f2364f79781d412d6c9cab15dcb77a55aa636 |