IP cluster-based commissioning

[cecille]

Problem

Commissioning doesn't currently perform any of the required steps for actually commissioning a device.

Change overview

Adds calls to clusters to perform commissioning required for IP-based devices

• arms failsafe
• sets regulatory config
• enables network
• looks for device on operational network
• calls commissioning complete.

Testing

manual (requires controller and device) - chip-device-ctrl and M5 in commissionable node mode.
Start M5 with network credentials, go to Setup->Force wifi commissioning. Use chip-device-ctrl to connect (connect -qr "[qrcode]")

Fixes #5715

[todo]

issue #6792 - the secure session parameter should be made non-optional and passed by reference.

connectedhomeip/src/app/CommandSender.h

Lines 48 to 52 in 1b2c80a

	// TODO: issue #6792 - the secure session parameter should be made non-optional and passed by reference.
	CHIP_ERROR SendCommandRequest(NodeId aNodeId, Transport::AdminId aAdminId, SecureSessionHandle * secureSession = nullptr);
	void OnMessageReceived(Messaging::ExchangeContext * apExchangeContext, const PacketHeader & aPacketHeader,
	const PayloadHeader & aPayloadHeader, System::PacketBufferHandle aPayload) override;

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): This is very dangerous - need to check against real netif name, ensure no password.

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

Lines 271 to 281 in 1b2c80a

	// TODO(cecille): This is very dangerous - need to check against real netif name, ensure no password.
	static constexpr char ethernetNetifMagicCode[] = "ETH0";
	if (networkID.size() == sizeof(ethernetNetifMagicCode) &&
	memcmp(networkID.data(), ethernetNetifMagicCode, networkID.size()) == 0)
	{
	ChipLogProgress(Zcl, "Enabling ethernet network");
	ExitNow(err = EMBER_ZCL_NETWORK_COMMISSIONING_ERROR_SUCCESS);
	}
	for (networkSeq = 0; networkSeq < kMaxNetworks; networkSeq++)
	{

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

Commissioning complete means we can finalize the admin in our storage

connectedhomeip/src/app/server/RendezvousServer.cpp

Lines 60 to 70 in 1b2c80a

	// 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,

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

remove this once we move all tools / examples onto cluster-based IP commissioning.

connectedhomeip/src/app/server/RendezvousServer.cpp

Lines 170 to 177 in 1b2c80a

	// 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());

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

Need to check if we're properly commissioned.

connectedhomeip/src/app/server/Server.cpp

Lines 459 to 462 in 1b2c80a

	// TODO : Need to check if we're properly commissioned.
	advertise();
	break;
	#if CHIP_DEVICE_CONFIG_ENABLE_THREAD

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): For IP rendezvous, these need to go through the state machine once they're implemented.

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1208 to 1211 in 1b2c80a

	// TODO(cecille): For IP rendezvous, these need to go through the state machine once they're implemented.
	ReturnErrorOnFailure(
	SendOperationalCertificate(device, ByteSpan(chipCert.Get(), opCertLen), ByteSpan(signingCert.Get(), signingCertLen)));

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

for softAP, this needs to be network setup

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1584 to 1594 in 1b2c80a

	return CommissioningStage::kNetworkEnable; // TODO : for softAP, this needs to be network setup
	case CommissioningStage::kNetworkEnable:
	#if CHIP_DEVICE_CONFIG_ENABLE_MDNS
	return CommissioningStage::kFindOperational; // TODO : once case is working, need to add stages to find and reconnect
	// here.
	#else
	return CommissioningStage::kSendComplete;
	#endif
	case CommissioningStage::kFindOperational:
	return CommissioningStage::kSendComplete;
	case CommissioningStage::kSendComplete:

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

