Use exchange for session establishment and provisioning (project-chip…

…#5938)

* Use exchange for session establishment and provisioning

- Add concept of ExchangeTransport to distinguish between encrypted
  and unencrypted message exchanges
- Update PASE to use exchange manager to send/receive messages
- Update network provisioning code to use exchange manager

* fix build errors

* update data model gni file

* rebase fixes

* release exchange transport on free

* fix failing test

* fix cirque failure

* cleanup

* use oneshot exchange for network provisioning

* fix softap based pairing

* address some review comments

* fix build issue

* reduce exchange context memory requirement

* rename ExchangeTransport to ExchangeMessageDispatch

* use payload header where possible

* reduce RAM usage

* further memory optimizations

* remove unused code

examples/chip-tool/main.cpp

@@ -24,7 +24,7 @@
 #include "commands/payload/Commands.h"
 #include "commands/reporting/Commands.h"
 
-#include <transport/PASESession.h>
+#include <protocols/secure_channel/PASESession.h>
 
 // ================================================================================
 // Main Code

examples/shell/shell_common/cmd_ping.cpp

@@ -26,8 +26,8 @@
 #include <messaging/ExchangeMgr.h>
 #include <platform/CHIPDeviceLayer.h>
 #include <protocols/echo/Echo.h>
+#include <protocols/secure_channel/PASESession.h>
 #include <system/SystemPacketBuffer.h>
-#include <transport/PASESession.h>
 #include <transport/SecureSessionMgr.h>
 #include <transport/raw/TCP.h>
 #include <transport/raw/UDP.h>

src/app/InteractionModelDelegate.h

@@ -26,6 +26,7 @@
 #include <core/CHIPCore.h>
 #include <core/CHIPTLV.h>
 #include <messaging/ExchangeContext.h>
+#include <protocols/secure_channel/Constants.h>
 #include <system/SystemPacketBuffer.h>
 
 namespace chip {

src/app/chip_data_model.gni

@@ -146,6 +146,7 @@ template("chip_data_model") {
       "${chip_root}/src/app",
       "${chip_root}/src/lib/core",
       "${chip_root}/src/lib/support",
+      "${chip_root}/src/protocols/secure_channel",
     ]
 
     if (!defined(public_configs)) {

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

@@ -41,7 +41,7 @@
 #include <platform/ThreadStackManager.h>
 #endif // CHIP_DEVICE_CONFIG_ENABLE_THREAD
 
-#include <transport/NetworkProvisioning.h>
+#include <protocols/secure_channel/NetworkProvisioning.h>
 
 // Include DeviceNetworkProvisioningDelegateImpl for WiFi provisioning.
 // TODO: Enable wifi network should be done by ConnectivityManager. (Or other platform neutral interfaces)

src/app/server/BUILD.gn

@@ -39,6 +39,8 @@ static_library("server") {
     "RendezvousServer.h",
     "Server.cpp",
     "Server.h",
+    "StorablePeerConnection.cpp",
+    "StorablePeerConnection.h",
   ]
 
   public_configs = [ ":server_config" ]

src/app/server/Mdns.cpp

@@ -24,10 +24,10 @@
 #include <messaging/ReliableMessageProtocolConfig.h>
 #include <platform/CHIPDeviceLayer.h>
 #include <platform/ConfigurationManager.h>
+#include <protocols/secure_channel/PASESession.h>
 #include <support/Span.h>
 #include <support/logging/CHIPLogging.h>
 #include <transport/AdminPairingTable.h>
-#include <transport/PASESession.h>
 
 #include "Server.h"
 

src/app/server/RendezvousServer.cpp

@@ -17,11 +17,11 @@
 
 #include <app/server/RendezvousServer.h>
 
+#include <app/server/StorablePeerConnection.h>
 #include <core/CHIPError.h>
 #include <support/CodeUtils.h>
 #include <support/SafeInt.h>
 #include <transport/SecureSessionMgr.h>
-#include <transport/StorablePeerConnection.h>
 
 #if CHIP_ENABLE_OPENTHREAD
 #include <platform/ThreadStackManager.h>
@@ -36,10 +36,11 @@ namespace chip {
 
 RendezvousServer::RendezvousServer() : mRendezvousSession(this) {}
 
-CHIP_ERROR RendezvousServer::WaitForPairing(const RendezvousParameters & params, TransportMgrBase * transportMgr,
-                                            SecureSessionMgr * sessionMgr, Transport::AdminPairingInfo * admin)
+CHIP_ERROR RendezvousServer::WaitForPairing(const RendezvousParameters & params, Messaging::ExchangeManager * exchangeManager,
+                                            TransportMgrBase * transportMgr, SecureSessionMgr * sessionMgr,
+                                            Transport::AdminPairingInfo * admin)
 {
-    return mRendezvousSession.Init(params, transportMgr, sessionMgr, admin);
+    return mRendezvousSession.Init(params, exchangeManager, transportMgr, sessionMgr, admin);
 }
 
 void RendezvousServer::OnRendezvousError(CHIP_ERROR err)

src/app/server/RendezvousServer.h

@@ -19,8 +19,9 @@
 
 #include <app/server/AppDelegate.h>
 #include <core/CHIPPersistentStorageDelegate.h>
+#include <messaging/ExchangeMgr.h>
 #include <platform/CHIPDeviceLayer.h>
-#include <transport/RendezvousSession.h>
+#include <protocols/secure_channel/RendezvousSession.h>
 
 namespace chip {
 
@@ -29,8 +30,8 @@ class RendezvousServer : public RendezvousSessionDelegate
 public:
     RendezvousServer();
 
-    CHIP_ERROR WaitForPairing(const RendezvousParameters & params, TransportMgrBase * transportMgr, SecureSessionMgr * sessionMgr,
-                              Transport::AdminPairingInfo * admin);
+    CHIP_ERROR WaitForPairing(const RendezvousParameters & params, Messaging::ExchangeManager * exchangeManager,
+                              TransportMgrBase * transportMgr, SecureSessionMgr * sessionMgr, Transport::AdminPairingInfo * admin);
 
     CHIP_ERROR Init(AppDelegate * delegate, PersistentStorageDelegate * storage)
     {

src/app/server/Server.cpp

@@ -22,6 +22,7 @@
 #include <app/InteractionModelEngine.h>
 #include <app/server/EchoHandler.h>
 #include <app/server/RendezvousServer.h>
+#include <app/server/StorablePeerConnection.h>
 #include <app/util/DataModelHandler.h>
 
 #include <ble/BLEEndPoint.h>
@@ -40,7 +41,6 @@
 #include <system/SystemPacketBuffer.h>
 #include <system/TLVPacketBufferBackingStore.h>
 #include <transport/SecureSessionMgr.h>
-#include <transport/StorablePeerConnection.h>
 
 #include "Mdns.h"
 
@@ -296,6 +296,7 @@ class ServerRendezvousAdvertisementDelegate : public RendezvousAdvertisementDele
 DemoTransportMgr gTransports;
 SecureSessionMgr gSessions;
 RendezvousServer gRendezvousServer;
+Messaging::ExchangeManager gExchangeMgr;
 ServerRendezvousAdvertisementDelegate gAdvDelegate;
 
 static CHIP_ERROR OpenPairingWindowUsingVerifier(uint16_t discriminator, PASEVerifier & verifier)
@@ -318,7 +319,7 @@ static CHIP_ERROR OpenPairingWindowUsingVerifier(uint16_t discriminator, PASEVer
     VerifyOrReturnError(adminInfo != nullptr, CHIP_ERROR_NO_MEMORY);
     gNextAvailableAdminId++;
 
-    return gRendezvousServer.WaitForPairing(std::move(params), &gTransports, &gSessions, adminInfo);
+    return gRendezvousServer.WaitForPairing(std::move(params), &gExchangeMgr, &gTransports, &gSessions, adminInfo);
 }
 
 class ServerCallback : public ExchangeDelegate
@@ -407,7 +408,6 @@ class ServerCallback : public ExchangeDelegate
     SecureSessionMgr * mSessionMgr = nullptr;
 };
 
-Messaging::ExchangeManager gExchangeMgr;
 ServerCallback gCallbacks;
 SecurePairingUsingTestSecret gTestPairing;
 
@@ -457,7 +457,7 @@ CHIP_ERROR OpenDefaultPairingWindow(ResetAdmins resetAdmins, chip::PairingWindow
     VerifyOrReturnError(adminInfo != nullptr, CHIP_ERROR_NO_MEMORY);
     gNextAvailableAdminId++;
 
-    return gRendezvousServer.WaitForPairing(std::move(params), &gTransports, &gSessions, adminInfo);
+    return gRendezvousServer.WaitForPairing(std::move(params), &gExchangeMgr, &gTransports, &gSessions, adminInfo);
 }
 
 // The function will initialize datamodel handler and then start the server

src/transport/StorablePeerConnection.cpp → src/app/server/StorablePeerConnection.cpp

@@ -15,9 +15,9 @@
  *    limitations under the License.
  */
 
+#include <app/server/StorablePeerConnection.h>
 #include <core/CHIPEncoding.h>
 #include <support/SafeInt.h>
-#include <transport/StorablePeerConnection.h>
 
 namespace chip {
 

src/transport/StorablePeerConnection.h → src/app/server/StorablePeerConnection.h

@@ -18,7 +18,7 @@
 #pragma once
 
 #include <core/CHIPPersistentStorageDelegate.h>
-#include <transport/PASESession.h>
+#include <protocols/secure_channel/PASESession.h>
 
 namespace chip {
 

src/app/tests/BUILD.gn

@@ -33,6 +33,7 @@ chip_test_suite("tests") {
   public_deps = [
     "${chip_root}/src/app",
     "${chip_root}/src/lib/core",
+    "${chip_root}/src/protocols",
     "${nlunit_test_root}:nlunit-test",
   ]
 }

src/app/tests/TestCommandInteraction.cpp

@@ -31,11 +31,11 @@
 #include <messaging/ExchangeMgr.h>
 #include <messaging/Flags.h>
 #include <platform/CHIPDeviceLayer.h>
+#include <protocols/secure_channel/PASESession.h>
 #include <support/ErrorStr.h>
 #include <support/UnitTestRegistration.h>
 #include <system/SystemPacketBuffer.h>
 #include <system/TLVPacketBufferBackingStore.h>
-#include <transport/PASESession.h>
 #include <transport/SecureSessionMgr.h>
 #include <transport/raw/UDP.h>
 
@@ -68,6 +68,15 @@ class TestCommandInteraction
                                                       bool aIsEmptyResponse);
 };
 
+class TestExchangeDelegate : public Messaging::ExchangeDelegate
+{
+    void OnMessageReceived(Messaging::ExchangeContext * ec, const PacketHeader & packetHeader, const PayloadHeader & payloadHeader,
+                           System::PacketBufferHandle payload) override
+    {}
+
+    void OnResponseTimeout(Messaging::ExchangeContext * ec) override {}
+};
+
 void TestCommandInteraction::GenerateReceivedCommand(nlTestSuite * apSuite, void * apContext, System::PacketBufferHandle & aPayload)
 {
     CHIP_ERROR err = CHIP_NO_ERROR;
@@ -189,7 +198,9 @@ void TestCommandInteraction::TestCommandHandlerWithSendEmptyCommand(nlTestSuite
     NL_TEST_ASSERT(apSuite, err == CHIP_NO_ERROR);
 
     commandHandler.mpExchangeCtx = gExchangeManager.NewContext({ 0, 0, 0 }, nullptr);
-    err                          = commandHandler.AddCommand(commandParams);
+    TestExchangeDelegate delegate;
+    commandHandler.mpExchangeCtx->SetDelegate(&delegate);
+    err = commandHandler.AddCommand(commandParams);
     NL_TEST_ASSERT(apSuite, err == CHIP_NO_ERROR);
     err = commandHandler.SendCommandResponse();
     NL_TEST_ASSERT(apSuite, err == CHIP_ERROR_NOT_CONNECTED);
@@ -221,7 +232,9 @@ void TestCommandInteraction::ValidateCommandHandlerWithSendCommand(nlTestSuite *
     NL_TEST_ASSERT(apSuite, err == CHIP_NO_ERROR);
 
     commandHandler.mpExchangeCtx = gExchangeManager.NewContext({ 0, 0, 0 }, nullptr);
-    ;
+    TestExchangeDelegate delegate;
+    commandHandler.mpExchangeCtx->SetDelegate(&delegate);
+
     AddCommandDataElement(apSuite, apContext, &commandHandler, aNeedStatusCode, aIsEmptyResponse);
     err = commandHandler.SendCommandResponse();
     NL_TEST_ASSERT(apSuite, err == CHIP_ERROR_NOT_CONNECTED);

src/app/tests/TestReadInteraction.cpp

@@ -31,11 +31,11 @@
 #include <messaging/ExchangeMgr.h>
 #include <messaging/Flags.h>
 #include <platform/CHIPDeviceLayer.h>
+#include <protocols/secure_channel/PASESession.h>
 #include <support/ErrorStr.h>
 #include <support/UnitTestRegistration.h>
 #include <system/SystemPacketBuffer.h>
 #include <system/TLVPacketBufferBackingStore.h>
-#include <transport/PASESession.h>
 #include <transport/SecureSessionMgr.h>
 #include <transport/raw/UDP.h>
 

src/app/tests/TestReportingEngine.cpp

@@ -32,11 +32,11 @@
 #include <messaging/ExchangeMgr.h>
 #include <messaging/Flags.h>
 #include <platform/CHIPDeviceLayer.h>
+#include <protocols/secure_channel/PASESession.h>
 #include <support/ErrorStr.h>
 #include <support/UnitTestRegistration.h>
 #include <system/SystemPacketBuffer.h>
 #include <system/TLVPacketBufferBackingStore.h>
-#include <transport/PASESession.h>
 #include <transport/SecureSessionMgr.h>
 #include <transport/raw/UDP.h>
 
@@ -57,6 +57,15 @@ class TestReportingEngine
     static void TestBuildAndSendSingleReportData(nlTestSuite * apSuite, void * apContext);
 };
 
+class TestExchangeDelegate : public Messaging::ExchangeDelegate
+{
+    void OnMessageReceived(Messaging::ExchangeContext * ec, const PacketHeader & packetHeader, const PayloadHeader & payloadHeader,
+                           System::PacketBufferHandle payload) override
+    {}
+
+    void OnResponseTimeout(Messaging::ExchangeContext * ec) override {}
+};
+
 void TestReportingEngine::TestBuildAndSendSingleReportData(nlTestSuite * apSuite, void * apContext)
 {
     CHIP_ERROR err = CHIP_NO_ERROR;
@@ -69,6 +78,9 @@ void TestReportingEngine::TestBuildAndSendSingleReportData(nlTestSuite * apSuite
     err = InteractionModelEngine::GetInstance()->Init(&gExchangeManager, nullptr);
     NL_TEST_ASSERT(apSuite, err == CHIP_NO_ERROR);
     Messaging::ExchangeContext * exchangeCtx = gExchangeManager.NewContext({ 0, 0, 0 }, nullptr);
+    TestExchangeDelegate delegate;
+    exchangeCtx->SetDelegate(&delegate);
+
     writer.Init(std::move(readRequestbuf));
     err = readRequestBuilder.Init(&writer);
     NL_TEST_ASSERT(apSuite, err == CHIP_NO_ERROR);

src/app/tests/integration/chip_im_initiator.cpp

@@ -33,10 +33,9 @@
 #include <core/CHIPCore.h>
 #include <mutex>
 #include <platform/CHIPDeviceLayer.h>
-
+#include <protocols/secure_channel/PASESession.h>
 #include <support/ErrorStr.h>
 #include <system/SystemPacketBuffer.h>
-#include <transport/PASESession.h>
 #include <transport/SecureSessionMgr.h>
 #include <transport/raw/UDP.h>
 

src/app/tests/integration/chip_im_responder.cpp

@@ -33,9 +33,9 @@
 #include <messaging/ExchangeMgr.h>
 #include <messaging/Flags.h>
 #include <platform/CHIPDeviceLayer.h>
+#include <protocols/secure_channel/PASESession.h>
 #include <support/ErrorStr.h>
 #include <system/SystemPacketBuffer.h>
-#include <transport/PASESession.h>
 #include <transport/SecureSessionMgr.h>
 #include <transport/raw/UDP.h>
 

src/controller/BUILD.gn

@@ -41,6 +41,7 @@ static_library("controller") {
     "${chip_root}/src/lib/support",
     "${chip_root}/src/messaging",
     "${chip_root}/src/platform",
+    "${chip_root}/src/protocols",
     "${chip_root}/src/setup_payload",
     "${chip_root}/src/transport",
   ]

src/controller/CHIPDevice.cpp

@@ -55,6 +55,15 @@ using namespace chip::Callback;
 
 namespace chip {
 namespace Controller {
+// TODO: This is a placeholder delegate for exchange context created in Device::SendMessage()
+//       Delete this class when Device::SendMessage() is obsoleted.
+class DeviceExchangeDelegate : public Messaging::ExchangeDelegate
+{
+    void OnMessageReceived(Messaging::ExchangeContext * ec, const PacketHeader & packetHeader, const PayloadHeader & payloadHeader,
+                           System::PacketBufferHandle payload) override
+    {}
+    void OnResponseTimeout(Messaging::ExchangeContext * ec) override {}
+};
 
 CHIP_ERROR Device::SendMessage(Protocols::Id protocolId, uint8_t msgType, System::PacketBufferHandle buffer)
 {
@@ -86,6 +95,9 @@ CHIP_ERROR Device::SendMessage(Protocols::Id protocolId, uint8_t msgType, System
     // receive the ack message. This logic need to be deleted after we converting all legacy ZCL messages to IM messages.
     sendFlags.Set(Messaging::SendMessageFlags::kFromInitiator).Set(Messaging::SendMessageFlags::kNoAutoRequestAck);
 
+    DeviceExchangeDelegate delegate;
+    exchange->SetDelegate(&delegate);
+
     CHIP_ERROR err = exchange->SendMessage(protocolId, msgType, std::move(buffer), sendFlags);
 
     buffer = nullptr;

src/controller/CHIPDevice.h

@@ -33,10 +33,10 @@
 #include <core/CHIPCallback.h>
 #include <core/CHIPCore.h>
 #include <messaging/ExchangeMgr.h>
+#include <protocols/secure_channel/PASESession.h>
 #include <setup_payload/SetupPayload.h>
 #include <support/Base64.h>
 #include <support/DLLUtil.h>
-#include <transport/PASESession.h>
 #include <transport/SecureSessionMgr.h>
 #include <transport/TransportMgr.h>
 #include <transport/raw/MessageHeader.h>

src/controller/CHIPDeviceController.cpp

@@ -705,8 +705,8 @@ CHIP_ERROR DeviceCommissioner::PairDevice(NodeId remoteDeviceId, RendezvousParam
     mRendezvousSession = chip::Platform::New<RendezvousSession>(this);
     VerifyOrExit(mRendezvousSession != nullptr, err = CHIP_ERROR_NO_MEMORY);
     mRendezvousSession->SetNextKeyId(mNextKeyId);
-    err = mRendezvousSession->Init(params.SetLocalNodeId(mLocalDeviceId).SetRemoteNodeId(remoteDeviceId), mTransportMgr,
-                                   mSessionMgr, admin);
+    err = mRendezvousSession->Init(params.SetLocalNodeId(mLocalDeviceId).SetRemoteNodeId(remoteDeviceId), mExchangeMgr,
+                                   mTransportMgr, mSessionMgr, admin);
     SuccessOrExit(err);
 
     device->Init(GetControllerDeviceInitParams(), mListenPort, remoteDeviceId, udpPeerAddress, admin->GetAdminId());

src/controller/CHIPDeviceController.h

@@ -35,10 +35,10 @@
 #include <core/CHIPTLV.h>
 #include <messaging/ExchangeMgr.h>
 #include <messaging/ExchangeMgrDelegate.h>
+#include <protocols/secure_channel/RendezvousSession.h>
 #include <support/DLLUtil.h>
 #include <support/SerializableIntegerSet.h>
 #include <transport/AdminPairingTable.h>
-#include <transport/RendezvousSession.h>
 #include <transport/RendezvousSessionDelegate.h>
 #include <transport/SecureSessionMgr.h>
 #include <transport/TransportMgr.h>