Skip to main content

Personal CLI utility tool to easily encrypt and decrypt files in a directory.

Project description

🔒 locksey 🔒

Personal CLI utility tool to easily encrypt and decrypt files in a directory. Can be used to encrypt secrets in a repo, MFA recovery codes, password text files, your journal/diary entries or any text file with personal or confidential information.

How does it work?

  • If you want a file in a directory to work with locksey, you name the file with ending with .unlocked.* extension. When you run locksey lock <password>, it will recursively find all .unlocked.* files, encrypt them and rename them to .locked.*.

  • Similarly when you run locksey unlock <password>, it will recursively find all .locked.* files, decrypt them and rename them to .unlocked.*.

  • You can also tell locksey to store the password in you home folder so you don't have to type it again.

  • Files are encrypted as described in this stackoverflow post.

Install

python3 -m pip install locksey

Usage

python3 -m locksey [-h] action [password]

Actions

Name Description
lock Recursively go through the directory encrypt and rename files matching glob ./**/*.unlocked.*
unlock Recursively go through the directory and decrypt and rename files matching glob ./**/*.locked.*
setpasswd Store password for current directory in home folder (~/.locksey), base64 encoded so you don't have to provide it again
rmpasswd Remove stored password for current directory

Changing password

For changing the password in you current directory, run

  1. unlock
  2. rmpasswd if needed
  3. lock with new password
  4. setpasswd with new password if needed

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

locksey-0.1.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

locksey-0.1.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file locksey-0.1.0.tar.gz.

File metadata

  • Download URL: locksey-0.1.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for locksey-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3ced43d38977cf84c6941509bedb835264a5f5c50c76d948e9ae64bfad317871
MD5 f8b9da006fcc884817266f6fc01aea44
BLAKE2b-256 f8fae51a62fddf69e308fcf0e53adf8feb9d9c64c4eceab4d78ed5fc0dcdb9b3

See more details on using hashes here.

File details

Details for the file locksey-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: locksey-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for locksey-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d10453886d6e69d1cc862959cd8e05b85c18fb9c6d958c69d5ecfcdb8cfe8669
MD5 6351a5d33309ae41f0c49e6768a9fad4
BLAKE2b-256 030bf5dadb984b49075070834b06deb07b847dc93c431060265dd517a9255d14

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page