Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add valid CSV info in authentication guide #3409

Merged
merged 3 commits into from
May 6, 2024
Merged

Add valid CSV info in authentication guide #3409

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e5184a
Add valid CSV info in auth guide
danielnugraha May 6, 2024
52ed155
Update doc/source/how-to-authenticate-supernodes.rst
danieljanes May 6, 2024
ddc9357
Merge branch 'main' into auth-valid-csv-info
danieljanes May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions doc/source/how-to-authenticate-supernodes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Flower node authentication works similar to how GitHub SSH authentication works:
* Shared secret is used to compute the HMAC value of the message sent from SuperNode to SuperLink as a token
* SuperLink verifies the token

You can find the complete code example demonstrating federated learning with Flower in an authenticated setting
`here <https://github.com/adap/flower/tree/main/examples/flower-client-authentication>`_.
We recommend you to check out the complete `code example <https://github.com/adap/flower/tree/main/examples/flower-client-authentication>`_ demonstrating federated learning with Flower in an authenticated setting.

danieljanes marked this conversation as resolved.
Show resolved Hide resolved

.. note::
This guide covers a preview feature that might change in future versions of Flower.
Expand All @@ -35,6 +35,9 @@ Use the following terminal command to start a Flower :code:`SuperNode` that has
Let's break down the :code:`--require-client-authentication` flag:

1. The first argument is 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`).

A valid CSV file storing known node public keys should list the keys in OpenSSH format, separated by commas and without any comments. For an example, refer to our code sample, which contains a CSV file with two known node public keys.

2. The second and third arguments are paths to the server's private and public keys. For development purposes, you can generate a private and public key pair using :code:`ssh-keygen -t ecdsa -b 384`.

.. note::
Expand Down
1 change: 0 additions & 1 deletion doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ Problem-oriented how-to guides show step-by-step how to achieve a specific goal.
how-to-monitor-simulation
how-to-configure-logging
how-to-enable-ssl-connections
how-to-enable-client-authentication
how-to-use-built-in-mods
how-to-use-differential-privacy
how-to-authenticate-supernodes
Expand Down