Line data Source code
1 : /*
2 : *
3 : * Copyright (c) 2020-2024 Project CHIP Authors
4 : * Copyright (c) 2013-2017 Nest Labs, Inc.
5 : * All rights reserved.
6 : *
7 : * Licensed under the Apache License, Version 2.0 (the "License");
8 : * you may not use this file except in compliance with the License.
9 : * You may obtain a copy of the License at
10 : *
11 : * http://www.apache.org/licenses/LICENSE-2.0
12 : *
13 : * Unless required by applicable law or agreed to in writing, software
14 : * distributed under the License is distributed on an "AS IS" BASIS,
15 : * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 : * See the License for the specific language governing permissions and
17 : * limitations under the License.
18 : */
19 :
20 : /**
21 : * @file
22 : * Implementation of CHIP Device Controller, a common class
23 : * that implements discovery, pairing and provisioning of CHIP
24 : * devices.
25 : *
26 : */
27 :
28 : // module header, comes first
29 : #include <controller/CHIPDeviceController.h>
30 :
31 : #include <app-common/zap-generated/ids/Attributes.h>
32 : #include <app-common/zap-generated/ids/Clusters.h>
33 :
34 : #include <app/InteractionModelEngine.h>
35 : #include <app/OperationalSessionSetup.h>
36 : #include <app/server/Dnssd.h>
37 : #include <controller/CurrentFabricRemover.h>
38 : #include <controller/InvokeInteraction.h>
39 : #include <controller/WriteInteraction.h>
40 : #include <credentials/CHIPCert.h>
41 : #include <credentials/DeviceAttestationCredsProvider.h>
42 : #include <crypto/CHIPCryptoPAL.h>
43 : #include <lib/address_resolve/AddressResolve.h>
44 : #include <lib/core/CHIPCore.h>
45 : #include <lib/core/CHIPEncoding.h>
46 : #include <lib/core/CHIPSafeCasts.h>
47 : #include <lib/core/ErrorStr.h>
48 : #include <lib/core/NodeId.h>
49 : #include <lib/support/Base64.h>
50 : #include <lib/support/CHIPMem.h>
51 : #include <lib/support/CodeUtils.h>
52 : #include <lib/support/PersistentStorageMacros.h>
53 : #include <lib/support/SafeInt.h>
54 : #include <lib/support/ScopedMemoryBuffer.h>
55 : #include <lib/support/ThreadOperationalDataset.h>
56 : #include <lib/support/TimeUtils.h>
57 : #include <lib/support/logging/CHIPLogging.h>
58 : #include <messaging/ExchangeContext.h>
59 : #include <platform/LockTracker.h>
60 : #include <protocols/secure_channel/MessageCounterManager.h>
61 : #include <setup_payload/QRCodeSetupPayloadParser.h>
62 : #include <tracing/macros.h>
63 : #include <tracing/metric_event.h>
64 :
65 : #if CONFIG_NETWORK_LAYER_BLE
66 : #include <ble/Ble.h>
67 : #include <transport/raw/BLE.h>
68 : #endif
69 : #if CHIP_DEVICE_CONFIG_ENABLE_WIFIPAF
70 : #include <transport/raw/WiFiPAF.h>
71 : #endif
72 :
73 : #if CHIP_DEVICE_CONFIG_ENABLE_NFC_BASED_COMMISSIONING
74 : #include <platform/internal/NFCCommissioningManager.h>
75 : #endif
76 :
77 : #include <algorithm>
78 : #include <array>
79 : #include <errno.h>
80 : #include <inttypes.h>
81 : #include <limits>
82 : #include <memory>
83 : #include <stdint.h>
84 : #include <stdlib.h>
85 : #include <string>
86 : #include <time.h>
87 :
88 : using namespace chip::app;
89 : using namespace chip::app::Clusters;
90 : using namespace chip::Inet;
91 : using namespace chip::System;
92 : using namespace chip::Transport;
93 : using namespace chip::Credentials;
94 : using namespace chip::Crypto;
95 : using namespace chip::Tracing;
96 :
97 : namespace chip {
98 : namespace Controller {
99 :
100 : using namespace chip::Encoding;
101 : #if CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY
102 : using namespace chip::Protocols::UserDirectedCommissioning;
103 : #endif // CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY
104 :
105 : using chip::AddressResolve::Resolver;
106 : using chip::AddressResolve::ResolveResult;
107 :
108 275 : DeviceController::DeviceController()
109 : {
110 25 : mState = State::NotInitialized;
111 25 : }
112 :
113 0 : CHIP_ERROR DeviceController::Init(ControllerInitParams params)
114 : {
115 0 : assertChipStackLockedByCurrentThread();
116 :
117 0 : VerifyOrReturnError(mState == State::NotInitialized, CHIP_ERROR_INCORRECT_STATE);
118 0 : VerifyOrReturnError(params.systemState != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
119 :
120 0 : VerifyOrReturnError(params.systemState->SystemLayer() != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
121 0 : VerifyOrReturnError(params.systemState->UDPEndPointManager() != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
122 :
123 : #if CONFIG_NETWORK_LAYER_BLE
124 0 : VerifyOrReturnError(params.systemState->BleLayer() != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
125 : #endif
126 :
127 0 : VerifyOrReturnError(params.systemState->TransportMgr() != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
128 :
129 0 : ReturnErrorOnFailure(mDNSResolver.Init(params.systemState->UDPEndPointManager()));
130 0 : mDNSResolver.SetDiscoveryDelegate(this);
131 0 : RegisterDeviceDiscoveryDelegate(params.deviceDiscoveryDelegate);
132 :
133 0 : mVendorId = params.controllerVendorId;
134 0 : if (params.operationalKeypair != nullptr || !params.controllerNOC.empty() || !params.controllerRCAC.empty())
135 : {
136 0 : ReturnErrorOnFailure(InitControllerNOCChain(params));
137 : }
138 0 : else if (params.fabricIndex.HasValue())
139 : {
140 0 : VerifyOrReturnError(params.systemState->Fabrics()->FabricCount() > 0, CHIP_ERROR_INVALID_ARGUMENT);
141 0 : if (params.systemState->Fabrics()->FindFabricWithIndex(params.fabricIndex.Value()) != nullptr)
142 : {
143 0 : mFabricIndex = params.fabricIndex.Value();
144 : }
145 : else
146 : {
147 0 : ChipLogError(Controller, "There is no fabric corresponding to the given fabricIndex");
148 0 : return CHIP_ERROR_INVALID_ARGUMENT;
149 : }
150 : }
151 :
152 0 : mSystemState = params.systemState->Retain();
153 0 : mState = State::Initialized;
154 :
155 0 : mRemoveFromFabricTableOnShutdown = params.removeFromFabricTableOnShutdown;
156 0 : mDeleteFromFabricTableOnShutdown = params.deleteFromFabricTableOnShutdown;
157 :
158 0 : if (GetFabricIndex() != kUndefinedFabricIndex)
159 : {
160 0 : ChipLogProgress(Controller,
161 : "Joined the fabric at index %d. Fabric ID is 0x" ChipLogFormatX64
162 : " (Compressed Fabric ID: " ChipLogFormatX64 ")",
163 : GetFabricIndex(), ChipLogValueX64(GetFabricId()), ChipLogValueX64(GetCompressedFabricId()));
164 : }
165 :
166 0 : return CHIP_NO_ERROR;
167 : }
168 :
169 0 : CHIP_ERROR DeviceController::InitControllerNOCChain(const ControllerInitParams & params)
170 : {
171 0 : FabricInfo newFabric;
172 0 : constexpr uint32_t chipCertAllocatedLen = kMaxCHIPCertLength;
173 0 : chip::Platform::ScopedMemoryBuffer<uint8_t> rcacBuf;
174 0 : chip::Platform::ScopedMemoryBuffer<uint8_t> icacBuf;
175 0 : chip::Platform::ScopedMemoryBuffer<uint8_t> nocBuf;
176 0 : Credentials::P256PublicKeySpan rootPublicKeySpan;
177 : FabricId fabricId;
178 : NodeId nodeId;
179 0 : bool hasExternallyOwnedKeypair = false;
180 0 : Crypto::P256Keypair * externalOperationalKeypair = nullptr;
181 0 : VendorId newFabricVendorId = params.controllerVendorId;
182 :
183 : // There are three possibilities here in terms of what happens with our
184 : // operational key:
185 : // 1) We have an externally owned operational keypair.
186 : // 2) We have an operational keypair that the fabric table should clone via
187 : // serialize/deserialize.
188 : // 3) We have no keypair at all, and the fabric table has been initialized
189 : // with a key store.
190 0 : if (params.operationalKeypair != nullptr)
191 : {
192 0 : hasExternallyOwnedKeypair = params.hasExternallyOwnedOperationalKeypair;
193 0 : externalOperationalKeypair = params.operationalKeypair;
194 : }
195 :
196 0 : VerifyOrReturnError(rcacBuf.Alloc(chipCertAllocatedLen), CHIP_ERROR_NO_MEMORY);
197 0 : VerifyOrReturnError(icacBuf.Alloc(chipCertAllocatedLen), CHIP_ERROR_NO_MEMORY);
198 0 : VerifyOrReturnError(nocBuf.Alloc(chipCertAllocatedLen), CHIP_ERROR_NO_MEMORY);
199 :
200 0 : MutableByteSpan rcacSpan(rcacBuf.Get(), chipCertAllocatedLen);
201 :
202 0 : ReturnErrorOnFailure(ConvertX509CertToChipCert(params.controllerRCAC, rcacSpan));
203 0 : ReturnErrorOnFailure(Credentials::ExtractPublicKeyFromChipCert(rcacSpan, rootPublicKeySpan));
204 0 : Crypto::P256PublicKey rootPublicKey{ rootPublicKeySpan };
205 :
206 0 : MutableByteSpan icacSpan;
207 0 : if (params.controllerICAC.empty())
208 : {
209 0 : ChipLogProgress(Controller, "Intermediate CA is not needed");
210 : }
211 : else
212 : {
213 0 : icacSpan = MutableByteSpan(icacBuf.Get(), chipCertAllocatedLen);
214 0 : ReturnErrorOnFailure(ConvertX509CertToChipCert(params.controllerICAC, icacSpan));
215 : }
216 :
217 0 : MutableByteSpan nocSpan = MutableByteSpan(nocBuf.Get(), chipCertAllocatedLen);
218 :
219 0 : ReturnErrorOnFailure(ConvertX509CertToChipCert(params.controllerNOC, nocSpan));
220 0 : ReturnErrorOnFailure(ExtractNodeIdFabricIdFromOpCert(nocSpan, &nodeId, &fabricId));
221 :
222 0 : auto * fabricTable = params.systemState->Fabrics();
223 0 : const FabricInfo * fabricInfo = nullptr;
224 :
225 : //
226 : // When multiple controllers are permitted on the same fabric, we need to find fabrics with
227 : // nodeId as an extra discriminant since we can have multiple FabricInfo objects that all
228 : // collide on the same fabric. Not doing so may result in a match with an existing FabricInfo
229 : // instance that matches the fabric in the provided NOC but is associated with a different NodeId
230 : // that is already in use by another active controller instance. That will effectively cause it
231 : // to change its identity inadvertently, which is not acceptable.
232 : //
233 : // TODO: Figure out how to clean up unreclaimed FabricInfos restored from persistent
234 : // storage that are not in use by active DeviceController instances. Also, figure out
235 : // how to reclaim FabricInfo slots when a DeviceController instance is deleted.
236 : //
237 0 : if (params.permitMultiControllerFabrics)
238 : {
239 0 : fabricInfo = fabricTable->FindIdentity(rootPublicKey, fabricId, nodeId);
240 : }
241 : else
242 : {
243 0 : fabricInfo = fabricTable->FindFabric(rootPublicKey, fabricId);
244 : }
245 :
246 0 : bool fabricFoundInTable = (fabricInfo != nullptr);
247 :
248 0 : FabricIndex fabricIndex = fabricFoundInTable ? fabricInfo->GetFabricIndex() : kUndefinedFabricIndex;
249 :
250 0 : CHIP_ERROR err = CHIP_NO_ERROR;
251 :
252 0 : auto advertiseOperational =
253 0 : params.enableServerInteractions ? FabricTable::AdvertiseIdentity::Yes : FabricTable::AdvertiseIdentity::No;
254 :
255 : //
256 : // We permit colliding fabrics when multiple controllers are present on the same logical fabric
257 : // since each controller is associated with a unique FabricInfo 'identity' object and consequently,
258 : // a unique FabricIndex.
259 : //
260 : // This sets a flag that will be cleared automatically when the fabric is committed/reverted later
261 : // in this function.
262 : //
263 0 : if (params.permitMultiControllerFabrics)
264 : {
265 0 : fabricTable->PermitCollidingFabrics();
266 : }
267 :
268 : // We have 4 cases to handle legacy usage of direct operational key injection
269 0 : if (externalOperationalKeypair)
270 : {
271 : // Cases 1 and 2: Injected operational keys
272 :
273 : // CASE 1: Fabric update with injected key
274 0 : if (fabricFoundInTable)
275 : {
276 0 : err = fabricTable->UpdatePendingFabricWithProvidedOpKey(fabricIndex, nocSpan, icacSpan, externalOperationalKeypair,
277 : hasExternallyOwnedKeypair, advertiseOperational);
278 : }
279 : else
280 : // CASE 2: New fabric with injected key
281 : {
282 0 : err = fabricTable->AddNewPendingTrustedRootCert(rcacSpan);
283 0 : if (err == CHIP_NO_ERROR)
284 : {
285 0 : err = fabricTable->AddNewPendingFabricWithProvidedOpKey(nocSpan, icacSpan, newFabricVendorId,
286 : externalOperationalKeypair, hasExternallyOwnedKeypair,
287 : &fabricIndex, advertiseOperational);
288 : }
289 : }
290 : }
291 : else
292 : {
293 : // Cases 3 and 4: OperationalKeystore has the keys
294 :
295 : // CASE 3: Fabric update with operational keystore
296 0 : if (fabricFoundInTable)
297 : {
298 0 : VerifyOrReturnError(fabricTable->HasOperationalKeyForFabric(fabricIndex), CHIP_ERROR_KEY_NOT_FOUND);
299 :
300 0 : err = fabricTable->UpdatePendingFabricWithOperationalKeystore(fabricIndex, nocSpan, icacSpan, advertiseOperational);
301 : }
302 : else
303 : // CASE 4: New fabric with operational keystore
304 : {
305 0 : err = fabricTable->AddNewPendingTrustedRootCert(rcacSpan);
306 0 : if (err == CHIP_NO_ERROR)
307 : {
308 0 : err = fabricTable->AddNewPendingFabricWithOperationalKeystore(nocSpan, icacSpan, newFabricVendorId, &fabricIndex,
309 : advertiseOperational);
310 : }
311 :
312 0 : if (err == CHIP_NO_ERROR)
313 : {
314 : // Now that we know our planned fabric index, verify that the
315 : // keystore has a key for it.
316 0 : if (!fabricTable->HasOperationalKeyForFabric(fabricIndex))
317 : {
318 0 : err = CHIP_ERROR_KEY_NOT_FOUND;
319 : }
320 : }
321 : }
322 : }
323 :
324 : // Commit after setup, error-out on failure.
325 0 : if (err == CHIP_NO_ERROR)
326 : {
327 : // No need to revert on error: CommitPendingFabricData reverts internally on *any* error.
328 0 : err = fabricTable->CommitPendingFabricData();
329 : }
330 : else
331 : {
332 0 : fabricTable->RevertPendingFabricData();
333 : }
334 :
335 0 : ReturnErrorOnFailure(err);
336 0 : VerifyOrReturnError(fabricIndex != kUndefinedFabricIndex, CHIP_ERROR_INTERNAL);
337 :
338 0 : mFabricIndex = fabricIndex;
339 0 : mAdvertiseIdentity = advertiseOperational;
340 0 : return CHIP_NO_ERROR;
341 0 : }
342 :
343 0 : CHIP_ERROR DeviceController::UpdateControllerNOCChain(const ByteSpan & noc, const ByteSpan & icac,
344 : Crypto::P256Keypair * operationalKeypair,
345 : bool operationalKeypairExternalOwned)
346 : {
347 0 : VerifyOrReturnError(mFabricIndex != kUndefinedFabricIndex, CHIP_ERROR_INTERNAL);
348 0 : VerifyOrReturnError(mSystemState != nullptr, CHIP_ERROR_INTERNAL);
349 0 : FabricTable * fabricTable = mSystemState->Fabrics();
350 0 : CHIP_ERROR err = CHIP_NO_ERROR;
351 : FabricId fabricId;
352 : NodeId nodeId;
353 0 : CATValues oldCats;
354 0 : CATValues newCats;
355 0 : ReturnErrorOnFailure(ExtractNodeIdFabricIdFromOpCert(noc, &nodeId, &fabricId));
356 0 : ReturnErrorOnFailure(fabricTable->FetchCATs(mFabricIndex, oldCats));
357 0 : ReturnErrorOnFailure(ExtractCATsFromOpCert(noc, newCats));
358 :
359 0 : bool needCloseSession = true;
360 0 : if (GetFabricInfo()->GetNodeId() == nodeId && oldCats == newCats)
361 : {
362 0 : needCloseSession = false;
363 : }
364 :
365 0 : if (operationalKeypair != nullptr)
366 : {
367 0 : err = fabricTable->UpdatePendingFabricWithProvidedOpKey(mFabricIndex, noc, icac, operationalKeypair,
368 : operationalKeypairExternalOwned, mAdvertiseIdentity);
369 : }
370 : else
371 : {
372 0 : VerifyOrReturnError(fabricTable->HasOperationalKeyForFabric(mFabricIndex), CHIP_ERROR_KEY_NOT_FOUND);
373 0 : err = fabricTable->UpdatePendingFabricWithOperationalKeystore(mFabricIndex, noc, icac, mAdvertiseIdentity);
374 : }
375 :
376 0 : if (err == CHIP_NO_ERROR)
377 : {
378 0 : err = fabricTable->CommitPendingFabricData();
379 : }
380 : else
381 : {
382 0 : fabricTable->RevertPendingFabricData();
383 : }
384 :
385 0 : ReturnErrorOnFailure(err);
386 0 : if (needCloseSession)
387 : {
388 : // If the node id or CATs have changed, our existing CASE sessions are no longer valid,
389 : // because the other side will think anything coming over those sessions comes from our
390 : // old node ID, and the new CATs might not satisfy the ACL requirements of the other side.
391 0 : mSystemState->SessionMgr()->ExpireAllSessionsForFabric(mFabricIndex);
392 : }
393 0 : ChipLogProgress(Controller, "Controller NOC chain has updated");
394 0 : return CHIP_NO_ERROR;
395 : }
396 :
397 0 : void DeviceController::Shutdown()
398 : {
399 0 : assertChipStackLockedByCurrentThread();
400 :
401 0 : VerifyOrReturn(mState != State::NotInitialized);
402 :
403 : // If our state is initialialized it means mSystemState is valid,
404 : // and we can use it below before we release our reference to it.
405 0 : ChipLogDetail(Controller, "Shutting down the controller");
406 0 : mState = State::NotInitialized;
407 :
408 0 : if (mFabricIndex != kUndefinedFabricIndex)
409 : {
410 : // Shut down any subscription clients for this fabric.
411 0 : app::InteractionModelEngine::GetInstance()->ShutdownSubscriptions(mFabricIndex);
412 :
413 : // Shut down any ongoing CASE session activity we have. We're going to
414 : // assume that all sessions for our fabric belong to us here.
415 0 : mSystemState->CASESessionMgr()->ReleaseSessionsForFabric(mFabricIndex);
416 :
417 : // Shut down any bdx transfers we're acting as the server for.
418 0 : mSystemState->BDXTransferServer()->AbortTransfersForFabric(mFabricIndex);
419 :
420 : // TODO: The CASE session manager does not shut down existing CASE
421 : // sessions. It just shuts down any ongoing CASE session establishment
422 : // we're in the middle of as initiator. Maybe it should shut down
423 : // existing sessions too?
424 0 : mSystemState->SessionMgr()->ExpireAllSessionsForFabric(mFabricIndex);
425 :
426 0 : if (mDeleteFromFabricTableOnShutdown)
427 : {
428 0 : TEMPORARY_RETURN_IGNORED mSystemState->Fabrics()->Delete(mFabricIndex);
429 : }
430 0 : else if (mRemoveFromFabricTableOnShutdown)
431 : {
432 0 : mSystemState->Fabrics()->Forget(mFabricIndex);
433 : }
434 : }
435 :
436 0 : mSystemState->Release();
437 0 : mSystemState = nullptr;
438 :
439 0 : mDNSResolver.Shutdown();
440 0 : mDeviceDiscoveryDelegate = nullptr;
441 : }
442 :
443 0 : CHIP_ERROR DeviceController::GetPeerAddressAndPort(NodeId peerId, Inet::IPAddress & addr, uint16_t & port)
444 : {
445 0 : VerifyOrReturnError(mState == State::Initialized, CHIP_ERROR_INCORRECT_STATE);
446 0 : Transport::PeerAddress peerAddr;
447 0 : ReturnErrorOnFailure(mSystemState->CASESessionMgr()->GetPeerAddress(GetPeerScopedId(peerId), peerAddr));
448 0 : addr = peerAddr.GetIPAddress();
449 0 : port = peerAddr.GetPort();
450 0 : return CHIP_NO_ERROR;
451 : }
452 :
453 0 : CHIP_ERROR DeviceController::GetPeerAddress(NodeId nodeId, Transport::PeerAddress & addr)
454 : {
455 0 : VerifyOrReturnError(mState == State::Initialized, CHIP_ERROR_INCORRECT_STATE);
456 0 : ReturnErrorOnFailure(mSystemState->CASESessionMgr()->GetPeerAddress(GetPeerScopedId(nodeId), addr));
457 :
458 0 : return CHIP_NO_ERROR;
459 : }
460 :
461 0 : CHIP_ERROR DeviceController::ComputePASEVerifier(uint32_t iterations, uint32_t setupPincode, const ByteSpan & salt,
462 : Spake2pVerifier & outVerifier)
463 : {
464 0 : ReturnErrorOnFailure(PASESession::GeneratePASEVerifier(outVerifier, iterations, salt, /* useRandomPIN= */ false, setupPincode));
465 :
466 0 : return CHIP_NO_ERROR;
467 : }
468 :
469 0 : ControllerDeviceInitParams DeviceController::GetControllerDeviceInitParams()
470 : {
471 : return ControllerDeviceInitParams{
472 0 : .sessionManager = mSystemState->SessionMgr(),
473 0 : .exchangeMgr = mSystemState->ExchangeMgr(),
474 0 : };
475 : }
476 :
477 13 : DeviceCommissioner::DeviceCommissioner() :
478 13 : mOnDeviceConnectedCallback(OnDeviceConnectedFn, this), mOnDeviceConnectionFailureCallback(OnDeviceConnectionFailureFn, this),
479 : #if CHIP_DEVICE_CONFIG_ENABLE_AUTOMATIC_CASE_RETRIES
480 13 : mOnDeviceConnectionRetryCallback(OnDeviceConnectionRetryFn, this),
481 : #endif // CHIP_DEVICE_CONFIG_ENABLE_AUTOMATIC_CASE_RETRIES
482 13 : mDeviceAttestationInformationVerificationCallback(OnDeviceAttestationInformationVerification, this),
483 26 : mDeviceNOCChainCallback(OnDeviceNOCChainGeneration, this), mSetUpCodePairer(this)
484 : {
485 : #if CHIP_DEVICE_CONFIG_ENABLE_JOINT_FABRIC
486 : (void) mPeerAdminJFAdminClusterEndpointId;
487 : #endif // CHIP_DEVICE_CONFIG_ENABLE_JOINT_FABRIC
488 13 : }
489 :
490 0 : CHIP_ERROR DeviceCommissioner::Init(CommissionerInitParams params)
491 : {
492 0 : VerifyOrReturnError(params.operationalCredentialsDelegate != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
493 0 : mOperationalCredentialsDelegate = params.operationalCredentialsDelegate;
494 0 : ReturnErrorOnFailure(DeviceController::Init(params));
495 :
496 0 : mPairingDelegate = params.pairingDelegate;
497 :
498 : // Configure device attestation validation
499 0 : mDeviceAttestationVerifier = params.deviceAttestationVerifier;
500 0 : if (mDeviceAttestationVerifier == nullptr)
501 : {
502 0 : mDeviceAttestationVerifier = Credentials::GetDeviceAttestationVerifier();
503 0 : if (mDeviceAttestationVerifier == nullptr)
504 : {
505 0 : ChipLogError(Controller,
506 : "Missing DeviceAttestationVerifier configuration at DeviceCommissioner init and none set with "
507 : "Credentials::SetDeviceAttestationVerifier()!");
508 0 : return CHIP_ERROR_INVALID_ARGUMENT;
509 : }
510 :
511 : // We fell back on a default from singleton accessor.
512 0 : ChipLogProgress(Controller,
513 : "*** Missing DeviceAttestationVerifier configuration at DeviceCommissioner init: using global default, "
514 : "consider passing one in CommissionerInitParams.");
515 : }
516 :
517 0 : if (params.defaultCommissioner != nullptr)
518 : {
519 0 : mDefaultCommissioner = params.defaultCommissioner;
520 : }
521 : // Otherwise leave it pointing to mAutoCommissioner.
522 :
523 : #if CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY // make this commissioner discoverable
524 : mUdcTransportMgr = chip::Platform::New<UdcTransportMgr>();
525 : ReturnErrorOnFailure(mUdcTransportMgr->Init(Transport::UdpListenParameters(mSystemState->UDPEndPointManager())
526 : .SetAddressType(Inet::IPAddressType::kIPv6)
527 : .SetListenPort(static_cast<uint16_t>(mUdcListenPort))
528 : #if INET_CONFIG_ENABLE_IPV4
529 : ,
530 : Transport::UdpListenParameters(mSystemState->UDPEndPointManager())
531 : .SetAddressType(Inet::IPAddressType::kIPv4)
532 : .SetListenPort(static_cast<uint16_t>(mUdcListenPort))
533 : #endif // INET_CONFIG_ENABLE_IPV4
534 : ));
535 :
536 : mUdcServer = chip::Platform::New<UserDirectedCommissioningServer>();
537 : mUdcTransportMgr->SetSessionManager(mUdcServer);
538 : mUdcServer->SetTransportManager(mUdcTransportMgr);
539 :
540 : mUdcServer->SetInstanceNameResolver(this);
541 : #endif // CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY
542 :
543 0 : mSetUpCodePairer.SetSystemLayer(mSystemState->SystemLayer());
544 : #if CONFIG_NETWORK_LAYER_BLE
545 0 : mSetUpCodePairer.SetBleLayer(mSystemState->BleLayer());
546 : #endif // CONFIG_NETWORK_LAYER_BLE
547 :
548 0 : return CHIP_NO_ERROR;
549 : }
550 :
551 0 : void DeviceCommissioner::Shutdown()
552 : {
553 0 : VerifyOrReturn(mState != State::NotInitialized);
554 :
555 0 : ChipLogDetail(Controller, "Shutting down the commissioner");
556 :
557 0 : mSetUpCodePairer.StopPairing();
558 :
559 : // Check to see if pairing in progress before shutting down
560 0 : CommissioneeDeviceProxy * device = mDeviceInPASEEstablishment;
561 0 : if (device != nullptr && device->IsSessionSetupInProgress())
562 : {
563 0 : ChipLogDetail(Controller, "Setup in progress, stopping setup before shutting down");
564 0 : OnSessionEstablishmentError(CHIP_ERROR_CONNECTION_ABORTED);
565 : }
566 :
567 0 : CancelCommissioningInteractions();
568 :
569 : #if CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY // make this commissioner discoverable
570 : if (mUdcTransportMgr != nullptr)
571 : {
572 : chip::Platform::Delete(mUdcTransportMgr);
573 : mUdcTransportMgr = nullptr;
574 : }
575 : if (mUdcServer != nullptr)
576 : {
577 : mUdcServer->SetInstanceNameResolver(nullptr);
578 : chip::Platform::Delete(mUdcServer);
579 : mUdcServer = nullptr;
580 : }
581 : #endif // CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY
582 : #if CHIP_DEVICE_CONFIG_ENABLE_WIFIPAF
583 0 : WiFiPAF::WiFiPAFLayer::GetWiFiPAFLayer().Shutdown();
584 : #endif
585 :
586 : // Release everything from the commissionee device pool here.
587 : // Make sure to use ReleaseCommissioneeDevice so we don't keep dangling
588 : // pointers to the device objects.
589 0 : mCommissioneeDevicePool.ForEachActiveObject([this](auto * commissioneeDevice) {
590 0 : ReleaseCommissioneeDevice(commissioneeDevice);
591 0 : return Loop::Continue;
592 : });
593 :
594 0 : DeviceController::Shutdown();
595 : }
596 :
597 0 : CommissioneeDeviceProxy * DeviceCommissioner::FindCommissioneeDevice(NodeId id)
598 : {
599 : MATTER_TRACE_SCOPE("FindCommissioneeDevice", "DeviceCommissioner");
600 0 : CommissioneeDeviceProxy * foundDevice = nullptr;
601 0 : mCommissioneeDevicePool.ForEachActiveObject([&](auto * deviceProxy) {
602 0 : if (deviceProxy->GetDeviceId() == id || deviceProxy->GetTemporaryCommissioningId() == id)
603 : {
604 0 : foundDevice = deviceProxy;
605 0 : return Loop::Break;
606 : }
607 0 : return Loop::Continue;
608 : });
609 :
610 0 : return foundDevice;
611 : }
612 :
613 0 : CommissioneeDeviceProxy * DeviceCommissioner::FindCommissioneeDevice(const Transport::PeerAddress & peerAddress)
614 : {
615 0 : CommissioneeDeviceProxy * foundDevice = nullptr;
616 0 : mCommissioneeDevicePool.ForEachActiveObject([&](auto * deviceProxy) {
617 0 : if (deviceProxy->GetPeerAddress() == peerAddress)
618 : {
619 0 : foundDevice = deviceProxy;
620 0 : return Loop::Break;
621 : }
622 0 : return Loop::Continue;
623 : });
624 :
625 0 : return foundDevice;
626 : }
627 :
628 0 : void DeviceCommissioner::ReleaseCommissioneeDevice(CommissioneeDeviceProxy * device)
629 : {
630 : #if CONFIG_NETWORK_LAYER_BLE
631 0 : if (mSystemState->BleLayer() != nullptr && device->GetDeviceTransportType() == Transport::Type::kBle)
632 : {
633 : // We only support one BLE connection, so if this is BLE, close it
634 0 : ChipLogProgress(Discovery, "Closing all BLE connections");
635 0 : mSystemState->BleLayer()->CloseAllBleConnections();
636 : }
637 : #endif
638 :
639 : #if CHIP_DEVICE_CONFIG_ENABLE_NFC_BASED_COMMISSIONING
640 : Nfc::NFCReaderTransport * readerTransport = DeviceLayer::Internal::NFCCommissioningMgr().GetNFCReaderTransport();
641 : if (readerTransport)
642 : {
643 : ChipLogProgress(Controller, "Stopping discovery of all NFC tags");
644 : TEMPORARY_RETURN_IGNORED readerTransport->StopDiscoveringTags();
645 : }
646 : #endif
647 :
648 : // Make sure that there will be no dangling pointer
649 0 : if (mDeviceInPASEEstablishment == device)
650 : {
651 0 : mDeviceInPASEEstablishment = nullptr;
652 : }
653 0 : if (mDeviceBeingCommissioned == device)
654 : {
655 0 : mDeviceBeingCommissioned = nullptr;
656 : }
657 :
658 : // Release the commissionee device after we have nulled out our pointers,
659 : // because that can call back in to us with error notifications as the
660 : // session is released.
661 0 : mCommissioneeDevicePool.ReleaseObject(device);
662 0 : }
663 :
664 0 : CHIP_ERROR DeviceCommissioner::GetDeviceBeingCommissioned(NodeId deviceId, CommissioneeDeviceProxy ** out_device)
665 : {
666 0 : VerifyOrReturnError(out_device != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
667 0 : CommissioneeDeviceProxy * device = FindCommissioneeDevice(deviceId);
668 :
669 0 : VerifyOrReturnError(device != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
670 :
671 0 : *out_device = device;
672 :
673 0 : return CHIP_NO_ERROR;
674 : }
675 :
676 0 : CHIP_ERROR DeviceCommissioner::PairDevice(NodeId remoteDeviceId, const char * setUpCode, const CommissioningParameters & params,
677 : DiscoveryType discoveryType, Optional<Dnssd::CommonResolutionData> resolutionData,
678 : Optional<SetUpCodePairer::ThreadMeshcopCommissionParameters> meshcopCommissionParams)
679 : {
680 : MATTER_TRACE_SCOPE("PairDevice", "DeviceCommissioner");
681 : #if CHIP_SUPPORT_THREAD_MESHCOP
682 0 : if (meshcopCommissionParams.HasValue())
683 : {
684 0 : mSetUpCodePairer.SetThreadMeshcopCommissionParamsAndProxy(meshcopCommissionParams.Value(), &mThreadMeshcopCommissionProxy);
685 : }
686 : #endif
687 0 : ReturnErrorOnFailure(mDefaultCommissioner->SetCommissioningParameters(params));
688 :
689 0 : return mSetUpCodePairer.PairDevice(remoteDeviceId, setUpCode, SetupCodePairerBehaviour::kCommission, discoveryType,
690 0 : resolutionData);
691 : }
692 :
693 0 : CHIP_ERROR DeviceCommissioner::PairDevice(NodeId remoteDeviceId, const char * setUpCode, DiscoveryType discoveryType,
694 : Optional<Dnssd::CommonResolutionData> resolutionData)
695 : {
696 : MATTER_TRACE_SCOPE("PairDevice", "DeviceCommissioner");
697 0 : return mSetUpCodePairer.PairDevice(remoteDeviceId, setUpCode, SetupCodePairerBehaviour::kCommission, discoveryType,
698 0 : resolutionData);
699 : }
700 :
701 0 : CHIP_ERROR DeviceCommissioner::PairDevice(NodeId remoteDeviceId, RendezvousParameters & params)
702 : {
703 : MATTER_TRACE_SCOPE("PairDevice", "DeviceCommissioner");
704 0 : ReturnErrorOnFailureWithMetric(kMetricDeviceCommissionerCommission, EstablishPASEConnection(remoteDeviceId, params));
705 0 : auto errorCode = Commission(remoteDeviceId);
706 0 : VerifyOrDoWithMetric(kMetricDeviceCommissionerCommission, CHIP_NO_ERROR == errorCode, errorCode);
707 0 : return errorCode;
708 : }
709 :
710 : #if CHIP_SUPPORT_THREAD_MESHCOP
711 0 : CHIP_ERROR DeviceCommissioner::PairThreadMeshcop(RendezvousParameters & rendezvousParams,
712 : CommissioningParameters & commissioningParams)
713 : {
714 0 : VerifyOrReturnError(rendezvousParams.GetSetupDiscriminator().has_value(), CHIP_ERROR_INVALID_ARGUMENT);
715 0 : VerifyOrReturnError(commissioningParams.GetThreadOperationalDataset().HasValue(), CHIP_ERROR_INVALID_ARGUMENT);
716 0 : auto discriminator = rendezvousParams.GetSetupDiscriminator().value();
717 0 : Thread::DiscoveryCode code;
718 0 : if (rendezvousParams.GetSetupDiscriminator().value().IsShortDiscriminator())
719 : {
720 0 : code = Thread::DiscoveryCode(discriminator.GetShortValue());
721 0 : ChipLogProgress(Controller, "Discovery code from short discriminator: 0x%" PRIx64, code.AsUInt64());
722 : }
723 : else
724 : {
725 0 : code = Thread::DiscoveryCode(discriminator.GetLongValue());
726 0 : ChipLogProgress(Controller, "Discovery code from long discriminator: 0x%" PRIx64, code.AsUInt64());
727 : }
728 :
729 : uint8_t pskcBuffer[Thread::kSizePSKc];
730 0 : ByteSpan pskc(pskcBuffer);
731 : {
732 0 : Thread::OperationalDatasetView dataset;
733 0 : ReturnErrorOnFailure(dataset.Init(commissioningParams.GetThreadOperationalDataset().Value()));
734 :
735 0 : ReturnErrorOnFailure(dataset.GetPSKc(pskcBuffer));
736 : }
737 :
738 : {
739 0 : Dnssd::DiscoveredNodeData discoveredNodeData;
740 0 : ReturnErrorOnFailure(mThreadMeshcopCommissionProxy.Discover(pskc, rendezvousParams.GetPeerAddress(), code, discriminator,
741 : discoveredNodeData, 30));
742 :
743 0 : ChipLogProgress(Controller, "Joiner discovered");
744 0 : OnNodeDiscovered(discoveredNodeData);
745 0 : }
746 0 : return CHIP_NO_ERROR;
747 : }
748 : #endif // CHIP_SUPPORT_THREAD_MESHCOP
749 :
750 0 : CHIP_ERROR DeviceCommissioner::PairDevice(NodeId remoteDeviceId, RendezvousParameters & rendezvousParams,
751 : CommissioningParameters & commissioningParams)
752 : {
753 : MATTER_TRACE_SCOPE("PairDevice", "DeviceCommissioner");
754 : #if CHIP_SUPPORT_THREAD_MESHCOP
755 0 : if (rendezvousParams.GetPeerAddress().GetTransportType() == Transport::Type::kThreadMeshcop)
756 : {
757 0 : return PairThreadMeshcop(rendezvousParams, commissioningParams);
758 : }
759 : #endif
760 0 : ReturnErrorOnFailureWithMetric(kMetricDeviceCommissionerCommission, EstablishPASEConnection(remoteDeviceId, rendezvousParams));
761 0 : auto errorCode = Commission(remoteDeviceId, commissioningParams);
762 0 : VerifyOrDoWithMetric(kMetricDeviceCommissionerCommission, CHIP_NO_ERROR == errorCode, errorCode);
763 0 : return errorCode;
764 : }
765 :
766 : CHIP_ERROR
767 0 : DeviceCommissioner::EstablishPASEConnection(NodeId remoteDeviceId, const char * setUpCode, DiscoveryType discoveryType,
768 : Optional<Dnssd::CommonResolutionData> resolutionData,
769 : Optional<SetUpCodePairer::ThreadMeshcopCommissionParameters> meshcopCommissionParams)
770 : {
771 : MATTER_TRACE_SCOPE("EstablishPASEConnection", "DeviceCommissioner");
772 : #if CHIP_SUPPORT_THREAD_MESHCOP
773 0 : if (meshcopCommissionParams.HasValue())
774 : {
775 0 : mSetUpCodePairer.SetThreadMeshcopCommissionParamsAndProxy(meshcopCommissionParams.Value(), &mThreadMeshcopCommissionProxy);
776 : }
777 : #endif
778 0 : return mSetUpCodePairer.PairDevice(remoteDeviceId, setUpCode, SetupCodePairerBehaviour::kPaseOnly, discoveryType,
779 0 : resolutionData);
780 : }
781 :
782 0 : CHIP_ERROR DeviceCommissioner::EstablishPASEConnection(NodeId remoteDeviceId, RendezvousParameters & params)
783 : {
784 : MATTER_TRACE_SCOPE("EstablishPASEConnection", "DeviceCommissioner");
785 : MATTER_LOG_METRIC_BEGIN(kMetricDeviceCommissionerPASESession);
786 :
787 0 : CHIP_ERROR err = CHIP_NO_ERROR;
788 0 : CommissioneeDeviceProxy * device = nullptr;
789 0 : CommissioneeDeviceProxy * current = nullptr;
790 0 : Transport::PeerAddress peerAddress = Transport::PeerAddress::UDP(Inet::IPAddress::Any);
791 :
792 0 : Messaging::ExchangeContext * exchangeCtxt = nullptr;
793 0 : Optional<SessionHandle> session;
794 :
795 0 : VerifyOrExit(mState == State::Initialized, err = CHIP_ERROR_INCORRECT_STATE);
796 0 : VerifyOrExit(mDeviceInPASEEstablishment == nullptr, err = CHIP_ERROR_INCORRECT_STATE);
797 :
798 : // TODO(#13940): We need to specify the peer address for BLE transport in bindings.
799 0 : if (params.GetPeerAddress().GetTransportType() == Transport::Type::kBle ||
800 0 : params.GetPeerAddress().GetTransportType() == Transport::Type::kUndefined)
801 : {
802 : #if CONFIG_NETWORK_LAYER_BLE
803 : #if CHIP_DEVICE_CONFIG_ENABLE_BOTH_COMMISSIONER_AND_COMMISSIONEE
804 : ConnectBleTransportToSelf();
805 : #endif // CHIP_DEVICE_CONFIG_ENABLE_BOTH_COMMISSIONER_AND_COMMISSIONEE
806 0 : if (!params.HasBleLayer())
807 : {
808 0 : params.SetPeerAddress(Transport::PeerAddress::BLE());
809 : }
810 0 : peerAddress = Transport::PeerAddress::BLE();
811 : #endif // CONFIG_NETWORK_LAYER_BLE
812 : }
813 0 : else if (params.GetPeerAddress().GetTransportType() == Transport::Type::kTcp ||
814 0 : params.GetPeerAddress().GetTransportType() == Transport::Type::kUdp)
815 : {
816 0 : peerAddress = Transport::PeerAddress::UDP(params.GetPeerAddress().GetIPAddress(), params.GetPeerAddress().GetPort(),
817 0 : params.GetPeerAddress().GetInterface());
818 : }
819 : #if CHIP_DEVICE_CONFIG_ENABLE_WIFIPAF
820 0 : else if (params.GetPeerAddress().GetTransportType() == Transport::Type::kWiFiPAF)
821 : {
822 0 : peerAddress = Transport::PeerAddress::WiFiPAF(remoteDeviceId);
823 : }
824 : #endif // CHIP_DEVICE_CONFIG_ENABLE_WIFIPAF
825 :
826 0 : current = FindCommissioneeDevice(peerAddress);
827 0 : if (current != nullptr)
828 : {
829 0 : if (current->GetDeviceId() == remoteDeviceId)
830 : {
831 : // We might be able to just reuse its connection if it has one or is
832 : // working on one.
833 0 : if (current->IsSecureConnected())
834 : {
835 0 : if (mPairingDelegate)
836 : {
837 : // We already have an open secure session to this device, call the callback immediately and early return.
838 : // We don't know what the right RendezvousParameters are here.
839 0 : mPairingDelegate->OnPairingComplete(CHIP_NO_ERROR, std::nullopt, std::nullopt);
840 : }
841 : MATTER_LOG_METRIC_END(kMetricDeviceCommissionerPASESession, CHIP_NO_ERROR);
842 0 : return CHIP_NO_ERROR;
843 : }
844 0 : if (current->IsSessionSetupInProgress())
845 : {
846 : // We're not connected yet, but we're in the process of connecting. Pairing delegate will get a callback when
847 : // connection completes
848 0 : return CHIP_NO_ERROR;
849 : }
850 : }
851 :
852 : // Either the consumer wants to assign a different device id to this
853 : // peer address now (so we can't reuse the commissionee device we have
854 : // already) or something has gone strange. Delete the old device, try
855 : // again.
856 0 : ChipLogError(Controller, "Found unconnected device, removing");
857 0 : ReleaseCommissioneeDevice(current);
858 : }
859 :
860 0 : device = mCommissioneeDevicePool.CreateObject();
861 0 : VerifyOrExit(device != nullptr, err = CHIP_ERROR_NO_MEMORY);
862 :
863 0 : mDeviceInPASEEstablishment = device;
864 0 : device->Init(GetControllerDeviceInitParams(), remoteDeviceId, peerAddress);
865 0 : device->UpdateDeviceData(params.GetPeerAddress(), params.GetMRPConfig());
866 :
867 : #if CONFIG_NETWORK_LAYER_BLE
868 0 : if (params.GetPeerAddress().GetTransportType() == Transport::Type::kBle)
869 : {
870 0 : if (params.HasConnectionObject())
871 : {
872 0 : SuccessOrExit(err = mSystemState->BleLayer()->NewBleConnectionByObject(params.GetConnectionObject()));
873 : }
874 0 : else if (params.HasDiscoveredObject())
875 : {
876 : // The RendezvousParameters argument needs to be recovered if the search succeed, so save them
877 : // for later.
878 0 : mRendezvousParametersForDeviceDiscoveredOverBle = params;
879 0 : ExitNow(err = mSystemState->BleLayer()->NewBleConnectionByObject(
880 : params.GetDiscoveredObject(), this, OnDiscoveredDeviceOverBleSuccess, OnDiscoveredDeviceOverBleError));
881 : }
882 0 : else if (params.GetSetupDiscriminator().has_value())
883 : {
884 : // The RendezvousParameters argument needs to be recovered if the search succeed, so save them
885 : // for later.
886 0 : mRendezvousParametersForDeviceDiscoveredOverBle = params;
887 0 : auto setupDiscriminator = params.GetSetupDiscriminator();
888 0 : VerifyOrExit(setupDiscriminator.has_value(), err = CHIP_ERROR_INVALID_ARGUMENT);
889 0 : ExitNow(err = mSystemState->BleLayer()->NewBleConnectionByDiscriminator(
890 : setupDiscriminator.value(), this, OnDiscoveredDeviceOverBleSuccess, OnDiscoveredDeviceOverBleError));
891 : }
892 : else
893 : {
894 0 : ExitNow(err = CHIP_ERROR_INVALID_ARGUMENT);
895 : }
896 : }
897 : #endif
898 : #if CHIP_DEVICE_CONFIG_ENABLE_WIFIPAF
899 0 : if (params.GetPeerAddress().GetTransportType() == Transport::Type::kWiFiPAF)
900 : {
901 0 : if (DeviceLayer::ConnectivityMgr().GetWiFiPAF()->GetWiFiPAFState() != WiFiPAF::State::kConnected)
902 : {
903 0 : ChipLogProgress(Controller, "WiFi-PAF: Subscribing to the NAN-USD devices, nodeId: %" PRIu64,
904 : params.GetPeerAddress().GetRemoteId());
905 0 : mRendezvousParametersForDeviceDiscoveredOverWiFiPAF = params;
906 0 : auto nodeId = params.GetPeerAddress().GetRemoteId();
907 0 : const SetupDiscriminator connDiscriminator(params.GetSetupDiscriminator().value());
908 0 : VerifyOrReturnValue(!connDiscriminator.IsShortDiscriminator(), CHIP_ERROR_INVALID_ARGUMENT,
909 : ChipLogError(Controller, "Error, Long discriminator is required"));
910 0 : uint16_t discriminator = connDiscriminator.GetLongValue();
911 0 : WiFiPAF::WiFiPAFSession sessionInfo = { .role = WiFiPAF::WiFiPafRole::kWiFiPafRole_Subscriber,
912 : .nodeId = nodeId,
913 0 : .discriminator = discriminator };
914 0 : ReturnErrorOnFailure(
915 : DeviceLayer::ConnectivityMgr().GetWiFiPAF()->AddPafSession(WiFiPAF::PafInfoAccess::kAccNodeInfo, sessionInfo));
916 0 : ExitNow(err = DeviceLayer::ConnectivityMgr().WiFiPAFSubscribe(discriminator, reinterpret_cast<void *>(this),
917 : OnWiFiPAFSubscribeComplete, OnWiFiPAFSubscribeError));
918 : }
919 : }
920 : #endif
921 0 : session = mSystemState->SessionMgr()->CreateUnauthenticatedSession(params.GetPeerAddress(), params.GetMRPConfig());
922 0 : VerifyOrExit(session.HasValue(), err = CHIP_ERROR_NO_MEMORY);
923 :
924 : // Allocate the exchange immediately before calling PASESession::Pair.
925 : //
926 : // PASESession::Pair takes ownership of the exchange and will free it on
927 : // error, but can only do this if it is actually called. Allocating the
928 : // exchange context right before calling Pair ensures that if allocation
929 : // succeeds, PASESession has taken ownership.
930 0 : exchangeCtxt = mSystemState->ExchangeMgr()->NewContext(session.Value(), &device->GetPairing());
931 0 : VerifyOrExit(exchangeCtxt != nullptr, err = CHIP_ERROR_INTERNAL);
932 :
933 0 : err = device->GetPairing().Pair(*mSystemState->SessionMgr(), params.GetSetupPINCode(), GetLocalMRPConfig(), exchangeCtxt, this);
934 0 : SuccessOrExit(err);
935 :
936 0 : mRendezvousParametersForPASEEstablishment = params;
937 :
938 0 : exit:
939 0 : if (err != CHIP_NO_ERROR)
940 : {
941 0 : if (device != nullptr)
942 : {
943 0 : ReleaseCommissioneeDevice(device);
944 : }
945 : MATTER_LOG_METRIC_END(kMetricDeviceCommissionerPASESession, err);
946 : }
947 :
948 0 : return err;
949 0 : }
950 :
951 : #if CONFIG_NETWORK_LAYER_BLE
952 0 : void DeviceCommissioner::OnDiscoveredDeviceOverBleSuccess(void * appState, BLE_CONNECTION_OBJECT connObj)
953 : {
954 0 : auto self = static_cast<DeviceCommissioner *>(appState);
955 0 : auto device = self->mDeviceInPASEEstablishment;
956 :
957 0 : if (nullptr != device && device->GetDeviceTransportType() == Transport::Type::kBle)
958 : {
959 0 : auto remoteId = device->GetDeviceId();
960 :
961 0 : auto params = self->mRendezvousParametersForDeviceDiscoveredOverBle;
962 0 : params.SetConnectionObject(connObj);
963 0 : self->mRendezvousParametersForDeviceDiscoveredOverBle = RendezvousParameters();
964 :
965 0 : self->ReleaseCommissioneeDevice(device);
966 0 : LogErrorOnFailure(self->EstablishPASEConnection(remoteId, params));
967 : }
968 0 : }
969 :
970 0 : void DeviceCommissioner::OnDiscoveredDeviceOverBleError(void * appState, CHIP_ERROR err)
971 : {
972 0 : auto self = static_cast<DeviceCommissioner *>(appState);
973 0 : auto device = self->mDeviceInPASEEstablishment;
974 :
975 0 : if (nullptr != device && device->GetDeviceTransportType() == Transport::Type::kBle)
976 : {
977 0 : self->ReleaseCommissioneeDevice(device);
978 0 : self->mRendezvousParametersForDeviceDiscoveredOverBle = RendezvousParameters();
979 :
980 : // Callback is required when BLE discovery fails, otherwise the caller will always be in a suspended state
981 : // A better way to handle it should define a new error code
982 0 : if (self->mPairingDelegate != nullptr)
983 : {
984 0 : self->mPairingDelegate->OnPairingComplete(err, std::nullopt, std::nullopt);
985 : }
986 : }
987 0 : }
988 : #endif // CONFIG_NETWORK_LAYER_BLE
989 :
990 : #if CHIP_DEVICE_CONFIG_ENABLE_WIFIPAF
991 0 : void DeviceCommissioner::OnWiFiPAFSubscribeComplete(void * appState)
992 : {
993 0 : auto self = reinterpret_cast<DeviceCommissioner *>(appState);
994 0 : auto device = self->mDeviceInPASEEstablishment;
995 :
996 0 : if (nullptr != device && device->GetDeviceTransportType() == Transport::Type::kWiFiPAF)
997 : {
998 0 : ChipLogProgress(Controller, "WiFi-PAF: Subscription Completed, dev_id = %" PRIu64, device->GetDeviceId());
999 0 : auto remoteId = device->GetDeviceId();
1000 0 : auto params = self->mRendezvousParametersForDeviceDiscoveredOverWiFiPAF;
1001 :
1002 0 : self->mRendezvousParametersForDeviceDiscoveredOverWiFiPAF = RendezvousParameters();
1003 0 : self->ReleaseCommissioneeDevice(device);
1004 0 : LogErrorOnFailure(self->EstablishPASEConnection(remoteId, params));
1005 : }
1006 0 : }
1007 :
1008 0 : void DeviceCommissioner::OnWiFiPAFSubscribeError(void * appState, CHIP_ERROR err)
1009 : {
1010 0 : auto self = (DeviceCommissioner *) appState;
1011 0 : auto device = self->mDeviceInPASEEstablishment;
1012 :
1013 0 : if (nullptr != device && device->GetDeviceTransportType() == Transport::Type::kWiFiPAF)
1014 : {
1015 0 : ChipLogError(Controller, "WiFi-PAF: Subscription Error, id = %" PRIu64 ", err = %" CHIP_ERROR_FORMAT, device->GetDeviceId(),
1016 : err.Format());
1017 0 : self->ReleaseCommissioneeDevice(device);
1018 0 : self->mRendezvousParametersForDeviceDiscoveredOverWiFiPAF = RendezvousParameters();
1019 0 : if (self->mPairingDelegate != nullptr)
1020 : {
1021 0 : self->mPairingDelegate->OnPairingComplete(err, std::nullopt, std::nullopt);
1022 : }
1023 : }
1024 0 : }
1025 : #endif
1026 :
1027 0 : CHIP_ERROR DeviceCommissioner::Commission(NodeId remoteDeviceId, CommissioningParameters & params)
1028 : {
1029 0 : ReturnErrorOnFailureWithMetric(kMetricDeviceCommissionerCommission, mDefaultCommissioner->SetCommissioningParameters(params));
1030 0 : auto errorCode = Commission(remoteDeviceId);
1031 0 : VerifyOrDoWithMetric(kMetricDeviceCommissionerCommission, CHIP_NO_ERROR == errorCode, errorCode);
1032 0 : return errorCode;
1033 : }
1034 :
1035 0 : CHIP_ERROR DeviceCommissioner::Commission(NodeId remoteDeviceId)
1036 : {
1037 : MATTER_TRACE_SCOPE("Commission", "DeviceCommissioner");
1038 :
1039 : #if CHIP_CONFIG_ENABLE_ADDRESS_RESOLVE_FALLBACK
1040 : // Reset fallback from any previous commissioning session
1041 : mFallbackOperationalResolveResult.ClearValue();
1042 : #endif // CHIP_CONFIG_ENABLE_ADDRESS_RESOLVE_FALLBACK
1043 :
1044 0 : CommissioneeDeviceProxy * device = FindCommissioneeDevice(remoteDeviceId);
1045 0 : if (device == nullptr || (!device->IsSecureConnected() && !device->IsSessionSetupInProgress()))
1046 : {
1047 0 : ChipLogError(Controller, "Invalid device for commissioning " ChipLogFormatX64, ChipLogValueX64(remoteDeviceId));
1048 0 : return CHIP_ERROR_INCORRECT_STATE;
1049 : }
1050 0 : if (!device->IsSecureConnected() && device != mDeviceInPASEEstablishment)
1051 : {
1052 : // We should not end up in this state because we won't attempt to establish more than one connection at a time.
1053 0 : ChipLogError(Controller, "Device is not connected and not being paired " ChipLogFormatX64, ChipLogValueX64(remoteDeviceId));
1054 0 : return CHIP_ERROR_INCORRECT_STATE;
1055 : }
1056 :
1057 0 : if (mCommissioningStage != CommissioningStage::kSecurePairing)
1058 : {
1059 0 : ChipLogError(Controller, "Commissioning already in progress (stage '%s') - not restarting",
1060 : StageToString(mCommissioningStage));
1061 0 : return CHIP_ERROR_INCORRECT_STATE;
1062 : }
1063 :
1064 0 : ChipLogProgress(Controller, "Commission called for node ID 0x" ChipLogFormatX64, ChipLogValueX64(remoteDeviceId));
1065 :
1066 0 : mDefaultCommissioner->SetOperationalCredentialsDelegate(mOperationalCredentialsDelegate);
1067 0 : if (device->IsSecureConnected())
1068 : {
1069 : MATTER_LOG_METRIC_BEGIN(kMetricDeviceCommissionerCommission);
1070 0 : ReturnErrorOnFailure(mDefaultCommissioner->StartCommissioning(this, device));
1071 : }
1072 : else
1073 : {
1074 0 : mRunCommissioningAfterConnection = true;
1075 : }
1076 0 : return CHIP_NO_ERROR;
1077 : }
1078 :
1079 : CHIP_ERROR
1080 0 : DeviceCommissioner::ContinueCommissioningAfterDeviceAttestation(DeviceProxy * device,
1081 : Credentials::AttestationVerificationResult attestationResult)
1082 : {
1083 : MATTER_TRACE_SCOPE("continueCommissioningDevice", "DeviceCommissioner");
1084 :
1085 0 : if (device == nullptr || device != mDeviceBeingCommissioned)
1086 : {
1087 0 : ChipLogError(Controller, "Invalid device for commissioning %p", device);
1088 0 : return CHIP_ERROR_INCORRECT_STATE;
1089 : }
1090 0 : CommissioneeDeviceProxy * commissioneeDevice = FindCommissioneeDevice(device->GetDeviceId());
1091 0 : if (commissioneeDevice == nullptr)
1092 : {
1093 0 : ChipLogError(Controller, "Couldn't find commissionee device");
1094 0 : return CHIP_ERROR_INCORRECT_STATE;
1095 : }
1096 0 : if (!commissioneeDevice->IsSecureConnected() || commissioneeDevice != mDeviceBeingCommissioned)
1097 : {
1098 0 : ChipLogError(Controller, "Invalid device for commissioning after attestation failure: 0x" ChipLogFormatX64,
1099 : ChipLogValueX64(commissioneeDevice->GetDeviceId()));
1100 0 : return CHIP_ERROR_INCORRECT_STATE;
1101 : }
1102 :
1103 0 : if (mCommissioningStage != CommissioningStage::kAttestationRevocationCheck)
1104 : {
1105 0 : ChipLogError(Controller, "Commissioning is not attestation verification phase");
1106 0 : return CHIP_ERROR_INCORRECT_STATE;
1107 : }
1108 :
1109 0 : ChipLogProgress(Controller, "Continuing commissioning after attestation failure for device ID 0x" ChipLogFormatX64,
1110 : ChipLogValueX64(commissioneeDevice->GetDeviceId()));
1111 :
1112 0 : if (attestationResult != AttestationVerificationResult::kSuccess)
1113 : {
1114 0 : ChipLogError(Controller, "Client selected error: %u for failed 'Attestation Information' for device",
1115 : to_underlying(attestationResult));
1116 :
1117 0 : CommissioningDelegate::CommissioningReport report;
1118 0 : report.Set<AttestationErrorInfo>(attestationResult);
1119 0 : CommissioningStageComplete(CHIP_ERROR_INTERNAL, report);
1120 0 : }
1121 : else
1122 : {
1123 0 : ChipLogProgress(Controller, "Overriding attestation failure per client and continuing commissioning");
1124 0 : CommissioningStageComplete(CHIP_NO_ERROR);
1125 : }
1126 0 : return CHIP_NO_ERROR;
1127 : }
1128 :
1129 : #if CHIP_DEVICE_CONFIG_ENABLE_NFC_BASED_COMMISSIONING
1130 : CHIP_ERROR DeviceCommissioner::ContinueCommissioningAfterConnectNetworkRequest(NodeId remoteDeviceId)
1131 : {
1132 : MATTER_TRACE_SCOPE("continueCommissioningAfterConnectNetworkRequest", "DeviceCommissioner");
1133 :
1134 : // Move to kEvictPreviousCaseSessions stage since the next stage will be to find the device
1135 : // on the operational network
1136 : mCommissioningStage = CommissioningStage::kEvictPreviousCaseSessions;
1137 :
1138 : // Setup device being commissioned
1139 : CommissioneeDeviceProxy * device = nullptr;
1140 : if (!mDeviceBeingCommissioned)
1141 : {
1142 : device = mCommissioneeDevicePool.CreateObject();
1143 : if (!device)
1144 : return CHIP_ERROR_NO_MEMORY;
1145 :
1146 : Transport::PeerAddress peerAddress = Transport::PeerAddress::UDP(Inet::IPAddress::Any);
1147 : device->Init(GetControllerDeviceInitParams(), remoteDeviceId, peerAddress);
1148 : mDeviceBeingCommissioned = device;
1149 : }
1150 :
1151 : mDefaultCommissioner->SetOperationalCredentialsDelegate(mOperationalCredentialsDelegate);
1152 :
1153 : ChipLogProgress(Controller, "Continuing commissioning after connect to network complete for device ID 0x" ChipLogFormatX64,
1154 : ChipLogValueX64(remoteDeviceId));
1155 :
1156 : MATTER_LOG_METRIC_BEGIN(kMetricDeviceCommissioningOperationalSetup);
1157 : CHIP_ERROR err = mDefaultCommissioner->StartCommissioning(this, device);
1158 : if (err != CHIP_NO_ERROR)
1159 : {
1160 : MATTER_LOG_METRIC_END(kMetricDeviceCommissioningOperationalSetup, err);
1161 : }
1162 : return err;
1163 : }
1164 : #endif
1165 :
1166 0 : CHIP_ERROR DeviceCommissioner::StopPairing(NodeId remoteDeviceId)
1167 : {
1168 0 : VerifyOrReturnError(mState == State::Initialized, CHIP_ERROR_INCORRECT_STATE);
1169 0 : VerifyOrReturnError(remoteDeviceId != kUndefinedNodeId, CHIP_ERROR_INVALID_ARGUMENT);
1170 :
1171 0 : ChipLogProgress(Controller, "StopPairing called for node ID 0x" ChipLogFormatX64, ChipLogValueX64(remoteDeviceId));
1172 :
1173 : // If we're still in the process of discovering the device, just stop the SetUpCodePairer
1174 0 : if (mSetUpCodePairer.StopPairing(remoteDeviceId))
1175 : {
1176 0 : mRunCommissioningAfterConnection = false;
1177 0 : OnSessionEstablishmentError(CHIP_ERROR_CANCELLED);
1178 0 : return CHIP_NO_ERROR;
1179 : }
1180 :
1181 : // Otherwise we might be pairing and / or commissioning it.
1182 0 : CommissioneeDeviceProxy * device = FindCommissioneeDevice(remoteDeviceId);
1183 0 : VerifyOrReturnError(device != nullptr, CHIP_ERROR_INVALID_DEVICE_DESCRIPTOR);
1184 :
1185 0 : if (mDeviceBeingCommissioned == device)
1186 : {
1187 0 : CancelCommissioningInteractions();
1188 0 : CommissioningStageComplete(CHIP_ERROR_CANCELLED);
1189 : }
1190 : else
1191 : {
1192 0 : ReleaseCommissioneeDevice(device);
1193 : }
1194 0 : return CHIP_NO_ERROR;
1195 : }
1196 :
1197 0 : void DeviceCommissioner::CancelCommissioningInteractions()
1198 : {
1199 0 : if (mReadClient)
1200 : {
1201 0 : ChipLogDetail(Controller, "Cancelling read request for step '%s'", StageToString(mCommissioningStage));
1202 0 : mReadClient.reset(); // destructor cancels
1203 0 : mAttributeCache.reset();
1204 : }
1205 0 : if (mInvokeCancelFn)
1206 : {
1207 0 : ChipLogDetail(Controller, "Cancelling command invocation for step '%s'", StageToString(mCommissioningStage));
1208 0 : mInvokeCancelFn();
1209 0 : mInvokeCancelFn = nullptr;
1210 : }
1211 0 : if (mWriteCancelFn)
1212 : {
1213 0 : ChipLogDetail(Controller, "Cancelling write request for step '%s'", StageToString(mCommissioningStage));
1214 0 : mWriteCancelFn();
1215 0 : mWriteCancelFn = nullptr;
1216 : }
1217 0 : if (mOnDeviceConnectedCallback.IsRegistered())
1218 : {
1219 0 : ChipLogDetail(Controller, "Cancelling CASE setup for step '%s'", StageToString(mCommissioningStage));
1220 0 : CancelCASECallbacks();
1221 : }
1222 0 : }
1223 :
1224 0 : void DeviceCommissioner::CancelCASECallbacks()
1225 : {
1226 0 : mOnDeviceConnectedCallback.Cancel();
1227 0 : mOnDeviceConnectionFailureCallback.Cancel();
1228 : #if CHIP_DEVICE_CONFIG_ENABLE_AUTOMATIC_CASE_RETRIES
1229 0 : mOnDeviceConnectionRetryCallback.Cancel();
1230 : #endif
1231 0 : }
1232 :
1233 0 : CHIP_ERROR DeviceCommissioner::UnpairDevice(NodeId remoteDeviceId)
1234 : {
1235 : MATTER_TRACE_SCOPE("UnpairDevice", "DeviceCommissioner");
1236 0 : VerifyOrReturnError(mState == State::Initialized, CHIP_ERROR_INCORRECT_STATE);
1237 :
1238 0 : return AutoCurrentFabricRemover::RemoveCurrentFabric(this, remoteDeviceId);
1239 : }
1240 :
1241 1 : void DeviceCommissioner::RendezvousCleanup(CHIP_ERROR status)
1242 : {
1243 1 : if (mDeviceInPASEEstablishment != nullptr)
1244 : {
1245 : // Release the commissionee device. For BLE, this is stored,
1246 : // for IP commissioning, we have taken a reference to the
1247 : // operational node to send the completion command.
1248 0 : ReleaseCommissioneeDevice(mDeviceInPASEEstablishment);
1249 :
1250 0 : if (mPairingDelegate != nullptr)
1251 : {
1252 0 : mPairingDelegate->OnPairingComplete(status, std::nullopt, std::nullopt);
1253 : }
1254 : }
1255 1 : }
1256 :
1257 1 : void DeviceCommissioner::OnSessionEstablishmentError(CHIP_ERROR err)
1258 : {
1259 : MATTER_LOG_METRIC_END(kMetricDeviceCommissionerPASESession, err);
1260 :
1261 1 : mRendezvousParametersForPASEEstablishment.reset();
1262 :
1263 1 : if (mPairingDelegate != nullptr)
1264 : {
1265 0 : mPairingDelegate->OnStatusUpdate(DevicePairingDelegate::SecurePairingFailed);
1266 : }
1267 :
1268 1 : RendezvousCleanup(err);
1269 1 : }
1270 :
1271 0 : void DeviceCommissioner::OnSessionEstablished(const SessionHandle & session)
1272 : {
1273 : // PASE session established.
1274 0 : CommissioneeDeviceProxy * device = mDeviceInPASEEstablishment;
1275 :
1276 : // We are in the callback for this pairing. Reset so we can pair another device.
1277 0 : mDeviceInPASEEstablishment = nullptr;
1278 :
1279 : // Make sure to clear out mRendezvousParametersForPASEEstablishment no
1280 : // matter what.
1281 0 : std::optional<RendezvousParameters> paseParameters;
1282 0 : paseParameters.swap(mRendezvousParametersForPASEEstablishment);
1283 :
1284 0 : VerifyOrReturn(device != nullptr, OnSessionEstablishmentError(CHIP_ERROR_INVALID_DEVICE_DESCRIPTOR));
1285 :
1286 0 : CHIP_ERROR err = device->SetConnected(session);
1287 0 : if (err != CHIP_NO_ERROR)
1288 : {
1289 0 : ChipLogError(Controller, "Failed in setting up secure channel: %" CHIP_ERROR_FORMAT, err.Format());
1290 0 : OnSessionEstablishmentError(err);
1291 0 : return;
1292 : }
1293 :
1294 0 : ChipLogDetail(Controller, "Remote device completed SPAKE2+ handshake");
1295 :
1296 : MATTER_LOG_METRIC_END(kMetricDeviceCommissionerPASESession, CHIP_NO_ERROR);
1297 0 : if (mPairingDelegate != nullptr)
1298 : {
1299 : // If we started with a string payload, then at this point mPairingDelegate is
1300 : // mSetUpCodePairer, and it will provide the right SetupPayload argument to
1301 : // OnPairingComplete as needed. If mPairingDelegate is not
1302 : // mSetUpCodePairer, then we don't have a SetupPayload to provide.
1303 0 : mPairingDelegate->OnPairingComplete(CHIP_NO_ERROR, paseParameters, std::nullopt);
1304 : }
1305 :
1306 0 : if (mRunCommissioningAfterConnection)
1307 : {
1308 0 : mRunCommissioningAfterConnection = false;
1309 : MATTER_LOG_METRIC_BEGIN(kMetricDeviceCommissionerCommission);
1310 0 : ReturnAndLogOnFailure(mDefaultCommissioner->StartCommissioning(this, device), Controller, "Failed to start commissioning");
1311 : }
1312 : }
1313 :
1314 0 : CHIP_ERROR DeviceCommissioner::SendCertificateChainRequestCommand(DeviceProxy * device,
1315 : Credentials::CertificateType certificateType,
1316 : Optional<System::Clock::Timeout> timeout)
1317 : {
1318 : MATTER_TRACE_SCOPE("SendCertificateChainRequestCommand", "DeviceCommissioner");
1319 0 : ChipLogDetail(Controller, "Sending Certificate Chain request to %p device", device);
1320 0 : VerifyOrReturnError(device != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
1321 :
1322 0 : OperationalCredentials::Commands::CertificateChainRequest::Type request;
1323 0 : request.certificateType = static_cast<OperationalCredentials::CertificateChainTypeEnum>(certificateType);
1324 0 : return SendCommissioningCommand(device, request, OnCertificateChainResponse, OnCertificateChainFailureResponse, kRootEndpointId,
1325 0 : timeout);
1326 : }
1327 :
1328 0 : void DeviceCommissioner::OnCertificateChainFailureResponse(void * context, CHIP_ERROR error)
1329 : {
1330 : MATTER_TRACE_SCOPE("OnCertificateChainFailureResponse", "DeviceCommissioner");
1331 0 : ChipLogProgress(Controller, "Device failed to receive the Certificate Chain request Response: %" CHIP_ERROR_FORMAT,
1332 : error.Format());
1333 0 : DeviceCommissioner * commissioner = reinterpret_cast<DeviceCommissioner *>(context);
1334 0 : commissioner->CommissioningStageComplete(error);
1335 0 : }
1336 :
1337 0 : void DeviceCommissioner::OnCertificateChainResponse(
1338 : void * context, const chip::app::Clusters::OperationalCredentials::Commands::CertificateChainResponse::DecodableType & response)
1339 : {
1340 : MATTER_TRACE_SCOPE("OnCertificateChainResponse", "DeviceCommissioner");
1341 0 : ChipLogProgress(Controller, "Received certificate chain from the device");
1342 0 : DeviceCommissioner * commissioner = reinterpret_cast<DeviceCommissioner *>(context);
1343 :
1344 0 : CommissioningDelegate::CommissioningReport report;
1345 0 : report.Set<RequestedCertificate>(RequestedCertificate(response.certificate));
1346 :
1347 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR, report);
1348 0 : }
1349 :
1350 0 : CHIP_ERROR DeviceCommissioner::SendAttestationRequestCommand(DeviceProxy * device, const ByteSpan & attestationNonce,
1351 : Optional<System::Clock::Timeout> timeout)
1352 : {
1353 : MATTER_TRACE_SCOPE("SendAttestationRequestCommand", "DeviceCommissioner");
1354 0 : ChipLogDetail(Controller, "Sending Attestation request to %p device", device);
1355 0 : VerifyOrReturnError(device != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
1356 :
1357 0 : OperationalCredentials::Commands::AttestationRequest::Type request;
1358 0 : request.attestationNonce = attestationNonce;
1359 :
1360 0 : ReturnErrorOnFailure(
1361 : SendCommissioningCommand(device, request, OnAttestationResponse, OnAttestationFailureResponse, kRootEndpointId, timeout));
1362 0 : ChipLogDetail(Controller, "Sent Attestation request, waiting for the Attestation Information");
1363 0 : return CHIP_NO_ERROR;
1364 : }
1365 :
1366 0 : void DeviceCommissioner::OnAttestationFailureResponse(void * context, CHIP_ERROR error)
1367 : {
1368 : MATTER_TRACE_SCOPE("OnAttestationFailureResponse", "DeviceCommissioner");
1369 0 : ChipLogProgress(Controller, "Device failed to receive the Attestation Information Response: %" CHIP_ERROR_FORMAT,
1370 : error.Format());
1371 0 : DeviceCommissioner * commissioner = reinterpret_cast<DeviceCommissioner *>(context);
1372 0 : commissioner->CommissioningStageComplete(error);
1373 0 : }
1374 :
1375 0 : void DeviceCommissioner::OnAttestationResponse(void * context,
1376 : const OperationalCredentials::Commands::AttestationResponse::DecodableType & data)
1377 : {
1378 : MATTER_TRACE_SCOPE("OnAttestationResponse", "DeviceCommissioner");
1379 0 : ChipLogProgress(Controller, "Received Attestation Information from the device");
1380 0 : DeviceCommissioner * commissioner = reinterpret_cast<DeviceCommissioner *>(context);
1381 :
1382 0 : CommissioningDelegate::CommissioningReport report;
1383 0 : report.Set<AttestationResponse>(AttestationResponse(data.attestationElements, data.attestationSignature));
1384 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR, report);
1385 0 : }
1386 :
1387 0 : void DeviceCommissioner::OnDeviceAttestationInformationVerification(
1388 : void * context, const Credentials::DeviceAttestationVerifier::AttestationInfo & info, AttestationVerificationResult result)
1389 : {
1390 : MATTER_TRACE_SCOPE("OnDeviceAttestationInformationVerification", "DeviceCommissioner");
1391 0 : DeviceCommissioner * commissioner = reinterpret_cast<DeviceCommissioner *>(context);
1392 :
1393 0 : if (commissioner->mCommissioningStage == CommissioningStage::kAttestationVerification)
1394 : {
1395 : // Check for revoked DAC Chain before calling delegate. Enter next stage.
1396 :
1397 0 : CommissioningDelegate::CommissioningReport report;
1398 0 : report.Set<AttestationErrorInfo>(result);
1399 :
1400 0 : return commissioner->CommissioningStageComplete(
1401 0 : result == AttestationVerificationResult::kSuccess ? CHIP_NO_ERROR : CHIP_ERROR_FAILED_DEVICE_ATTESTATION, report);
1402 0 : }
1403 :
1404 0 : if (!commissioner->mDeviceBeingCommissioned)
1405 : {
1406 0 : ChipLogError(Controller, "Device attestation verification result received when we're not commissioning a device");
1407 0 : return;
1408 : }
1409 :
1410 0 : auto & params = commissioner->mDefaultCommissioner->GetCommissioningParameters();
1411 0 : Credentials::DeviceAttestationDelegate * deviceAttestationDelegate = params.GetDeviceAttestationDelegate();
1412 :
1413 0 : if (params.GetCompletionStatus().attestationResult.HasValue())
1414 : {
1415 0 : auto previousResult = params.GetCompletionStatus().attestationResult.Value();
1416 0 : if (previousResult != AttestationVerificationResult::kSuccess)
1417 : {
1418 0 : result = previousResult;
1419 : }
1420 : }
1421 :
1422 0 : if (result != AttestationVerificationResult::kSuccess)
1423 : {
1424 0 : CommissioningDelegate::CommissioningReport report;
1425 0 : report.Set<AttestationErrorInfo>(result);
1426 0 : if (result == AttestationVerificationResult::kNotImplemented)
1427 : {
1428 0 : ChipLogError(Controller,
1429 : "Failed in verifying 'Attestation Information' command received from the device due to default "
1430 : "DeviceAttestationVerifier Class not being overridden by a real implementation.");
1431 0 : commissioner->CommissioningStageComplete(CHIP_ERROR_NOT_IMPLEMENTED, report);
1432 0 : return;
1433 : }
1434 :
1435 0 : ChipLogError(Controller, "Failed in verifying 'Attestation Information' command received from the device: err %hu (%s)",
1436 : static_cast<uint16_t>(result), GetAttestationResultDescription(result));
1437 : // Go look at AttestationVerificationResult enum in src/credentials/attestation_verifier/DeviceAttestationVerifier.h to
1438 : // understand the errors.
1439 :
1440 : // If a device attestation status delegate is installed, delegate handling of failure to the client and let them
1441 : // decide on whether to proceed further or not.
1442 0 : if (deviceAttestationDelegate)
1443 : {
1444 0 : commissioner->ExtendArmFailSafeForDeviceAttestation(info, result);
1445 : }
1446 : else
1447 : {
1448 0 : commissioner->CommissioningStageComplete(CHIP_ERROR_FAILED_DEVICE_ATTESTATION, report);
1449 : }
1450 0 : }
1451 : else
1452 : {
1453 0 : if (deviceAttestationDelegate && deviceAttestationDelegate->ShouldWaitAfterDeviceAttestation())
1454 : {
1455 0 : commissioner->ExtendArmFailSafeForDeviceAttestation(info, result);
1456 : }
1457 : else
1458 : {
1459 0 : ChipLogProgress(Controller, "Successfully validated 'Attestation Information' command received from the device.");
1460 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR);
1461 : }
1462 : }
1463 : }
1464 :
1465 0 : void DeviceCommissioner::OnArmFailSafeExtendedForDeviceAttestation(
1466 : void * context, const GeneralCommissioning::Commands::ArmFailSafeResponse::DecodableType &)
1467 : {
1468 0 : ChipLogProgress(Controller, "Successfully extended fail-safe timer to handle DA failure");
1469 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1470 :
1471 : // We have completed our command invoke, but we're not going to finish the
1472 : // commissioning step until our client examines the attestation
1473 : // information. Clear out mInvokeCancelFn (which points at the
1474 : // CommandSender we just finished using) now, so it's not dangling.
1475 0 : commissioner->mInvokeCancelFn = nullptr;
1476 :
1477 0 : commissioner->HandleDeviceAttestationCompleted();
1478 0 : }
1479 :
1480 0 : void DeviceCommissioner::HandleDeviceAttestationCompleted()
1481 : {
1482 0 : if (!mDeviceBeingCommissioned)
1483 : {
1484 0 : return;
1485 : }
1486 :
1487 0 : auto & params = mDefaultCommissioner->GetCommissioningParameters();
1488 0 : Credentials::DeviceAttestationDelegate * deviceAttestationDelegate = params.GetDeviceAttestationDelegate();
1489 0 : if (deviceAttestationDelegate)
1490 : {
1491 0 : ChipLogProgress(Controller, "Device attestation completed, delegating continuation to client");
1492 0 : deviceAttestationDelegate->OnDeviceAttestationCompleted(this, mDeviceBeingCommissioned, *mAttestationDeviceInfo,
1493 : mAttestationResult);
1494 : }
1495 : else
1496 : {
1497 0 : ChipLogError(Controller, "Need to wait for device attestation delegate, but no delegate available. Failing commissioning");
1498 0 : CommissioningDelegate::CommissioningReport report;
1499 0 : report.Set<AttestationErrorInfo>(mAttestationResult);
1500 0 : CommissioningStageComplete(CHIP_ERROR_INTERNAL, report);
1501 0 : }
1502 : }
1503 :
1504 0 : void DeviceCommissioner::OnFailedToExtendedArmFailSafeDeviceAttestation(void * context, CHIP_ERROR error)
1505 : {
1506 0 : ChipLogProgress(Controller, "Failed to extend fail-safe timer to handle attestation failure: %" CHIP_ERROR_FORMAT,
1507 : error.Format());
1508 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1509 :
1510 0 : CommissioningDelegate::CommissioningReport report;
1511 0 : report.Set<AttestationErrorInfo>(commissioner->mAttestationResult);
1512 0 : commissioner->CommissioningStageComplete(CHIP_ERROR_INTERNAL, report);
1513 0 : }
1514 :
1515 0 : void DeviceCommissioner::OnICDManagementRegisterClientResponse(
1516 : void * context, const app::Clusters::IcdManagement::Commands::RegisterClientResponse::DecodableType & data)
1517 : {
1518 0 : CHIP_ERROR err = CHIP_NO_ERROR;
1519 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1520 0 : VerifyOrExit(commissioner != nullptr, err = CHIP_ERROR_INVALID_ARGUMENT);
1521 0 : VerifyOrExit(commissioner->mCommissioningStage == CommissioningStage::kICDRegistration, err = CHIP_ERROR_INCORRECT_STATE);
1522 0 : VerifyOrExit(commissioner->mDeviceBeingCommissioned != nullptr, err = CHIP_ERROR_INCORRECT_STATE);
1523 :
1524 0 : if (commissioner->mPairingDelegate != nullptr)
1525 : {
1526 0 : commissioner->mPairingDelegate->OnICDRegistrationComplete(
1527 0 : ScopedNodeId(commissioner->mDeviceBeingCommissioned->GetDeviceId(), commissioner->GetFabricIndex()), data.ICDCounter);
1528 : }
1529 :
1530 0 : exit:
1531 0 : CommissioningDelegate::CommissioningReport report;
1532 0 : commissioner->CommissioningStageComplete(err, report);
1533 0 : }
1534 :
1535 0 : void DeviceCommissioner::OnICDManagementStayActiveResponse(
1536 : void * context, const app::Clusters::IcdManagement::Commands::StayActiveResponse::DecodableType & data)
1537 : {
1538 0 : CHIP_ERROR err = CHIP_NO_ERROR;
1539 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1540 0 : VerifyOrExit(commissioner != nullptr, err = CHIP_ERROR_INVALID_ARGUMENT);
1541 0 : VerifyOrExit(commissioner->mCommissioningStage == CommissioningStage::kICDSendStayActive, err = CHIP_ERROR_INCORRECT_STATE);
1542 0 : VerifyOrExit(commissioner->mDeviceBeingCommissioned != nullptr, err = CHIP_ERROR_INCORRECT_STATE);
1543 :
1544 0 : if (commissioner->mPairingDelegate != nullptr)
1545 : {
1546 0 : commissioner->mPairingDelegate->OnICDStayActiveComplete(
1547 :
1548 0 : ScopedNodeId(commissioner->mDeviceBeingCommissioned->GetDeviceId(), commissioner->GetFabricIndex()),
1549 0 : data.promisedActiveDuration);
1550 : }
1551 :
1552 0 : exit:
1553 0 : CommissioningDelegate::CommissioningReport report;
1554 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR, report);
1555 0 : }
1556 :
1557 0 : bool DeviceCommissioner::ExtendArmFailSafeInternal(DeviceProxy * proxy, CommissioningStage step, uint16_t armFailSafeTimeout,
1558 : Optional<System::Clock::Timeout> commandTimeout,
1559 : OnExtendFailsafeSuccess onSuccess, OnExtendFailsafeFailure onFailure,
1560 : bool fireAndForget)
1561 : {
1562 : using namespace System;
1563 : using namespace System::Clock;
1564 0 : auto now = SystemClock().GetMonotonicTimestamp();
1565 0 : auto newFailSafeTimeout = now + Seconds16(armFailSafeTimeout);
1566 0 : if (newFailSafeTimeout < proxy->GetFailSafeExpirationTimestamp())
1567 : {
1568 0 : ChipLogProgress(
1569 : Controller, "Skipping arming failsafe: new time (%u seconds from now) before old time (%u seconds from now)",
1570 : armFailSafeTimeout, std::chrono::duration_cast<Seconds16>(proxy->GetFailSafeExpirationTimestamp() - now).count());
1571 0 : return false;
1572 : }
1573 :
1574 0 : uint64_t breadcrumb = static_cast<uint64_t>(step);
1575 0 : GeneralCommissioning::Commands::ArmFailSafe::Type request;
1576 0 : request.expiryLengthSeconds = armFailSafeTimeout;
1577 0 : request.breadcrumb = breadcrumb;
1578 0 : ChipLogProgress(Controller, "Arming failsafe (%u seconds)", request.expiryLengthSeconds);
1579 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, onSuccess, onFailure, kRootEndpointId, commandTimeout, fireAndForget);
1580 0 : if (err != CHIP_NO_ERROR)
1581 : {
1582 0 : onFailure((!fireAndForget) ? this : nullptr, err);
1583 0 : return true; // we have called onFailure already
1584 : }
1585 :
1586 : // Note: The stored timestamp may become invalid if we fail asynchronously
1587 0 : proxy->SetFailSafeExpirationTimestamp(newFailSafeTimeout);
1588 0 : return true;
1589 : }
1590 :
1591 0 : void DeviceCommissioner::ExtendArmFailSafeForDeviceAttestation(const Credentials::DeviceAttestationVerifier::AttestationInfo & info,
1592 : Credentials::AttestationVerificationResult result)
1593 : {
1594 0 : mAttestationResult = result;
1595 :
1596 0 : auto & params = mDefaultCommissioner->GetCommissioningParameters();
1597 0 : Credentials::DeviceAttestationDelegate * deviceAttestationDelegate = params.GetDeviceAttestationDelegate();
1598 :
1599 0 : mAttestationDeviceInfo = Platform::MakeUnique<Credentials::DeviceAttestationVerifier::AttestationDeviceInfo>(info);
1600 :
1601 0 : auto expiryLengthSeconds = deviceAttestationDelegate->FailSafeExpiryTimeoutSecs();
1602 0 : bool waitForFailsafeExtension = expiryLengthSeconds.HasValue();
1603 0 : if (waitForFailsafeExtension)
1604 : {
1605 0 : ChipLogProgress(Controller, "Changing fail-safe timer to %u seconds to handle DA failure", expiryLengthSeconds.Value());
1606 : // Per spec, anything we do with the fail-safe armed must not time out
1607 : // in less than kMinimumCommissioningStepTimeout.
1608 : waitForFailsafeExtension =
1609 0 : ExtendArmFailSafeInternal(mDeviceBeingCommissioned, mCommissioningStage, expiryLengthSeconds.Value(),
1610 0 : MakeOptional(kMinimumCommissioningStepTimeout), OnArmFailSafeExtendedForDeviceAttestation,
1611 : OnFailedToExtendedArmFailSafeDeviceAttestation, /* fireAndForget = */ false);
1612 : }
1613 : else
1614 : {
1615 0 : ChipLogProgress(Controller, "Proceeding without changing fail-safe timer value as delegate has not set it");
1616 : }
1617 :
1618 0 : if (!waitForFailsafeExtension)
1619 : {
1620 0 : HandleDeviceAttestationCompleted();
1621 : }
1622 0 : }
1623 :
1624 0 : CHIP_ERROR DeviceCommissioner::ValidateAttestationInfo(const Credentials::DeviceAttestationVerifier::AttestationInfo & info)
1625 : {
1626 : MATTER_TRACE_SCOPE("ValidateAttestationInfo", "DeviceCommissioner");
1627 0 : VerifyOrReturnError(mState == State::Initialized, CHIP_ERROR_INCORRECT_STATE);
1628 0 : VerifyOrReturnError(mDeviceAttestationVerifier != nullptr, CHIP_ERROR_INCORRECT_STATE);
1629 :
1630 0 : mDeviceAttestationVerifier->VerifyAttestationInformation(info, &mDeviceAttestationInformationVerificationCallback);
1631 :
1632 : // TODO: Validate Firmware Information
1633 :
1634 0 : return CHIP_NO_ERROR;
1635 : }
1636 :
1637 : CHIP_ERROR
1638 0 : DeviceCommissioner::CheckForRevokedDACChain(const Credentials::DeviceAttestationVerifier::AttestationInfo & info)
1639 : {
1640 : MATTER_TRACE_SCOPE("CheckForRevokedDACChain", "DeviceCommissioner");
1641 0 : VerifyOrReturnError(mState == State::Initialized, CHIP_ERROR_INCORRECT_STATE);
1642 0 : VerifyOrReturnError(mDeviceAttestationVerifier != nullptr, CHIP_ERROR_INCORRECT_STATE);
1643 :
1644 0 : mDeviceAttestationVerifier->CheckForRevokedDACChain(info, &mDeviceAttestationInformationVerificationCallback);
1645 :
1646 0 : return CHIP_NO_ERROR;
1647 : }
1648 :
1649 0 : CHIP_ERROR DeviceCommissioner::ValidateCSR(DeviceProxy * proxy, const ByteSpan & NOCSRElements,
1650 : const ByteSpan & AttestationSignature, const ByteSpan & dac, const ByteSpan & csrNonce)
1651 : {
1652 : MATTER_TRACE_SCOPE("ValidateCSR", "DeviceCommissioner");
1653 0 : VerifyOrReturnError(mState == State::Initialized, CHIP_ERROR_INCORRECT_STATE);
1654 0 : VerifyOrReturnError(mDeviceAttestationVerifier != nullptr, CHIP_ERROR_INCORRECT_STATE);
1655 :
1656 0 : P256PublicKey dacPubkey;
1657 0 : ReturnErrorOnFailure(ExtractPubkeyFromX509Cert(dac, dacPubkey));
1658 :
1659 : // Retrieve attestation challenge
1660 : ByteSpan attestationChallenge =
1661 0 : proxy->GetSecureSession().Value()->AsSecureSession()->GetCryptoContext().GetAttestationChallenge();
1662 :
1663 : // The operational CA should also verify this on its end during NOC generation, if end-to-end attestation is desired.
1664 0 : return mDeviceAttestationVerifier->VerifyNodeOperationalCSRInformation(NOCSRElements, attestationChallenge,
1665 0 : AttestationSignature, dacPubkey, csrNonce);
1666 0 : }
1667 :
1668 0 : CHIP_ERROR DeviceCommissioner::SendOperationalCertificateSigningRequestCommand(DeviceProxy * device, const ByteSpan & csrNonce,
1669 : Optional<System::Clock::Timeout> timeout)
1670 : {
1671 : MATTER_TRACE_SCOPE("SendOperationalCertificateSigningRequestCommand", "DeviceCommissioner");
1672 0 : ChipLogDetail(Controller, "Sending CSR request to %p device", device);
1673 0 : VerifyOrReturnError(device != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
1674 :
1675 0 : OperationalCredentials::Commands::CSRRequest::Type request;
1676 0 : request.CSRNonce = csrNonce;
1677 :
1678 0 : ReturnErrorOnFailure(SendCommissioningCommand(device, request, OnOperationalCertificateSigningRequest, OnCSRFailureResponse,
1679 : kRootEndpointId, timeout));
1680 0 : ChipLogDetail(Controller, "Sent CSR request, waiting for the CSR");
1681 0 : return CHIP_NO_ERROR;
1682 : }
1683 :
1684 0 : void DeviceCommissioner::OnCSRFailureResponse(void * context, CHIP_ERROR error)
1685 : {
1686 : MATTER_TRACE_SCOPE("OnCSRFailureResponse", "DeviceCommissioner");
1687 0 : ChipLogProgress(Controller, "Device failed to receive the CSR request Response: %" CHIP_ERROR_FORMAT, error.Format());
1688 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1689 0 : commissioner->CommissioningStageComplete(error);
1690 0 : }
1691 :
1692 0 : void DeviceCommissioner::OnOperationalCertificateSigningRequest(
1693 : void * context, const OperationalCredentials::Commands::CSRResponse::DecodableType & data)
1694 : {
1695 : MATTER_TRACE_SCOPE("OnOperationalCertificateSigningRequest", "DeviceCommissioner");
1696 0 : ChipLogProgress(Controller, "Received certificate signing request from the device");
1697 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1698 :
1699 0 : CommissioningDelegate::CommissioningReport report;
1700 0 : report.Set<CSRResponse>(CSRResponse(data.NOCSRElements, data.attestationSignature));
1701 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR, report);
1702 0 : }
1703 :
1704 0 : void DeviceCommissioner::OnDeviceNOCChainGeneration(void * context, CHIP_ERROR status, const ByteSpan & noc, const ByteSpan & icac,
1705 : const ByteSpan & rcac, Optional<IdentityProtectionKeySpan> ipk,
1706 : Optional<NodeId> adminSubject)
1707 : {
1708 : MATTER_TRACE_SCOPE("OnDeviceNOCChainGeneration", "DeviceCommissioner");
1709 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1710 :
1711 : // The placeholder IPK is not satisfactory, but is there to fill the NocChain struct on error. It will still fail.
1712 0 : const uint8_t placeHolderIpk[] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
1713 : 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
1714 0 : if (status == CHIP_NO_ERROR && !ipk.HasValue())
1715 : {
1716 0 : ChipLogError(Controller, "Did not have an IPK from the OperationalCredentialsIssuer! Cannot commission.");
1717 0 : status = CHIP_ERROR_INVALID_ARGUMENT;
1718 : }
1719 :
1720 0 : ChipLogProgress(Controller, "Received callback from the CA for NOC Chain generation. Status: %" CHIP_ERROR_FORMAT,
1721 : status.Format());
1722 0 : if (status == CHIP_NO_ERROR && commissioner->mState != State::Initialized)
1723 : {
1724 0 : status = CHIP_ERROR_INCORRECT_STATE;
1725 : }
1726 0 : if (status != CHIP_NO_ERROR)
1727 : {
1728 0 : ChipLogError(Controller, "Failed in generating device's operational credentials. Error: %" CHIP_ERROR_FORMAT,
1729 : status.Format());
1730 : }
1731 :
1732 : // TODO - Verify that the generated root cert matches with commissioner's root cert
1733 0 : CommissioningDelegate::CommissioningReport report;
1734 0 : report.Set<NocChain>(NocChain(noc, icac, rcac, ipk.HasValue() ? ipk.Value() : IdentityProtectionKeySpan(placeHolderIpk),
1735 0 : adminSubject.HasValue() ? adminSubject.Value() : commissioner->GetNodeId()));
1736 0 : commissioner->CommissioningStageComplete(status, report);
1737 0 : }
1738 :
1739 0 : CHIP_ERROR DeviceCommissioner::IssueNOCChain(const ByteSpan & NOCSRElements, NodeId nodeId,
1740 : chip::Callback::Callback<OnNOCChainGeneration> * callback)
1741 : {
1742 : MATTER_TRACE_SCOPE("IssueNOCChain", "DeviceCommissioner");
1743 0 : VerifyOrReturnError(mState == State::Initialized, CHIP_ERROR_INCORRECT_STATE);
1744 :
1745 0 : ChipLogProgress(Controller, "Getting certificate chain for the device on fabric idx %u", static_cast<unsigned>(mFabricIndex));
1746 :
1747 0 : mOperationalCredentialsDelegate->SetNodeIdForNextNOCRequest(nodeId);
1748 :
1749 0 : if (mFabricIndex != kUndefinedFabricIndex)
1750 : {
1751 0 : mOperationalCredentialsDelegate->SetFabricIdForNextNOCRequest(GetFabricId());
1752 : }
1753 :
1754 : // Note: we don't have attestationSignature, attestationChallenge, DAC, PAI so we are just providing an empty ByteSpan
1755 : // for those arguments.
1756 0 : return mOperationalCredentialsDelegate->GenerateNOCChain(NOCSRElements, ByteSpan(), ByteSpan(), ByteSpan(), ByteSpan(),
1757 0 : ByteSpan(), callback);
1758 : }
1759 :
1760 0 : CHIP_ERROR DeviceCommissioner::ProcessCSR(DeviceProxy * proxy, const ByteSpan & NOCSRElements,
1761 : const ByteSpan & AttestationSignature, const ByteSpan & dac, const ByteSpan & pai,
1762 : const ByteSpan & csrNonce)
1763 : {
1764 : MATTER_TRACE_SCOPE("ProcessOpCSR", "DeviceCommissioner");
1765 0 : VerifyOrReturnError(mState == State::Initialized, CHIP_ERROR_INCORRECT_STATE);
1766 :
1767 0 : ChipLogProgress(Controller, "Getting certificate chain for the device from the issuer");
1768 :
1769 0 : P256PublicKey dacPubkey;
1770 0 : ReturnErrorOnFailure(ExtractPubkeyFromX509Cert(dac, dacPubkey));
1771 :
1772 : // Retrieve attestation challenge
1773 : ByteSpan attestationChallenge =
1774 0 : proxy->GetSecureSession().Value()->AsSecureSession()->GetCryptoContext().GetAttestationChallenge();
1775 :
1776 0 : mOperationalCredentialsDelegate->SetNodeIdForNextNOCRequest(proxy->GetDeviceId());
1777 :
1778 0 : if (mFabricIndex != kUndefinedFabricIndex)
1779 : {
1780 0 : mOperationalCredentialsDelegate->SetFabricIdForNextNOCRequest(GetFabricId());
1781 : }
1782 :
1783 0 : return mOperationalCredentialsDelegate->GenerateNOCChain(NOCSRElements, csrNonce, AttestationSignature, attestationChallenge,
1784 0 : dac, pai, &mDeviceNOCChainCallback);
1785 0 : }
1786 :
1787 0 : CHIP_ERROR DeviceCommissioner::SendOperationalCertificate(DeviceProxy * device, const ByteSpan & nocCertBuf,
1788 : const Optional<ByteSpan> & icaCertBuf,
1789 : const IdentityProtectionKeySpan ipk, const NodeId adminSubject,
1790 : Optional<System::Clock::Timeout> timeout)
1791 : {
1792 : MATTER_TRACE_SCOPE("SendOperationalCertificate", "DeviceCommissioner");
1793 :
1794 0 : VerifyOrReturnError(device != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
1795 :
1796 0 : OperationalCredentials::Commands::AddNOC::Type request;
1797 0 : request.NOCValue = nocCertBuf;
1798 0 : request.ICACValue = icaCertBuf;
1799 0 : request.IPKValue = ipk;
1800 0 : request.caseAdminSubject = adminSubject;
1801 0 : request.adminVendorId = mVendorId;
1802 :
1803 0 : ReturnErrorOnFailure(SendCommissioningCommand(device, request, OnOperationalCertificateAddResponse, OnAddNOCFailureResponse,
1804 : kRootEndpointId, timeout));
1805 :
1806 0 : ChipLogProgress(Controller, "Sent operational certificate to the device");
1807 :
1808 0 : return CHIP_NO_ERROR;
1809 : }
1810 :
1811 0 : CHIP_ERROR DeviceCommissioner::ConvertFromOperationalCertStatus(OperationalCredentials::NodeOperationalCertStatusEnum err)
1812 : {
1813 : using OperationalCredentials::NodeOperationalCertStatusEnum;
1814 0 : switch (err)
1815 : {
1816 0 : case NodeOperationalCertStatusEnum::kOk:
1817 0 : return CHIP_NO_ERROR;
1818 0 : case NodeOperationalCertStatusEnum::kInvalidPublicKey:
1819 0 : return CHIP_ERROR_INVALID_PUBLIC_KEY;
1820 0 : case NodeOperationalCertStatusEnum::kInvalidNodeOpId:
1821 0 : return CHIP_ERROR_WRONG_NODE_ID;
1822 0 : case NodeOperationalCertStatusEnum::kInvalidNOC:
1823 0 : return CHIP_ERROR_UNSUPPORTED_CERT_FORMAT;
1824 0 : case NodeOperationalCertStatusEnum::kMissingCsr:
1825 0 : return CHIP_ERROR_INCORRECT_STATE;
1826 0 : case NodeOperationalCertStatusEnum::kTableFull:
1827 0 : return CHIP_ERROR_NO_MEMORY;
1828 0 : case NodeOperationalCertStatusEnum::kInvalidAdminSubject:
1829 0 : return CHIP_ERROR_INVALID_ADMIN_SUBJECT;
1830 0 : case NodeOperationalCertStatusEnum::kFabricConflict:
1831 0 : return CHIP_ERROR_FABRIC_EXISTS;
1832 0 : case NodeOperationalCertStatusEnum::kLabelConflict:
1833 0 : return CHIP_ERROR_INVALID_ARGUMENT;
1834 0 : case NodeOperationalCertStatusEnum::kInvalidFabricIndex:
1835 0 : return CHIP_ERROR_INVALID_FABRIC_INDEX;
1836 0 : case NodeOperationalCertStatusEnum::kUnknownEnumValue:
1837 : // Is this a reasonable value?
1838 0 : return CHIP_ERROR_CERT_LOAD_FAILED;
1839 : }
1840 :
1841 0 : return CHIP_ERROR_CERT_LOAD_FAILED;
1842 : }
1843 :
1844 0 : void DeviceCommissioner::OnAddNOCFailureResponse(void * context, CHIP_ERROR error)
1845 : {
1846 : MATTER_TRACE_SCOPE("OnAddNOCFailureResponse", "DeviceCommissioner");
1847 0 : ChipLogProgress(Controller, "Device failed to receive the operational certificate Response: %" CHIP_ERROR_FORMAT,
1848 : error.Format());
1849 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1850 0 : commissioner->CommissioningStageComplete(error);
1851 0 : }
1852 :
1853 0 : void DeviceCommissioner::OnOperationalCertificateAddResponse(
1854 : void * context, const OperationalCredentials::Commands::NOCResponse::DecodableType & data)
1855 : {
1856 : MATTER_TRACE_SCOPE("OnOperationalCertificateAddResponse", "DeviceCommissioner");
1857 0 : ChipLogProgress(Controller, "Device returned status %d on receiving the NOC", to_underlying(data.statusCode));
1858 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1859 :
1860 0 : CHIP_ERROR err = CHIP_NO_ERROR;
1861 :
1862 0 : VerifyOrExit(commissioner->mState == State::Initialized, err = CHIP_ERROR_INCORRECT_STATE);
1863 :
1864 0 : VerifyOrExit(commissioner->mDeviceBeingCommissioned != nullptr, err = CHIP_ERROR_INCORRECT_STATE);
1865 :
1866 0 : err = ConvertFromOperationalCertStatus(data.statusCode);
1867 0 : SuccessOrExit(err);
1868 :
1869 0 : err = commissioner->OnOperationalCredentialsProvisioningCompletion(commissioner->mDeviceBeingCommissioned);
1870 :
1871 0 : exit:
1872 0 : if (err != CHIP_NO_ERROR)
1873 : {
1874 0 : ChipLogProgress(Controller, "Add NOC failed with error: %" CHIP_ERROR_FORMAT, err.Format());
1875 : // Preserve the device-reported NodeOperationalCertStatusEnum (kInvalidPublicKey,
1876 : // kInvalidNodeOpId, kInvalidNOC, kFabricConflict, kLabelConflict, kInvalidFabricIndex,
1877 : // kTableFull, etc.) in the report so OnCommissioningFailure consumers can distinguish
1878 : // these without losing fidelity to the generic CHIP_ERROR returned by
1879 : // ConvertFromOperationalCertStatus.
1880 0 : CommissioningDelegate::CommissioningReport report;
1881 : // ConvertFromOperationalCertStatus succeeds on kOk and returns a non-success CHIP_ERROR
1882 : // for any other value, but `err` at this point can also be a downstream local failure
1883 : // (e.g. from OnOperationalCredentialsProvisioningCompletion) while data.statusCode is
1884 : // still kOk. Guard so we never publish a "success enum" alongside a non-success err to
1885 : // OnCommissioningFailure consumers.
1886 0 : if (data.statusCode != OperationalCredentials::NodeOperationalCertStatusEnum::kOk)
1887 : {
1888 0 : report.Set<OperationalCertErrorInfo>(data.statusCode);
1889 : }
1890 0 : commissioner->CommissioningStageComplete(err, report);
1891 0 : }
1892 0 : }
1893 :
1894 0 : CHIP_ERROR DeviceCommissioner::SendTrustedRootCertificate(DeviceProxy * device, const ByteSpan & rcac,
1895 : Optional<System::Clock::Timeout> timeout)
1896 : {
1897 : MATTER_TRACE_SCOPE("SendTrustedRootCertificate", "DeviceCommissioner");
1898 0 : VerifyOrReturnError(device != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
1899 :
1900 0 : ChipLogProgress(Controller, "Sending root certificate to the device");
1901 :
1902 0 : OperationalCredentials::Commands::AddTrustedRootCertificate::Type request;
1903 0 : request.rootCACertificate = rcac;
1904 0 : ReturnErrorOnFailure(
1905 : SendCommissioningCommand(device, request, OnRootCertSuccessResponse, OnRootCertFailureResponse, kRootEndpointId, timeout));
1906 :
1907 0 : ChipLogProgress(Controller, "Sent root certificate to the device");
1908 :
1909 0 : return CHIP_NO_ERROR;
1910 : }
1911 :
1912 0 : void DeviceCommissioner::OnRootCertSuccessResponse(void * context, const chip::app::DataModel::NullObjectType &)
1913 : {
1914 : MATTER_TRACE_SCOPE("OnRootCertSuccessResponse", "DeviceCommissioner");
1915 0 : ChipLogProgress(Controller, "Device confirmed that it has received the root certificate");
1916 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1917 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR);
1918 0 : }
1919 :
1920 0 : void DeviceCommissioner::OnRootCertFailureResponse(void * context, CHIP_ERROR error)
1921 : {
1922 : MATTER_TRACE_SCOPE("OnRootCertFailureResponse", "DeviceCommissioner");
1923 0 : ChipLogProgress(Controller, "Device failed to receive the root certificate Response: %" CHIP_ERROR_FORMAT, error.Format());
1924 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
1925 0 : commissioner->CommissioningStageComplete(error);
1926 0 : }
1927 :
1928 0 : CHIP_ERROR DeviceCommissioner::OnOperationalCredentialsProvisioningCompletion(DeviceProxy * device)
1929 : {
1930 : MATTER_TRACE_SCOPE("OnOperationalCredentialsProvisioningCompletion", "DeviceCommissioner");
1931 0 : ChipLogProgress(Controller, "Operational credentials provisioned on device %p", device);
1932 0 : VerifyOrReturnError(device != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
1933 :
1934 0 : if (mPairingDelegate != nullptr)
1935 : {
1936 0 : mPairingDelegate->OnStatusUpdate(DevicePairingDelegate::SecurePairingSuccess);
1937 : }
1938 0 : CommissioningStageComplete(CHIP_NO_ERROR);
1939 :
1940 0 : return CHIP_NO_ERROR;
1941 : }
1942 :
1943 : #if CONFIG_NETWORK_LAYER_BLE
1944 : #if CHIP_DEVICE_CONFIG_ENABLE_BOTH_COMMISSIONER_AND_COMMISSIONEE
1945 : void DeviceCommissioner::ConnectBleTransportToSelf()
1946 : {
1947 : Transport::BLEBase & transport = std::get<Transport::BLE<1>>(mSystemState->TransportMgr()->GetTransport().GetTransports());
1948 : if (!transport.IsBleLayerTransportSetToSelf())
1949 : {
1950 : transport.SetBleLayerTransportToSelf();
1951 : }
1952 : }
1953 : #endif // CHIP_DEVICE_CONFIG_ENABLE_BOTH_COMMISSIONER_AND_COMMISSIONEE
1954 :
1955 0 : void DeviceCommissioner::CloseBleConnection()
1956 : {
1957 : // It is fine since we can only commission one device at the same time.
1958 : // We should be able to distinguish different BLE connections if we want
1959 : // to commission multiple devices at the same time over BLE.
1960 0 : mSystemState->BleLayer()->CloseAllBleConnections();
1961 0 : }
1962 : #endif
1963 :
1964 0 : CHIP_ERROR DeviceCommissioner::DiscoverCommissionableNodes(Dnssd::DiscoveryFilter filter)
1965 : {
1966 0 : ReturnErrorOnFailure(SetUpNodeDiscovery());
1967 0 : return mDNSResolver.DiscoverCommissionableNodes(filter);
1968 : }
1969 :
1970 2 : CHIP_ERROR DeviceCommissioner::StopCommissionableDiscovery()
1971 : {
1972 2 : return mDNSResolver.StopDiscovery();
1973 : }
1974 :
1975 0 : const Dnssd::CommissionNodeData * DeviceCommissioner::GetDiscoveredDevice(int idx)
1976 : {
1977 0 : return GetDiscoveredNode(idx);
1978 : }
1979 :
1980 : #if CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY // make this commissioner discoverable
1981 :
1982 : CHIP_ERROR DeviceCommissioner::SetUdcListenPort(uint16_t listenPort)
1983 : {
1984 : if (mState == State::Initialized)
1985 : {
1986 : return CHIP_ERROR_INCORRECT_STATE;
1987 : }
1988 :
1989 : mUdcListenPort = listenPort;
1990 : return CHIP_NO_ERROR;
1991 : }
1992 :
1993 : void DeviceCommissioner::FindCommissionableNode(const char * instanceName)
1994 : {
1995 : Dnssd::DiscoveryFilter filter(Dnssd::DiscoveryFilterType::kInstanceName, instanceName);
1996 : TEMPORARY_RETURN_IGNORED DiscoverCommissionableNodes(filter);
1997 : }
1998 :
1999 : #endif // CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY
2000 :
2001 0 : void DeviceCommissioner::OnNodeDiscovered(const chip::Dnssd::DiscoveredNodeData & nodeData)
2002 : {
2003 : #if CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY
2004 : if (mUdcServer != nullptr)
2005 : {
2006 : mUdcServer->OnCommissionableNodeFound(nodeData);
2007 : }
2008 : #endif // CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY
2009 0 : if (nodeData.Get<Dnssd::CommissionNodeData>().threadMeshcop)
2010 : {
2011 0 : mAutoCommissioner.SetNetworkSetupNeeded(true);
2012 : }
2013 0 : AbstractDnssdDiscoveryController::OnNodeDiscovered(nodeData);
2014 0 : mSetUpCodePairer.NotifyCommissionableDeviceDiscovered(nodeData);
2015 0 : }
2016 :
2017 0 : void DeviceCommissioner::OnBasicSuccess(void * context, const chip::app::DataModel::NullObjectType &)
2018 : {
2019 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
2020 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR);
2021 0 : }
2022 :
2023 0 : void DeviceCommissioner::OnBasicFailure(void * context, CHIP_ERROR error)
2024 : {
2025 0 : ChipLogProgress(Controller, "Received failure response: %" CHIP_ERROR_FORMAT, error.Format());
2026 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
2027 0 : commissioner->CommissioningStageComplete(error);
2028 0 : }
2029 :
2030 0 : static GeneralCommissioning::Commands::ArmFailSafe::Type DisarmFailsafeRequest()
2031 : {
2032 0 : GeneralCommissioning::Commands::ArmFailSafe::Type request;
2033 0 : request.expiryLengthSeconds = 0; // Expire immediately.
2034 0 : request.breadcrumb = 0;
2035 0 : return request;
2036 : }
2037 :
2038 0 : static void MarkForEviction(const Optional<SessionHandle> & session)
2039 : {
2040 0 : if (session.HasValue())
2041 : {
2042 0 : session.Value()->AsSecureSession()->MarkForEviction();
2043 : }
2044 0 : }
2045 :
2046 0 : void DeviceCommissioner::CleanupCommissioning(DeviceProxy * proxy, NodeId nodeId, const CompletionStatus & completionStatus)
2047 : {
2048 : // At this point, proxy == mDeviceBeingCommissioned, nodeId == mDeviceBeingCommissioned->GetDeviceId()
2049 :
2050 0 : mCommissioningCompletionStatus = completionStatus;
2051 :
2052 0 : if (completionStatus.err == CHIP_NO_ERROR)
2053 : {
2054 : // CommissioningStageComplete uses mDeviceBeingCommissioned, which can
2055 : // be commissionee if we are cleaning up before we've gone operational. Normally
2056 : // that would not happen in this non-error case, _except_ if we were told to skip sending
2057 : // CommissioningComplete: in that case we do not have an operational DeviceProxy, so
2058 : // we're using our CommissioneeDeviceProxy to do a successful cleanup.
2059 : //
2060 : // This means we have to call CommissioningStageComplete() before we destroy commissionee.
2061 : //
2062 : // This should be safe, because CommissioningStageComplete() does not call CleanupCommissioning
2063 : // when called in the cleanup stage (which is where we are), and StopPairing does not directly release
2064 : // mDeviceBeingCommissioned.
2065 0 : CommissioningStageComplete(CHIP_NO_ERROR);
2066 :
2067 0 : CommissioneeDeviceProxy * commissionee = FindCommissioneeDevice(nodeId);
2068 0 : if (commissionee != nullptr)
2069 : {
2070 0 : ReleaseCommissioneeDevice(commissionee);
2071 : }
2072 : // Send the callbacks, we're done.
2073 0 : SendCommissioningCompleteCallbacks(nodeId, mCommissioningCompletionStatus);
2074 : }
2075 0 : else if (completionStatus.err == CHIP_ERROR_CANCELLED)
2076 : {
2077 : // If we're cleaning up because cancellation has been requested via StopPairing(), expire the failsafe
2078 : // in the background and reset our state synchronously, so a new commissioning attempt can be started.
2079 0 : CommissioneeDeviceProxy * commissionee = FindCommissioneeDevice(nodeId);
2080 0 : SessionHolder session((commissionee == proxy) ? commissionee->DetachSecureSession().Value()
2081 0 : : proxy->GetSecureSession().Value());
2082 :
2083 0 : auto request = DisarmFailsafeRequest();
2084 0 : auto onSuccessCb = [session](const app::ConcreteCommandPath & aPath, const app::StatusIB & aStatus,
2085 : const decltype(request)::ResponseType & responseData) {
2086 0 : ChipLogProgress(Controller, "Failsafe disarmed");
2087 0 : MarkForEviction(session.Get());
2088 0 : };
2089 0 : auto onFailureCb = [session](CHIP_ERROR aError) {
2090 0 : ChipLogProgress(Controller, "Ignoring failure to disarm failsafe: %" CHIP_ERROR_FORMAT, aError.Format());
2091 0 : MarkForEviction(session.Get());
2092 0 : };
2093 :
2094 0 : ChipLogProgress(Controller, "Disarming failsafe on device %p in background", proxy);
2095 0 : CHIP_ERROR err = InvokeCommandRequest(proxy->GetExchangeManager(), session.Get().Value(), kRootEndpointId, request,
2096 : onSuccessCb, onFailureCb);
2097 0 : if (err != CHIP_NO_ERROR)
2098 : {
2099 0 : ChipLogError(Controller, "Failed to send command to disarm fail-safe: %" CHIP_ERROR_FORMAT, err.Format());
2100 : }
2101 :
2102 0 : CleanupDoneAfterError();
2103 0 : }
2104 0 : else if (completionStatus.failedStage.HasValue() && completionStatus.failedStage.Value() >= kWiFiNetworkSetup)
2105 : {
2106 : // If we were already doing network setup, we need to retain the pase session and start again from network setup stage.
2107 : // We do not need to reset the failsafe here because we want to keep everything on the device up to this point, so just
2108 : // send the completion callbacks (see "Commissioning Flows Error Handling" in the spec).
2109 0 : CommissioningStageComplete(CHIP_NO_ERROR);
2110 0 : SendCommissioningCompleteCallbacks(nodeId, mCommissioningCompletionStatus);
2111 : }
2112 : else
2113 : {
2114 : // If we've failed somewhere in the early stages (or we don't have a failedStage specified), we need to start from the
2115 : // beginning. However, because some of the commands can only be sent once per arm-failsafe, we also need to force a reset on
2116 : // the failsafe so we can start fresh on the next attempt.
2117 0 : ChipLogProgress(Controller, "Disarming failsafe on device %p", proxy);
2118 0 : auto request = DisarmFailsafeRequest();
2119 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnDisarmFailsafe, OnDisarmFailsafeFailure, kRootEndpointId);
2120 0 : if (err != CHIP_NO_ERROR)
2121 : {
2122 : // We won't get any async callbacks here, so just pretend like the command errored out async.
2123 0 : ChipLogError(Controller, "Failed to send command to disarm fail-safe: %" CHIP_ERROR_FORMAT, err.Format());
2124 0 : CleanupDoneAfterError();
2125 : }
2126 : }
2127 0 : }
2128 :
2129 0 : void DeviceCommissioner::OnDisarmFailsafe(void * context,
2130 : const GeneralCommissioning::Commands::ArmFailSafeResponse::DecodableType & data)
2131 : {
2132 0 : ChipLogProgress(Controller, "Failsafe disarmed");
2133 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
2134 0 : commissioner->CleanupDoneAfterError();
2135 0 : }
2136 :
2137 0 : void DeviceCommissioner::OnDisarmFailsafeFailure(void * context, CHIP_ERROR error)
2138 : {
2139 0 : ChipLogProgress(Controller, "Ignoring failure to disarm failsafe: %" CHIP_ERROR_FORMAT, error.Format());
2140 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
2141 0 : commissioner->CleanupDoneAfterError();
2142 0 : }
2143 :
2144 0 : void DeviceCommissioner::CleanupDoneAfterError()
2145 : {
2146 : // If someone nulled out our mDeviceBeingCommissioned, there's nothing else
2147 : // to do here.
2148 0 : VerifyOrReturn(mDeviceBeingCommissioned != nullptr);
2149 :
2150 0 : NodeId nodeId = mDeviceBeingCommissioned->GetDeviceId();
2151 :
2152 : // Signal completion - this will reset mDeviceBeingCommissioned.
2153 0 : CommissioningStageComplete(CHIP_NO_ERROR);
2154 :
2155 : // At this point, we also want to close off the pase session so we need to re-establish
2156 0 : CommissioneeDeviceProxy * commissionee = FindCommissioneeDevice(nodeId);
2157 :
2158 : // If we've disarmed the failsafe, it's because we're starting again, so kill the pase connection.
2159 0 : if (commissionee != nullptr)
2160 : {
2161 0 : ReleaseCommissioneeDevice(commissionee);
2162 : }
2163 :
2164 : // Invoke callbacks last, after we have cleared up all state.
2165 0 : SendCommissioningCompleteCallbacks(nodeId, mCommissioningCompletionStatus);
2166 : }
2167 :
2168 0 : void DeviceCommissioner::SendCommissioningCompleteCallbacks(NodeId nodeId, const CompletionStatus & completionStatus)
2169 : {
2170 : MATTER_LOG_METRIC_END(kMetricDeviceCommissionerCommission, completionStatus.err);
2171 :
2172 0 : ChipLogProgress(Controller, "Commissioning complete for node ID 0x" ChipLogFormatX64 ": %s", ChipLogValueX64(nodeId),
2173 : (completionStatus.err == CHIP_NO_ERROR ? "success" : completionStatus.err.AsString()));
2174 0 : mCommissioningStage = CommissioningStage::kSecurePairing;
2175 :
2176 0 : if (mPairingDelegate == nullptr)
2177 : {
2178 0 : return;
2179 : }
2180 :
2181 0 : mPairingDelegate->OnCommissioningComplete(nodeId, completionStatus.err);
2182 :
2183 0 : PeerId peerId(GetCompressedFabricId(), nodeId);
2184 0 : if (completionStatus.err == CHIP_NO_ERROR)
2185 : {
2186 0 : mPairingDelegate->OnCommissioningSuccess(peerId);
2187 : }
2188 : else
2189 : {
2190 0 : mPairingDelegate->OnCommissioningFailure(peerId, completionStatus);
2191 : }
2192 : }
2193 :
2194 0 : void DeviceCommissioner::CommissioningStageComplete(CHIP_ERROR err, CommissioningDelegate::CommissioningReport report)
2195 : {
2196 : // Once this stage is complete, reset mDeviceBeingCommissioned - this will be reset when the delegate calls the next step.
2197 : MATTER_TRACE_SCOPE("CommissioningStageComplete", "DeviceCommissioner");
2198 : MATTER_LOG_METRIC_END(MetricKeyForCommissioningStage(mCommissioningStage), err);
2199 0 : VerifyOrDie(mDeviceBeingCommissioned);
2200 :
2201 0 : NodeId nodeId = mDeviceBeingCommissioned->GetDeviceId();
2202 0 : DeviceProxy * proxy = mDeviceBeingCommissioned;
2203 0 : mDeviceBeingCommissioned = nullptr;
2204 0 : mInvokeCancelFn = nullptr;
2205 0 : mWriteCancelFn = nullptr;
2206 :
2207 0 : if (mPairingDelegate != nullptr)
2208 : {
2209 0 : mPairingDelegate->OnCommissioningStatusUpdate(PeerId(GetCompressedFabricId(), nodeId), mCommissioningStage, err);
2210 : }
2211 :
2212 0 : if (mCommissioningDelegate == nullptr)
2213 : {
2214 0 : return;
2215 : }
2216 0 : report.stageCompleted = mCommissioningStage;
2217 0 : CHIP_ERROR status = mCommissioningDelegate->CommissioningStepFinished(err, report);
2218 0 : if (status != CHIP_NO_ERROR && mCommissioningStage != CommissioningStage::kCleanup)
2219 : {
2220 : // Commissioning delegate will only return error if it failed to perform the appropriate commissioning step.
2221 : // In this case, we should complete the commissioning for it.
2222 0 : CompletionStatus completionStatus;
2223 0 : completionStatus.err = status;
2224 0 : completionStatus.failedStage = MakeOptional(report.stageCompleted);
2225 0 : mCommissioningStage = CommissioningStage::kCleanup;
2226 0 : mDeviceBeingCommissioned = proxy;
2227 0 : CleanupCommissioning(proxy, nodeId, completionStatus);
2228 0 : }
2229 : }
2230 :
2231 0 : void DeviceCommissioner::OnDeviceConnectedFn(void * context, Messaging::ExchangeManager & exchangeMgr,
2232 : const SessionHandle & sessionHandle)
2233 : {
2234 : // CASE session established.
2235 : MATTER_LOG_METRIC_END(kMetricDeviceCommissioningOperationalSetup, CHIP_NO_ERROR);
2236 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
2237 0 : VerifyOrDie(commissioner->mCommissioningStage == CommissioningStage::kFindOperationalForStayActive ||
2238 : commissioner->mCommissioningStage == CommissioningStage::kFindOperationalForCommissioningComplete);
2239 0 : VerifyOrDie(commissioner->mDeviceBeingCommissioned->GetDeviceId() == sessionHandle->GetPeer().GetNodeId());
2240 0 : commissioner->CancelCASECallbacks(); // ensure all CASE callbacks are unregistered
2241 :
2242 0 : CommissioningDelegate::CommissioningReport report;
2243 0 : report.Set<OperationalNodeFoundData>(OperationalNodeFoundData(OperationalDeviceProxy(&exchangeMgr, sessionHandle)));
2244 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR, report);
2245 0 : }
2246 :
2247 0 : void DeviceCommissioner::OnDeviceConnectionFailureFn(void * context, const ScopedNodeId & peerId, CHIP_ERROR error)
2248 : {
2249 : // CASE session establishment failed.
2250 : MATTER_LOG_METRIC_END(kMetricDeviceCommissioningOperationalSetup, error);
2251 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
2252 0 : VerifyOrDie(commissioner->mCommissioningStage == CommissioningStage::kFindOperationalForStayActive ||
2253 : commissioner->mCommissioningStage == CommissioningStage::kFindOperationalForCommissioningComplete);
2254 0 : VerifyOrDie(commissioner->mDeviceBeingCommissioned->GetDeviceId() == peerId.GetNodeId());
2255 0 : commissioner->CancelCASECallbacks(); // ensure all CASE callbacks are unregistered
2256 :
2257 0 : if (error != CHIP_NO_ERROR)
2258 : {
2259 0 : ChipLogProgress(Controller, "Device connection failed. Error %" CHIP_ERROR_FORMAT, error.Format());
2260 : }
2261 : else
2262 : {
2263 : // Ensure that commissioning stage advancement is done based on seeing an error.
2264 0 : ChipLogError(Controller, "Device connection failed without a valid error code.");
2265 0 : error = CHIP_ERROR_INTERNAL;
2266 : }
2267 0 : commissioner->CommissioningStageComplete(error);
2268 0 : }
2269 :
2270 : #if CHIP_DEVICE_CONFIG_ENABLE_AUTOMATIC_CASE_RETRIES
2271 : // No specific action to take on either success or failure here; we're just
2272 : // trying to bump the fail-safe, and if that fails it's not clear there's much
2273 : // we can to with that.
2274 0 : static void OnExtendFailsafeForCASERetryFailure(void * context, CHIP_ERROR error)
2275 : {
2276 0 : ChipLogError(Controller, "Failed to extend fail-safe for CASE retry: %" CHIP_ERROR_FORMAT, error.Format());
2277 0 : }
2278 : static void
2279 0 : OnExtendFailsafeForCASERetrySuccess(void * context,
2280 : const app::Clusters::GeneralCommissioning::Commands::ArmFailSafeResponse::DecodableType & data)
2281 : {
2282 0 : ChipLogProgress(Controller, "Status of extending fail-safe for CASE retry: %u", to_underlying(data.errorCode));
2283 0 : }
2284 :
2285 0 : void DeviceCommissioner::OnDeviceConnectionRetryFn(void * context, const ScopedNodeId & peerId, CHIP_ERROR error,
2286 : System::Clock::Seconds16 retryTimeout)
2287 : {
2288 0 : ChipLogError(Controller,
2289 : "Session establishment failed for " ChipLogFormatScopedNodeId ", error: %" CHIP_ERROR_FORMAT
2290 : ". Next retry expected to get a response to Sigma1 or fail within %d seconds",
2291 : ChipLogValueScopedNodeId(peerId), error.Format(), retryTimeout.count());
2292 :
2293 0 : auto self = static_cast<DeviceCommissioner *>(context);
2294 0 : VerifyOrDie(self->GetCommissioningStage() == CommissioningStage::kFindOperationalForStayActive ||
2295 : self->GetCommissioningStage() == CommissioningStage::kFindOperationalForCommissioningComplete);
2296 0 : VerifyOrDie(self->mDeviceBeingCommissioned->GetDeviceId() == peerId.GetNodeId());
2297 :
2298 : bool supportsConcurrent =
2299 0 : self->mCommissioningDelegate->GetCommissioningParameters().GetSupportsConcurrentConnection().ValueOr(true);
2300 0 : if (!supportsConcurrent)
2301 : {
2302 : // Concurrent mode not supported.
2303 : // We are in operational phase so the commissioning channel is not
2304 : // available anymore and it is not possible to re-arm the fail-safe timer.
2305 0 : return;
2306 : }
2307 :
2308 : // We need to do the fail-safe arming over the PASE session.
2309 0 : auto * commissioneeDevice = self->FindCommissioneeDevice(peerId.GetNodeId());
2310 0 : if (!commissioneeDevice)
2311 : {
2312 : // Commissioning canceled, presumably. Just ignore the notification,
2313 : // not much we can do here.
2314 0 : return;
2315 : }
2316 :
2317 : // Extend by the default failsafe timeout plus our retry timeout, so we can
2318 : // be sure the fail-safe will not expire before we try the next time, if
2319 : // there will be a next time.
2320 : //
2321 : // TODO: Make it possible for our clients to control the exact timeout here?
2322 : uint16_t failsafeTimeout;
2323 0 : if (UINT16_MAX - retryTimeout.count() < kDefaultFailsafeTimeout)
2324 : {
2325 0 : failsafeTimeout = UINT16_MAX;
2326 : }
2327 : else
2328 : {
2329 0 : failsafeTimeout = static_cast<uint16_t>(retryTimeout.count() + kDefaultFailsafeTimeout);
2330 : }
2331 :
2332 : // A false return is fine; we don't want to make the fail-safe shorter here.
2333 0 : self->ExtendArmFailSafeInternal(commissioneeDevice, self->GetCommissioningStage(), failsafeTimeout,
2334 0 : MakeOptional(kMinimumCommissioningStepTimeout), OnExtendFailsafeForCASERetrySuccess,
2335 : OnExtendFailsafeForCASERetryFailure, /* fireAndForget = */ true);
2336 : }
2337 : #endif // CHIP_DEVICE_CONFIG_ENABLE_AUTOMATIC_CASE_RETRIES
2338 :
2339 : // ClusterStateCache::Callback / ReadClient::Callback
2340 0 : void DeviceCommissioner::OnDone(app::ReadClient * readClient)
2341 : {
2342 0 : VerifyOrDie(readClient != nullptr && readClient == mReadClient.get());
2343 0 : mReadClient.reset();
2344 0 : switch (mCommissioningStage)
2345 : {
2346 0 : case CommissioningStage::kReadCommissioningInfo:
2347 0 : ContinueReadingCommissioningInfo(mCommissioningDelegate->GetCommissioningParameters());
2348 0 : break;
2349 0 : default:
2350 0 : VerifyOrDie(false);
2351 : break;
2352 : }
2353 0 : }
2354 :
2355 : namespace {
2356 : // Helper for grouping attribute paths into read interactions in ContinueReadingCommissioningInfo()
2357 : // below. The logic generates a sequence of calls to AddAttributePath(), stopping when the capacity
2358 : // of the builder is exceeded. When creating subsequent read requests, the same sequence of calls
2359 : // is generated again, but the builder will skip however many attributes were already read in
2360 : // previous requests. This makes it easy to have logic that conditionally reads attributes, without
2361 : // needing to write manual code to work out where subsequent reads need to resume -- the logic that
2362 : // decides which attributes to read simply needs to be repeatable / deterministic.
2363 : class ReadInteractionBuilder
2364 : {
2365 : static constexpr auto kCapacity = InteractionModelEngine::kMinSupportedPathsPerReadRequest;
2366 :
2367 : size_t mSkip = 0;
2368 : size_t mCount = 0;
2369 : app::AttributePathParams mPaths[kCapacity];
2370 :
2371 : public:
2372 0 : ReadInteractionBuilder(size_t skip = 0) : mSkip(skip) {}
2373 :
2374 0 : size_t size() { return std::min(mCount, kCapacity); }
2375 0 : bool exceeded() { return mCount > kCapacity; }
2376 0 : app::AttributePathParams * paths() { return mPaths; }
2377 :
2378 : // Adds an attribute path if within the current window.
2379 : // Returns false if the available space has been exceeded.
2380 : template <typename... Ts>
2381 0 : bool AddAttributePath(Ts &&... args)
2382 : {
2383 0 : if (mSkip > 0)
2384 : {
2385 0 : mSkip--;
2386 0 : return true;
2387 : }
2388 0 : if (mCount >= kCapacity)
2389 : {
2390 : // capacity exceeded
2391 0 : mCount = kCapacity + 1;
2392 0 : return false;
2393 : }
2394 0 : mPaths[mCount++] = app::AttributePathParams(std::forward<Ts>(args)...);
2395 0 : return true;
2396 : }
2397 : };
2398 : } // namespace
2399 :
2400 0 : void DeviceCommissioner::ContinueReadingCommissioningInfo(const CommissioningParameters & params)
2401 : {
2402 0 : VerifyOrDie(mCommissioningStage == CommissioningStage::kReadCommissioningInfo);
2403 :
2404 : // mReadCommissioningInfoProgress starts at 0 and counts the number of paths we have read.
2405 : // A marker value is used to indicate that there are no further attributes to read.
2406 : static constexpr auto kReadProgressNoFurtherAttributes = std::numeric_limits<decltype(mReadCommissioningInfoProgress)>::max();
2407 0 : if (mReadCommissioningInfoProgress == kReadProgressNoFurtherAttributes)
2408 : {
2409 0 : FinishReadingCommissioningInfo(params);
2410 0 : return;
2411 : }
2412 :
2413 : // We can ony read 9 paths per Read Interaction, since that is the minimum a server has to
2414 : // support per spec (see "Interaction Model Limits"), so we generally need to perform more
2415 : // that one interaction. To build the list of attributes for each interaction, we use a
2416 : // builder that skips adding paths that we already handled in a previous interaction, and
2417 : // returns false if the current request is exhausted. This construction avoids allocating
2418 : // memory to hold the complete list of attributes to read up front; however the logic to
2419 : // determine the attributes to include must be deterministic since it runs multiple times.
2420 : // The use of an immediately-invoked lambda is convenient for control flow.
2421 0 : ReadInteractionBuilder builder(mReadCommissioningInfoProgress);
2422 0 : [&]() -> void {
2423 : // General Commissioning
2424 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::GeneralCommissioning::Id,
2425 : Clusters::GeneralCommissioning::Attributes::SupportsConcurrentConnection::Id));
2426 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::GeneralCommissioning::Id,
2427 : Clusters::GeneralCommissioning::Attributes::Breadcrumb::Id));
2428 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::GeneralCommissioning::Id,
2429 : Clusters::GeneralCommissioning::Attributes::BasicCommissioningInfo::Id));
2430 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::GeneralCommissioning::Id,
2431 : Clusters::GeneralCommissioning::Attributes::RegulatoryConfig::Id));
2432 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::GeneralCommissioning::Id,
2433 : Clusters::GeneralCommissioning::Attributes::LocationCapability::Id));
2434 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::GeneralCommissioning::Id,
2435 : Clusters::GeneralCommissioning::Attributes::IsCommissioningWithoutPower::Id));
2436 :
2437 : // Basic Information: VID and PID for device attestation purposes
2438 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::BasicInformation::Id,
2439 : Clusters::BasicInformation::Attributes::VendorID::Id));
2440 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::BasicInformation::Id,
2441 : Clusters::BasicInformation::Attributes::ProductID::Id));
2442 :
2443 : // Time Synchronization: all attributes
2444 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::TimeSynchronization::Id));
2445 :
2446 : // Network Commissioning (all endpoints): Read the feature map and connect time
2447 : // TODO: Expose a flag that disables network setup so we don't need to read this
2448 0 : VerifyOrReturn(builder.AddAttributePath(Clusters::NetworkCommissioning::Id,
2449 : Clusters::NetworkCommissioning::Attributes::FeatureMap::Id));
2450 0 : VerifyOrReturn(builder.AddAttributePath(Clusters::NetworkCommissioning::Id,
2451 : Clusters::NetworkCommissioning::Attributes::ConnectMaxTimeSeconds::Id));
2452 :
2453 : // If we were asked to do network scans, also read ScanMaxTimeSeconds,
2454 : // so we know how long to wait for those.
2455 0 : if (params.GetAttemptWiFiNetworkScan().ValueOr(false) || params.GetAttemptThreadNetworkScan().ValueOr(false))
2456 : {
2457 0 : VerifyOrReturn(builder.AddAttributePath(Clusters::NetworkCommissioning::Id,
2458 : Clusters::NetworkCommissioning::Attributes::ScanMaxTimeSeconds::Id));
2459 : }
2460 :
2461 : // OperationalCredentials: existing fabrics, if necessary
2462 0 : if (params.GetCheckForMatchingFabric())
2463 : {
2464 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::OperationalCredentials::Id,
2465 : Clusters::OperationalCredentials::Attributes::Fabrics::Id));
2466 : }
2467 :
2468 : // ICD Management
2469 0 : if (params.GetICDRegistrationStrategy() != ICDRegistrationStrategy::kIgnore)
2470 : {
2471 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::IcdManagement::Id,
2472 : Clusters::IcdManagement::Attributes::FeatureMap::Id));
2473 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::IcdManagement::Id,
2474 : Clusters::IcdManagement::Attributes::UserActiveModeTriggerHint::Id));
2475 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::IcdManagement::Id,
2476 : Clusters::IcdManagement::Attributes::UserActiveModeTriggerInstruction::Id));
2477 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::IcdManagement::Id,
2478 : Clusters::IcdManagement::Attributes::IdleModeDuration::Id));
2479 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::IcdManagement::Id,
2480 : Clusters::IcdManagement::Attributes::ActiveModeDuration::Id));
2481 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::IcdManagement::Id,
2482 : Clusters::IcdManagement::Attributes::ActiveModeThreshold::Id));
2483 0 : VerifyOrReturn(builder.AddAttributePath(kRootEndpointId, Clusters::IcdManagement::Id,
2484 : Clusters::IcdManagement::Attributes::ClusterRevision::Id));
2485 : }
2486 :
2487 : // Extra paths requested via CommissioningParameters
2488 0 : for (auto const & path : params.GetExtraReadPaths())
2489 : {
2490 0 : VerifyOrReturn(builder.AddAttributePath(path));
2491 : }
2492 0 : }();
2493 :
2494 0 : VerifyOrDie(builder.size() > 0); // our logic is broken if there is nothing to read
2495 0 : if (builder.exceeded())
2496 : {
2497 : // Keep track of the number of attributes we have read already so we can resume from there.
2498 0 : auto progress = mReadCommissioningInfoProgress + builder.size();
2499 0 : VerifyOrDie(progress < kReadProgressNoFurtherAttributes);
2500 0 : mReadCommissioningInfoProgress = static_cast<decltype(mReadCommissioningInfoProgress)>(progress);
2501 : }
2502 : else
2503 : {
2504 0 : mReadCommissioningInfoProgress = kReadProgressNoFurtherAttributes;
2505 : }
2506 :
2507 0 : SendCommissioningReadRequest(mDeviceBeingCommissioned, mCommissioningStepTimeout, builder.paths(), builder.size());
2508 : }
2509 :
2510 : namespace {
2511 0 : void AccumulateErrors(CHIP_ERROR & acc, CHIP_ERROR err)
2512 : {
2513 0 : if (acc == CHIP_NO_ERROR && err != CHIP_NO_ERROR)
2514 : {
2515 0 : acc = err;
2516 : }
2517 0 : }
2518 : } // namespace
2519 :
2520 0 : void DeviceCommissioner::FinishReadingCommissioningInfo(const CommissioningParameters & params)
2521 : {
2522 : // We want to parse as much information as possible, even if we eventually end
2523 : // up returning an error (e.g. because some mandatory information was missing).
2524 0 : CHIP_ERROR err = CHIP_NO_ERROR;
2525 0 : ReadCommissioningInfo info;
2526 0 : info.attributes = mAttributeCache.get();
2527 0 : AccumulateErrors(err, ParseGeneralCommissioningInfo(info));
2528 0 : AccumulateErrors(err, ParseBasicInformation(info));
2529 0 : AccumulateErrors(err, ParseNetworkCommissioningInfo(info));
2530 0 : AccumulateErrors(err, ParseTimeSyncInfo(info));
2531 0 : AccumulateErrors(err, ParseFabrics(info));
2532 0 : AccumulateErrors(err, ParseICDInfo(info));
2533 0 : AccumulateErrors(err, ParseExtraCommissioningInfo(info, params));
2534 :
2535 0 : if (mPairingDelegate != nullptr && err == CHIP_NO_ERROR)
2536 : {
2537 0 : mPairingDelegate->OnReadCommissioningInfo(info);
2538 : }
2539 :
2540 0 : CommissioningDelegate::CommissioningReport report;
2541 0 : report.Set<ReadCommissioningInfo>(info);
2542 0 : CommissioningStageComplete(err, report);
2543 :
2544 : // Only release the attribute cache once `info` is no longer needed.
2545 0 : mAttributeCache.reset();
2546 0 : }
2547 :
2548 0 : CHIP_ERROR DeviceCommissioner::ParseGeneralCommissioningInfo(ReadCommissioningInfo & info)
2549 : {
2550 : using namespace GeneralCommissioning::Attributes;
2551 0 : CHIP_ERROR return_err = CHIP_NO_ERROR;
2552 : CHIP_ERROR err;
2553 :
2554 0 : BasicCommissioningInfo::TypeInfo::DecodableType basicInfo;
2555 0 : err = mAttributeCache->Get<BasicCommissioningInfo::TypeInfo>(kRootEndpointId, basicInfo);
2556 0 : if (err == CHIP_NO_ERROR)
2557 : {
2558 0 : info.general.recommendedFailsafe = basicInfo.failSafeExpiryLengthSeconds;
2559 : }
2560 : else
2561 : {
2562 0 : ChipLogError(Controller, "Failed to read BasicCommissioningInfo: %" CHIP_ERROR_FORMAT, err.Format());
2563 0 : return_err = err;
2564 : }
2565 :
2566 0 : err = mAttributeCache->Get<RegulatoryConfig::TypeInfo>(kRootEndpointId, info.general.currentRegulatoryLocation);
2567 0 : if (err != CHIP_NO_ERROR)
2568 : {
2569 0 : ChipLogError(Controller, "Failed to read RegulatoryConfig: %" CHIP_ERROR_FORMAT, err.Format());
2570 0 : return_err = err;
2571 : }
2572 :
2573 0 : err = mAttributeCache->Get<LocationCapability::TypeInfo>(kRootEndpointId, info.general.locationCapability);
2574 0 : if (err != CHIP_NO_ERROR)
2575 : {
2576 0 : ChipLogError(Controller, "Failed to read LocationCapability: %" CHIP_ERROR_FORMAT, err.Format());
2577 0 : return_err = err;
2578 : }
2579 :
2580 0 : err = mAttributeCache->Get<Breadcrumb::TypeInfo>(kRootEndpointId, info.general.breadcrumb);
2581 0 : if (err != CHIP_NO_ERROR)
2582 : {
2583 0 : ChipLogError(Controller, "Failed to read Breadcrumb: %" CHIP_ERROR_FORMAT, err.Format());
2584 0 : return_err = err;
2585 : }
2586 :
2587 0 : err = mAttributeCache->Get<SupportsConcurrentConnection::TypeInfo>(kRootEndpointId, info.supportsConcurrentConnection);
2588 0 : if (err != CHIP_NO_ERROR)
2589 : {
2590 0 : ChipLogError(Controller, "Ignoring failure to read SupportsConcurrentConnection: %" CHIP_ERROR_FORMAT, err.Format());
2591 0 : info.supportsConcurrentConnection = true; // default to true (concurrent), not a fatal error
2592 : }
2593 :
2594 0 : err = mAttributeCache->Get<IsCommissioningWithoutPower::TypeInfo>(kRootEndpointId, info.general.isCommissioningWithoutPower);
2595 0 : if (err != CHIP_NO_ERROR)
2596 : {
2597 : // 'IsCommissioningWithoutPower' is optional. Any failures (likely not present) means default to assuming false.
2598 0 : info.general.isCommissioningWithoutPower = false;
2599 : }
2600 :
2601 0 : return return_err;
2602 : }
2603 :
2604 0 : CHIP_ERROR DeviceCommissioner::ParseBasicInformation(ReadCommissioningInfo & info)
2605 : {
2606 : using namespace BasicInformation::Attributes;
2607 0 : CHIP_ERROR return_err = CHIP_NO_ERROR;
2608 : CHIP_ERROR err;
2609 :
2610 0 : err = mAttributeCache->Get<VendorID::TypeInfo>(kRootEndpointId, info.basic.vendorId);
2611 0 : if (err != CHIP_NO_ERROR)
2612 : {
2613 0 : ChipLogError(Controller, "Failed to read VendorID: %" CHIP_ERROR_FORMAT, err.Format());
2614 0 : return_err = err;
2615 : }
2616 :
2617 0 : err = mAttributeCache->Get<ProductID::TypeInfo>(kRootEndpointId, info.basic.productId);
2618 0 : if (err != CHIP_NO_ERROR)
2619 : {
2620 0 : ChipLogError(Controller, "Failed to read ProductID: %" CHIP_ERROR_FORMAT, err.Format());
2621 0 : return_err = err;
2622 : }
2623 :
2624 0 : return return_err;
2625 : }
2626 :
2627 0 : CHIP_ERROR DeviceCommissioner::ParseNetworkCommissioningInfo(ReadCommissioningInfo & info)
2628 : {
2629 : using namespace NetworkCommissioning::Attributes;
2630 0 : CHIP_ERROR return_err = CHIP_NO_ERROR;
2631 : CHIP_ERROR err;
2632 :
2633 : // Set the network cluster endpoints first so we can match up the connection
2634 : // times. Note that here we don't know what endpoints the network
2635 : // commissioning clusters might be on.
2636 0 : err = mAttributeCache->ForEachAttribute(NetworkCommissioning::Id, [this, &info](const ConcreteAttributePath & path) {
2637 0 : VerifyOrReturnError(path.mAttributeId == FeatureMap::Id, CHIP_NO_ERROR);
2638 0 : BitFlags<NetworkCommissioning::Feature> features;
2639 0 : if (mAttributeCache->Get<FeatureMap::TypeInfo>(path, *features.RawStorage()) == CHIP_NO_ERROR)
2640 : {
2641 0 : if (features.Has(NetworkCommissioning::Feature::kWiFiNetworkInterface))
2642 : {
2643 0 : ChipLogProgress(Controller, "NetworkCommissioning Features: has WiFi. endpointid = %u", path.mEndpointId);
2644 0 : info.network.wifi.endpoint = path.mEndpointId;
2645 : }
2646 0 : else if (features.Has(NetworkCommissioning::Feature::kThreadNetworkInterface))
2647 : {
2648 0 : ChipLogProgress(Controller, "NetworkCommissioning Features: has Thread. endpointid = %u", path.mEndpointId);
2649 0 : info.network.thread.endpoint = path.mEndpointId;
2650 : }
2651 0 : else if (features.Has(NetworkCommissioning::Feature::kEthernetNetworkInterface))
2652 : {
2653 0 : ChipLogProgress(Controller, "NetworkCommissioning Features: has Ethernet. endpointid = %u", path.mEndpointId);
2654 0 : info.network.eth.endpoint = path.mEndpointId;
2655 : }
2656 : }
2657 0 : return CHIP_NO_ERROR;
2658 : });
2659 0 : AccumulateErrors(return_err, err);
2660 :
2661 0 : if (info.network.thread.endpoint != kInvalidEndpointId)
2662 : {
2663 0 : err = ParseNetworkCommissioningTimeouts(info.network.thread, "Thread");
2664 0 : AccumulateErrors(return_err, err);
2665 : }
2666 :
2667 0 : if (info.network.wifi.endpoint != kInvalidEndpointId)
2668 : {
2669 0 : err = ParseNetworkCommissioningTimeouts(info.network.wifi, "Wi-Fi");
2670 0 : AccumulateErrors(return_err, err);
2671 : }
2672 :
2673 0 : if (return_err != CHIP_NO_ERROR)
2674 : {
2675 0 : ChipLogError(Controller, "Failed to parse Network Commissioning information: %" CHIP_ERROR_FORMAT, return_err.Format());
2676 : }
2677 0 : return return_err;
2678 : }
2679 :
2680 0 : CHIP_ERROR DeviceCommissioner::ParseNetworkCommissioningTimeouts(NetworkClusterInfo & networkInfo, const char * networkType)
2681 : {
2682 : using namespace NetworkCommissioning::Attributes;
2683 :
2684 0 : CHIP_ERROR err = mAttributeCache->Get<ConnectMaxTimeSeconds::TypeInfo>(networkInfo.endpoint, networkInfo.minConnectionTime);
2685 0 : if (err != CHIP_NO_ERROR)
2686 : {
2687 0 : ChipLogError(Controller, "Failed to read %s ConnectMaxTimeSeconds (endpoint %u): %" CHIP_ERROR_FORMAT, networkType,
2688 : networkInfo.endpoint, err.Format());
2689 0 : return err;
2690 : }
2691 :
2692 0 : err = mAttributeCache->Get<ScanMaxTimeSeconds::TypeInfo>(networkInfo.endpoint, networkInfo.maxScanTime);
2693 0 : if (err != CHIP_NO_ERROR)
2694 : {
2695 : // We don't always read this attribute, and we read it as a wildcard, so
2696 : // don't treat it as an error simply because it's missing.
2697 0 : if (err != CHIP_ERROR_KEY_NOT_FOUND)
2698 : {
2699 0 : ChipLogError(Controller, "Failed to read %s ScanMaxTimeSeconds (endpoint: %u): %" CHIP_ERROR_FORMAT, networkType,
2700 : networkInfo.endpoint, err.Format());
2701 0 : return err;
2702 : }
2703 :
2704 : // Just flag as "we don't know".
2705 0 : networkInfo.maxScanTime = 0;
2706 : }
2707 :
2708 0 : return CHIP_NO_ERROR;
2709 : }
2710 :
2711 0 : CHIP_ERROR DeviceCommissioner::ParseTimeSyncInfo(ReadCommissioningInfo & info)
2712 : {
2713 : using namespace TimeSynchronization::Attributes;
2714 : CHIP_ERROR err;
2715 :
2716 : // If we fail to get the feature map, there's no viable time cluster, don't set anything.
2717 0 : BitFlags<TimeSynchronization::Feature> featureMap;
2718 0 : err = mAttributeCache->Get<FeatureMap::TypeInfo>(kRootEndpointId, *featureMap.RawStorage());
2719 0 : if (err != CHIP_NO_ERROR)
2720 : {
2721 0 : info.requiresUTC = false;
2722 0 : info.requiresTimeZone = false;
2723 0 : info.requiresDefaultNTP = false;
2724 0 : info.requiresTrustedTimeSource = false;
2725 0 : return CHIP_NO_ERROR;
2726 : }
2727 0 : info.requiresUTC = true;
2728 0 : info.requiresTimeZone = featureMap.Has(TimeSynchronization::Feature::kTimeZone);
2729 0 : info.requiresDefaultNTP = featureMap.Has(TimeSynchronization::Feature::kNTPClient);
2730 0 : info.requiresTrustedTimeSource = featureMap.Has(TimeSynchronization::Feature::kTimeSyncClient);
2731 :
2732 0 : if (info.requiresTimeZone)
2733 : {
2734 0 : err = mAttributeCache->Get<TimeZoneListMaxSize::TypeInfo>(kRootEndpointId, info.maxTimeZoneSize);
2735 0 : if (err != CHIP_NO_ERROR)
2736 : {
2737 : // This information should be available, let's do our best with what we have, but we can't set
2738 : // the time zone without this information
2739 0 : info.requiresTimeZone = false;
2740 : }
2741 0 : err = mAttributeCache->Get<DSTOffsetListMaxSize::TypeInfo>(kRootEndpointId, info.maxDSTSize);
2742 0 : if (err != CHIP_NO_ERROR)
2743 : {
2744 0 : info.requiresTimeZone = false;
2745 : }
2746 : }
2747 0 : if (info.requiresDefaultNTP)
2748 : {
2749 0 : DefaultNTP::TypeInfo::DecodableType defaultNTP;
2750 0 : err = mAttributeCache->Get<DefaultNTP::TypeInfo>(kRootEndpointId, defaultNTP);
2751 0 : if (err == CHIP_NO_ERROR && (!defaultNTP.IsNull()) && (defaultNTP.Value().size() != 0))
2752 : {
2753 0 : info.requiresDefaultNTP = false;
2754 : }
2755 : }
2756 0 : if (info.requiresTrustedTimeSource)
2757 : {
2758 0 : TrustedTimeSource::TypeInfo::DecodableType trustedTimeSource;
2759 0 : err = mAttributeCache->Get<TrustedTimeSource::TypeInfo>(kRootEndpointId, trustedTimeSource);
2760 0 : if (err == CHIP_NO_ERROR && !trustedTimeSource.IsNull())
2761 : {
2762 0 : info.requiresTrustedTimeSource = false;
2763 : }
2764 : }
2765 :
2766 0 : return CHIP_NO_ERROR;
2767 : }
2768 :
2769 0 : CHIP_ERROR DeviceCommissioner::ParseFabrics(ReadCommissioningInfo & info)
2770 : {
2771 : using namespace OperationalCredentials::Attributes;
2772 : CHIP_ERROR err;
2773 0 : CHIP_ERROR return_err = CHIP_NO_ERROR;
2774 :
2775 : // We might not have requested a Fabrics attribute at all, so not having a
2776 : // value for it is not an error.
2777 0 : err = mAttributeCache->ForEachAttribute(OperationalCredentials::Id, [this, &info](const ConcreteAttributePath & path) {
2778 : using namespace chip::app::Clusters::OperationalCredentials::Attributes;
2779 : // this code is checking if the device is already on the commissioner's fabric.
2780 : // if a matching fabric is found, then remember the nodeId so that the commissioner
2781 : // can, if it decides to, cancel commissioning (before it fails in AddNoc) and know
2782 : // the device's nodeId on its fabric.
2783 0 : switch (path.mAttributeId)
2784 : {
2785 0 : case Fabrics::Id: {
2786 0 : Fabrics::TypeInfo::DecodableType fabrics;
2787 0 : ReturnErrorOnFailure(this->mAttributeCache->Get<Fabrics::TypeInfo>(path, fabrics));
2788 : // this is a best effort attempt to find a matching fabric, so no error checking on iter
2789 0 : auto iter = fabrics.begin();
2790 0 : while (iter.Next())
2791 : {
2792 0 : auto & fabricDescriptor = iter.GetValue();
2793 0 : ChipLogProgress(Controller,
2794 : "DeviceCommissioner::OnDone - fabric.vendorId=0x%04X fabric.fabricId=0x" ChipLogFormatX64
2795 : " fabric.nodeId=0x" ChipLogFormatX64,
2796 : fabricDescriptor.vendorID, ChipLogValueX64(fabricDescriptor.fabricID),
2797 : ChipLogValueX64(fabricDescriptor.nodeID));
2798 0 : if (GetFabricId() == fabricDescriptor.fabricID)
2799 : {
2800 0 : ChipLogProgress(Controller, "DeviceCommissioner::OnDone - found a matching fabric id");
2801 0 : chip::ByteSpan rootKeySpan = fabricDescriptor.rootPublicKey;
2802 0 : if (rootKeySpan.size() != Crypto::kP256_PublicKey_Length)
2803 : {
2804 0 : ChipLogError(Controller, "DeviceCommissioner::OnDone - fabric root key size mismatch %u != %u",
2805 : static_cast<unsigned>(rootKeySpan.size()),
2806 : static_cast<unsigned>(Crypto::kP256_PublicKey_Length));
2807 0 : continue;
2808 : }
2809 0 : P256PublicKeySpan rootPubKeySpan(rootKeySpan.data());
2810 0 : Crypto::P256PublicKey deviceRootPublicKey(rootPubKeySpan);
2811 :
2812 0 : Crypto::P256PublicKey commissionerRootPublicKey;
2813 0 : if (CHIP_NO_ERROR != GetRootPublicKey(commissionerRootPublicKey))
2814 : {
2815 0 : ChipLogError(Controller, "DeviceCommissioner::OnDone - error reading commissioner root public key");
2816 : }
2817 0 : else if (commissionerRootPublicKey.Matches(deviceRootPublicKey))
2818 : {
2819 0 : ChipLogProgress(Controller, "DeviceCommissioner::OnDone - fabric root keys match");
2820 0 : info.remoteNodeId = fabricDescriptor.nodeID;
2821 : }
2822 0 : }
2823 : }
2824 :
2825 0 : return CHIP_NO_ERROR;
2826 : }
2827 0 : default:
2828 0 : return CHIP_NO_ERROR;
2829 : }
2830 : });
2831 :
2832 0 : if (mPairingDelegate != nullptr)
2833 : {
2834 0 : mPairingDelegate->OnFabricCheck(info.remoteNodeId);
2835 : }
2836 :
2837 0 : return return_err;
2838 : }
2839 :
2840 2 : CHIP_ERROR DeviceCommissioner::ParseICDInfo(ReadCommissioningInfo & info)
2841 : {
2842 : using namespace IcdManagement::Attributes;
2843 : CHIP_ERROR err;
2844 :
2845 2 : bool hasUserActiveModeTrigger = false;
2846 2 : bool isICD = false;
2847 :
2848 2 : BitFlags<IcdManagement::Feature> featureMap;
2849 2 : err = mAttributeCache->Get<FeatureMap::TypeInfo>(kRootEndpointId, *featureMap.RawStorage());
2850 4 : if (err == CHIP_NO_ERROR)
2851 : {
2852 2 : info.icd.isLIT = featureMap.Has(IcdManagement::Feature::kLongIdleTimeSupport);
2853 2 : info.icd.checkInProtocolSupport = featureMap.Has(IcdManagement::Feature::kCheckInProtocolSupport);
2854 2 : hasUserActiveModeTrigger = featureMap.Has(IcdManagement::Feature::kUserActiveModeTrigger);
2855 2 : isICD = true;
2856 :
2857 : // LIT support was introduced but broken in ICD Management cluster revision 2 (Matter 1.3).
2858 : // Only treat a device as LIT for cluster revisions after 1.3 (i.e., revision > 2).
2859 2 : if (info.icd.isLIT)
2860 : {
2861 2 : uint16_t clusterRevision = 0;
2862 2 : CHIP_ERROR revErr = mAttributeCache->Get<ClusterRevision::TypeInfo>(kRootEndpointId, clusterRevision);
2863 4 : if (revErr != CHIP_NO_ERROR || clusterRevision <= 2)
2864 : {
2865 2 : if (revErr == CHIP_NO_ERROR)
2866 : {
2867 1 : ChipLogProgress(Controller,
2868 : "IcdManagement: Device claims LIT support but cluster revision is %" PRIu16
2869 : " (Matter 1.3). Disabling LIT due to known Matter 1.3 LIT issues.",
2870 : clusterRevision);
2871 : }
2872 : else
2873 : {
2874 0 : ChipLogProgress(Controller,
2875 : "IcdManagement: Device claims LIT support but ClusterRevision attribute is "
2876 : "missing or unreadable (err=%" CHIP_ERROR_FORMAT
2877 : "). Treating as revision <= 2 and disabling LIT.",
2878 : revErr.Format());
2879 : }
2880 1 : info.icd.isLIT = false;
2881 : }
2882 : }
2883 : }
2884 0 : else if (err == CHIP_ERROR_KEY_NOT_FOUND)
2885 : {
2886 : // This key is optional so not an error
2887 0 : info.icd.isLIT = false;
2888 0 : err = CHIP_NO_ERROR;
2889 : }
2890 0 : else if (err == CHIP_ERROR_IM_STATUS_CODE_RECEIVED)
2891 : {
2892 0 : app::StatusIB statusIB;
2893 0 : err = mAttributeCache->GetStatus(app::ConcreteAttributePath(kRootEndpointId, IcdManagement::Id, FeatureMap::Id), statusIB);
2894 0 : if (err == CHIP_NO_ERROR)
2895 : {
2896 0 : if (statusIB.mStatus == Protocols::InteractionModel::Status::UnsupportedCluster)
2897 : {
2898 0 : info.icd.isLIT = false;
2899 : }
2900 : else
2901 : {
2902 0 : err = statusIB.ToChipError();
2903 : }
2904 : }
2905 : }
2906 :
2907 2 : ReturnErrorOnFailure(err);
2908 :
2909 2 : info.icd.userActiveModeTriggerHint.ClearAll();
2910 2 : info.icd.userActiveModeTriggerInstruction = CharSpan();
2911 :
2912 2 : if (hasUserActiveModeTrigger)
2913 : {
2914 : // Intentionally ignore errors since they are not mandatory.
2915 0 : bool activeModeTriggerInstructionRequired = false;
2916 :
2917 0 : err = mAttributeCache->Get<UserActiveModeTriggerHint::TypeInfo>(kRootEndpointId, info.icd.userActiveModeTriggerHint);
2918 0 : if (err != CHIP_NO_ERROR)
2919 : {
2920 0 : ChipLogError(Controller, "IcdManagement.UserActiveModeTriggerHint expected, but failed to read.");
2921 0 : return err;
2922 : }
2923 :
2924 : using IcdManagement::UserActiveModeTriggerBitmap;
2925 0 : activeModeTriggerInstructionRequired = info.icd.userActiveModeTriggerHint.HasAny(
2926 0 : UserActiveModeTriggerBitmap::kCustomInstruction, UserActiveModeTriggerBitmap::kActuateSensorSeconds,
2927 0 : UserActiveModeTriggerBitmap::kActuateSensorTimes, UserActiveModeTriggerBitmap::kActuateSensorLightsBlink,
2928 0 : UserActiveModeTriggerBitmap::kResetButtonLightsBlink, UserActiveModeTriggerBitmap::kResetButtonSeconds,
2929 0 : UserActiveModeTriggerBitmap::kResetButtonTimes, UserActiveModeTriggerBitmap::kSetupButtonSeconds,
2930 0 : UserActiveModeTriggerBitmap::kSetupButtonTimes, UserActiveModeTriggerBitmap::kSetupButtonTimes,
2931 0 : UserActiveModeTriggerBitmap::kAppDefinedButton);
2932 :
2933 0 : if (activeModeTriggerInstructionRequired)
2934 : {
2935 0 : err = mAttributeCache->Get<UserActiveModeTriggerInstruction::TypeInfo>(kRootEndpointId,
2936 0 : info.icd.userActiveModeTriggerInstruction);
2937 0 : if (err != CHIP_NO_ERROR)
2938 : {
2939 0 : ChipLogError(Controller,
2940 : "IcdManagement.UserActiveModeTriggerInstruction expected for given active mode trigger hint, but "
2941 : "failed to read.");
2942 0 : return err;
2943 : }
2944 : }
2945 : }
2946 :
2947 2 : if (!isICD)
2948 : {
2949 0 : info.icd.idleModeDuration = 0;
2950 0 : info.icd.activeModeDuration = 0;
2951 0 : info.icd.activeModeThreshold = 0;
2952 0 : return CHIP_NO_ERROR;
2953 : }
2954 :
2955 2 : err = mAttributeCache->Get<IdleModeDuration::TypeInfo>(kRootEndpointId, info.icd.idleModeDuration);
2956 4 : if (err != CHIP_NO_ERROR)
2957 : {
2958 0 : ChipLogError(Controller, "IcdManagement.IdleModeDuration expected, but failed to read: %" CHIP_ERROR_FORMAT, err.Format());
2959 0 : return err;
2960 : }
2961 :
2962 2 : err = mAttributeCache->Get<ActiveModeDuration::TypeInfo>(kRootEndpointId, info.icd.activeModeDuration);
2963 4 : if (err != CHIP_NO_ERROR)
2964 : {
2965 0 : ChipLogError(Controller, "IcdManagement.ActiveModeDuration expected, but failed to read: %" CHIP_ERROR_FORMAT,
2966 : err.Format());
2967 0 : return err;
2968 : }
2969 :
2970 2 : err = mAttributeCache->Get<ActiveModeThreshold::TypeInfo>(kRootEndpointId, info.icd.activeModeThreshold);
2971 4 : if (err != CHIP_NO_ERROR)
2972 : {
2973 0 : ChipLogError(Controller, "IcdManagement.ActiveModeThreshold expected, but failed to read: %" CHIP_ERROR_FORMAT,
2974 : err.Format());
2975 : }
2976 :
2977 2 : return err;
2978 : }
2979 :
2980 0 : void DeviceCommissioner::OnArmFailSafe(void * context,
2981 : const GeneralCommissioning::Commands::ArmFailSafeResponse::DecodableType & data)
2982 : {
2983 0 : CommissioningDelegate::CommissioningReport report;
2984 0 : CHIP_ERROR err = CHIP_NO_ERROR;
2985 :
2986 0 : ChipLogProgress(Controller, "Received ArmFailSafe response errorCode=%u", to_underlying(data.errorCode));
2987 0 : if (data.errorCode != GeneralCommissioning::CommissioningErrorEnum::kOk)
2988 : {
2989 0 : err = CHIP_ERROR_INTERNAL;
2990 : // Preserve the device-supplied debugText so failure consumers can disambiguate
2991 : // ambiguous error codes (e.g. kBusyWithOtherAdmin specifics).
2992 0 : report.Set<CommissioningErrorInfo>(data.errorCode, data.debugText);
2993 : }
2994 :
2995 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
2996 0 : commissioner->CommissioningStageComplete(err, report);
2997 0 : }
2998 :
2999 0 : void DeviceCommissioner::OnSetRegulatoryConfigResponse(
3000 : void * context, const GeneralCommissioning::Commands::SetRegulatoryConfigResponse::DecodableType & data)
3001 : {
3002 0 : CommissioningDelegate::CommissioningReport report;
3003 0 : CHIP_ERROR err = CHIP_NO_ERROR;
3004 :
3005 0 : ChipLogProgress(Controller, "Received SetRegulatoryConfig response errorCode=%u", to_underlying(data.errorCode));
3006 0 : if (data.errorCode != GeneralCommissioning::CommissioningErrorEnum::kOk)
3007 : {
3008 0 : err = CHIP_ERROR_INTERNAL;
3009 0 : report.Set<CommissioningErrorInfo>(data.errorCode, data.debugText);
3010 : }
3011 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
3012 0 : commissioner->CommissioningStageComplete(err, report);
3013 0 : }
3014 :
3015 0 : void DeviceCommissioner::OnSetTCAcknowledgementsResponse(
3016 : void * context, const GeneralCommissioning::Commands::SetTCAcknowledgementsResponse::DecodableType & data)
3017 : {
3018 0 : CommissioningDelegate::CommissioningReport report;
3019 0 : CHIP_ERROR err = CHIP_NO_ERROR;
3020 :
3021 0 : ChipLogProgress(Controller, "Received SetTCAcknowledgements response errorCode=%u", to_underlying(data.errorCode));
3022 0 : if (data.errorCode != GeneralCommissioning::CommissioningErrorEnum::kOk)
3023 : {
3024 0 : err = CHIP_ERROR_INTERNAL;
3025 : // SetTCAcknowledgementsResponse has no debugText field per spec.
3026 0 : report.Set<CommissioningErrorInfo>(data.errorCode);
3027 : }
3028 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
3029 0 : commissioner->CommissioningStageComplete(err, report);
3030 0 : }
3031 :
3032 0 : void DeviceCommissioner::OnSetTimeZoneResponse(void * context,
3033 : const TimeSynchronization::Commands::SetTimeZoneResponse::DecodableType & data)
3034 : {
3035 0 : CommissioningDelegate::CommissioningReport report;
3036 0 : CHIP_ERROR err = CHIP_NO_ERROR;
3037 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
3038 : TimeZoneResponseInfo info;
3039 0 : info.requiresDSTOffsets = data.DSTOffsetRequired;
3040 0 : report.Set<TimeZoneResponseInfo>(info);
3041 0 : commissioner->CommissioningStageComplete(err, report);
3042 0 : }
3043 :
3044 0 : void DeviceCommissioner::OnSetUTCError(void * context, CHIP_ERROR error)
3045 : {
3046 : // For SetUTCTime, we don't actually care if the commissionee didn't want out time, that's its choice
3047 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
3048 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR);
3049 0 : }
3050 :
3051 0 : void DeviceCommissioner::OnScanNetworksFailure(void * context, CHIP_ERROR error)
3052 : {
3053 0 : ChipLogProgress(Controller, "Received ScanNetworks failure response %" CHIP_ERROR_FORMAT, error.Format());
3054 :
3055 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
3056 :
3057 : // advance to the kNeedsNetworkCreds waiting step
3058 : // clear error so that we don't abort the commissioning when ScanNetworks fails
3059 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR);
3060 :
3061 0 : if (commissioner->GetPairingDelegate() != nullptr)
3062 : {
3063 0 : commissioner->GetPairingDelegate()->OnScanNetworksFailure(error);
3064 : }
3065 0 : }
3066 :
3067 0 : void DeviceCommissioner::OnScanNetworksResponse(void * context,
3068 : const NetworkCommissioning::Commands::ScanNetworksResponse::DecodableType & data)
3069 : {
3070 0 : CommissioningDelegate::CommissioningReport report;
3071 :
3072 0 : ChipLogProgress(Controller, "Received ScanNetwork response, networkingStatus=%u debugText=%s",
3073 : to_underlying(data.networkingStatus),
3074 : (data.debugText.HasValue() ? std::string(data.debugText.Value().data(), data.debugText.Value().size()).c_str()
3075 : : "none provided"));
3076 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
3077 :
3078 : // advance to the kNeedsNetworkCreds waiting step
3079 0 : commissioner->CommissioningStageComplete(CHIP_NO_ERROR);
3080 :
3081 0 : if (commissioner->GetPairingDelegate() != nullptr)
3082 : {
3083 0 : commissioner->GetPairingDelegate()->OnScanNetworksSuccess(data);
3084 : }
3085 0 : }
3086 :
3087 0 : CHIP_ERROR DeviceCommissioner::NetworkCredentialsReady()
3088 : {
3089 0 : VerifyOrReturnError(mCommissioningStage == CommissioningStage::kNeedsNetworkCreds, CHIP_ERROR_INCORRECT_STATE);
3090 :
3091 : // need to advance to next step
3092 0 : CommissioningStageComplete(CHIP_NO_ERROR);
3093 :
3094 0 : return CHIP_NO_ERROR;
3095 : }
3096 :
3097 0 : CHIP_ERROR DeviceCommissioner::ICDRegistrationInfoReady()
3098 : {
3099 0 : VerifyOrReturnError(mCommissioningStage == CommissioningStage::kICDGetRegistrationInfo, CHIP_ERROR_INCORRECT_STATE);
3100 :
3101 : // need to advance to next step
3102 0 : CommissioningStageComplete(CHIP_NO_ERROR);
3103 :
3104 0 : return CHIP_NO_ERROR;
3105 : }
3106 :
3107 0 : void DeviceCommissioner::OnNetworkConfigResponse(void * context,
3108 : const NetworkCommissioning::Commands::NetworkConfigResponse::DecodableType & data)
3109 : {
3110 0 : CommissioningDelegate::CommissioningReport report;
3111 0 : CHIP_ERROR err = CHIP_NO_ERROR;
3112 :
3113 0 : ChipLogProgress(Controller, "Received NetworkConfig response, networkingStatus=%u", to_underlying(data.networkingStatus));
3114 0 : if (data.networkingStatus != NetworkCommissioning::NetworkCommissioningStatusEnum::kSuccess)
3115 : {
3116 0 : err = CHIP_ERROR_INTERNAL;
3117 : // Preserve debugText alongside the status enum so callers can distinguish
3118 : // ambiguous statuses (e.g. kAuthFailure: "wrong password" vs "regulatory restriction").
3119 0 : report.Set<NetworkCommissioningStatusInfo>(data.networkingStatus, data.debugText.ValueOr(CharSpan{}));
3120 : }
3121 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
3122 0 : commissioner->CommissioningStageComplete(err, report);
3123 0 : }
3124 :
3125 0 : void DeviceCommissioner::OnConnectNetworkResponse(
3126 : void * context, const NetworkCommissioning::Commands::ConnectNetworkResponse::DecodableType & data)
3127 : {
3128 0 : CommissioningDelegate::CommissioningReport report;
3129 0 : CHIP_ERROR err = CHIP_NO_ERROR;
3130 :
3131 0 : ChipLogProgress(Controller, "Received ConnectNetwork response, networkingStatus=%u", to_underlying(data.networkingStatus));
3132 0 : if (data.networkingStatus != NetworkCommissioning::NetworkCommissioningStatusEnum::kSuccess)
3133 : {
3134 0 : err = CHIP_ERROR_INTERNAL;
3135 : // Preserve debugText alongside the status enum (see OnNetworkConfigResponse). Also
3136 : // surface the device-specific errorValue which carries driver-level failure detail
3137 : // (TX-power-limited / interference / association-failure code) distinct from the
3138 : // spec-level networkingStatus enum.
3139 0 : Optional<int32_t> errorValue = data.errorValue.IsNull() ? NullOptional : MakeOptional(data.errorValue.Value());
3140 0 : report.Set<NetworkCommissioningStatusInfo>(data.networkingStatus, data.debugText.ValueOr(CharSpan{}), errorValue);
3141 : }
3142 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
3143 0 : commissioner->CommissioningStageComplete(err, report);
3144 0 : }
3145 :
3146 0 : void DeviceCommissioner::OnCommissioningCompleteResponse(
3147 : void * context, const GeneralCommissioning::Commands::CommissioningCompleteResponse::DecodableType & data)
3148 : {
3149 0 : CommissioningDelegate::CommissioningReport report;
3150 0 : CHIP_ERROR err = CHIP_NO_ERROR;
3151 :
3152 0 : ChipLogProgress(Controller, "Received CommissioningComplete response, errorCode=%u", to_underlying(data.errorCode));
3153 0 : if (data.errorCode != GeneralCommissioning::CommissioningErrorEnum::kOk)
3154 : {
3155 0 : err = CHIP_ERROR_INTERNAL;
3156 0 : report.Set<CommissioningErrorInfo>(data.errorCode, data.debugText);
3157 : }
3158 0 : DeviceCommissioner * commissioner = static_cast<DeviceCommissioner *>(context);
3159 0 : commissioner->CommissioningStageComplete(err, report);
3160 0 : }
3161 :
3162 : template <typename RequestObjectT>
3163 : CHIP_ERROR
3164 0 : DeviceCommissioner::SendCommissioningCommand(DeviceProxy * device, const RequestObjectT & request,
3165 : CommandResponseSuccessCallback<typename RequestObjectT::ResponseType> successCb,
3166 : CommandResponseFailureCallback failureCb, EndpointId endpoint,
3167 : Optional<System::Clock::Timeout> timeout, bool fireAndForget)
3168 :
3169 : {
3170 : // Default behavior is to make sequential, cancellable calls tracked via mInvokeCancelFn.
3171 : // Fire-and-forget calls are not cancellable and don't receive `this` as context in callbacks.
3172 0 : VerifyOrDie(fireAndForget || !mInvokeCancelFn); // we don't make parallel (cancellable) calls
3173 :
3174 0 : void * context = (!fireAndForget) ? this : nullptr;
3175 0 : auto onSuccessCb = [context, successCb](const app::ConcreteCommandPath & aPath, const app::StatusIB & aStatus,
3176 : const typename RequestObjectT::ResponseType & responseData) {
3177 0 : successCb(context, responseData);
3178 : };
3179 0 : auto onFailureCb = [context, failureCb](CHIP_ERROR aError) { failureCb(context, aError); };
3180 :
3181 0 : return InvokeCommandRequest(device->GetExchangeManager(), device->GetSecureSession().Value(), endpoint, request, onSuccessCb,
3182 0 : onFailureCb, NullOptional, timeout, (!fireAndForget) ? &mInvokeCancelFn : nullptr);
3183 : }
3184 :
3185 : template <typename AttrType>
3186 : CHIP_ERROR DeviceCommissioner::SendCommissioningWriteRequest(DeviceProxy * device, EndpointId endpoint, ClusterId cluster,
3187 : AttributeId attribute, const AttrType & requestData,
3188 : WriteResponseSuccessCallback successCb,
3189 : WriteResponseFailureCallback failureCb)
3190 : {
3191 : VerifyOrDie(!mWriteCancelFn); // we don't make parallel (cancellable) calls
3192 : auto onSuccessCb = [this, successCb](const app::ConcreteAttributePath & aPath) { successCb(this); };
3193 : auto onFailureCb = [this, failureCb](const app::ConcreteAttributePath * aPath, CHIP_ERROR aError) { failureCb(this, aError); };
3194 : return WriteAttribute(device->GetSecureSession().Value(), endpoint, cluster, attribute, requestData, onSuccessCb, onFailureCb,
3195 : /* aTimedWriteTimeoutMs = */ NullOptional, /* onDoneCb = */ nullptr, /* aDataVersion = */ NullOptional,
3196 : /* outCancelFn = */ &mWriteCancelFn);
3197 : }
3198 :
3199 0 : void DeviceCommissioner::SendCommissioningReadRequest(DeviceProxy * proxy, Optional<System::Clock::Timeout> timeout,
3200 : app::AttributePathParams * readPaths, size_t readPathsSize)
3201 : {
3202 0 : VerifyOrDie(!mReadClient); // we don't perform parallel reads
3203 :
3204 0 : app::InteractionModelEngine * engine = app::InteractionModelEngine::GetInstance();
3205 0 : app::ReadPrepareParams readParams(proxy->GetSecureSession().Value());
3206 0 : readParams.mIsFabricFiltered = false;
3207 0 : if (timeout.HasValue())
3208 : {
3209 0 : readParams.mTimeout = timeout.Value();
3210 : }
3211 0 : readParams.mpAttributePathParamsList = readPaths;
3212 0 : readParams.mAttributePathParamsListSize = readPathsSize;
3213 :
3214 : // Take ownership of the attribute cache, so it can be released if SendRequest fails.
3215 0 : auto attributeCache = std::move(mAttributeCache);
3216 : auto readClient = chip::Platform::MakeUnique<app::ReadClient>(
3217 0 : engine, proxy->GetExchangeManager(), attributeCache->GetBufferedCallback(), app::ReadClient::InteractionType::Read);
3218 0 : CHIP_ERROR err = readClient->SendRequest(readParams);
3219 0 : if (err != CHIP_NO_ERROR)
3220 : {
3221 0 : ChipLogError(Controller, "Failed to send read request: %" CHIP_ERROR_FORMAT, err.Format());
3222 0 : CommissioningStageComplete(err);
3223 0 : return;
3224 : }
3225 0 : mAttributeCache = std::move(attributeCache);
3226 0 : mReadClient = std::move(readClient);
3227 0 : }
3228 :
3229 0 : void DeviceCommissioner::PerformCommissioningStep(DeviceProxy * proxy, CommissioningStage step, CommissioningParameters & params,
3230 : CommissioningDelegate * delegate, EndpointId endpoint,
3231 : Optional<System::Clock::Timeout> timeout)
3232 :
3233 : {
3234 : MATTER_LOG_METRIC(kMetricDeviceCommissionerCommissionStage, step);
3235 : MATTER_LOG_METRIC_BEGIN(MetricKeyForCommissioningStage(step));
3236 :
3237 0 : if (params.GetCompletionStatus().err == CHIP_NO_ERROR)
3238 : {
3239 0 : ChipLogProgress(Controller, "Performing next commissioning step '%s'", StageToString(step));
3240 : }
3241 : else
3242 : {
3243 0 : ChipLogProgress(Controller, "Performing next commissioning step '%s' with completion status = '%s'", StageToString(step),
3244 : params.GetCompletionStatus().err.AsString());
3245 : }
3246 :
3247 0 : if (mPairingDelegate)
3248 : {
3249 0 : mPairingDelegate->OnCommissioningStageStart(PeerId(GetCompressedFabricId(), proxy->GetDeviceId()), step);
3250 : }
3251 :
3252 0 : mCommissioningStepTimeout = timeout;
3253 0 : mCommissioningStage = step;
3254 0 : mCommissioningDelegate = delegate;
3255 0 : mDeviceBeingCommissioned = proxy;
3256 :
3257 : // TODO: Extend timeouts to the DAC and Opcert requests.
3258 : // TODO(cecille): We probably want something better than this for breadcrumbs.
3259 0 : uint64_t breadcrumb = static_cast<uint64_t>(step);
3260 :
3261 0 : switch (step)
3262 : {
3263 0 : case CommissioningStage::kArmFailsafe: {
3264 0 : VerifyOrDie(endpoint == kRootEndpointId);
3265 : // Make sure the fail-safe value we set here actually ends up being used
3266 : // no matter what.
3267 0 : proxy->SetFailSafeExpirationTimestamp(System::Clock::kZero);
3268 0 : VerifyOrDie(ExtendArmFailSafeInternal(proxy, step, params.GetFailsafeTimerSeconds().ValueOr(kDefaultFailsafeTimeout),
3269 : timeout, OnArmFailSafe, OnBasicFailure, /* fireAndForget = */ false));
3270 : }
3271 0 : break;
3272 0 : case CommissioningStage::kReadCommissioningInfo: {
3273 0 : VerifyOrDie(endpoint == kRootEndpointId);
3274 0 : ChipLogProgress(Controller, "Sending read requests for commissioning information");
3275 :
3276 : // Allocate a ClusterStateCache to collect the data from our read requests.
3277 : // The cache will be released in:
3278 : // - SendCommissioningReadRequest when failing to send a read request.
3279 : // - FinishReadingCommissioningInfo when the ReadCommissioningInfo stage is completed.
3280 : // - CancelCommissioningInteractions
3281 0 : mAttributeCache = Platform::MakeUnique<app::ClusterStateCache>(*this);
3282 :
3283 : // Generally we need to make more than one read request, because as per spec a server only
3284 : // supports a limited number of paths per Read Interaction. Because the actual number of
3285 : // interactions we end up performing is dynamic, we track all of them within a single
3286 : // commissioning stage.
3287 0 : mReadCommissioningInfoProgress = 0;
3288 0 : ContinueReadingCommissioningInfo(params); // Note: assume params == delegate.GetCommissioningParameters()
3289 0 : break;
3290 : }
3291 0 : case CommissioningStage::kConfigureUTCTime: {
3292 0 : TimeSynchronization::Commands::SetUTCTime::Type request;
3293 0 : uint64_t kChipEpochUsSinceUnixEpoch = static_cast<uint64_t>(kChipEpochSecondsSinceUnixEpoch) * chip::kMicrosecondsPerSecond;
3294 : System::Clock::Microseconds64 utcTime;
3295 0 : if (System::SystemClock().GetClock_RealTime(utcTime) != CHIP_NO_ERROR || utcTime.count() <= kChipEpochUsSinceUnixEpoch)
3296 : {
3297 : // We have no time to give, but that's OK, just complete this stage
3298 0 : CommissioningStageComplete(CHIP_NO_ERROR);
3299 0 : return;
3300 : }
3301 :
3302 0 : request.UTCTime = utcTime.count() - kChipEpochUsSinceUnixEpoch;
3303 : // For now, we assume a seconds granularity
3304 0 : request.granularity = TimeSynchronization::GranularityEnum::kSecondsGranularity;
3305 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnBasicSuccess, OnSetUTCError, endpoint, timeout);
3306 0 : if (err != CHIP_NO_ERROR)
3307 : {
3308 : // We won't get any async callbacks here, so just complete our stage.
3309 0 : ChipLogError(Controller, "Failed to send SetUTCTime command: %" CHIP_ERROR_FORMAT, err.Format());
3310 0 : CommissioningStageComplete(err);
3311 0 : return;
3312 : }
3313 0 : break;
3314 : }
3315 0 : case CommissioningStage::kConfigureTimeZone: {
3316 0 : if (!params.GetTimeZone().HasValue())
3317 : {
3318 0 : ChipLogError(Controller, "ConfigureTimeZone stage called with no time zone data");
3319 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3320 0 : return;
3321 : }
3322 0 : TimeSynchronization::Commands::SetTimeZone::Type request;
3323 0 : request.timeZone = params.GetTimeZone().Value();
3324 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnSetTimeZoneResponse, OnBasicFailure, endpoint, timeout);
3325 0 : if (err != CHIP_NO_ERROR)
3326 : {
3327 : // We won't get any async callbacks here, so just complete our stage.
3328 0 : ChipLogError(Controller, "Failed to send SetTimeZone command: %" CHIP_ERROR_FORMAT, err.Format());
3329 0 : CommissioningStageComplete(err);
3330 0 : return;
3331 : }
3332 0 : break;
3333 : }
3334 0 : case CommissioningStage::kConfigureDSTOffset: {
3335 0 : if (!params.GetDSTOffsets().HasValue())
3336 : {
3337 0 : ChipLogError(Controller, "ConfigureDSTOffset stage called with no DST data");
3338 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3339 0 : return;
3340 : }
3341 0 : TimeSynchronization::Commands::SetDSTOffset::Type request;
3342 0 : request.DSTOffset = params.GetDSTOffsets().Value();
3343 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnBasicSuccess, OnBasicFailure, endpoint, timeout);
3344 0 : if (err != CHIP_NO_ERROR)
3345 : {
3346 : // We won't get any async callbacks here, so just complete our stage.
3347 0 : ChipLogError(Controller, "Failed to send SetDSTOffset command: %" CHIP_ERROR_FORMAT, err.Format());
3348 0 : CommissioningStageComplete(err);
3349 0 : return;
3350 : }
3351 0 : break;
3352 : }
3353 0 : case CommissioningStage::kConfigureDefaultNTP: {
3354 0 : if (!params.GetDefaultNTP().HasValue())
3355 : {
3356 0 : ChipLogError(Controller, "ConfigureDefaultNTP stage called with no default NTP data");
3357 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3358 0 : return;
3359 : }
3360 0 : TimeSynchronization::Commands::SetDefaultNTP::Type request;
3361 0 : request.defaultNTP = params.GetDefaultNTP().Value();
3362 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnBasicSuccess, OnBasicFailure, endpoint, timeout);
3363 0 : if (err != CHIP_NO_ERROR)
3364 : {
3365 : // We won't get any async callbacks here, so just complete our stage.
3366 0 : ChipLogError(Controller, "Failed to send SetDefaultNTP command: %" CHIP_ERROR_FORMAT, err.Format());
3367 0 : CommissioningStageComplete(err);
3368 0 : return;
3369 : }
3370 0 : break;
3371 : }
3372 0 : case CommissioningStage::kScanNetworks: {
3373 0 : NetworkCommissioning::Commands::ScanNetworks::Type request;
3374 0 : if (params.GetWiFiCredentials().HasValue())
3375 : {
3376 0 : request.ssid.Emplace(params.GetWiFiCredentials().Value().ssid);
3377 : }
3378 0 : request.breadcrumb.Emplace(breadcrumb);
3379 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnScanNetworksResponse, OnScanNetworksFailure, endpoint, timeout);
3380 0 : if (err != CHIP_NO_ERROR)
3381 : {
3382 : // We won't get any async callbacks here, so just complete our stage.
3383 0 : ChipLogError(Controller, "Failed to send ScanNetworks command: %" CHIP_ERROR_FORMAT, err.Format());
3384 0 : CommissioningStageComplete(err);
3385 0 : return;
3386 : }
3387 0 : break;
3388 : }
3389 0 : case CommissioningStage::kNeedsNetworkCreds: {
3390 : // Nothing to do.
3391 : //
3392 : // Either we did a scan and the OnScanNetworksSuccess and OnScanNetworksFailure
3393 : // callbacks will tell the DevicePairingDelegate that network credentials are
3394 : // needed, or we asked the DevicePairingDelegate for network credentials
3395 : // explicitly, and are waiting for it to get back to us.
3396 0 : break;
3397 : }
3398 0 : case CommissioningStage::kConfigRegulatory: {
3399 : // TODO(cecille): Worthwhile to keep this around as part of the class?
3400 : // TODO(cecille): Where is the country config actually set?
3401 0 : ChipLogProgress(Controller, "Setting Regulatory Config");
3402 : auto capability =
3403 0 : params.GetLocationCapability().ValueOr(app::Clusters::GeneralCommissioning::RegulatoryLocationTypeEnum::kOutdoor);
3404 : app::Clusters::GeneralCommissioning::RegulatoryLocationTypeEnum regulatoryConfig;
3405 : // Value is only switchable on the devices with indoor/outdoor capability
3406 0 : if (capability == app::Clusters::GeneralCommissioning::RegulatoryLocationTypeEnum::kIndoorOutdoor)
3407 : {
3408 : // If the device supports indoor and outdoor configs, use the setting from the commissioner, otherwise fall back to
3409 : // the current device setting then to outdoor (most restrictive)
3410 0 : if (params.GetDeviceRegulatoryLocation().HasValue())
3411 : {
3412 0 : regulatoryConfig = params.GetDeviceRegulatoryLocation().Value();
3413 0 : ChipLogProgress(Controller, "Setting regulatory config to %u from commissioner override",
3414 : static_cast<uint8_t>(regulatoryConfig));
3415 : }
3416 0 : else if (params.GetDefaultRegulatoryLocation().HasValue())
3417 : {
3418 0 : regulatoryConfig = params.GetDefaultRegulatoryLocation().Value();
3419 0 : ChipLogProgress(Controller, "No regulatory config supplied by controller, leaving as device default (%u)",
3420 : static_cast<uint8_t>(regulatoryConfig));
3421 : }
3422 : else
3423 : {
3424 0 : regulatoryConfig = app::Clusters::GeneralCommissioning::RegulatoryLocationTypeEnum::kOutdoor;
3425 0 : ChipLogProgress(Controller, "No overrride or device regulatory config supplied, setting to outdoor");
3426 : }
3427 : }
3428 : else
3429 : {
3430 0 : ChipLogProgress(Controller, "Device does not support configurable regulatory location");
3431 0 : regulatoryConfig = capability;
3432 : }
3433 :
3434 0 : CharSpan countryCode;
3435 0 : const auto & providedCountryCode = params.GetCountryCode();
3436 0 : if (providedCountryCode.HasValue())
3437 : {
3438 0 : countryCode = providedCountryCode.Value();
3439 : }
3440 : else
3441 : {
3442 : // Default to "XX", for lack of anything better.
3443 0 : countryCode = "XX"_span;
3444 : }
3445 :
3446 0 : GeneralCommissioning::Commands::SetRegulatoryConfig::Type request;
3447 0 : request.newRegulatoryConfig = regulatoryConfig;
3448 0 : request.countryCode = countryCode;
3449 0 : request.breadcrumb = breadcrumb;
3450 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnSetRegulatoryConfigResponse, OnBasicFailure, endpoint, timeout);
3451 0 : if (err != CHIP_NO_ERROR)
3452 : {
3453 : // We won't get any async callbacks here, so just complete our stage.
3454 0 : ChipLogError(Controller, "Failed to send SetRegulatoryConfig command: %" CHIP_ERROR_FORMAT, err.Format());
3455 0 : CommissioningStageComplete(err);
3456 0 : return;
3457 : }
3458 : }
3459 0 : break;
3460 0 : case CommissioningStage::kConfigureTCAcknowledgments: {
3461 0 : ChipLogProgress(Controller, "Setting Terms and Conditions");
3462 :
3463 0 : if (!params.GetTermsAndConditionsAcknowledgement().HasValue())
3464 : {
3465 0 : ChipLogProgress(Controller, "Setting Terms and Conditions: Skipped");
3466 0 : CommissioningStageComplete(CHIP_NO_ERROR);
3467 0 : return;
3468 : }
3469 :
3470 0 : GeneralCommissioning::Commands::SetTCAcknowledgements::Type request;
3471 0 : TermsAndConditionsAcknowledgement termsAndConditionsAcknowledgement = params.GetTermsAndConditionsAcknowledgement().Value();
3472 0 : request.TCUserResponse = termsAndConditionsAcknowledgement.acceptedTermsAndConditions;
3473 0 : request.TCVersion = termsAndConditionsAcknowledgement.acceptedTermsAndConditionsVersion;
3474 :
3475 0 : ChipLogProgress(Controller, "Setting Terms and Conditions: %hu, %hu", request.TCUserResponse, request.TCVersion);
3476 : CHIP_ERROR err =
3477 0 : SendCommissioningCommand(proxy, request, OnSetTCAcknowledgementsResponse, OnBasicFailure, endpoint, timeout);
3478 0 : if (err != CHIP_NO_ERROR)
3479 : {
3480 0 : ChipLogError(Controller, "Failed to send SetTCAcknowledgements command: %" CHIP_ERROR_FORMAT, err.Format());
3481 0 : CommissioningStageComplete(err);
3482 0 : return;
3483 : }
3484 0 : break;
3485 : }
3486 0 : case CommissioningStage::kSendPAICertificateRequest: {
3487 0 : ChipLogProgress(Controller, "Sending request for PAI certificate");
3488 0 : CHIP_ERROR err = SendCertificateChainRequestCommand(proxy, CertificateType::kPAI, timeout);
3489 0 : if (err != CHIP_NO_ERROR)
3490 : {
3491 : // We won't get any async callbacks here, so just complete our stage.
3492 0 : ChipLogError(Controller, "Failed to send CertificateChainRequest command to get PAI: %" CHIP_ERROR_FORMAT,
3493 : err.Format());
3494 0 : CommissioningStageComplete(err);
3495 0 : return;
3496 : }
3497 0 : break;
3498 : }
3499 0 : case CommissioningStage::kSendDACCertificateRequest: {
3500 0 : ChipLogProgress(Controller, "Sending request for DAC certificate");
3501 0 : CHIP_ERROR err = SendCertificateChainRequestCommand(proxy, CertificateType::kDAC, timeout);
3502 0 : if (err != CHIP_NO_ERROR)
3503 : {
3504 : // We won't get any async callbacks here, so just complete our stage.
3505 0 : ChipLogError(Controller, "Failed to send CertificateChainRequest command to get DAC: %" CHIP_ERROR_FORMAT,
3506 : err.Format());
3507 0 : CommissioningStageComplete(err);
3508 0 : return;
3509 : }
3510 0 : break;
3511 : }
3512 0 : case CommissioningStage::kSendAttestationRequest: {
3513 0 : ChipLogProgress(Controller, "Sending Attestation Request to the device.");
3514 0 : if (!params.GetAttestationNonce().HasValue())
3515 : {
3516 0 : ChipLogError(Controller, "No attestation nonce found");
3517 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3518 0 : return;
3519 : }
3520 0 : CHIP_ERROR err = SendAttestationRequestCommand(proxy, params.GetAttestationNonce().Value(), timeout);
3521 0 : if (err != CHIP_NO_ERROR)
3522 : {
3523 : // We won't get any async callbacks here, so just complete our stage.
3524 0 : ChipLogError(Controller, "Failed to send AttestationRequest command: %" CHIP_ERROR_FORMAT, err.Format());
3525 0 : CommissioningStageComplete(err);
3526 0 : return;
3527 : }
3528 0 : break;
3529 : }
3530 0 : case CommissioningStage::kAttestationVerification: {
3531 0 : ChipLogProgress(Controller, "Verifying Device Attestation information received from the device");
3532 0 : if (IsAttestationInformationMissing(params))
3533 : {
3534 0 : ChipLogError(Controller, "Missing attestation information");
3535 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3536 0 : return;
3537 : }
3538 :
3539 : DeviceAttestationVerifier::AttestationInfo info(
3540 0 : params.GetAttestationElements().Value(),
3541 0 : proxy->GetSecureSession().Value()->AsSecureSession()->GetCryptoContext().GetAttestationChallenge(),
3542 0 : params.GetAttestationSignature().Value(), params.GetPAI().Value(), params.GetDAC().Value(),
3543 0 : params.GetAttestationNonce().Value(), params.GetRemoteVendorId().Value(), params.GetRemoteProductId().Value());
3544 :
3545 0 : CHIP_ERROR err = ValidateAttestationInfo(info);
3546 0 : if (err != CHIP_NO_ERROR)
3547 : {
3548 0 : ChipLogError(Controller, "Error validating attestation information: %" CHIP_ERROR_FORMAT, err.Format());
3549 0 : CommissioningStageComplete(CHIP_ERROR_FAILED_DEVICE_ATTESTATION);
3550 0 : return;
3551 : }
3552 : }
3553 0 : break;
3554 0 : case CommissioningStage::kAttestationRevocationCheck: {
3555 0 : ChipLogProgress(Controller, "Verifying the device's DAC chain revocation status");
3556 0 : if (IsAttestationInformationMissing(params))
3557 : {
3558 0 : ChipLogError(Controller, "Missing attestation information");
3559 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3560 0 : return;
3561 : }
3562 :
3563 : DeviceAttestationVerifier::AttestationInfo info(
3564 0 : params.GetAttestationElements().Value(),
3565 0 : proxy->GetSecureSession().Value()->AsSecureSession()->GetCryptoContext().GetAttestationChallenge(),
3566 0 : params.GetAttestationSignature().Value(), params.GetPAI().Value(), params.GetDAC().Value(),
3567 0 : params.GetAttestationNonce().Value(), params.GetRemoteVendorId().Value(), params.GetRemoteProductId().Value());
3568 :
3569 0 : CHIP_ERROR err = CheckForRevokedDACChain(info);
3570 :
3571 0 : if (err != CHIP_NO_ERROR)
3572 : {
3573 0 : ChipLogError(Controller, "Error validating device's DAC chain revocation status: %" CHIP_ERROR_FORMAT, err.Format());
3574 0 : CommissioningStageComplete(CHIP_ERROR_FAILED_DEVICE_ATTESTATION);
3575 0 : return;
3576 : }
3577 : }
3578 0 : break;
3579 0 : case CommissioningStage::kJCMTrustVerification: {
3580 0 : CHIP_ERROR err = StartJCMTrustVerification(proxy);
3581 0 : if (err != CHIP_NO_ERROR)
3582 : {
3583 0 : ChipLogError(Controller, "Failed to start JCM Trust Verification: %" CHIP_ERROR_FORMAT, err.Format());
3584 0 : CommissioningStageComplete(err);
3585 0 : return;
3586 : }
3587 0 : break;
3588 : }
3589 :
3590 0 : case CommissioningStage::kSendOpCertSigningRequest: {
3591 0 : if (!params.GetCSRNonce().HasValue())
3592 : {
3593 0 : ChipLogError(Controller, "No CSR nonce found");
3594 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3595 0 : return;
3596 : }
3597 0 : CHIP_ERROR err = SendOperationalCertificateSigningRequestCommand(proxy, params.GetCSRNonce().Value(), timeout);
3598 0 : if (err != CHIP_NO_ERROR)
3599 : {
3600 : // We won't get any async callbacks here, so just complete our stage.
3601 0 : ChipLogError(Controller, "Failed to send CSR request: %" CHIP_ERROR_FORMAT, err.Format());
3602 0 : CommissioningStageComplete(err);
3603 0 : return;
3604 : }
3605 0 : break;
3606 : }
3607 0 : case CommissioningStage::kValidateCSR: {
3608 0 : if (!params.GetNOCChainGenerationParameters().HasValue() || !params.GetDAC().HasValue() || !params.GetCSRNonce().HasValue())
3609 : {
3610 0 : ChipLogError(Controller, "Unable to validate CSR");
3611 0 : return CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3612 : }
3613 : // This is non-blocking, so send the callback immediately.
3614 0 : CHIP_ERROR err = ValidateCSR(proxy, params.GetNOCChainGenerationParameters().Value().nocsrElements,
3615 0 : params.GetNOCChainGenerationParameters().Value().signature, params.GetDAC().Value(),
3616 0 : params.GetCSRNonce().Value());
3617 0 : if (err != CHIP_NO_ERROR)
3618 : {
3619 0 : ChipLogError(Controller, "Failed to validate CSR: %" CHIP_ERROR_FORMAT, err.Format());
3620 : }
3621 0 : CommissioningStageComplete(err);
3622 0 : return;
3623 : }
3624 : break;
3625 0 : case CommissioningStage::kGenerateNOCChain: {
3626 0 : if (!params.GetNOCChainGenerationParameters().HasValue() || !params.GetDAC().HasValue() || !params.GetPAI().HasValue() ||
3627 0 : !params.GetCSRNonce().HasValue())
3628 : {
3629 0 : ChipLogError(Controller, "Unable to generate NOC chain parameters");
3630 0 : return CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3631 : }
3632 0 : CHIP_ERROR err = ProcessCSR(proxy, params.GetNOCChainGenerationParameters().Value().nocsrElements,
3633 0 : params.GetNOCChainGenerationParameters().Value().signature, params.GetDAC().Value(),
3634 0 : params.GetPAI().Value(), params.GetCSRNonce().Value());
3635 0 : if (err != CHIP_NO_ERROR)
3636 : {
3637 0 : ChipLogError(Controller, "Failed to process Operational Certificate Signing Request (CSR): %" CHIP_ERROR_FORMAT,
3638 : err.Format());
3639 0 : CommissioningStageComplete(err);
3640 0 : return;
3641 : }
3642 : }
3643 0 : break;
3644 0 : case CommissioningStage::kSendTrustedRootCert: {
3645 0 : if (!params.GetRootCert().HasValue() || !params.GetNoc().HasValue())
3646 : {
3647 0 : ChipLogError(Controller, "No trusted root cert or NOC specified");
3648 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3649 0 : return;
3650 : }
3651 0 : CHIP_ERROR err = SendTrustedRootCertificate(proxy, params.GetRootCert().Value(), timeout);
3652 0 : if (err != CHIP_NO_ERROR)
3653 : {
3654 0 : ChipLogError(Controller, "Error sending trusted root certificate: %" CHIP_ERROR_FORMAT, err.Format());
3655 0 : CommissioningStageComplete(err);
3656 0 : return;
3657 : }
3658 :
3659 0 : err = proxy->SetPeerId(params.GetRootCert().Value(), params.GetNoc().Value());
3660 0 : if (err != CHIP_NO_ERROR)
3661 : {
3662 0 : ChipLogError(Controller, "Error setting peer id: %" CHIP_ERROR_FORMAT, err.Format());
3663 0 : CommissioningStageComplete(err);
3664 0 : return;
3665 : }
3666 0 : if (!IsOperationalNodeId(proxy->GetDeviceId()))
3667 : {
3668 0 : ChipLogError(Controller, "Given node ID is not an operational node ID");
3669 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3670 0 : return;
3671 : }
3672 : }
3673 0 : break;
3674 0 : case CommissioningStage::kSendNOC: {
3675 0 : if (!params.GetNoc().HasValue() || !params.GetIpk().HasValue() || !params.GetAdminSubject().HasValue())
3676 : {
3677 0 : ChipLogError(Controller, "AddNOC contents not specified");
3678 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3679 0 : return;
3680 : }
3681 0 : CHIP_ERROR err = SendOperationalCertificate(proxy, params.GetNoc().Value(), params.GetIcac(), params.GetIpk().Value(),
3682 0 : params.GetAdminSubject().Value(), timeout);
3683 0 : if (err != CHIP_NO_ERROR)
3684 : {
3685 : // We won't get any async callbacks here, so just complete our stage.
3686 0 : ChipLogError(Controller, "Error installing operational certificate with AddNOC: %" CHIP_ERROR_FORMAT, err.Format());
3687 0 : CommissioningStageComplete(err);
3688 0 : return;
3689 : }
3690 0 : break;
3691 : }
3692 0 : case CommissioningStage::kConfigureTrustedTimeSource: {
3693 0 : if (!params.GetTrustedTimeSource().HasValue())
3694 : {
3695 0 : ChipLogError(Controller, "ConfigureTrustedTimeSource stage called with no trusted time source data!");
3696 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3697 0 : return;
3698 : }
3699 0 : TimeSynchronization::Commands::SetTrustedTimeSource::Type request;
3700 0 : request.trustedTimeSource = params.GetTrustedTimeSource().Value();
3701 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnBasicSuccess, OnBasicFailure, endpoint, timeout);
3702 0 : if (err != CHIP_NO_ERROR)
3703 : {
3704 : // We won't get any async callbacks here, so just complete our stage.
3705 0 : ChipLogError(Controller, "Failed to send SendTrustedTimeSource command: %" CHIP_ERROR_FORMAT, err.Format());
3706 0 : CommissioningStageComplete(err);
3707 0 : return;
3708 : }
3709 0 : break;
3710 : }
3711 0 : case CommissioningStage::kRequestWiFiCredentials: {
3712 0 : if (!mPairingDelegate)
3713 : {
3714 0 : ChipLogError(Controller, "Unable to request Wi-Fi credentials: no delegate available");
3715 0 : CommissioningStageComplete(CHIP_ERROR_INCORRECT_STATE);
3716 0 : return;
3717 : }
3718 :
3719 0 : CHIP_ERROR err = mPairingDelegate->WiFiCredentialsNeeded(endpoint);
3720 0 : CommissioningStageComplete(err);
3721 0 : return;
3722 : }
3723 0 : case CommissioningStage::kRequestThreadCredentials: {
3724 0 : if (!mPairingDelegate)
3725 : {
3726 0 : ChipLogError(Controller, "Unable to request Thread credentials: no delegate available");
3727 0 : CommissioningStageComplete(CHIP_ERROR_INCORRECT_STATE);
3728 0 : return;
3729 : }
3730 :
3731 0 : CHIP_ERROR err = mPairingDelegate->ThreadCredentialsNeeded(endpoint);
3732 0 : CommissioningStageComplete(err);
3733 0 : return;
3734 : }
3735 0 : case CommissioningStage::kWiFiNetworkSetup: {
3736 0 : if (!params.GetWiFiCredentials().HasValue())
3737 : {
3738 0 : ChipLogError(Controller, "No wifi credentials specified");
3739 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3740 0 : return;
3741 : }
3742 :
3743 0 : NetworkCommissioning::Commands::AddOrUpdateWiFiNetwork::Type request;
3744 0 : request.ssid = params.GetWiFiCredentials().Value().ssid;
3745 0 : request.credentials = params.GetWiFiCredentials().Value().credentials;
3746 0 : request.breadcrumb.Emplace(breadcrumb);
3747 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnNetworkConfigResponse, OnBasicFailure, endpoint, timeout);
3748 0 : if (err != CHIP_NO_ERROR)
3749 : {
3750 : // We won't get any async callbacks here, so just complete our stage.
3751 0 : ChipLogError(Controller, "Failed to send AddOrUpdateWiFiNetwork command: %" CHIP_ERROR_FORMAT, err.Format());
3752 0 : CommissioningStageComplete(err);
3753 0 : return;
3754 : }
3755 : }
3756 0 : break;
3757 0 : case CommissioningStage::kThreadNetworkSetup: {
3758 0 : if (!params.GetThreadOperationalDataset().HasValue())
3759 : {
3760 0 : ChipLogError(Controller, "No thread credentials specified");
3761 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3762 0 : return;
3763 : }
3764 0 : NetworkCommissioning::Commands::AddOrUpdateThreadNetwork::Type request;
3765 0 : request.operationalDataset = params.GetThreadOperationalDataset().Value();
3766 0 : request.breadcrumb.Emplace(breadcrumb);
3767 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnNetworkConfigResponse, OnBasicFailure, endpoint, timeout);
3768 0 : if (err != CHIP_NO_ERROR)
3769 : {
3770 : // We won't get any async callbacks here, so just complete our stage.
3771 0 : ChipLogError(Controller, "Failed to send AddOrUpdateThreadNetwork command: %" CHIP_ERROR_FORMAT, err.Format());
3772 0 : CommissioningStageComplete(err);
3773 0 : return;
3774 : }
3775 : }
3776 0 : break;
3777 0 : case CommissioningStage::kFailsafeBeforeWiFiEnable:
3778 : FALLTHROUGH;
3779 : case CommissioningStage::kFailsafeBeforeThreadEnable:
3780 : // Before we try to do network enablement, make sure that our fail-safe
3781 : // is set far enough out that we can later try to do operational
3782 : // discovery without it timing out.
3783 0 : ExtendFailsafeBeforeNetworkEnable(proxy, params, step);
3784 0 : break;
3785 0 : case CommissioningStage::kWiFiNetworkEnable: {
3786 0 : if (!params.GetWiFiCredentials().HasValue())
3787 : {
3788 0 : ChipLogError(Controller, "No wifi credentials specified");
3789 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3790 0 : return;
3791 : }
3792 0 : NetworkCommissioning::Commands::ConnectNetwork::Type request;
3793 0 : request.networkID = params.GetWiFiCredentials().Value().ssid;
3794 0 : request.breadcrumb.Emplace(breadcrumb);
3795 :
3796 0 : CHIP_ERROR err = CHIP_NO_ERROR;
3797 0 : ChipLogProgress(Controller, "SendCommand kWiFiNetworkEnable, supportsConcurrentConnection=%s",
3798 : params.GetSupportsConcurrentConnection().HasValue()
3799 : ? (params.GetSupportsConcurrentConnection().Value() ? "true" : "false")
3800 : : "missing");
3801 0 : err = SendCommissioningCommand(proxy, request, OnConnectNetworkResponse, OnBasicFailure, endpoint, timeout);
3802 :
3803 0 : if (err != CHIP_NO_ERROR)
3804 : {
3805 : // We won't get any async callbacks here, so just complete our stage.
3806 0 : ChipLogError(Controller, "Failed to send WiFi ConnectNetwork command: %" CHIP_ERROR_FORMAT, err.Format());
3807 0 : CommissioningStageComplete(err);
3808 0 : return;
3809 : }
3810 : }
3811 0 : break;
3812 0 : case CommissioningStage::kThreadNetworkEnable: {
3813 0 : ByteSpan extendedPanId;
3814 0 : chip::Thread::OperationalDataset operationalDataset;
3815 0 : if (!params.GetThreadOperationalDataset().HasValue() ||
3816 0 : operationalDataset.Init(params.GetThreadOperationalDataset().Value()) != CHIP_NO_ERROR ||
3817 0 : operationalDataset.GetExtendedPanIdAsByteSpan(extendedPanId) != CHIP_NO_ERROR)
3818 : {
3819 0 : ChipLogError(Controller, "Invalid Thread operational dataset configured at commissioner!");
3820 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3821 0 : return;
3822 : }
3823 0 : NetworkCommissioning::Commands::ConnectNetwork::Type request;
3824 0 : request.networkID = extendedPanId;
3825 0 : request.breadcrumb.Emplace(breadcrumb);
3826 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnConnectNetworkResponse, OnBasicFailure, endpoint, timeout);
3827 0 : if (err != CHIP_NO_ERROR)
3828 : {
3829 : // We won't get any async callbacks here, so just complete our stage.
3830 0 : ChipLogError(Controller, "Failed to send Thread ConnectNetwork command: %" CHIP_ERROR_FORMAT, err.Format());
3831 0 : CommissioningStageComplete(err);
3832 0 : return;
3833 : }
3834 : }
3835 0 : break;
3836 0 : case CommissioningStage::kICDGetRegistrationInfo: {
3837 0 : GetPairingDelegate()->OnICDRegistrationInfoRequired();
3838 0 : return;
3839 : }
3840 : break;
3841 0 : case CommissioningStage::kICDRegistration: {
3842 0 : IcdManagement::Commands::RegisterClient::Type request;
3843 :
3844 0 : if (!(params.GetICDCheckInNodeId().HasValue() && params.GetICDMonitoredSubject().HasValue() &&
3845 0 : params.GetICDSymmetricKey().HasValue()))
3846 : {
3847 0 : ChipLogError(Controller, "No ICD Registration information provided!");
3848 0 : CommissioningStageComplete(CHIP_ERROR_INCORRECT_STATE);
3849 0 : return;
3850 : }
3851 :
3852 0 : request.checkInNodeID = params.GetICDCheckInNodeId().Value();
3853 0 : request.monitoredSubject = params.GetICDMonitoredSubject().Value();
3854 0 : request.key = params.GetICDSymmetricKey().Value();
3855 :
3856 : CHIP_ERROR err =
3857 0 : SendCommissioningCommand(proxy, request, OnICDManagementRegisterClientResponse, OnBasicFailure, endpoint, timeout);
3858 0 : if (err != CHIP_NO_ERROR)
3859 : {
3860 : // We won't get any async callbacks here, so just complete our stage.
3861 0 : ChipLogError(Controller, "Failed to send IcdManagement.RegisterClient command: %" CHIP_ERROR_FORMAT, err.Format());
3862 0 : CommissioningStageComplete(err);
3863 0 : return;
3864 : }
3865 : }
3866 0 : break;
3867 0 : case CommissioningStage::kEvictPreviousCaseSessions: {
3868 0 : auto scopedPeerId = GetPeerScopedId(proxy->GetDeviceId());
3869 :
3870 : // If we ever had a commissioned device with this node ID before, we may
3871 : // have stale sessions to it. Make sure we don't re-use any of those,
3872 : // because clearly they are not related to this new device we are
3873 : // commissioning. We only care about sessions we might reuse, so just
3874 : // clearing the ones associated with our fabric index is good enough and
3875 : // we don't need to worry about ExpireAllSessionsOnLogicalFabric.
3876 0 : mSystemState->SessionMgr()->ExpireAllSessions(scopedPeerId);
3877 : #if CHIP_CONFIG_ENABLE_ADDRESS_RESOLVE_FALLBACK
3878 : Transport::Type type = proxy->GetSecureSession().Value()->AsSecureSession()->GetPeerAddress().GetTransportType();
3879 : // cache address if we are connected over TCP or UDP
3880 : if (type == Transport::Type::kTcp || type == Transport::Type::kUdp)
3881 : {
3882 : // Store the address we are using for PASE as a fallback for operational discovery
3883 : ResolveResult result;
3884 : result.address = proxy->GetSecureSession().Value()->AsSecureSession()->GetPeerAddress();
3885 : result.mrpRemoteConfig = proxy->GetSecureSession().Value()->GetRemoteMRPConfig();
3886 : // Note: supportsTcpClient and supportsTcpServer are device capabilities from DNS-SD TXT records,
3887 : // not derivable from the transport type. They remain false (default) here.
3888 : // TODO: Consider passing these through RendezvousParameters if available from SetUpCodePairer.
3889 : mFallbackOperationalResolveResult.SetValue(result);
3890 : }
3891 : #endif // CHIP_CONFIG_ENABLE_ADDRESS_RESOLVE_FALLBACK
3892 0 : CommissioningStageComplete(CHIP_NO_ERROR);
3893 0 : return;
3894 : }
3895 0 : case CommissioningStage::kFindOperationalForStayActive:
3896 : case CommissioningStage::kFindOperationalForCommissioningComplete: {
3897 : // If there is an error, CommissioningStageComplete will be called from OnDeviceConnectionFailureFn.
3898 0 : auto scopedPeerId = GetPeerScopedId(proxy->GetDeviceId());
3899 : MATTER_LOG_METRIC_BEGIN(kMetricDeviceCommissioningOperationalSetup);
3900 0 : mSystemState->CASESessionMgr()->FindOrEstablishSession(
3901 : scopedPeerId, &mOnDeviceConnectedCallback, &mOnDeviceConnectionFailureCallback,
3902 : #if CHIP_DEVICE_CONFIG_ENABLE_AUTOMATIC_CASE_RETRIES
3903 : /* attemptCount = */ 3, &mOnDeviceConnectionRetryCallback,
3904 : #endif // CHIP_DEVICE_CONFIG_ENABLE_AUTOMATIC_CASE_RETRIES
3905 0 : TransportPayloadCapability::kMRPPayload, mFallbackOperationalResolveResult);
3906 : }
3907 0 : break;
3908 0 : case CommissioningStage::kPrimaryOperationalNetworkFailed: {
3909 : // nothing to do. This stage indicates that the primary operational network failed and the network config should be
3910 : // removed later.
3911 0 : break;
3912 : }
3913 0 : case CommissioningStage::kRemoveWiFiNetworkConfig: {
3914 0 : NetworkCommissioning::Commands::RemoveNetwork::Type request;
3915 0 : request.networkID = params.GetWiFiCredentials().Value().ssid;
3916 0 : request.breadcrumb.Emplace(breadcrumb);
3917 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnNetworkConfigResponse, OnBasicFailure, endpoint, timeout);
3918 0 : if (err != CHIP_NO_ERROR)
3919 : {
3920 : // We won't get any async callbacks here, so just complete our stage.
3921 0 : ChipLogError(Controller, "Failed to send RemoveNetwork command: %" CHIP_ERROR_FORMAT, err.Format());
3922 0 : CommissioningStageComplete(err);
3923 0 : return;
3924 : }
3925 0 : break;
3926 : }
3927 0 : case CommissioningStage::kRemoveThreadNetworkConfig: {
3928 0 : ByteSpan extendedPanId;
3929 0 : chip::Thread::OperationalDataset operationalDataset;
3930 0 : if (!params.GetThreadOperationalDataset().HasValue() ||
3931 0 : operationalDataset.Init(params.GetThreadOperationalDataset().Value()) != CHIP_NO_ERROR ||
3932 0 : operationalDataset.GetExtendedPanIdAsByteSpan(extendedPanId) != CHIP_NO_ERROR)
3933 : {
3934 0 : ChipLogError(Controller, "Invalid Thread operational dataset configured at commissioner!");
3935 0 : CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT);
3936 0 : return;
3937 : }
3938 0 : NetworkCommissioning::Commands::RemoveNetwork::Type request;
3939 0 : request.networkID = extendedPanId;
3940 0 : request.breadcrumb.Emplace(breadcrumb);
3941 0 : CHIP_ERROR err = SendCommissioningCommand(proxy, request, OnNetworkConfigResponse, OnBasicFailure, endpoint, timeout);
3942 0 : if (err != CHIP_NO_ERROR)
3943 : {
3944 : // We won't get any async callbacks here, so just complete our stage.
3945 0 : ChipLogError(Controller, "Failed to send RemoveNetwork command: %" CHIP_ERROR_FORMAT, err.Format());
3946 0 : CommissioningStageComplete(err);
3947 0 : return;
3948 : }
3949 0 : break;
3950 : }
3951 0 : case CommissioningStage::kICDSendStayActive: {
3952 0 : if (!(params.GetICDStayActiveDurationMsec().HasValue()))
3953 : {
3954 0 : ChipLogProgress(Controller, "Skipping kICDSendStayActive");
3955 0 : CommissioningStageComplete(CHIP_NO_ERROR);
3956 0 : return;
3957 : }
3958 :
3959 : // StayActive Command happens over CASE Connection
3960 0 : IcdManagement::Commands::StayActiveRequest::Type request;
3961 0 : request.stayActiveDuration = params.GetICDStayActiveDurationMsec().Value();
3962 0 : ChipLogError(Controller, "Send ICD StayActive with Duration %u", request.stayActiveDuration);
3963 : CHIP_ERROR err =
3964 0 : SendCommissioningCommand(proxy, request, OnICDManagementStayActiveResponse, OnBasicFailure, endpoint, timeout);
3965 0 : if (err != CHIP_NO_ERROR)
3966 : {
3967 : // We won't get any async callbacks here, so just complete our stage.
3968 0 : ChipLogError(Controller, "Failed to send IcdManagement.StayActive command: %" CHIP_ERROR_FORMAT, err.Format());
3969 0 : CommissioningStageComplete(err);
3970 0 : return;
3971 : }
3972 : }
3973 0 : break;
3974 0 : case CommissioningStage::kSendComplete: {
3975 : // CommissioningComplete command happens over the CASE connection.
3976 : GeneralCommissioning::Commands::CommissioningComplete::Type request;
3977 : CHIP_ERROR err =
3978 0 : SendCommissioningCommand(proxy, request, OnCommissioningCompleteResponse, OnBasicFailure, endpoint, timeout);
3979 0 : if (err != CHIP_NO_ERROR)
3980 : {
3981 : // We won't get any async callbacks here, so just complete our stage.
3982 0 : ChipLogError(Controller, "Failed to send CommissioningComplete command: %" CHIP_ERROR_FORMAT, err.Format());
3983 0 : CommissioningStageComplete(err);
3984 0 : return;
3985 : }
3986 : }
3987 0 : break;
3988 : #if CHIP_DEVICE_CONFIG_ENABLE_NFC_BASED_COMMISSIONING
3989 : case CommissioningStage::kUnpoweredPhaseComplete:
3990 : ChipLogProgress(Controller, "Completed unpowered commissioning phase, marking commissioning as complete");
3991 : CommissioningStageComplete(CHIP_NO_ERROR);
3992 : break;
3993 : #endif
3994 0 : case CommissioningStage::kCleanup:
3995 0 : CleanupCommissioning(proxy, proxy->GetDeviceId(), params.GetCompletionStatus());
3996 0 : break;
3997 0 : case CommissioningStage::kError:
3998 0 : mCommissioningStage = CommissioningStage::kSecurePairing;
3999 0 : break;
4000 0 : case CommissioningStage::kSecurePairing:
4001 0 : break;
4002 : }
4003 : }
4004 :
4005 0 : void DeviceCommissioner::ExtendFailsafeBeforeNetworkEnable(DeviceProxy * device, CommissioningParameters & params,
4006 : CommissioningStage step)
4007 : {
4008 0 : auto * commissioneeDevice = FindCommissioneeDevice(device->GetDeviceId());
4009 0 : if (device != commissioneeDevice)
4010 : {
4011 : // Not a commissionee device; just return.
4012 0 : ChipLogError(Controller, "Trying to extend fail-safe for an unknown commissionee with device id " ChipLogFormatX64,
4013 : ChipLogValueX64(device->GetDeviceId()));
4014 0 : CommissioningStageComplete(CHIP_ERROR_INCORRECT_STATE, CommissioningDelegate::CommissioningReport());
4015 0 : return;
4016 : }
4017 :
4018 : // Try to make sure we have at least enough time for our expected
4019 : // commissioning bits plus the MRP retries for a Sigma1.
4020 0 : uint16_t failSafeTimeoutSecs = params.GetFailsafeTimerSeconds().ValueOr(kDefaultFailsafeTimeout);
4021 0 : auto sigma1Timeout = CASESession::ComputeSigma1ResponseTimeout(commissioneeDevice->GetPairing().GetRemoteMRPConfig());
4022 0 : uint16_t sigma1TimeoutSecs = std::chrono::duration_cast<System::Clock::Seconds16>(sigma1Timeout).count();
4023 0 : if (UINT16_MAX - failSafeTimeoutSecs < sigma1TimeoutSecs)
4024 : {
4025 0 : failSafeTimeoutSecs = UINT16_MAX;
4026 : }
4027 : else
4028 : {
4029 0 : failSafeTimeoutSecs = static_cast<uint16_t>(failSafeTimeoutSecs + sigma1TimeoutSecs);
4030 : }
4031 :
4032 0 : if (!ExtendArmFailSafeInternal(commissioneeDevice, step, failSafeTimeoutSecs, MakeOptional(kMinimumCommissioningStepTimeout),
4033 : OnArmFailSafe, OnBasicFailure, /* fireAndForget = */ false))
4034 : {
4035 : // A false return is fine; we don't want to make the fail-safe shorter here.
4036 0 : CommissioningStageComplete(CHIP_NO_ERROR, CommissioningDelegate::CommissioningReport());
4037 : }
4038 : }
4039 :
4040 0 : bool DeviceCommissioner::IsAttestationInformationMissing(const CommissioningParameters & params)
4041 : {
4042 0 : if (!params.GetAttestationElements().HasValue() || !params.GetAttestationSignature().HasValue() ||
4043 0 : !params.GetAttestationNonce().HasValue() || !params.GetDAC().HasValue() || !params.GetPAI().HasValue() ||
4044 0 : !params.GetRemoteVendorId().HasValue() || !params.GetRemoteProductId().HasValue())
4045 : {
4046 0 : return true;
4047 : }
4048 :
4049 0 : return false;
4050 : }
4051 :
4052 0 : CHIP_ERROR DeviceController::GetCompressedFabricIdBytes(MutableByteSpan & outBytes) const
4053 : {
4054 0 : const auto * fabricInfo = GetFabricInfo();
4055 0 : VerifyOrReturnError(fabricInfo != nullptr, CHIP_ERROR_INVALID_FABRIC_INDEX);
4056 0 : return fabricInfo->GetCompressedFabricIdBytes(outBytes);
4057 : }
4058 :
4059 0 : CHIP_ERROR DeviceController::GetRootPublicKey(Crypto::P256PublicKey & outRootPublicKey) const
4060 : {
4061 0 : const auto * fabricTable = GetFabricTable();
4062 0 : VerifyOrReturnError(fabricTable != nullptr, CHIP_ERROR_INCORRECT_STATE);
4063 0 : return fabricTable->FetchRootPubkey(mFabricIndex, outRootPublicKey);
4064 : }
4065 :
4066 0 : bool DeviceCommissioner::HasValidCommissioningMode(const Dnssd::CommissionNodeData & nodeData)
4067 : {
4068 0 : if (nodeData.commissioningMode == to_underlying(Dnssd::CommissioningMode::kDisabled))
4069 : {
4070 0 : ChipLogProgress(Controller, "Discovered device does not have an open commissioning window.");
4071 0 : return false;
4072 : }
4073 0 : return true;
4074 : }
4075 :
4076 : } // namespace Controller
4077 : } // namespace chip
|