once case is working, need to add stages to find and reconnect

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1587 to 1597 in 1b2c80a

	return CommissioningStage::kFindOperational; // TODO : once case is working, need to add stages to find and reconnect
	// here.
	#else
	return CommissioningStage::kSendComplete;
	#endif
	case CommissioningStage::kFindOperational:
	return CommissioningStage::kSendComplete;
	case CommissioningStage::kSendComplete:
	return CommissioningStage::kCleanup;
	// Currently unimplemented.

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): We probably want something better than this for breadcrumbs.

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1632 to 1642 in 1b2c80a

	// TODO(cecille): We probably want something better than this for breadcrumbs.
	uint64_t breadcrumb = static_cast<uint64_t>(nextStage);
	// TODO(cecille): This should be customized per command.
	uint32_t commandTimeoutMs = 1000;
	switch (nextStage)
	{
	case CommissioningStage::kArmFailsafe: {
	// TODO(cecille): This is NOT the right way to do this - we should consider attaching an im delegate per command or
	// something. Per exchange context?

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): This should be customized per command.

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1635 to 1645 in 1b2c80a

	// TODO(cecille): This should be customized per command.
	uint32_t commandTimeoutMs = 1000;
	switch (nextStage)
	{
	case CommissioningStage::kArmFailsafe: {
	// TODO(cecille): This is NOT the right way to do this - we should consider attaching an im delegate per command or
	// something. Per exchange context?
	if (mDefaultIMDelegate == nullptr)
	{
	ChipLogProgress(Controller, "swapping delegate for IM");

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): This is NOT the right way to do this - we should consider attaching an im delegate per command or

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1641 to 1651 in 1b2c80a

	// TODO(cecille): This is NOT the right way to do this - we should consider attaching an im delegate per command or
	// something. Per exchange context?
	if (mDefaultIMDelegate == nullptr)
	{
	ChipLogProgress(Controller, "swapping delegate for IM");
	mDefaultIMDelegate = chip::Platform::New<DeviceControllerInteractionModelDelegate>();
	chip::app::InteractionModelEngine::GetInstance()->SetDelegate(mDefaultIMDelegate);
	device->InitCommandSender();
	}
	ChipLogProgress(Controller, "Arming failsafe");

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): Find a way to enumerate the clusters here.

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1653 to 1663 in 1b2c80a

	// TODO(cecille): Find a way to enumerate the clusters here.
	GeneralCommissioningCluster genCom;
	uint16_t commissioningExpirySeconds = 5;
	// TODO: should get the endpoint information from the descriptor cluster.
	genCom.Associate(device, 0);
	genCom.ArmFailSafe(success->Cancel(), failure->Cancel(), commissioningExpirySeconds, breadcrumb, commandTimeoutMs);
	}
	break;
	case CommissioningStage::kConfigRegulatory: {
	// To set during config phase:
	// UTC time

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

should get the endpoint information from the descriptor cluster.

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1656 to 1666 in 1b2c80a

	// TODO: should get the endpoint information from the descriptor cluster.
	genCom.Associate(device, 0);
	genCom.ArmFailSafe(success->Cancel(), failure->Cancel(), commissioningExpirySeconds, breadcrumb, commandTimeoutMs);
	}
	break;
	case CommissioningStage::kConfigRegulatory: {
	// To set during config phase:
	// UTC time
	// time zone
	// dst offset
	// Regulatory config

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): Set time as well once the time cluster is implemented

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1667 to 1677 in 1b2c80a

	// TODO(cecille): Set time as well once the time cluster is implemented
	// TODO(cecille): Worthwhile to keep this around as part of the class?
	// TODO(cecille): Where is the country config actually set?
	ChipLogProgress(Controller, "Setting Regulatory Config");
	uint32_t regulatoryLocation;
	CHIP_ERROR status = DeviceLayer::ConfigurationMgr().GetRegulatoryLocation(regulatoryLocation);
	if (status != CHIP_NO_ERROR)
	{
	ChipLogError(Controller, "Unable to find regulatory location, defaulting to outdoor");
	regulatoryLocation = EMBER_ZCL_REGULATORY_LOCATION_TYPE_OUTDOOR;
	}

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): Worthwhile to keep this around as part of the class?

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1668 to 1678 in 1b2c80a

	// TODO(cecille): Worthwhile to keep this around as part of the class?
	// TODO(cecille): Where is the country config actually set?
	ChipLogProgress(Controller, "Setting Regulatory Config");
	uint32_t regulatoryLocation;
	CHIP_ERROR status = DeviceLayer::ConfigurationMgr().GetRegulatoryLocation(regulatoryLocation);
	if (status != CHIP_NO_ERROR)
	{
	ChipLogError(Controller, "Unable to find regulatory location, defaulting to outdoor");
	regulatoryLocation = EMBER_ZCL_REGULATORY_LOCATION_TYPE_OUTDOOR;
	}

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): Where is the country config actually set?

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1669 to 1679 in 1b2c80a

	// TODO(cecille): Where is the country config actually set?
	ChipLogProgress(Controller, "Setting Regulatory Config");
	uint32_t regulatoryLocation;
	CHIP_ERROR status = DeviceLayer::ConfigurationMgr().GetRegulatoryLocation(regulatoryLocation);
	if (status != CHIP_NO_ERROR)
	{
	ChipLogError(Controller, "Unable to find regulatory location, defaulting to outdoor");
	regulatoryLocation = EMBER_ZCL_REGULATORY_LOCATION_TYPE_OUTDOOR;
	}
	static constexpr size_t kMaxCountryCodeSize = 3;

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): Once this is implemented through the clusters, it should be moved to the proper stage and the callback

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1699 to 1709 in 1b2c80a

	// TODO(cecille): Once this is implemented through the clusters, it should be moved to the proper stage and the callback
	// should advance the commissioning stage
	CHIP_ERROR status = SendOperationalCertificateSigningRequestCommand(device);
	if (status != CHIP_NO_ERROR)
	{
	ChipLogError(Controller, "Failed in sending opcsr request command to the device: err %s", ErrorStr(err));
	OnSessionEstablishmentError(err);
	return;
	}
	}
	break;

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

