samples: matter: lock: Add ValidatePINResult

Return `ValidatePINResult` containing user id and credential used for
validation.

Signed-off-by: Adrian Gielniewski <adrian.gielniewski@nordicsemi.no>

Author: adigie

samples/matter/lock/src/access/access_manager.cpp

@@ -54,7 +54,8 @@ bool AccessManager<CRED_BIT_MASK>::ValidateCustom(CredentialTypeEnum type, chip:
 }
 
 template <CredentialsBits CRED_BIT_MASK>
-bool AccessManager<CRED_BIT_MASK>::ValidatePIN(const Optional<ByteSpan> &pinCode, OperationErrorEnum &err)
+bool AccessManager<CRED_BIT_MASK>::ValidatePIN(const Optional<ByteSpan> &pinCode, OperationErrorEnum &err,
+					       Nullable<ValidatePINResult> &result)
 {
 	/* Optionality of the PIN code is validated by the caller, so assume it is OK not to provide the PIN
 	 * code. */
@@ -72,6 +73,18 @@ bool AccessManager<CRED_BIT_MASK>::ValidatePIN(const Optional<ByteSpan> &pinCode
 			}
 
 			if (credential.credentialData.data_equal(pinCode.Value())) {
+				uint32_t credentialUserId;
+				if (GetCredentialUserId(index, CredentialTypeEnum::kPin, credentialUserId) ==
+				    CHIP_NO_ERROR) {
+					result = ValidatePINResult{
+						.userId = static_cast<uint16_t>(credentialUserId),
+						.credential = LockOpCredentials{ CredentialTypeEnum::kPin,
+										 static_cast<uint16_t>(index) },
+					};
+				} else {
+					result = {};
+				}
+
 				LOG_DBG("Valid lock PIN code provided");
 				return true;
 			}

samples/matter/lock/src/access/access_manager.h

@@ -13,6 +13,11 @@
 
 template <DoorLockData::CredentialsBits CRED_BIT_MASK> class AccessManager {
 public:
+	struct ValidatePINResult {
+		uint16_t userId;
+		LockOpCredentials credential;
+	};
+
 	/**
 	 * @brief Signature of the callback fired when the credential is set.
 	 *
@@ -234,9 +239,11 @@ template <DoorLockData::CredentialsBits CRED_BIT_MASK> class AccessManager {
 	 *
 	 * @param pinCode PIN code data.
 	 * @param err specific error code enumeration.
+	 * @param result user and credential data set on success.
 	 * @return true on success, false otherwise.
 	 */
-	bool ValidatePIN(const Optional<chip::ByteSpan> &pinCode, OperationErrorEnum &err);
+	bool ValidatePIN(const Optional<chip::ByteSpan> &pinCode, OperationErrorEnum &err,
+			 Nullable<ValidatePINResult> &result);
 	bool ValidateCustom(CredentialTypeEnum type, chip::MutableByteSpan &secret);
 
 	/**

samples/matter/lock/src/bolt_lock_manager.cpp

@@ -96,9 +96,10 @@ DlStatus BoltLockManager::SetHolidaySchedule(uint8_t holidayIndex, DlScheduleSta
 
 #endif /* CONFIG_LOCK_SCHEDULES */
 
-bool BoltLockManager::ValidatePIN(const Optional<ByteSpan> &pinCode, OperationErrorEnum &err)
+bool BoltLockManager::ValidatePIN(const Optional<chip::ByteSpan> &pinCode, OperationErrorEnum &err,
+				  Nullable<ValidatePINResult> &result)
 {
-	return AccessMgr::Instance().ValidatePIN(pinCode, err);
+	return AccessMgr::Instance().ValidatePIN(pinCode, err, result);
 }
 
 void BoltLockManager::SetRequirePIN(bool require)

samples/matter/lock/src/bolt_lock_manager.h

@@ -18,6 +18,8 @@
 struct BoltLockManagerEvent;
 
 class BoltLockManager {
+	using AccessMgr = AccessManager<DoorLockData::PIN>;
+
 public:
 	static constexpr size_t kMaxCredentialLength = 128;
 
@@ -39,6 +41,7 @@ class BoltLockManager {
 
 	using OperationSource = chip::app::Clusters::DoorLock::OperationSourceEnum;
 	using StateChangeCallback = void (*)(State, OperationSource);
+	using ValidatePINResult = AccessMgr::ValidatePINResult;
 
 	static constexpr uint32_t kActuatorMovementTimeMs = 2000;
 
@@ -74,7 +77,8 @@ class BoltLockManager {
 				    uint32_t localEndTime, OperatingModeEnum operatingMode);
 #endif /* CONFIG_LOCK_SCHEDULES */
 
-	bool ValidatePIN(const Optional<chip::ByteSpan> &pinCode, OperationErrorEnum &err);
+	bool ValidatePIN(const Optional<chip::ByteSpan> &pinCode, OperationErrorEnum &err,
+			 Nullable<ValidatePINResult> &result);
 
 	void Lock(OperationSource source);
 	void Unlock(OperationSource source);
@@ -85,7 +89,6 @@ class BoltLockManager {
 	void FactoryReset();
 
 private:
-	using AccessMgr = AccessManager<DoorLockData::PIN>;
 	friend class AppTask;
 
 	void SetState(State state, OperationSource source);

samples/matter/lock/src/zcl_callbacks.cpp

@@ -63,28 +63,30 @@ bool emberAfPluginDoorLockOnDoorLockCommand(EndpointId endpointId, const Nullabl
 					    const Nullable<chip::NodeId> &nodeId, const Optional<ByteSpan> &pinCode,
 					    OperationErrorEnum &err)
 {
-	bool result = BoltLockMgr().ValidatePIN(pinCode, err);
+	Nullable<BoltLockManager::ValidatePINResult> validatePINResult;
+	bool success = BoltLockMgr().ValidatePIN(pinCode, err, validatePINResult);
 
 	/* Handle changing attribute state on command reception */
-	if (result) {
+	if (success) {
 		BoltLockMgr().Lock(BoltLockManager::OperationSource::kRemote);
 	}
 
-	return result;
+	return success;
 }
 
 bool emberAfPluginDoorLockOnDoorUnlockCommand(EndpointId endpointId, const Nullable<chip::FabricIndex> &fabricIdx,
 					      const Nullable<chip::NodeId> &nodeId, const Optional<ByteSpan> &pinCode,
 					      OperationErrorEnum &err)
 {
-	bool result = BoltLockMgr().ValidatePIN(pinCode, err);
+	Nullable<BoltLockManager::ValidatePINResult> validatePINResult;
+	bool success = BoltLockMgr().ValidatePIN(pinCode, err, validatePINResult);
 
 	/* Handle changing attribute state on command reception */
-	if (result) {
+	if (success) {
 		BoltLockMgr().Unlock(BoltLockManager::OperationSource::kRemote);
 	}
 
-	return result;
+	return success;
 }
 
 void emberAfDoorLockClusterInitCallback(EndpointId endpoint)