[NWPROV] Fix spec compliance issues #17038

erjiaqing · 2022-04-05T04:29:32Z

Problem

Fixes #17010

Some definitions in network commissioning cluster does not match the spec

Change overview

Update the xml and the code
Apply some trivial changes to platform code

Testing

Build should pass.

bzbarsky-apple · 2022-04-05T14:27:46Z

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

+    using ClusterObject     = NetworkCommissioning::WiFiSecurity;
+    using PlatformInterface = NetworkCommissioning::WiFiSecurity;


These are the same type, so the asserts below are trivially going to pass.

What I would suggests is that we get rid of DeviceLayer::NetworkCommissioning::WiFiSecurity and include cluster-enums.h in the relevant places so we can use Clusters::NetworkCommissioning::WiFiSecurity directly.

This is discuessed before, and we want to avoid using cluster-enums in platform code.

cluster-enums was specifically created so it can be used in platform code. Not to be confused with non-ABI-stable cluster-objects.

+1 cluster-enums.h is usable in platform layer and was introduced to avoid this

bzbarsky-apple · 2022-04-05T14:32:56Z

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

+        if (!nullableSSID.IsNull())
+        {
+            ssid = nullableSSID.Value();
+        }


This should enforce the "1 to 32" length constraint from the spec.

bzbarsky-apple · 2022-04-05T14:36:40Z

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

        mAsyncCommandHandle = CommandHandler::Handle(&ctx.mCommandHandler);
-        mpDriver.Get<WiFiDriver *>()->ScanNetworks(req.ssid, this);
+        mpDriver.Get<WiFiDriver *>()->ScanNetworks(ssid, this);


Unfortunately, the driver interface is not documented very well, so the implementations of it differ in how they handle the SSID. For example, src/platform/Ameba/NetworkCommissioningWiFiDriver.cpp checks ssid.data() to decide whether we're doing a single-ssid scan or general scan, while src/platform/EFR32/NetworkCommissioningWiFiDriver.cpp checks ssid.size(). If we checked the size here the difference would at least not be observable, but as it is they would reply differently to the same protocol message.

My recommendation would be to change the driver API to have separate functions for "scan for networks with the given SSID" and "scan for all networks" so the only place where we have to make that decision is here.

#17060 filed on this

bzbarsky-apple · 2022-04-05T14:37:07Z

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

-    memcpy(mLastNetworkID, mConnectingNetworkID, mLastNetworkIDLen);
-    mLastNetworkingStatusValue.SetNonNull(ToClusterObjectEnum(commissioningError));
-
+    if (debugText.size() != 0)


Should be using empty(), really.

bzbarsky-apple · 2022-04-05T14:39:50Z

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


    SuccessOrExit(err = commandHandle->PrepareCommand(
                      ConcreteCommandPath(mPath.mEndpointId, NetworkCommissioning::Id, Commands::ScanNetworksResponse::Id)));
    VerifyOrExit((writer = commandHandle->GetCommandDataIBTLVWriter()) != nullptr, err = CHIP_ERROR_INCORRECT_STATE);

    SuccessOrExit(err = writer->Put(TLV::ContextTag(to_underlying(Commands::ScanNetworksResponse::Fields::kNetworkingStatus)),
                                    ToClusterObjectEnum(status)));
-    SuccessOrExit(err = DataModel::Encode(
-                      *writer, TLV::ContextTag(to_underlying(Commands::ScanNetworksResponse::Fields::kDebugText)), debugText));
+    if (debugText.size() != 0)


bzbarsky-apple · 2022-04-05T14:40:52Z

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

