Skip to content

Commit

Permalink
Documentation improvement and listening ports modification
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas Prévost committed Feb 26, 2024
1 parent b40c78f commit 8219337
Show file tree
Hide file tree
Showing 7 changed files with 424 additions and 98 deletions.
434 changes: 343 additions & 91 deletions README.md
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions assets/.gitignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.bkp
73 changes: 73 additions & 0 deletions assets/certificates_final_scheme.drawio
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<mxfile host="Electron" modified="2024-02-26T12:43:10.958Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/23.1.5 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="jTCMQ98t3t3KP7VpAoRX" version="23.1.5" type="device">
<diagram name="Page-1" id="eztUc_0EYkRh4IjBg9Pf">
<mxGraphModel dx="2074" dy="1230" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="bMN083J7vXd9c35bLOTA-1" value="" style="whiteSpace=wrap;html=1;aspect=fixed;fillColor=#ffe6cc;strokeColor=#d79b00;" vertex="1" parent="1">
<mxGeometry x="200" y="330" width="370" height="370" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-2" value="&lt;b&gt;&lt;font color=&quot;#cc6600&quot; style=&quot;font-size: 28px;&quot;&gt;KME&lt;/font&gt;&lt;/b&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="355" y="350" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-3" value="&lt;font style=&quot;font-size: 14px;&quot;&gt;&lt;b&gt;Server certificate&lt;/b&gt;&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#cdeb8b;strokeColor=#36393d;" vertex="1" parent="1">
<mxGeometry x="250" y="410" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-6" value="&lt;b&gt;&lt;font style=&quot;font-size: 14px;&quot;&gt;SAEs root CA&lt;/font&gt;&lt;/b&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#d0cee2;strokeColor=#56517e;" vertex="1" parent="1">
<mxGeometry x="330" y="620" width="140" height="50" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-7" value="&lt;font style=&quot;font-size: 14px;&quot;&gt;&lt;b&gt;KMEs root CA&lt;/b&gt;&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#b0e3e6;strokeColor=#0e8088;" vertex="1" parent="1">
<mxGeometry x="410" y="490" width="140" height="50" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-9" value="&lt;font style=&quot;font-size: 16px;&quot;&gt;&lt;b&gt;Other KMES&lt;/b&gt;&lt;/font&gt;" style="ellipse;shape=cloud;whiteSpace=wrap;html=1;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="1">
<mxGeometry x="720" y="380" width="270" height="120" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-10" value="&lt;font style=&quot;font-size: 16px;&quot;&gt;&lt;b&gt;Secure zone&#39;s SAEs&lt;/b&gt;&lt;/font&gt;" style="ellipse;shape=cloud;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="180" y="820" width="240" height="140" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-12" value="&lt;b style=&quot;font-size: 16px;&quot;&gt;Authenticated by&lt;br&gt;SSL client certificates&lt;/b&gt;" style="shape=callout;whiteSpace=wrap;html=1;perimeter=calloutPerimeter;position2=0.26;" vertex="1" parent="1">
<mxGeometry x="365" y="770" width="230" height="100" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-13" value="&lt;b style=&quot;font-size: 16px;&quot;&gt;Authenticated by&lt;br&gt;SSL client certificates&lt;/b&gt;" style="shape=callout;whiteSpace=wrap;html=1;perimeter=calloutPerimeter;position2=0.26;" vertex="1" parent="1">
<mxGeometry x="850" y="300" width="230" height="100" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-16" value="&lt;font style=&quot;font-size: 15px;&quot; color=&quot;#660066&quot;&gt;&lt;b&gt;Authenticates&lt;/b&gt;&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="610" y="510" width="90" height="40" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-17" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.13;entryY=0.77;entryDx=0;entryDy=0;entryPerimeter=0;strokeColor=#660066;strokeWidth=3;" edge="1" parent="1" target="bMN083J7vXd9c35bLOTA-9">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="550" y="520" as="sourcePoint" />
<mxPoint x="600" y="470" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-18" value="&lt;font style=&quot;font-size: 15px;&quot; color=&quot;#660066&quot;&gt;&lt;b&gt;Authenticates&lt;/b&gt;&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="350" y="670" width="90" height="40" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-19" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0.071;entryDx=0;entryDy=0;entryPerimeter=0;strokeColor=#660066;strokeWidth=3;" edge="1" parent="1" target="bMN083J7vXd9c35bLOTA-10">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="345" y="670" as="sourcePoint" />
<mxPoint x="550" y="622" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-20" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.25;entryY=1;entryDx=0;entryDy=0;exitX=0.4;exitY=0.1;exitDx=0;exitDy=0;exitPerimeter=0;strokeWidth=3;strokeColor=#0000CC;" edge="1" parent="1" source="bMN083J7vXd9c35bLOTA-10" target="bMN083J7vXd9c35bLOTA-3">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="260" y="830" as="sourcePoint" />
<mxPoint x="310" y="780" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-21" value="" style="endArrow=classic;html=1;rounded=0;strokeWidth=3;strokeColor=#0000CC;" edge="1" parent="1" source="bMN083J7vXd9c35bLOTA-9">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="370" y="804" as="sourcePoint" />
<mxPoint x="370" y="440" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-22" value="&lt;font color=&quot;#0000cc&quot; style=&quot;font-size: 16px;&quot;&gt;&lt;b&gt;Checks&lt;/b&gt;&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="200" y="750" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="bMN083J7vXd9c35bLOTA-23" value="&lt;font color=&quot;#0000cc&quot; style=&quot;font-size: 16px;&quot;&gt;&lt;b&gt;Checks&lt;/b&gt;&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="650" y="400" width="60" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Binary file added assets/certificates_final_scheme.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/qkd_simple_topology.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions config_kme1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
"sqlite_db_path": ":memory:",
"key_directory_to_watch": "raw_keys/kme-1-1",
"saes_https_interface": {
"listen_address": "127.0.0.1:3000",
"listen_address": "0.0.0.0:13000",
"ca_client_cert_path": "certs/zone1/CA-zone1.crt",
"server_cert_path": "certs/zone1/kme1.crt",
"server_key_path": "certs/zone1/kme1.key"
},
"debugging_http_interface": "0.0.0.0:8080",
"debugging_http_interface": "0.0.0.0:18080",
"kmes_https_interface": {
"listen_address": "0.0.0.0:3001",
"listen_address": "0.0.0.0:13001",
"ca_client_cert_path": "certs/inter_kmes/root-ca-kme1.crt",
"server_cert_path": "certs/zone1/kme1.crt",
"server_key_path": "certs/zone1/kme1.key"
Expand All @@ -22,7 +22,7 @@
{
"id": 2,
"key_directory_to_watch": "raw_keys/kme-1-2",
"inter_kme_bind_address": "127.0.0.1:4001",
"inter_kme_bind_address": "127.0.0.1:14001",
"ignore_system_proxy_settings": true,
"https_client_authentication_certificate": "certs/inter_kmes/client-kme1-to-kme2.pfx",
"https_client_authentication_certificate_password": ""
Expand Down
6 changes: 3 additions & 3 deletions config_kme2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"sqlite_db_path": ":memory:",
"key_directory_to_watch": "raw_keys/kme-2-2",
"saes_https_interface": {
"listen_address": "127.0.0.1:4000",
"listen_address": "0.0.0.0:14000",
"ca_client_cert_path": "certs/zone2/CA-zone2.crt",
"server_cert_path": "certs/zone2/kme2.crt",
"server_key_path": "certs/zone2/kme2.key"
},
"kmes_https_interface": {
"listen_address": "0.0.0.0:4001",
"listen_address": "0.0.0.0:14001",
"ca_client_cert_path": "certs/inter_kmes/root-ca-kme2.crt",
"server_cert_path": "certs/zone2/kme2.crt",
"server_key_path": "certs/zone2/kme2.key"
Expand All @@ -20,7 +20,7 @@
{
"id": 1,
"key_directory_to_watch": "raw_keys/kme-1-2",
"inter_kme_bind_address": "127.0.0.1:3001",
"inter_kme_bind_address": "127.0.0.1:13001",
"ignore_system_proxy_settings": true,
"https_client_authentication_certificate": "certs/inter_kmes/client-kme2-to-kme1.pfx",
"https_client_authentication_certificate_password": ""
Expand Down

0 comments on commit 8219337

Please sign in to comment.