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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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