@@ -436,28 +468,33 @@ void Instance::OnFinished(Status status, CharSpan debugText, ThreadScanResponseI
    TLV::TLVType listContainerType;
    ThreadScanResponse scanResponse;
    size_t networksEncoded = 0;
+    uint8_t extendedAddressBuffer[8];


That 8 should be a constant defined somewhere. I would be very surprised if we do not have a constant for this already.

* Fix spec compliance of network commissioning cluster * Update existing platform code * Run Codegen

* [nwprov] Resolve comments in #17038 add more checks * Remove enums in include/platform/NetworkCommissioning.h use ssid.empty() instead of ssid.size() * Fix template * Regen

* Fix spec compliance of network commissioning cluster * Update existing platform code * Run Codegen

…ect-chip#17197) * [nwprov] Resolve comments in project-chip#17038 add more checks * Remove enums in include/platform/NetworkCommissioning.h use ssid.empty() instead of ssid.size() * Fix template * Regen

erjiaqing added 3 commits April 5, 2022 12:24

Fix spec compliance of network commissioning cluster

ce6e914

Update existing platform code

506b962

Run Codegen

bd33f25

boring-cyborg bot added app controller darwin examples labels Apr 5, 2022

pullapprove bot requested review from sagar-apple, saurabhst, selissia, tecimovic, turon, vijs, vivien-apple, wbschiller, woody-apple, xylophone21 and yufengwangca April 5, 2022 04:37

pullapprove bot added the review - pending label Apr 5, 2022

woody-apple approved these changes Apr 5, 2022

View reviewed changes

Damian-Nordic approved these changes Apr 5, 2022

View reviewed changes

pullapprove bot added review - approved and removed review - pending labels Apr 5, 2022

tcarmelveilleux approved these changes Apr 5, 2022

View reviewed changes

tcarmelveilleux merged commit fae3888 into project-chip:master Apr 5, 2022

bzbarsky-apple reviewed Apr 5, 2022

View reviewed changes

bzbarsky-apple mentioned this pull request Apr 5, 2022

Fix handling of 0-length SSID in ScanNetworks #17060

Closed

chencheung pushed a commit to chencheung/connectedhomeip that referenced this pull request Apr 6, 2022

[NWPROV] Fix spec compliance issues (project-chip#17038)

826fece

* Fix spec compliance of network commissioning cluster * Update existing platform code * Run Codegen

chencheung pushed a commit to chencheung/connectedhomeip that referenced this pull request Apr 6, 2022

[NWPROV] Fix spec compliance issues (project-chip#17038)

637741c

* Fix spec compliance of network commissioning cluster * Update existing platform code * Run Codegen

erjiaqing added a commit to erjiaqing/connectedhomeip that referenced this pull request Apr 7, 2022

[nwprov] Resolve comments in project-chip#17038 add more checks

57e3dc0

erjiaqing added a commit to erjiaqing/connectedhomeip that referenced this pull request Apr 8, 2022

[nwprov] Resolve comments in project-chip#17038 add more checks

8ed091a

erjiaqing added a commit to erjiaqing/connectedhomeip that referenced this pull request Apr 8, 2022

[nwprov] Resolve comments in project-chip#17038 add more checks

0c81935

erjiaqing mentioned this pull request Apr 8, 2022

[nwprov] Resolve comments in #17038 add more checks #17197

Merged

erjiaqing added a commit to erjiaqing/connectedhomeip that referenced this pull request Apr 8, 2022

[nwprov] Resolve comments in project-chip#17038 add more checks

f84edea

andrei-menzopol pushed a commit to andrei-menzopol/connectedhomeip that referenced this pull request Apr 14, 2022

[NWPROV] Fix spec compliance issues (project-chip#17038)

6437e1c

* Fix spec compliance of network commissioning cluster * Update existing platform code * Run Codegen

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NWPROV] Fix spec compliance issues #17038

[NWPROV] Fix spec compliance issues #17038

erjiaqing commented Apr 5, 2022 •

edited

Loading

bzbarsky-apple Apr 5, 2022

erjiaqing Apr 5, 2022

bzbarsky-apple Apr 5, 2022

tcarmelveilleux Apr 5, 2022

bzbarsky-apple Apr 5, 2022

bzbarsky-apple Apr 5, 2022

bzbarsky-apple Apr 5, 2022

bzbarsky-apple Apr 5, 2022

bzbarsky-apple Apr 5, 2022

bzbarsky-apple Apr 5, 2022

		using ClusterObject = NetworkCommissioning::WiFiSecurity;
		using PlatformInterface = NetworkCommissioning::WiFiSecurity;

[NWPROV] Fix spec compliance issues #17038

[NWPROV] Fix spec compliance issues #17038

Conversation

erjiaqing commented Apr 5, 2022 • edited Loading

Problem

Change overview

Testing

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erjiaqing commented Apr 5, 2022 •

edited

Loading