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.0.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

locksey-0.0.1-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for locksey-0.0.1.tar.gz
Algorithm Hash digest
SHA256 dd8d6e40a2cb959ac69b2afad3e134bbc328f51c83bd946507a05eb28b9c3e40
MD5 63da2f0c59efa3bbeabcf14d29f05d6f
BLAKE2b-256 b0d2039fd752c0e2bc6987d5e9e39cff4d9925f6d15472ebb8330fd58a143241

See more details on using hashes here.

File details

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

File metadata

  • Download URL: locksey-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.5 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2c93c951f438d94507e41f99244b572d9255cb1c8851f2634e62e791da8d2372
MD5 30436a3d5bb57af23b3ac07312266b52
BLAKE2b-256 c09a9c19023f57a1b3cc7dfdf09ddb8b51af9d17c04b957d3ab4ccc5b3e14bd8

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