[chip-tool] Create ChipToolCheckInDelegate

Author: erjiaqing

examples/chip-tool/BUILD.gn

@@ -58,6 +58,8 @@ static_library("chip-tool-utils") {
     "commands/common/BDXDiagnosticLogsServerDelegate.cpp",
     "commands/common/CHIPCommand.cpp",
     "commands/common/CHIPCommand.h",
+    "commands/common/ChipToolCheckInDelegate.cpp",
+    "commands/common/ChipToolCheckInDelegate.h",
     "commands/common/Command.cpp",
     "commands/common/Command.h",
     "commands/common/Commands.cpp",

examples/chip-tool/commands/common/CHIPCommand.cpp

@@ -18,6 +18,7 @@
 
 #include "CHIPCommand.h"
 
+#include <commands/common/ChipToolCheckInDelegate.h>
 #include <controller/CHIPDeviceControllerFactory.h>
 #include <credentials/attestation_verifier/FileAttestationTrustStore.h>
 #include <lib/core/CHIPConfig.h>
@@ -50,7 +51,7 @@ chip::Credentials::GroupDataProviderImpl CHIPCommand::sGroupDataProvider{ kMaxGr
 // All fabrics share the same ICD client storage.
 chip::app::DefaultICDClientStorage CHIPCommand::sICDClientStorage;
 chip::Crypto::RawKeySessionKeystore CHIPCommand::sSessionKeystore;
-chip::app::DefaultCheckInDelegate CHIPCommand::sCheckInDelegate;
+ChipToolCheckInDelegate CHIPCommand::sCheckInDelegate;
 chip::app::CheckInHandler CHIPCommand::sCheckInHandler;
 
 namespace {
@@ -651,3 +652,13 @@ void CHIPCommand::ExecuteDeferredCleanups(intptr_t ignored)
     }
     sDeferredCleanups.clear();
 }
+
+void CHIPCommand::RegisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler)
+{
+    sCheckInDelegate.RegisterOnCheckInCompleteCallback(handler);
+}
+
+void CHIPCommand::UnregisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler)
+{
+    sCheckInDelegate.UnregisterOnCheckInCompleteCallback(handler);
+}

examples/chip-tool/commands/common/CHIPCommand.h

@@ -28,8 +28,8 @@
 
 #include <TracingCommandLineArgument.h>
 #include <app/icd/client/CheckInHandler.h>
-#include <app/icd/client/DefaultCheckInDelegate.h>
 #include <app/icd/client/DefaultICDClientStorage.h>
+#include <commands/common/ChipToolCheckInDelegate.h>
 #include <commands/common/CredentialIssuerCommands.h>
 #include <commands/example/ExampleCredentialIssuerCommands.h>
 #include <credentials/GroupDataProviderImpl.h>
@@ -164,7 +164,7 @@ class CHIPCommand : public Command
 
     static chip::Credentials::GroupDataProviderImpl sGroupDataProvider;
     static chip::app::DefaultICDClientStorage sICDClientStorage;
-    static chip::app::DefaultCheckInDelegate sCheckInDelegate;
+    static ChipToolCheckInDelegate sCheckInDelegate;
     static chip::app::CheckInHandler sCheckInHandler;
     CredentialIssuerCommands * mCredIssuerCmds;
 
@@ -180,6 +180,10 @@ class CHIPCommand : public Command
 
     ChipDeviceCommissioner & GetCommissioner(std::string identity);
 
+    static void RegisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler);
+
+    static void UnregisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler);
+
 private:
     CHIP_ERROR MaybeSetUpStack();
     void MaybeTearDownStack();

examples/chip-tool/commands/common/ChipToolCheckInDelegate.cpp

