Skip to content
Snippets Groups Projects
Commit f2c84c3a authored by Fabian Seidl's avatar Fabian Seidl
Browse files

adjust README

parent 77c74404
No related branches found
No related tags found
1 merge request!137Resolve "Implement QKDN manager dummy"
Pipeline #204953 passed
...@@ -185,40 +185,48 @@ Usage of quantumlayer: ...@@ -185,40 +185,48 @@ Usage of quantumlayer:
A simple simulation of an AKMS endpoint. This provides a REST endpoint to receive KSA keys from a `goKMS`. The following functionalities are not implemented, the explanation is just there as a means of describing the KMS type. The 'A' stands for access and one of the main purposes of this type of KMS is providing a security barrier protecting the core network of a provider from malicious activity of an end user. Its further purpose is to interact with AAA instances of providers for contractual matters. A simple simulation of an AKMS endpoint. This provides a REST endpoint to receive KSA keys from a `goKMS`. The following functionalities are not implemented, the explanation is just there as a means of describing the KMS type. The 'A' stands for access and one of the main purposes of this type of KMS is providing a security barrier protecting the core network of a provider from malicious activity of an end user. Its further purpose is to interact with AAA instances of providers for contractual matters.
## QKDNManager-simlator ## QKDNManager-simulator
A simple simulation of a monitoring software being able to receive information from `KMS` and send information to a SDN controller respectively a SDN application. Reachable endpoints are defined in: A simple simulation of a monitoring software being able to retrieve information from `KMS` and send information to a SDN controller respectively a SDN application. The controller and kms clients endpoints are defined in:
``` ```
qkdnManager-simulator/config/example/qkdnManagerConfig.yaml.example qkdnManager-simulator/config/example/qkdnManagerConfig.yaml.example
``` ```
Currently they are: **Current app client requests**
```
/security/alert (POST)
Body:
- ID string (ID of the information)
- KMS_ID uuid (ID of the KMS where the issue occured or was resolved)
- status string (Status of the KMS regarding security issues, Values: issue/resolved)
/link/quality (POST)
Body:
- ID string (ID of the information)
- KMS_ID uuid (ID of the KMS from where the link quality was reported)
- PeerID uuid (ID of the peer from the reporting KMS)
- quality string (Link quality of the reporting KMS, Values: good/ok/bad)
```
**Current kms client requests**
``` ```
/operationalState​ /operationalState​
Parameter:​
- KMS_ID uuid​
- running boolean​
/qkdInterface​ /qkdInterface​
Parameter:​
- KMS_ID uuid​
- running boolean​
/interCKMSInterface​ /interCKMSInterface​
Parameter:​
- KMS_ID uuid​
- peerID uuid​
- running boolean​
/akmsInterface​ /akmsInterface​
Parameter:​
- KMS_ID uuid​
- running boolean
``` ```
The data has to be sent as `application/x-www-form-urlencoded` and will just be printed in the console of the `qkdnManager-simulator`. The data will be provided as `application/json` and will just be printed in the console of the `qkdnManager-simulator`.
## Usage ## Usage
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment