[Android] Support ICD Check in message (project-chip#32476)

* Add Android Checkin

* Restyled by clang-format

* Restyled by clang-format

* Add enableServerInteractions comment

* Restyled by whitespace

* Restyled by google-java-format

* Update src/controller/java/src/chip/devicecontroller/ControllerParams.java

Co-authored-by: mkardous-silabs <84793247+mkardous-silabs@users.noreply.github.com>

* Update ControllerParams.java

address comment

---------

Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: yunhanw-google <yunhanw@google.com>
Co-authored-by: mkardous-silabs <84793247+mkardous-silabs@users.noreply.github.com>

Author: 4 people

examples/android/CHIPTool/app/src/main/java/com/google/chip/chiptool/ChipClient.kt

@@ -48,7 +48,12 @@ object ChipClient {
 
     if (!this::chipDeviceController.isInitialized) {
       chipDeviceController =
-        ChipDeviceController(ControllerParams.newBuilder().setControllerVendorId(VENDOR_ID).build())
+        ChipDeviceController(
+          ControllerParams.newBuilder()
+            .setControllerVendorId(VENDOR_ID)
+            .setEnableServerInteractions(true)
+            .build()
+        )
 
       // Set delegate for attestation trust store for device attestation verifier.
       // It will replace the default attestation trust store.

src/controller/java/AndroidDeviceControllerWrapper.cpp

@@ -104,7 +104,7 @@ AndroidDeviceControllerWrapper * AndroidDeviceControllerWrapper::AllocateNew(
     jobject keypairDelegate, jbyteArray rootCertificate, jbyteArray intermediateCertificate, jbyteArray nodeOperationalCertificate,
     jbyteArray ipkEpochKey, uint16_t listenPort, uint16_t controllerVendorId, uint16_t failsafeTimerSeconds,
     bool attemptNetworkScanWiFi, bool attemptNetworkScanThread, bool skipCommissioningComplete,
-    bool skipAttestationCertificateValidation, jstring countryCode, CHIP_ERROR * errInfoOnFailure)
+    bool skipAttestationCertificateValidation, jstring countryCode, bool enableServerInteractions, CHIP_ERROR * errInfoOnFailure)
 {
     if (errInfoOnFailure == nullptr)
     {
@@ -351,6 +351,9 @@ AndroidDeviceControllerWrapper * AndroidDeviceControllerWrapper::AllocateNew(
         setupParams.controllerNOC  = nocSpan;
     }
 
+    initParams.enableServerInteractions  = enableServerInteractions;
+    setupParams.enableServerInteractions = enableServerInteractions;
+
     *errInfoOnFailure = DeviceControllerFactory::GetInstance().Init(initParams);
     if (*errInfoOnFailure != CHIP_NO_ERROR)
     {
@@ -393,6 +396,11 @@ AndroidDeviceControllerWrapper * AndroidDeviceControllerWrapper::AllocateNew(
 
     wrapper->getICDClientStorage()->UpdateFabricList(wrapper->Controller()->GetFabricIndex());
 
+    auto engine       = chip::app::InteractionModelEngine::GetInstance();
+    *errInfoOnFailure = wrapper->mCheckInDelegate.Init(&wrapper->mICDClientStorage, engine);
+    *errInfoOnFailure = wrapper->mCheckInHandler.Init(DeviceControllerFactory::GetInstance().GetSystemState()->ExchangeMgr(),
+                                                      &wrapper->mICDClientStorage, &wrapper->mCheckInDelegate, engine);
+
     memset(ipkBuffer.data(), 0, ipkBuffer.size());
 
     if (*errInfoOnFailure != CHIP_NO_ERROR)
@@ -769,6 +777,7 @@ void AndroidDeviceControllerWrapper::OnReadCommissioningInfo(const chip::Control
 
     // For ICD
     mUserActiveModeTriggerHint = info.icd.userActiveModeTriggerHint;
+    memset(mUserActiveModeTriggerInstructionBuffer, 0x00, kUserActiveModeTriggerInstructionBufferLen);
     CopyCharSpanToMutableCharSpan(info.icd.userActiveModeTriggerInstruction, mUserActiveModeTriggerInstruction);
 
     env->CallVoidMethod(mJavaObjectRef.ObjectRef(), onReadCommissioningInfoMethod, static_cast<jint>(info.basic.vendorId),

src/controller/java/AndroidDeviceControllerWrapper.h

@@ -24,6 +24,8 @@
 
 #include <jni.h>
 
+#include <app/icd/client/CheckInHandler.h>
+#include <app/icd/client/DefaultCheckInDelegate.h>
 #include <app/icd/client/DefaultICDClientStorage.h>
 #include <controller/CHIPDeviceController.h>
 #include <credentials/GroupDataProviderImpl.h>
@@ -170,19 +172,21 @@ class AndroidDeviceControllerWrapper : public chip::Controller::DevicePairingDel
      * @param[in] skipCommissioningComplete whether to skip the CASE commissioningComplete command during commissioning
      * @param[out] errInfoOnFailure a pointer to a CHIP_ERROR that will be populated if this method returns nullptr
      */
-    static AndroidDeviceControllerWrapper * AllocateNew(
-        JavaVM * vm, jobject deviceControllerObj, chip::NodeId nodeId, chip::FabricId fabricId, const chip::CATValues & cats,
-        chip::System::Layer * systemLayer, chip::Inet::EndPointManager<chip::Inet::TCPEndPoint> * tcpEndPointManager,
-        chip::Inet::EndPointManager<chip::Inet::UDPEndPoint> * udpEndPointManager,
+    static AndroidDeviceControllerWrapper *
+    AllocateNew(JavaVM * vm, jobject deviceControllerObj, chip::NodeId nodeId, chip::FabricId fabricId,
+                const chip::CATValues & cats, chip::System::Layer * systemLayer,
+                chip::Inet::EndPointManager<chip::Inet::TCPEndPoint> * tcpEndPointManager,
+                chip::Inet::EndPointManager<chip::Inet::UDPEndPoint> * udpEndPointManager,
 #ifdef JAVA_MATTER_CONTROLLER_TEST
-        ExampleOperationalCredentialsIssuerPtr opCredsIssuer,
+                ExampleOperationalCredentialsIssuerPtr opCredsIssuer,
 #else
-        AndroidOperationalCredentialsIssuerPtr opCredsIssuer,
+                AndroidOperationalCredentialsIssuerPtr opCredsIssuer,
 #endif
-        jobject keypairDelegate, jbyteArray rootCertificate, jbyteArray intermediateCertificate,
-        jbyteArray nodeOperationalCertificate, jbyteArray ipkEpochKey, uint16_t listenPort, uint16_t controllerVendorId,
-        uint16_t failsafeTimerSeconds, bool attemptNetworkScanWiFi, bool attemptNetworkScanThread, bool skipCommissioningComplete,
-        bool skipAttestationCertificateValidation, jstring countryCode, CHIP_ERROR * errInfoOnFailure);
+                jobject keypairDelegate, jbyteArray rootCertificate, jbyteArray intermediateCertificate,
+                jbyteArray nodeOperationalCertificate, jbyteArray ipkEpochKey, uint16_t listenPort, uint16_t controllerVendorId,
+                uint16_t failsafeTimerSeconds, bool attemptNetworkScanWiFi, bool attemptNetworkScanThread,
+                bool skipCommissioningComplete, bool skipAttestationCertificateValidation, jstring countryCode,
+                bool enableServerInteractions, CHIP_ERROR * errInfoOnFailure);
 
     void Shutdown();
 
@@ -221,6 +225,8 @@ class AndroidDeviceControllerWrapper : public chip::Controller::DevicePairingDel
     chip::Crypto::RawKeySessionKeystore mSessionKeystore;
 
     chip::app::DefaultICDClientStorage mICDClientStorage;
+    chip::app::DefaultCheckInDelegate mCheckInDelegate;
+    chip::app::CheckInHandler mCheckInHandler;
 
     JavaVM * mJavaVM = nullptr;
     chip::JniGlobalReference mJavaObjectRef;

src/controller/java/CHIPDeviceController-JNI.cpp

@@ -350,6 +350,11 @@ JNI_METHOD(jlong, newDeviceController)(JNIEnv * env, jobject self, jobject contr
     err = chip::JniReferences::GetInstance().FindMethod(env, controllerParams, "getAdminSubject", "()J", &getAdminSubject);
     SuccessOrExit(err);
 
+    jmethodID getEnableServerInteractions;
+    err = chip::JniReferences::GetInstance().FindMethod(env, controllerParams, "getEnableServerInteractions", "()Z",
+                                                        &getEnableServerInteractions);
+    SuccessOrExit(err);
+
     {
         uint64_t fabricId                  = static_cast<uint64_t>(env->CallLongMethod(controllerParams, getFabricId));
         uint16_t listenPort                = static_cast<uint16_t>(env->CallIntMethod(controllerParams, getUdpListenPort));
@@ -370,6 +375,7 @@ JNI_METHOD(jlong, newDeviceController)(JNIEnv * env, jobject self, jobject contr
         uint64_t adminSubject              = static_cast<uint64_t>(env->CallLongMethod(controllerParams, getAdminSubject));
         jobject countryCodeOptional        = env->CallObjectMethod(controllerParams, getCountryCode);
         jobject regulatoryLocationOptional = env->CallObjectMethod(controllerParams, getRegulatoryLocation);
+        bool enableServerInteractions      = env->CallBooleanMethod(controllerParams, getEnableServerInteractions) == JNI_TRUE;
 
         jobject countryCode;
         err = chip::JniReferences::GetInstance().GetOptionalValue(countryCodeOptional, countryCode);
@@ -387,7 +393,7 @@ JNI_METHOD(jlong, newDeviceController)(JNIEnv * env, jobject self, jobject contr
             DeviceLayer::TCPEndPointManager(), DeviceLayer::UDPEndPointManager(), std::move(opCredsIssuer), keypairDelegate,
             rootCertificate, intermediateCertificate, operationalCertificate, ipk, listenPort, controllerVendorId,
             failsafeTimerSeconds, attemptNetworkScanWiFi, attemptNetworkScanThread, skipCommissioningComplete,
-            skipAttestationCertificateValidation, static_cast<jstring>(countryCode), &err);
+            skipAttestationCertificateValidation, static_cast<jstring>(countryCode), enableServerInteractions, &err);
         SuccessOrExit(err);
 
         if (caseFailsafeTimerSeconds > 0)

src/controller/java/src/chip/devicecontroller/ControllerParams.java

@@ -23,6 +23,7 @@ public final class ControllerParams {
   @Nullable private final byte[] operationalCertificate;
   @Nullable private final byte[] ipk;
   private final long adminSubject;
+  private final boolean enableServerInteractions;
 
   /** @param udpListenPort the UDP listening port, or 0 to pick any available port. */
   private ControllerParams(Builder builder) {
@@ -43,6 +44,7 @@ private ControllerParams(Builder builder) {
     this.operationalCertificate = builder.operationalCertificate;
     this.ipk = builder.ipk;
     this.adminSubject = builder.adminSubject;
+    this.enableServerInteractions = builder.enableServerInteractions;
   }
 
   public long getFabricId() {
@@ -114,6 +116,10 @@ public long getAdminSubject() {
     return adminSubject;
   }
 
+  public boolean getEnableServerInteractions() {
+    return enableServerInteractions;
+  }
+
   /** Returns parameters with ephemerally generated operational credentials */
   public static Builder newBuilder() {
     return new Builder();
@@ -152,6 +158,7 @@ public static class Builder {
     @Nullable private byte[] operationalCertificate = null;
     @Nullable private byte[] ipk = null;
     private long adminSubject = 0;
+    private boolean enableServerInteractions = false;
 
     private Builder() {}
 
@@ -357,6 +364,17 @@ public Builder setAdminSubject(long adminSubject) {
       return this;
     }
 
+    /**
+     * Controls enabling server interactions on a controller. For ICD check-in message, this feature
+     * has to be enabled.
+     *
+     * @param enableServerInteractions indicates whether to enable server interactions.
+     */
+    public Builder setEnableServerInteractions(boolean enableServerInteractions) {
+      this.enableServerInteractions = enableServerInteractions;
+      return this;
+    }
+
     public ControllerParams build() {
       return new ControllerParams(this);
     }

src/controller/java/src/matter/controller/ControllerParams.kt

@@ -32,6 +32,7 @@ constructor(
   val udpListenPort: Int = UDP_PORT_AUTO,
   val vendorId: Int = VENDOR_ID_TEST,
   val countryCode: String? = null,
+  val enableServerInteractions: Boolean = false,
 ) {
   companion object {
     /** Matter assigned vendor ID for Google. */

src/controller/java/src/matter/controller/MatterControllerImpl.kt

@@ -543,6 +543,7 @@ class MatterControllerImpl(params: ControllerParams) : MatterController {
         .setUdpListenPort(params.udpListenPort)
         .setControllerVendorId(params.vendorId)
         .setCountryCode(params.countryCode)
+        .setEnableServerInteractions(params.enableServerInteractions)
 
     if (config != null) {
       val intermediateCertificate = config.certificateData.intermediateCertificate