IP cluster-based commissioning (project-chip#6798)

* Cluster-based commissioning - phase 1.

Adds calls to clusters to commission a device properly. This is
intended to be used to setup a device that is already on the
network, but not already on a CHIP network. Hence, network
credentials are not required, but we do need to send all the
remaining commissioning information.

Challenges:
IM cluster commands time out more often than the non-IM commands,
even when the device is clearly sending a reply.
Need to find the race and get rid of it.

Still to do:
- add operational credentials into state machine
- add more commissioning phases (time set etc.)
- add proper scan command for determining ethernet netif name
- swap over to CASE before sending commissioning complete command
- once we're totally in IM, combine some commands
- add post commissioning setup commands (trusted node ids etc.)

* Restyled by gn

* Address review comments.

* Add back some lines lost in a rebase.

* Address review comments

- remove heap allocation from callbacks
- overwrite node ID resolution functions rather than using a delegate

* Restyled by gn

* Restyled by shfmt

Co-authored-by: Restyled.io <commits@restyled.io>

Author: cecille

config/esp32/components/chip/Kconfig

@@ -654,6 +654,18 @@ menu "CHIP Device Layer"
 
     endmenu
 
+    menu "Commissioning options"
+        config RENDEZVOUS_WAIT_FOR_COMMISSIONING_COMPLETE
+            int "Use full IP-based commissioning (expect cluster commands)"
+            default 0
+            help
+                Setting this to y will cause the commissioner to send commissioning commands to the
+                various clusters after establishing a PASE session.
+
+    endmenu
+
+
+
     menu "Testing Options"
 
         config ENABLE_TEST_DEVICE_IDENTITY

examples/all-clusters-app/esp32/main/main.cpp

@@ -339,7 +339,7 @@ class SetupListModel : public ListScreen::Model
         else if (i == 2)
         {
             app::Mdns::AdvertiseCommissionableNode();
-            OpenDefaultPairingWindow(ResetAdmins::kNo, PairingWindowAdvertisement::kMdns);
+            OpenDefaultPairingWindow(ResetAdmins::kYes, PairingWindowAdvertisement::kMdns);
         }
     }
 

scripts/build_python.sh

@@ -40,6 +40,7 @@ ENVIRONMENT_ROOT="$CHIP_ROOT/out/python_env"
 
 declare chip_detail_logging=false
 declare chip_mdns="minimal"
+declare clusters=true
 
 help() {
 
@@ -52,6 +53,8 @@ Input Options:
                                                             By default it is false.
   -m, --chip_mdns           ChipMDNSValue                   Specify ChipMDNSValue as platform or minimal.
                                                             By default it is minimal.
+  -c, --clusters_for_ip_commissioning  true/false           Specify whether to use clusters for IP commissioning.
+                                                            By default it is true.
 "
 }
 
@@ -71,6 +74,10 @@ while (($#)); do
             chip_mdns=$2
             shift
             ;;
+        --clusters_for_ip_commissioning | -c)
+            clusters=$2
+            shift
+            ;;
         -*)
             help
             echo "Unknown Option \"$1\""
@@ -87,7 +94,7 @@ echo "Input values: chip_detail_logging = $chip_detail_logging , chip_mdns = \"$
 source "$CHIP_ROOT/scripts/activate.sh"
 
 # Generates ninja files
-gn --root="$CHIP_ROOT" gen "$OUTPUT_ROOT" --args="chip_detail_logging=$chip_detail_logging chip_mdns=\"$chip_mdns\""
+gn --root="$CHIP_ROOT" gen "$OUTPUT_ROOT" --args="chip_detail_logging=$chip_detail_logging chip_mdns=\"$chip_mdns\" chip_use_clusters_for_ip_commissioning=$clusters"
 
 # Compiles python files
 ninja -C "$OUTPUT_ROOT" python

src/app/clusters/network-commissioning/network-commissioning.cpp

@@ -28,6 +28,7 @@
 #include <lib/support/logging/CHIPLogging.h>
 #include <platform/CHIPDeviceLayer.h>
 #include <platform/ConnectivityManager.h>
+#include <platform/internal/DeviceControlServer.h>
 
 #if CHIP_DEVICE_CONFIG_ENABLE_THREAD
 #include <platform/ThreadStackManager.h>