@@ -0,0 +1,94 @@
+/*
+ *    Copyright (c) 2024 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#include "ChipToolCheckInDelegate.h"
+
+#include <app/icd/client/RefreshKeySender.h>
+#include <crypto/CHIPCryptoPAL.h>
+#include <lib/support/CodeUtils.h>
+#include <lib/support/logging/CHIPLogging.h>
+
+using namespace chip;
+using namespace chip::app;
+
+CHIP_ERROR ChipToolCheckInDelegate::Init(ICDClientStorage * storage, InteractionModelEngine * engine)
+{
+    VerifyOrReturnError(storage != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
+    VerifyOrReturnError(mpStorage == nullptr, CHIP_ERROR_INCORRECT_STATE);
+    mpStorage  = storage;
+    mpImEngine = engine;
+    return CHIP_NO_ERROR;
+}
+
+void ChipToolCheckInDelegate::OnCheckInComplete(const ICDClientInfo & clientInfo)
+{
+    ChipLogProgress(
+        ICD, "Check In Message processing complete: start_counter=%" PRIu32 " offset=%" PRIu32 " nodeid=" ChipLogFormatScopedNodeId,
+        clientInfo.start_icd_counter, clientInfo.offset, ChipLogValueScopedNodeId(clientInfo.peer_node));
+    for (auto handler : mCheckInCompleteCallbacks)
+    {
+        handler->OnCheckInComplete(clientInfo);
+    }
+}
+
+RefreshKeySender * ChipToolCheckInDelegate::OnKeyRefreshNeeded(ICDClientInfo & clientInfo, ICDClientStorage * clientStorage)
+{
+    CHIP_ERROR err = CHIP_NO_ERROR;
+    RefreshKeySender::RefreshKeyBuffer newKey;
+
+    err = Crypto::DRBG_get_bytes(newKey.Bytes(), newKey.Capacity());
+    if (err != CHIP_NO_ERROR)
+    {
+        ChipLogError(ICD, "Generation of new key failed: %" CHIP_ERROR_FORMAT, err.Format());
+        return nullptr;
+    }
+
+    auto refreshKeySender = Platform::New<RefreshKeySender>(this, clientInfo, clientStorage, mpImEngine, newKey);
+    if (refreshKeySender == nullptr)
+    {
+        return nullptr;
+    }
+    return refreshKeySender;
+}
+
+void ChipToolCheckInDelegate::OnKeyRefreshDone(RefreshKeySender * refreshKeySender, CHIP_ERROR error)
+{
+    if (error == CHIP_NO_ERROR)
+    {
+        ChipLogProgress(ICD, "Re-registration with new key completed successfully");
+    }
+    else
+    {
+        ChipLogError(ICD, "Re-registration with new key failed with error : %" CHIP_ERROR_FORMAT, error.Format());
+        // The callee can take corrective action  based on the error received.
+    }
+    if (refreshKeySender != nullptr)
+    {
+        Platform::Delete(refreshKeySender);
+        refreshKeySender = nullptr;
+    }
+}
+
+void ChipToolCheckInDelegate::RegisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler)
+{
+    chip::DeviceLayer::SystemLayer().ScheduleLambda([this, handler]() { mCheckInCompleteCallbacks.insert(handler); });
+}
+
+void ChipToolCheckInDelegate::UnregisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler)
+{
+    chip::DeviceLayer::SystemLayer().ScheduleLambda([this, handler]() { mCheckInCompleteCallbacks.insert(handler); });
+}

examples/chip-tool/commands/common/ChipToolCheckInDelegate.h

@@ -0,0 +1,76 @@
+/*
+ *
+ *    Copyright (c) 2024 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#pragma once
+
+#include <set>
+
+#include <app/InteractionModelEngine.h>
+#include <app/icd/client/CheckInDelegate.h>
+#include <app/icd/client/ICDClientStorage.h>
+
+class CheckInCompleteCallback
+{
+public:
+    virtual ~CheckInCompleteCallback() {}
+
+    /**
+     * @brief Callback used to let the application know that a check-in message was received and validated.
+     *
+     * The callback will be executed in CHIP main loop. Implementations avoid blocking in this callback.
+     *
+     * @param[in] clientInfo - ICDClientInfo object representing the state associated with the
+     *                         node that sent the check-in message.
+     */
+    virtual void OnCheckInComplete(const chip::app::ICDClientInfo & clientInfo);
+};
+
+class ChipToolCheckInDelegate : public chip::app::CheckInDelegate
+{
+public:
+    virtual ~ChipToolCheckInDelegate() {}
+    CHIP_ERROR Init(chip::app::ICDClientStorage * storage, chip::app::InteractionModelEngine * engine);
+    void OnCheckInComplete(const chip::app::ICDClientInfo & clientInfo) override;
+    chip::app::RefreshKeySender * OnKeyRefreshNeeded(chip::app::ICDClientInfo & clientInfo,
+                                                     chip::app::ICDClientStorage * clientStorage) override;
+    void OnKeyRefreshDone(chip::app::RefreshKeySender * refreshKeySender, CHIP_ERROR error) override;
+
+    /**
+     * @brief Reigsters a callback when the check-in completes.
+     *
+     * The registeration will be processed inside CHIP main loop.
+     *
+     * @param[in] handler - A pointer to CheckInCompleteCallback to register.
+     */
+    void RegisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler);
+
+    /**
+     * @brief Unreigsters a callback when the check-in completes.
+     *
+     * The unregisteration will be processed inside CHIP main loop.
+     *
+     * @param[in] handler - A pointer to CheckInCompleteCallback to unregister.
+     */
+    void UnregisterOnCheckInCompleteCallback(CheckInCompleteCallback * handler);
+
+private:
+    chip::app::ICDClientStorage * mpStorage        = nullptr;
+    chip::app::InteractionModelEngine * mpImEngine = nullptr;
+
+    std::set<CheckInCompleteCallback *> mCheckInCompleteCallbacks;
+};