KeyCrypt

KeyCrypt is a secure, provider-driven cryptography platform for building encryption workflows, key management services, policy-aware data protection, and pluggable storage integrations.

Project Overview

KeyCrypt combines a Python SDK, CLI, orchestration layer, and provider interfaces into one extensible platform. It is designed for teams that need a single cryptographic control plane across local apps, services, and cloud workloads.

Key Features

• Pluggable crypto, key, and storage provider interfaces
• High-level Python SDK and keycrypt CLI
• Policy-driven orchestration and configuration
• Cloud, AI, and observability extras for optional installs
• REST, gRPC, and adapter-friendly integration surfaces
• Package metadata and public exports for stable imports

Quick Start

from src import KeyCrypt
from pathlib import Path
sdk = KeyCrypt.configure("keycrypt.yaml")
artifact = sdk.encrypt(Path("example.txt"))
print(artifact.encrypted_path)

Installation

pip

pip install keycrypt

Docker

docker build -t keycrypt .
docker run --rm -it keycrypt keycrypt --help

From Source

git clone https://github.com/Brahamanbtp/KeyCrypt-Shield-X.git
cd KeyCrypt-Shield-X
pip install -e .

Documentation Links

• API Reference
• OpenAPI Spec
• Postman Collection
• Architecture Notes
• State Machine Guide

Use Cases

File encryption in applications

from src import KeyCryptClient

with KeyCryptClient() as client:
    encrypted = client.encrypt_file("report.pdf")

Policy-aware platform integration

from src import PolicyEngine
from pathlib import Path

engine = PolicyEngine()
policy = engine.load_policy(Path("policy.yaml"))

Automated CLI workflows

keycrypt encrypt --input report.pdf --output report.pdf.kcx
keycrypt decrypt --input report.pdf.kcx.json --output report.restored.pdf

Architecture

flowchart TD
	U[User / App] --> S[Python SDK / CLI]
	S --> O[Orchestration & Policy Engine]
	O --> C[Crypto Providers]
	O --> K[Key Providers]
	O --> T[Storage Providers]
	C --> D[(Encrypted Data)]
	K --> M[(Key Material)]
	T --> A[(Object / File Storage)]

Loading

Contributing

See CONTRIBUTING.md for local development and contribution guidance.

License

Licensed under the MIT License.

Acknowledgments

• The KeyCrypt Team for the core platform design
• The open-source cryptography and Python ecosystem
• Contributors, testers, and early adopters who shaped the project