Right now, these stages are not implemented as a separate stage because they are no-ops.

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1710 to 1720 in 1b2c80a

	// TODO: Right now, these stages are not implemented as a separate stage because they are no-ops.
	// Once these are implemented through the clusters, these should be moved into their separate stages and the callbacks
	// should advance the commissioning stage.
	case CommissioningStage::kConfigACL:
	case CommissioningStage::kNetworkSetup:
	case CommissioningStage::kScanNetworks:
	// TODO: Implement
	break;
	case CommissioningStage::kNetworkEnable: {
	ChipLogProgress(Controller, "Enabling Network");
	// TODO: For ethernet, we actually need a scan stage to get the ethernet netif name. Right now, default to using a magic

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

Implement

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1716 to 1726 in 1b2c80a

	// TODO: Implement
	break;
	case CommissioningStage::kNetworkEnable: {
	ChipLogProgress(Controller, "Enabling Network");
	// TODO: For ethernet, we actually need a scan stage to get the ethernet netif name. Right now, default to using a magic
	// value to enable without checks.
	NetworkCommissioningCluster netCom;
	// TODO: should get the endpoint information from the descriptor cluster.
	netCom.Associate(device, 0);
	// TODO: Once network credential sending is implemented, attempting to set wifi credential on an ethernet only device
	// will cause an error to be sent back. At that point, we should scan and we shoud see the proper ethernet network ID

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

For ethernet, we actually need a scan stage to get the ethernet netif name. Right now, default to using a magic

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1720 to 1730 in 1b2c80a

	// TODO: For ethernet, we actually need a scan stage to get the ethernet netif name. Right now, default to using a magic
	// value to enable without checks.
	NetworkCommissioningCluster netCom;
	// TODO: should get the endpoint information from the descriptor cluster.
	netCom.Associate(device, 0);
	// TODO: Once network credential sending is implemented, attempting to set wifi credential on an ethernet only device
	// will cause an error to be sent back. At that point, we should scan and we shoud see the proper ethernet network ID
	// returned in the scan results. For now, we use magic.
	char magicNetworkEnableCode[] = "ETH0";
	netCom.EnableNetwork(success->Cancel(), failure->Cancel(),
	ByteSpan(reinterpret_cast<uint8_t *>(&magicNetworkEnableCode), sizeof(magicNetworkEnableCode)),

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

should get the endpoint information from the descriptor cluster.

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1723 to 1733 in 1b2c80a

	// TODO: should get the endpoint information from the descriptor cluster.
	netCom.Associate(device, 0);
	// TODO: Once network credential sending is implemented, attempting to set wifi credential on an ethernet only device
	// will cause an error to be sent back. At that point, we should scan and we shoud see the proper ethernet network ID
	// returned in the scan results. For now, we use magic.
	char magicNetworkEnableCode[] = "ETH0";
	netCom.EnableNetwork(success->Cancel(), failure->Cancel(),
	ByteSpan(reinterpret_cast<uint8_t *>(&magicNetworkEnableCode), sizeof(magicNetworkEnableCode)),
	breadcrumb, commandTimeoutMs);
	}
	break;

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

Once network credential sending is implemented, attempting to set wifi credential on an ethernet only device

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1725 to 1735 in 1b2c80a

	// TODO: Once network credential sending is implemented, attempting to set wifi credential on an ethernet only device
	// will cause an error to be sent back. At that point, we should scan and we shoud see the proper ethernet network ID
	// returned in the scan results. For now, we use magic.
	char magicNetworkEnableCode[] = "ETH0";
	netCom.EnableNetwork(success->Cancel(), failure->Cancel(),
	ByteSpan(reinterpret_cast<uint8_t *>(&magicNetworkEnableCode), sizeof(magicNetworkEnableCode)),
	breadcrumb, commandTimeoutMs);
	}
	break;
	case CommissioningStage::kFindOperational: {
	#if CHIP_DEVICE_CONFIG_ENABLE_MDNS

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

this is actualy not correct - we must reconnect over CASE to send this command.

connectedhomeip/src/controller/CHIPDeviceController.cpp

Lines 1744 to 1754 in 1b2c80a

	// TODO this is actualy not correct - we must reconnect over CASE to send this command.
	ChipLogProgress(Controller, "Calling commissioning complete");
	GeneralCommissioningCluster genCom;
	genCom.Associate(device, 0);
	genCom.CommissioningComplete(success->Cancel(), failure->Cancel());
	}
	break;
	case CommissioningStage::kCleanup:
	ChipLogProgress(Controller, "Rendezvous cleanup");
	RendezvousCleanup(CHIP_NO_ERROR);
	break;

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): This should just specify wifi or thread since we assume at most 1.

connectedhomeip/src/include/platform/CHIPDeviceEvent.h

Lines 422 to 427 in 1b2c80a

	// TODO(cecille): This should just specify wifi or thread since we assume at most 1.
	int network;
	} OperationalNetwork;
	};
	void Clear() { memset(this, 0, sizeof(*this)); }

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.

[todo]

(cecille): This command fails on ESP32, but it's blocking IP cluster-based commissioning so for now just return a success

connectedhomeip/src/platform/DeviceControlServer.cpp

Lines 94 to 104 in 1b2c80a

	// TODO(cecille): This command fails on ESP32, but it's blocking IP cluster-based commissioning so for now just return a success
	// status.
	return CHIP_NO_ERROR;
	}
	CHIP_ERROR DeviceControlServer::EnableNetworkForOperational(ByteSpan networkID)
	{
	ChipDeviceEvent event;
	event.Type = DeviceEventType::kOperationalNetworkEnabled;
	// TODO(cecille): This should be some way to specify thread or wifi.
	event.OperationalNetwork.network = 0;

---

This comment was generated by todo based on a TODO comment in 1b2c80a in #6798. cc @cecille.