Skip to main content

Secure token management library for CLI tools, using two-layer encryption with local key and 1Password vault integration.

Project description

KeySentinel 🔐

KeySentinel is a lightweight, secure token encryption library and CLI tool for managing sensitive credentials with strong Zero Trust principles.

📖 Read the full article explaining the Two-Layer Security Architecture here


✨ Features

  • 🔐 Two-layer token encryption: local symmetric key + vault storage
  • 🚀 Developer-friendly CLI (keysentinel) with zero plaintext leakage
  • 🔥 Predefined profiles for common APIs (AWS, GitHub, OpenAI, GCP, etc.)
  • 🛡️ Extensible custom profiles via JSON
  • 💩 Zero Trust Local Environment Enforcement
  • 🗋 Secure clipboard copy with automatic timeout cleaning
  • ❌ Export to plaintext files (.env, .json) intentionally blocked for safety

🚀 Why KeySentinel?

Most CLI tools expose credentials through .env files or unsecured memory spaces.

KeySentinel breaks this insecure paradigm:

  • No unencrypted secrets on disk.
  • No unguarded outputs without user consent.
  • Ephemeral secrets that self-destroy after a timeout.
  • Clear warnings to educate developers about security risks.

"If it’s not encrypted, it’s exposed. If it’s on disk, it’s compromised." — The Zen of Zero Trust


⚡ Quick Usage

Encrypt and store a token via Python

from keysentinel import upsert_encrypted_fields

upsert_encrypted_fields(
    fields={"github_token": "ghp_xxx123"},
    item_title="GitHub CLI Token",
)

Retrieve and decrypt a token via Python

from keysentinel import retrieve_and_decrypt_fields

fields = retrieve_and_decrypt_fields("GitHub CLI Token")
print(fields["github_token"])

Using the CLI (Recommended)

# Encrypt and store fields securely (values prompted securely)
keysentinel encrypt-token --title "AWS CLI Credentials" --fields aws_access_key_id --fields aws_secret_access_key

# Or use a predefined profile
keysentinel encrypt-token --title "GitHub Token" --profile github

# Retrieve and decrypt fields
keysentinel get-token --title "AWS CLI Credentials"

⚠️ Credentials will be cleared from your terminal and memory automatically after a short timeout.


🛡️ Security Model

Aspect Behavior
Local Encryption AES256/Fernet with a user-local symmetric key
Vault Transport Secrets stored inside 1Password CLI (“op”)
Decryption Memory-only, no disk writes
Export Blocked by default (no .env, no .json)
User Awareness Visual warnings on decrypted output
Secret Lifecycle Timeout auto-clears memory and screen

📂 Token Profiles (Built-in)

KeySentinel supports predefined profiles to simplify common API credential handling:

Profile Fields
aws aws_access_key_id, aws_secret_access_key
github github_token
gcp gcp_client_email, gcp_private_key, gcp_project_id
openai openai_api_key
azure azure_client_id, azure_client_secret, azure_tenant_id, azure_subscription_id
slack slack_token

and many others… (30+ profiles supported!)

You can list and use these profiles by passing --profile <profile_name>.


🛠️ Extend with Custom Profiles

You can extend KeySentinel by creating a file at:

~/.keysentinel_profiles.json

Example content:

{
  "huggingface": {
    "description": "Hugging Face API Token",
    "fields": ["hf_token"]
  },
  "figma": {
    "description": "Figma Personal Access Token",
    "fields": ["figma_token"]
  }
}

When running encrypt-token, your custom profiles will be automatically available!


❌ Why Export is Blocked

KeySentinel blocks plaintext exports (--export-env, --export-json) intentionally.

Attempting to use them shows this educational warning:

⚠️ Do NOT store or copy them into plaintext files or version control.

"If it's not encrypted, it's exposed. If it's on disk, it's compromised."

from "The Zen of Zero Trust"

For more info:


📜 Zero Trust Manifest

You can load the philosophy inside Python:

import zero_trust

Or read it online:

👉 Zero Trust Local Environment Manifesto


🔗 Related Reading


🛃️ Roadmap

  • Secure CLI operations
  • Custom and extensible token profiles
  • Memory-timeout auto-clear after exposure
  • Multi-vault support (future)
  • Bitwarden CLI integration (future)

⚖️ License

MIT License


👨‍💼 Author

Built with ❤️ by Davi Luiz Guides


KeySentinel: Secure your tokens, secure your workflows. 🔐

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

keysentinel-0.1.1.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

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

keysentinel-0.1.1-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file keysentinel-0.1.1.tar.gz.

File metadata

  • Download URL: keysentinel-0.1.1.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for keysentinel-0.1.1.tar.gz
Algorithm Hash digest
SHA256 91275bf2dbc62fedd46cc60f2224ec4b1293dc9bfffdd8a461fb41f9b5e67c21
MD5 9171335a2e967cef46f60269e7ce8b61
BLAKE2b-256 5f3a062cb8021bcce6675a89cbbade0f7e7977b5a093e7822aca7327df489062

See more details on using hashes here.

Provenance

The following attestation bundles were made for keysentinel-0.1.1.tar.gz:

Publisher: publish-pypi.yml on daviguides/keysentinel

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

File details

Details for the file keysentinel-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: keysentinel-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for keysentinel-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8babb3d392ea75fedc6925069a3775a3558104acb2f0105f2205828e2cc69971
MD5 842c9c4c61810c00906630e7777abbce
BLAKE2b-256 f5dda15e270ce4a9236dd9ef5046feec84324f5748006ab9f875e15e1b04fb42

See more details on using hashes here.

Provenance

The following attestation bundles were made for keysentinel-0.1.1-py3-none-any.whl:

Publisher: publish-pypi.yml on daviguides/keysentinel

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