@@ -258,6 +259,14 @@ EmberAfNetworkCommissioningError OnEnableNetworkCommandCallbackInternal(app::Com
 {
     size_t networkSeq;
     EmberAfNetworkCommissioningError err = EMBER_ZCL_NETWORK_COMMISSIONING_ERROR_NETWORK_ID_NOT_FOUND;
+    // TODO(cecille): This is very dangerous - need to check against real netif name, ensure no password.
+    constexpr char ethernetNetifMagicCode[] = "ETH0";
+    if (networkID.size() == sizeof(ethernetNetifMagicCode) &&
+        memcmp(networkID.data(), ethernetNetifMagicCode, networkID.size()) == 0)
+    {
+        ChipLogProgress(Zcl, "Wired network enabling requested. Assuming success.");
+        ExitNow(err = EMBER_ZCL_NETWORK_COMMISSIONING_ERROR_SUCCESS);
+    }
 
     for (networkSeq = 0; networkSeq < kMaxNetworks; networkSeq++)
     {
@@ -274,6 +283,10 @@ EmberAfNetworkCommissioningError OnEnableNetworkCommandCallbackInternal(app::Com
     }
     // TODO: We should encode response command here.
 exit:
+    if (err == EMBER_ZCL_NETWORK_COMMISSIONING_ERROR_SUCCESS)
+    {
+        DeviceLayer::Internal::DeviceControlServer::DeviceControlSvr().EnableNetworkForOperational(networkID);
+    }
     return err;
 }
 

src/app/server/RendezvousServer.cpp

@@ -17,6 +17,7 @@
 
 #include <app/server/RendezvousServer.h>
 
+#include <app/server/Mdns.h>
 #include <app/server/StorablePeerConnection.h>
 #include <core/CHIPError.h>
 #include <support/CodeUtils.h>
@@ -33,9 +34,38 @@ using namespace ::chip::Transport;
 using namespace ::chip::DeviceLayer;
 
 namespace chip {
+
+namespace {
+void OnPlatformEventWrapper(const DeviceLayer::ChipDeviceEvent * event, intptr_t arg)
+{
+    RendezvousServer * server = reinterpret_cast<RendezvousServer *>(arg);
+    server->OnPlatformEvent(event);
+}
+} // namespace
 static constexpr uint32_t kSpake2p_Iteration_Count = 100;
 static const char * kSpake2pKeyExchangeSalt        = "SPAKE2P Key Salt";
 
+void RendezvousServer::OnPlatformEvent(const DeviceLayer::ChipDeviceEvent * event)
+{
+    if (event->Type == DeviceLayer::DeviceEventType::kCommissioningComplete)
+    {
+        if (event->CommissioningComplete.status == CHIP_NO_ERROR)
+        {
+            ChipLogProgress(Discovery, "Commissioning completed successfully");
+        }
+        else
+        {
+            ChipLogError(Discovery, "Commissioning errored out with error %u", event->CommissioningComplete.status);
+        }
+        // TODO: Commissioning complete means we can finalize the admin in our storage
+    }
+    else if (event->Type == DeviceLayer::DeviceEventType::kOperationalNetworkEnabled)
+    {
+        app::Mdns::AdvertiseOperational();
+        ChipLogError(Discovery, "Operational advertising enabled");
+    }
+}
+
 CHIP_ERROR RendezvousServer::WaitForPairing(const RendezvousParameters & params, Messaging::ExchangeManager * exchangeManager,
                                             TransportMgrBase * transportMgr, SecureSessionMgr * sessionMgr,
                                             Transport::AdminPairingInfo * admin)
@@ -129,7 +159,19 @@ void RendezvousServer::OnSessionEstablished()
         mDelegate->OnRendezvousStarted();
     }
 
-    Cleanup();
+    DeviceLayer::PlatformMgr().AddEventHandler(OnPlatformEventWrapper, reinterpret_cast<intptr_t>(this));
+
+    if (mPairingSession.PeerConnection().GetPeerAddress().GetTransportType() == Transport::Type::kBle)
+    {
+        Cleanup();
+    }
+    else
+    {
+        // TODO: remove this once we move all tools / examples onto cluster-based IP commissioning.
+#if CONFIG_RENDEZVOUS_WAIT_FOR_COMMISSIONING_COMPLETE
+        Cleanup();
+#endif
+    }
 
     ChipLogProgress(AppServer, "Device completed Rendezvous process");
     StorablePeerConnection connection(mPairingSession, mAdmin->GetAdminId());

src/app/server/RendezvousServer.h

@@ -47,6 +47,7 @@ class RendezvousServer : public SessionEstablishmentDelegate
 
     uint16_t GetNextKeyId() const { return mNextKeyId; }
     void SetNextKeyId(uint16_t id) { mNextKeyId = id; }
+    void OnPlatformEvent(const DeviceLayer::ChipDeviceEvent * event);
 
 private:
     AppDelegate * mDelegate;

src/app/server/Server.cpp

@@ -457,6 +457,7 @@ static void ChipEventHandler(const DeviceLayer::ChipDeviceEvent * event, intptr_
     {
     case DeviceLayer::DeviceEventType::kInternetConnectivityChange:
         VerifyOrReturn(event->InternetConnectivityChange.IPv4 == DeviceLayer::kConnectivity_Established);
+        // TODO : Need to check if we're properly commissioned.
         advertise();
         break;
 #if CHIP_DEVICE_CONFIG_ENABLE_THREAD