How open-qkd-network/qkd-net works
The “qkd-net” project is a reference implementation of a quantum key distribution network system that adopts a layered, microservice‐oriented approach. In this system, three main layers are defined:
• The Key Management System (KMS) layer – consists of several microservices (configuration service, registration service, authorization service, KMS service, KMS API gateway, and KMS QNL service) that collectively provide an application interface for symmetric key retrieval.
• The Quantum Network Layer (QNL) – a single microservice (Key Routing Service) that sits between the KMS layer and the QKD Link Layer, responsible for managing routing, key relaying, and (in longer term) handling network topology dynamics.
• The QKD Link Layer (QLL) – representing the physical or simulated layer where the quantum key generation happens (including simulators for when real QKD devices are unavailable).
Main Components
a. KMS Layer – List individual microservices as separate components (Configuration Service, Registration Service, Authorization Service, KMS Service, KMS API Gateway, KMS QNL Service).
b. QNL Layer – Represent the “Key Routing Service” component that handles routing and key block relaying.
c. QLL (Quantum Link Layer) – Represent the QKD devices (or the provided simulator) which generate the raw quantum keys.
– Additionally, include sample “applications” (such as tls-kms-demo, qTox, etc.) to illustrate how external clients integrate with the system.
Relationships and Interactions
• The QLL layer provides key blocks (via simulated or real QKD links) to the QNL service.
• The QNL layer (Key Routing Service) both receives and routes key blocks between sites and pushes key blocks to the KMS QNL service.
• The KMS layer’s services (especially the KMS Service and API gateway) expose endpoints for client applications to make “newkey” and “getkey” REST calls.
Architectural Patterns and Design Principles
– Emphasize that a microservices architecture has been adopted, which provides flexibility for deployment and scaling.
– The project follows SOLID principles to achieve good separation of concerns.
– There is clear separation between the layers (each with its own responsibility and communication interface), which makes the system modular.
Specify Key Technologies and Artifacts
– Mention Java (with Maven as the build tool) as the primary technology for KMS and related services.
– Identify configuration files (like kms.conf, config.yaml, and routes.json) that are crucial in coordinating the operation between layers.
– Mention supporting scripts (e.g., shell scripts under the kms/scripts directory) that build and run services.
Elements
– Notations for deployment-specific configuration (e.g., configuration files, scripts) that indicate how services are expected to be integrated and run.