Authenticate SuperNodes

Flower has built-in support for authenticated SuperNodes that you can use to verify the identities of each SuperNode connecting to a SuperLink. Flower node authentication works similar to how GitHub SSH authentication works:

• SuperLink (server) stores a list of known (client) node public keys

• Using ECDH, both SuperNode and SuperLink independently derive a shared secret

• Shared secret is used to compute the HMAC value of the message sent from SuperNode to SuperLink as a token

• SuperLink verifies the token

We recommend you to check out the complete code example demonstrating federated learning with Flower in an authenticated setting.

Note

This guide covers a preview feature that might change in future versions of Flower.

Note

For increased security, node authentication can only be used when encrypted connections (SSL/TLS) are enabled.

Enable node authentication in SuperLink

To enable node authentication, first you need to configure SSL/TLS connections to secure the SuperLink<>SuperNode communication. You can find the complete guide here. After configuring secure connections, you can enable client authentication in a long-running Flower SuperLink. Use the following terminal command to start a Flower SuperNode that has both secure connections and node authentication enabled:

flower-superlink
    --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 --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 (.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 flags --auth-superlink-private-key and --auth-superlink-public-key expect paths to the server's private and public keys. For development purposes, you can generate a private and public key pair using ssh-keygen -t ecdsa -b 384.

Note

In Flower 1.9, there is no support for dynamically removing, editing, or adding known node public keys to the SuperLink. To change the set of known nodes, you need to shut the server down, edit the CSV file, and start the server again. Support for dynamically changing the set of known nodes is on the roadmap to be released in Flower 1.10 (ETA: June).

Enable node authentication in SuperNode

Similar to the long-running Flower server (SuperLink), you can easily enable node authentication in the long-running Flower client (SuperNode). Use the following terminal command to start an authenticated SuperNode:

flower-supernode
     --root-certificates certificates/ca.crt
     --superlink 127.0.0.1:9092
     --auth-supernode-private-key keys/client_credentials
     --auth-supernode-public-key keys/client_credentials.pub

The --auth-supernode-private-key flag expects a path to the node's private key file and the --auth-supernode-public-key flag expects a path to the node's public key file. For development purposes, you can generate a private and public key pair using ssh-keygen -t ecdsa -b 384.

Security notice

The system's security relies on the credentials of the SuperLink and each SuperNode. Therefore, it is imperative to safeguard and safely store the credentials to avoid security risks such as Public Key Infrastructure (PKI) impersonation attacks. The node authentication mechanism also involves human interaction, so please ensure that all of the communication is done in a secure manner, using trusted communication methods.

总结

You should now have learned how to start a long-running Flower server (SuperLink) and client (SuperNode) with node authentication enabled. You should also know the significance of the private key and store it safely to minimize security risks.