How tikipiya/entanglekey works
Project Type & Purpose
• EntangleKey is a Python “open-source tool” / library with an accompanying CLI that provides distributed session-key generation based on quantum entanglement simulation.
• It is not a monolithic web app but a modular, event-driven, async framework that orchestrates multiple internal services and communicates peer-to-peer over WebSockets.
Directory Structure → Implicit Architecture
• entanglekey/cli.py → CLI entrypoint
• entanglekey/core.py → EntangleKeyManager orchestrator
• entanglekey/config*.py → ConfigLoader & Config model
• entanglekey/network.py → NetworkManager (WebSocket)
• entanglekey/quantum.py → QuantumEntanglementSimulator
• entanglekey/crypto.py → SessionKeyGenerator & low-level crypto primitives
• entanglekey/security_monitor.py → SecurityMonitor
• entanglekey/logging_config.py → LoggingSystem setup
• examples/ → Consumer code (demonstrates API usage)
• tests/ → Unit & integration tests
Key README Insights
• Shows six sub-systems under EntangleKeyManager: Quantum Simulator, Security Monitor, Network Manager, Config Loader, Session Key Generator, Logging System.
• Emphasizes async, event-driven, peer synchronization, and plugin-style extensibility (config formats, custom callbacks).
Main Components & Interactions
A. User & CLI Layer
• “User” (shell or Python import)
• CLI module → parses args, loads config → calls EntangleKeyManager
• Python API entrypoint: EntangleKeyManager class
B. Core Orchestrator
• EntangleKeyManager
• Initializes sub-components
• Runs event loop (asyncio)
• Provides start/stop, connect_instance, generate_session_key, get_session_key
C. Sub-Components
1. Config Loader
• Reads YAML/JSON/TOML, env vars, defaults
• Provides typed configuration to Manager & other components
2. Logging System
• Structured JSON logs, security vs. general
• Multi-output handlers
3. Quantum Entanglement Simulator
• Simulate Bell states, measurements → quantum entropy
• Exposes async create_entanglement, measure, verify
4. Network Manager
• WebSocket server/client, peer discovery, message routing
• Handles reconnect, broadcast, errors
5. Session Key Generator
• Combines quantum & classical entropy via HKDF, ChaCha20Poly1305, HMAC-SHA256
• Encrypt/decrypt helpers, signature, key hash
6. Security Monitor
• Hooks into quantum & network events
• Records metrics, attack detection, auto-revoke keys, alerts
D. External Entities
• File System for config files & key files
• Environment Variables
• Remote EntangleKey instances over TCP/WebSocket
• Optional TLS/SSL layer for underlying transport
• Downstream application using session keys for encryption
Architectural Patterns & Principles
• Layered modular design: CLI/API → Orchestrator → Sub-systems
• Async event-driven choreography (asyncio)
• Single Responsibility per module
• Dependency injection via config object
• Plugins/extensibility: new config formats, alert callbacks