Skip to main content

Python library for password management and TOTP verification.

Project description

jkey

Python library for password management and TOTP verification.

Install

uv tool install jkey

Or run without installing:

uv run jkey --help

Quick Start

# Initialize vault (set master password)
jkey pv init

# Add a 2FA account from QR code image
jkey 2fa add ./github.jpg

# List TOTP codes (optional keyword filter)
jkey 2fa ls
jkey 2fa ls github

# Generate a random password
jkey pm get -L 24

# Store a password
jkey pm add my-site

# List all stored passwords
jkey pm ls

# Encrypt/decrypt any file
jkey pv encrypt secret.pdf
jkey pv decrypt secret.pdf.jkey -o secret.pdf

Commands

Command Description
jkey 2fa ls [keyword] List TOTP accounts and codes
jkey 2fa add <image> Import from QR code image
jkey 2fa rm <account> Remove a TOTP account
jkey rc add <file> Import recovery codes from file
jkey rc ls [keyword] List recovery codes
jkey rc rm <account> Remove recovery codes
jkey pm ls [keyword] List stored passwords
jkey pm get [-L N] Generate a random password
jkey pm add <name> Store a password (prompts for input)
jkey pm edit <name> Update an existing password
jkey pm rm <name> Delete a stored password
jkey pv init Initialize the encrypted vault
jkey pv unlock Unlock the vault
jkey pv lock Lock the vault
jkey pv status Show vault status
jkey pv set-pw Change master password
jkey pv encrypt <file> Encrypt a file
jkey pv decrypt <file> Decrypt a .jkey file
jkey pv export totp Export TOTP secrets (re-enters master password)
jkey pv export passwords Export passwords as CSV
jkey pv export recovery Export recovery codes
jkey pv export qr -o <dir> Export QR code images
jkey pv export all -o <dir> Export everything

Set JKEY_PASS environment variable to skip the password prompt.

How It Works

Data is encrypted with AES-256-CBC + HMAC-SHA256 and stored in ~/.config/jkey/:

~/.config/jkey/
├── .session          # Session cache (5 min timeout)
├── totp.jkey         # Encrypted TOTP secrets
├── passwords.jkey    # Encrypted passwords
├── recovery.jkey     # Encrypted recovery codes
└── qr/               # Encrypted QR images

Back up ~/.config/jkey/ (excluding .session) to migrate to another machine.

Dependencies

  • opencv-python-headless — QR code scanning

Pure Python, no OpenSSL or libsodium required.

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

jkey-0.3.2.tar.gz (31.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jkey-0.3.2-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

Details for the file jkey-0.3.2.tar.gz.

File metadata

  • Download URL: jkey-0.3.2.tar.gz
  • Upload date:
  • Size: 31.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for jkey-0.3.2.tar.gz
Algorithm Hash digest
SHA256 2711a6d3d25555f1996be5c6adac1e76f49355c868a153d9588b7bd4a45bc06d
MD5 0985cf022acfa9551b783b6e3cfe22b9
BLAKE2b-256 506fef5f8b09afe2e2ad311803574a84e66117cc097182ffa26b4d4772c64bf6

See more details on using hashes here.

Provenance

The following attestation bundles were made for jkey-0.3.2.tar.gz:

Publisher: publish.yml on imjiaoyuan/jkey

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jkey-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: jkey-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 26.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for jkey-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 570dd73449a61d26144fcf211d0b615b1fdb0e714f56203a06a1bbb2189d8d25
MD5 1c7fac5b76c19c90cd59c8a443ec4aa0
BLAKE2b-256 c1a51e403a3d8e1896d2a60adc40346d374519921fb808a94a0bd998ca9ea84f

See more details on using hashes here.

Provenance

The following attestation bundles were made for jkey-0.3.2-py3-none-any.whl:

Publisher: publish.yml on imjiaoyuan/jkey

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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