Add verifier arg to CommissioningWindowOpener

samadDotDev · Jul 5, 2024 · 1699db0 · 1699db0
1 parent f779369
commit 1699db0
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 12 deletions.
diff --git a/examples/chip-tool/commands/pairing/OpenCommissioningWindowCommand.cpp b/examples/chip-tool/commands/pairing/OpenCommissioningWindowCommand.cpp
@@ -35,7 +35,7 @@ CHIP_ERROR OpenCommissioningWindowCommand::RunCommand()
     {
         SetupPayload ignored;
         return mWindowOpener->OpenCommissioningWindow(mNodeId, System::Clock::Seconds16(mCommissioningWindowTimeout), mIteration,
-                                                      mDiscriminator, NullOptional, NullOptional,
+                                                      mDiscriminator, NullOptional, NullOptional, NullOptional,
                                                       &mOnOpenCommissioningWindowCallback, ignored,
                                                       /* readVIDPIDAttributes */ true);
     }

diff --git a/examples/fabric-admin/commands/pairing/OpenCommissioningWindowCommand.cpp b/examples/fabric-admin/commands/pairing/OpenCommissioningWindowCommand.cpp
@@ -35,7 +35,7 @@ CHIP_ERROR OpenCommissioningWindowCommand::RunCommand()
     {
         SetupPayload ignored;
         return mWindowOpener->OpenCommissioningWindow(mNodeId, System::Clock::Seconds16(mCommissioningWindowTimeout), mIteration,
-                                                      mDiscriminator, NullOptional, NullOptional,
+                                                      mDiscriminator, NullOptional, NullOptional, NullOptional,
                                                       &mOnOpenCommissioningWindowCallback, ignored,
                                                       /* readVIDPIDAttributes */ true);
     }

diff --git a/src/controller/CommissioningWindowOpener.cpp b/src/controller/CommissioningWindowOpener.cpp
@@ -55,7 +55,7 @@ CHIP_ERROR CommissioningWindowOpener::OpenBasicCommissioningWindow(NodeId device
 
 CHIP_ERROR CommissioningWindowOpener::OpenCommissioningWindow(NodeId deviceId, Seconds16 timeout, uint32_t iteration,
                                                               uint16_t discriminator, Optional<uint32_t> setupPIN,
-                                                              Optional<ByteSpan> salt,
+                                                              Optional<ByteSpan> salt, Optional<ByteSpan> verifier,
                                                               Callback::Callback<OnOpenCommissioningWindow> * callback,
                                                               SetupPayload & payload, bool readVIDPIDAttributes)
 {
@@ -106,9 +106,16 @@ CHIP_ERROR CommissioningWindowOpener::OpenCommissioningWindow(NodeId deviceId, S
     mCommissioningWindowTimeout       = timeout;
     mPBKDFIterations                  = iteration;
 
-    bool randomSetupPIN = !setupPIN.HasValue();
-    ReturnErrorOnFailure(
-        PASESession::GeneratePASEVerifier(mVerifier, mPBKDFIterations, mPBKDFSalt, randomSetupPIN, mSetupPayload.setUpPINCode));
+    if (verifier.HasValue())
+    {
+        ReturnErrorOnFailure(mVerifier.Deserialize(verifier.Value()));
+    }
+    else
+    {
+        bool randomSetupPIN = !setupPIN.HasValue();
+        ReturnErrorOnFailure(
+            PASESession::GeneratePASEVerifier(mVerifier, mPBKDFIterations, mPBKDFSalt, randomSetupPIN, mSetupPayload.setUpPINCode));
+    }
 
     payload = mSetupPayload;
 
@@ -354,8 +361,8 @@ CHIP_ERROR AutoCommissioningWindowOpener::OpenCommissioningWindow(DeviceControll
     }
 
     CHIP_ERROR err = opener->CommissioningWindowOpener::OpenCommissioningWindow(
-        deviceId, timeout, iteration, discriminator, setupPIN, salt, &opener->mOnOpenCommissioningWindowCallback, payload,
-        readVIDPIDAttributes);
+        deviceId, timeout, iteration, discriminator, setupPIN, salt, NullOptional, &opener->mOnOpenCommissioningWindowCallback,
+        payload, readVIDPIDAttributes);
     if (err != CHIP_NO_ERROR)
     {
         delete opener;

diff --git a/src/controller/CommissioningWindowOpener.h b/src/controller/CommissioningWindowOpener.h
@@ -89,6 +89,8 @@ class CommissioningWindowOpener
      *                          least kSpake2p_Min_PBKDF_Salt_Length bytes and
      *                          at most kSpake2p_Max_PBKDF_Salt_Length bytes in
      *                          length.
+     * @param[in] verifier      The PAKE passcode verifier to use, or NullOptional to
+     *                          generate verifier based on PIN and other parameters.
      * @param[in] callback      The function to be called on success or failure of opening of commissioning window.
      * @param[out] payload      The setup payload, not including the VID/PID bits,
      *                          even if those were asked for, that is generated
@@ -104,8 +106,8 @@ class CommissioningWindowOpener
      */
     CHIP_ERROR OpenCommissioningWindow(NodeId deviceId, System::Clock::Seconds16 timeout, uint32_t iteration,
                                        uint16_t discriminator, Optional<uint32_t> setupPIN, Optional<ByteSpan> salt,
-                                       Callback::Callback<OnOpenCommissioningWindow> * callback, SetupPayload & payload,
-                                       bool readVIDPIDAttributes = false);
+                                       Optional<ByteSpan> verifier, Callback::Callback<OnOpenCommissioningWindow> * callback,
+                                       SetupPayload & payload, bool readVIDPIDAttributes = false);
 
 private:
     enum class Step : uint8_t

diff --git a/src/controller/python/ChipDeviceController-ScriptBinding.cpp b/src/controller/python/ChipDeviceController-ScriptBinding.cpp
@@ -715,7 +715,7 @@ PyChipError pychip_DeviceController_OpenCommissioningWindow(chip::Controller::De
         auto opener =
             Platform::New<Controller::CommissioningWindowOpener>(static_cast<chip::Controller::DeviceController *>(devCtrl));
         PyChipError err = ToPyChipError(opener->OpenCommissioningWindow(nodeid, System::Clock::Seconds16(timeout), iteration,
-                                                                        discriminator, NullOptional, NullOptional,
+                                                                        discriminator, NullOptional, NullOptional, NullOptional,
                                                                         pairingDelegate->GetOpenWindowCallback(opener), payload));
         return err;
     }

diff --git a/src/darwin/Framework/CHIP/MTRBaseDevice.mm b/src/darwin/Framework/CHIP/MTRBaseDevice.mm
@@ -1784,7 +1784,7 @@ static CHIP_ERROR OpenCommissioningWindow(Controller::DeviceController * control
     auto * self = new OpenCommissioningWindowHelper(controller, callback);
     SetupPayload unused;
     CHIP_ERROR err = self->mOpener.OpenCommissioningWindow(nodeID, timeout, Crypto::kSpake2p_Min_PBKDF_Iterations, discriminator,
-        setupPIN, NullOptional, &self->mOnOpenCommissioningWindowCallback, unused);
+        setupPIN, NullOptional, NullOptional, &self->mOnOpenCommissioningWindowCallback, unused);
     if (err != CHIP_NO_ERROR) {
         delete self;
     }