From e29fe8dd7e7b39145eb4e5f0595712d29272b2ae Mon Sep 17 00:00:00 2001 From: Robert Steiner Date: Mon, 9 Sep 2024 12:00:19 +0200 Subject: [PATCH] docs(framework) Update node auth docs Signed-off-by: Robert Steiner --- doc/source/how-to-authenticate-supernodes.rst | 10 +++++----- doc/source/how-to-enable-ssl-connections.rst | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/source/how-to-authenticate-supernodes.rst b/doc/source/how-to-authenticate-supernodes.rst index 73987261b29f..9b001531ee33 100644 --- a/doc/source/how-to-authenticate-supernodes.rst +++ b/doc/source/how-to-authenticate-supernodes.rst @@ -28,13 +28,13 @@ Use the following terminal command to start a Flower :code:`SuperNode` that has .. code-block:: bash flower-superlink - --ssl-ca-certfile certificates/ca.crt - --ssl-certfile certificates/server.pem + --ssl-ca-certfile certificates/ca.crt + --ssl-certfile certificates/server.pem --ssl-keyfile certificates/server.key --auth-list-public-keys keys/client_public_keys.csv --auth-superlink-private-key keys/server_credentials --auth-superlink-public-key keys/server_credentials.pub - + Let's break down the authentication flags: 1. The first flag :code:`--auth-list-public-keys` expects a path to a CSV file storing all known node public keys. You need to store all known node public keys that are allowed to participate in a federation in one CSV file (:code:`.csv`). @@ -56,8 +56,8 @@ Similar to the long-running Flower server (:code:`SuperLink`), you can easily en Use the following terminal command to start an authenticated :code:`SuperNode`: .. code-block:: bash - - flower-client-app client:app + + flower-supernode --root-certificates certificates/ca.crt --superlink 127.0.0.1:9092 --auth-supernode-private-key keys/client_credentials diff --git a/doc/source/how-to-enable-ssl-connections.rst b/doc/source/how-to-enable-ssl-connections.rst index 1828f4ed3258..fc8e89914ac2 100644 --- a/doc/source/how-to-enable-ssl-connections.rst +++ b/doc/source/how-to-enable-ssl-connections.rst @@ -4,7 +4,7 @@ Enable SSL connections This guide describes how to a SSL-enabled secure Flower server (:code:`SuperLink`) can be started and how a Flower client (:code:`SuperNode`) can establish a secure connections to it. -A complete code example demonstrating a secure connection can be found +A complete code example demonstrating a secure connection can be found `here `_. The code example comes with a :code:`README.md` file which explains how to start it. Although it is @@ -42,9 +42,9 @@ Use the following terminal command to start a sever (SuperLink) that uses the pr .. code-block:: bash - flower-superlink - --ssl-ca-certfile certificates/ca.crt - --ssl-certfile certificates/server.pem + flower-superlink + --ssl-ca-certfile certificates/ca.crt + --ssl-certfile certificates/server.pem --ssl-keyfile certificates/server.key When providing certificates, the server expects a tuple of three certificates paths: CA certificate, server certificate and server private key. @@ -57,7 +57,7 @@ Use the following terminal command to start a client (SuperNode) that uses the p .. code-block:: bash - flower-client-app client:app + flower-supernode --root-certificates certificates/ca.crt --superlink 127.0.0.1:9092