forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdoor-lock-server.cpp
4485 lines (3926 loc) · 198 KB
/
door-lock-server.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
*
* Copyright (c) 2020 - 2024 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/****************************************************************************
* @file
* @brief Routines for the Door Lock Server plugin.
*******************************************************************************
******************************************************************************/
#include "door-lock-server.h"
#include <app-common/zap-generated/attributes/Accessors.h>
#include <app-common/zap-generated/callback.h>
#include <app-common/zap-generated/ids/Clusters.h>
#include <app/AttributeAccessInterfaceRegistry.h>
#include <app/EventLogging.h>
#include <app/server/Server.h>
#include <app/util/attribute-storage.h>
#include <app/util/config.h>
#include <cinttypes>
#include <app/CommandHandler.h>
#include <app/ConcreteAttributePath.h>
#include <app/ConcreteCommandPath.h>
#include <lib/support/CodeUtils.h>
using namespace chip;
using namespace chip::app;
using namespace chip::app::DataModel;
using namespace chip::app::Clusters::DoorLock;
using namespace chip::app::Clusters::DoorLock::Attributes;
using chip::Protocols::InteractionModel::ClusterStatusCode;
using chip::Protocols::InteractionModel::Status;
static constexpr uint8_t DOOR_LOCK_SCHEDULE_MAX_HOUR = 23;
static constexpr uint8_t DOOR_LOCK_SCHEDULE_MAX_MINUTE = 59;
static constexpr uint8_t DOOR_LOCK_ALIRO_CREDENTIAL_SIZE = 65;
static constexpr uint32_t DOOR_LOCK_MAX_LOCK_TIMEOUT_SEC = MAX_INT32U_VALUE / MILLISECOND_TICKS_PER_SECOND;
DoorLockServer DoorLockServer::instance;
class DoorLockClusterFabricDelegate : public chip::FabricTable::Delegate
{
void OnFabricRemoved(const FabricTable & fabricTable, FabricIndex fabricIndex) override
{
for (auto endpointId : EnabledEndpointsWithServerCluster(Clusters::DoorLock::Id))
{
if (!DoorLockServer::Instance().OnFabricRemoved(endpointId, fabricIndex))
{
ChipLogError(Zcl,
"Unable to handle fabric removal from the Door Lock Server instance [endpointId=%d,fabricIndex=%d]",
endpointId, fabricIndex);
}
}
}
};
static DoorLockClusterFabricDelegate gFabricDelegate;
/**********************************************************
* DoorLockServer public methods
*********************************************************/
DoorLockServer & DoorLockServer::Instance()
{
return instance;
}
/**
* @brief Initializes given endpoint for a server.
*
* @param endpointId
*/
void DoorLockServer::InitServer(EndpointId endpointId)
{
CHIP_ERROR err = InitEndpoint(endpointId);
// We have no way to communicate this error, so just log it.
if (err != CHIP_NO_ERROR)
{
ChipLogError(Zcl, "Door Lock cluster initialization on endpoint %d failed: %" CHIP_ERROR_FORMAT, endpointId, err.Format());
}
}
CHIP_ERROR DoorLockServer::InitEndpoint(EndpointId endpointId, Delegate * delegate)
{
ChipLogProgress(Zcl, "Door Lock cluster initialized at endpoint #%u", endpointId);
auto status = Attributes::LockState::SetNull(endpointId);
if (Status::Success != status)
{
ChipLogError(Zcl, "[InitDoorLockServer] Unable to set the Lock State attribute to null [status=%d]", to_underlying(status));
}
SetActuatorEnabled(endpointId, true);
auto * endpointContext = getContext(endpointId);
if (!endpointContext)
{
ChipLogError(Zcl, "Invalid endpoint %d for initializing lock server: no endpoint context available", endpointId);
return CHIP_ERROR_INVALID_ARGUMENT;
}
endpointContext->lockoutEndTimestamp = endpointContext->lockoutEndTimestamp.zero();
endpointContext->wrongCodeEntryAttempts = 0;
endpointContext->delegate = delegate;
return CHIP_NO_ERROR;
}
void DoorLockServer::ShutdownEndpoint(EndpointId endpointId)
{
auto * endpointContext = getContext(endpointId);
if (!endpointContext)
{
ChipLogError(Zcl, "Invalid endpoint %d for shutting down lock server: no endpoint context available", endpointId);
return;
}
endpointContext->delegate = nullptr;
}
CHIP_ERROR DoorLockServer::SetDelegate(chip::EndpointId endpointId, chip::app::Clusters::DoorLock::Delegate * delegate)
{
if (!delegate)
{
ChipLogError(Zcl, "Trying to set a null DoorLock::Delegate on endpoint %d", endpointId);
return CHIP_ERROR_INVALID_ARGUMENT;
}
auto * endpointContext = getContext(endpointId);
if (!endpointContext)
{
ChipLogError(Zcl, "Invalid endpoint %d for setting a delegate: no endpoint context available", endpointId);
return CHIP_ERROR_INVALID_ARGUMENT;
}
endpointContext->delegate = delegate;
return CHIP_NO_ERROR;
}
bool DoorLockServer::SetLockState(chip::EndpointId endpointId, DlLockState newLockState)
{
return SetAttribute(endpointId, Attributes::LockState::Id, Attributes::LockState::Set, newLockState);
}
bool DoorLockServer::SetLockState(chip::EndpointId endpointId, DlLockState newLockState, OperationSourceEnum opSource,
const Nullable<uint16_t> & userIndex, const Nullable<List<const LockOpCredentials>> & credentials,
const Nullable<chip::FabricIndex> & fabricIdx, const Nullable<chip::NodeId> & nodeId)
{
bool success = SetLockState(endpointId, newLockState);
// DlLockState::kNotFullyLocked has no appropriate event to send. Also it is unclear whether
// it should schedule auto-relocking. So skip it here. Check for supported states explicitly
// to handle possible enum extending in future.
VerifyOrReturnError(DlLockState::kLocked == newLockState || DlLockState::kUnlocked == newLockState ||
DlLockState::kUnlatched == newLockState,
success);
// Send LockOperation event
auto opType = LockOperationTypeEnum::kUnlock;
if (DlLockState::kLocked == newLockState)
{
opType = LockOperationTypeEnum::kLock;
}
else if (DlLockState::kUnlatched == newLockState)
{
opType = LockOperationTypeEnum::kUnlatch;
}
if (OperationSourceEnum::kRemote == opSource && (fabricIdx.IsNull() || nodeId.IsNull()))
{
ChipLogError(Zcl, "Received SetLockState for remote operation without fabricIdx or nodeId");
}
SendLockOperationEvent(endpointId, opType, opSource, OperationErrorEnum::kUnspecified, userIndex, fabricIdx, nodeId,
credentials, success);
// Reset wrong entry attempts (in case there were any incorrect credentials presented before) if lock/unlock was a success
// and a valid credential was presented.
if (success && !credentials.IsNull() && !(credentials.Value().empty()))
{
ResetWrongCodeEntryAttempts(endpointId);
}
// Schedule auto-relocking
if (success && LockOperationTypeEnum::kUnlock == opType)
{
// appclusters.pdf 5.3.3.25:
// The number of seconds to wait after unlocking a lock before it automatically locks again. 0=disabled. If set, unlock
// operations from any source will be timed. For one time unlock with timeout use the specific command.
uint32_t autoRelockTime = 0;
VerifyOrReturnError(GetAutoRelockTime(endpointId, autoRelockTime), false);
VerifyOrReturnError(0 != autoRelockTime, true);
ScheduleAutoRelock(endpointId, autoRelockTime);
}
return success;
}
bool DoorLockServer::SetActuatorEnabled(chip::EndpointId endpointId, bool newActuatorState)
{
return SetAttribute(endpointId, Attributes::ActuatorEnabled::Id, Attributes::ActuatorEnabled::Set, newActuatorState);
}
bool DoorLockServer::SetDoorState(chip::EndpointId endpointId, DoorStateEnum newDoorState)
{
bool success = SetAttribute(endpointId, Attributes::DoorState::Id, Attributes::DoorState::Set, newDoorState);
if (success)
{
Events::DoorStateChange::Type event{ newDoorState };
SendEvent(endpointId, event);
}
return success;
}
bool DoorLockServer::SetLanguage(chip::EndpointId endpointId, chip::CharSpan newLanguage)
{
return SetAttribute(endpointId, Attributes::Language::Id, Attributes::Language::Set, newLanguage);
}
bool DoorLockServer::SetAutoRelockTime(chip::EndpointId endpointId, uint32_t newAutoRelockTimeSec)
{
return SetAttribute(endpointId, Attributes::AutoRelockTime::Id, Attributes::AutoRelockTime::Set, newAutoRelockTimeSec);
}
bool DoorLockServer::SetSoundVolume(chip::EndpointId endpointId, uint8_t newSoundVolume)
{
return SetAttribute(endpointId, Attributes::SoundVolume::Id, Attributes::SoundVolume::Set, newSoundVolume);
}
bool DoorLockServer::SetOneTouchLocking(chip::EndpointId endpointId, bool isEnabled)
{
return SetAttribute(endpointId, Attributes::EnableOneTouchLocking::Id, Attributes::EnableOneTouchLocking::Set, isEnabled);
}
bool DoorLockServer::SetPrivacyModeButton(chip::EndpointId endpointId, bool isEnabled)
{
return SetAttribute(endpointId, Attributes::EnablePrivacyModeButton::Id, Attributes::EnablePrivacyModeButton::Set, isEnabled);
}
void DoorLockServer::HandleLocalLockOperationError(chip::EndpointId endpointId, LockOperationTypeEnum opType,
OperationSourceEnum opSource, Nullable<uint16_t> userId)
{
SendLockOperationEvent(endpointId, opType, opSource, OperationErrorEnum::kInvalidCredential, userId,
Nullable<chip::FabricIndex>(), Nullable<chip::NodeId>(), Nullable<List<const LockOpCredentials>>(),
false);
HandleWrongCodeEntry(endpointId);
ChipLogProgress(Zcl, "Handling a local Lock Operation Error: [endpoint=%d]", endpointId);
}
bool DoorLockServer::HandleWrongCodeEntry(chip::EndpointId endpointId)
{
auto endpointContext = getContext(endpointId);
if (nullptr == endpointContext)
{
ChipLogError(Zcl, "Failed to get endpoint index for cluster [endpoint=%d]", endpointId);
return false;
}
uint8_t wrongCodeEntryLimit = 0xFF;
auto status = Attributes::WrongCodeEntryLimit::Get(endpointId, &wrongCodeEntryLimit);
if (Status::Success == status)
{
if (++endpointContext->wrongCodeEntryAttempts >= wrongCodeEntryLimit)
{
ChipLogProgress(Zcl, "Too many wrong code entry attempts, engaging lockout [endpoint=%d,wrongCodeAttempts=%d]",
endpointId, endpointContext->wrongCodeEntryAttempts);
engageLockout(endpointId);
}
}
else if (Status::UnsupportedAttribute != status)
{
ChipLogError(Zcl, "Failed to read Wrong Code Entry Limit attribute, status=0x%x", to_underlying(status));
return false;
}
return true;
}
void DoorLockServer::ResetWrongCodeEntryAttempts(chip::EndpointId endpointId)
{
auto endpointContext = getContext(endpointId);
if (nullptr == endpointContext)
{
ChipLogError(Zcl, "Failed to reset wrong code entry attempts. No context for endpoint %d", endpointId);
return;
}
endpointContext->wrongCodeEntryAttempts = 0;
}
bool DoorLockServer::engageLockout(chip::EndpointId endpointId)
{
uint8_t lockoutTimeout;
auto endpointContext = getContext(endpointId);
if (nullptr == endpointContext)
{
ChipLogError(Zcl, "Failed to get endpoint index for cluster [endpoint=%d]", endpointId);
return false;
}
auto status = Attributes::UserCodeTemporaryDisableTime::Get(endpointId, &lockoutTimeout);
if (Status::UnsupportedAttribute == status)
{
return false;
}
if (Status::Success != status)
{
ChipLogError(Zcl, "Unable to read the UserCodeTemporaryDisableTime attribute [status=%d]", to_underlying(status));
return false;
}
endpointContext->wrongCodeEntryAttempts = 0;
endpointContext->lockoutEndTimestamp =
chip::System::SystemClock().GetMonotonicTimestamp() + chip::System::Clock::Seconds32(lockoutTimeout);
ChipLogProgress(Zcl, "Lockout engaged [endpointId=%d,lockoutTimeout=%d]", endpointId, lockoutTimeout);
SendLockAlarmEvent(endpointId, AlarmCodeEnum::kWrongCodeEntryLimit);
emberAfPluginDoorLockLockoutStarted(endpointId, endpointContext->lockoutEndTimestamp);
return true;
}
bool DoorLockServer::GetAutoRelockTime(chip::EndpointId endpointId, uint32_t & autoRelockTime)
{
return GetAttribute(endpointId, Attributes::AutoRelockTime::Id, Attributes::AutoRelockTime::Get, autoRelockTime);
}
bool DoorLockServer::GetNumberOfUserSupported(chip::EndpointId endpointId, uint16_t & numberOfUsersSupported)
{
return GetAttribute(endpointId, Attributes::NumberOfTotalUsersSupported::Id, Attributes::NumberOfTotalUsersSupported::Get,
numberOfUsersSupported);
}
bool DoorLockServer::GetNumberOfPINCredentialsSupported(chip::EndpointId endpointId, uint16_t & numberOfPINCredentials)
{
return GetAttribute(endpointId, Attributes::NumberOfPINUsersSupported::Id, Attributes::NumberOfPINUsersSupported::Get,
numberOfPINCredentials);
}
bool DoorLockServer::GetNumberOfRFIDCredentialsSupported(chip::EndpointId endpointId, uint16_t & numberOfRFIDCredentials)
{
return GetAttribute(endpointId, Attributes::NumberOfRFIDUsersSupported::Id, Attributes::NumberOfRFIDUsersSupported::Get,
numberOfRFIDCredentials);
}
bool DoorLockServer::GetNumberOfWeekDaySchedulesPerUserSupported(chip::EndpointId endpointId,
uint8_t & numberOfWeekDaySchedulesPerUser)
{
return GetAttribute(endpointId, Attributes::NumberOfWeekDaySchedulesSupportedPerUser::Id,
Attributes::NumberOfWeekDaySchedulesSupportedPerUser::Get, numberOfWeekDaySchedulesPerUser);
}
bool DoorLockServer::GetNumberOfYearDaySchedulesPerUserSupported(chip::EndpointId endpointId,
uint8_t & numberOfYearDaySchedulesPerUser)
{
return GetAttribute(endpointId, Attributes::NumberOfYearDaySchedulesSupportedPerUser::Id,
Attributes::NumberOfYearDaySchedulesSupportedPerUser::Get, numberOfYearDaySchedulesPerUser);
}
bool DoorLockServer::GetNumberOfCredentialsSupportedPerUser(chip::EndpointId endpointId,
uint8_t & numberOfCredentialsSupportedPerUser)
{
return GetAttribute(endpointId, Attributes::NumberOfCredentialsSupportedPerUser::Id,
Attributes::NumberOfCredentialsSupportedPerUser::Get, numberOfCredentialsSupportedPerUser);
}
bool DoorLockServer::GetNumberOfHolidaySchedulesSupported(chip::EndpointId endpointId, uint8_t & numberOfHolidaySchedules)
{
return GetAttribute(endpointId, Attributes::NumberOfHolidaySchedulesSupported::Id,
Attributes::NumberOfHolidaySchedulesSupported::Get, numberOfHolidaySchedules);
}
bool DoorLockServer::SendLockAlarmEvent(chip::EndpointId endpointId, AlarmCodeEnum alarmCode)
{
Events::DoorLockAlarm::Type event{ alarmCode };
SendEvent(endpointId, event);
return true;
}
namespace {
// Check whether this is valid UserStatus for a SetUser or SetCredential
// command.
bool IsValidUserStatusForSet(const Nullable<UserStatusEnum> & userStatus)
{
return userStatus.IsNull() || (userStatus.Value() == UserStatusEnum::kOccupiedEnabled) ||
(userStatus.Value() == UserStatusEnum::kOccupiedDisabled);
}
} // anonymous namespace
void DoorLockServer::setUserCommandHandler(chip::app::CommandHandler * commandObj,
const chip::app::ConcreteCommandPath & commandPath,
const chip::app::Clusters::DoorLock::Commands::SetUser::DecodableType & commandData)
{
auto & userIndex = commandData.userIndex;
ChipLogProgress(Zcl, "[SetUser] Incoming command [endpointId=%d,userIndex=%d]", commandPath.mEndpointId, userIndex);
if (!SupportsUSR(commandPath.mEndpointId))
{
ChipLogProgress(Zcl, "[SetUser] User management is not supported [endpointId=%d]", commandPath.mEndpointId);
sendClusterResponse(commandObj, commandPath, ClusterStatusCode(Status::UnsupportedCommand));
return;
}
auto fabricIdx = getFabricIndex(commandObj);
if (chip::kUndefinedFabricIndex == fabricIdx)
{
ChipLogError(Zcl, "[SetUser] Unable to get the fabric IDX [endpointId=%d,userIndex=%d]", commandPath.mEndpointId,
userIndex);
sendClusterResponse(commandObj, commandPath, ClusterStatusCode(Status::Failure));
return;
}
auto sourceNodeId = getNodeId(commandObj);
if (chip::kUndefinedNodeId == sourceNodeId)
{
ChipLogError(Zcl, "[SetUser] Unable to get the source node index [endpointId=%d,userIndex=%d]", commandPath.mEndpointId,
userIndex);
sendClusterResponse(commandObj, commandPath, ClusterStatusCode(Status::Failure));
return;
}
auto & operationType = commandData.operationType;
auto & userName = commandData.userName;
auto & userUniqueId = commandData.userUniqueID;
auto & userStatus = commandData.userStatus;
auto & userType = commandData.userType;
auto & credentialRule = commandData.credentialRule;
if (!userIndexValid(commandPath.mEndpointId, userIndex))
{
ChipLogProgress(Zcl, "[SetUser] User index out of bounds [endpointId=%d,userIndex=%d]", commandPath.mEndpointId, userIndex);
sendClusterResponse(commandObj, commandPath, ClusterStatusCode(Status::InvalidCommand));
return;
}
// appclusters, 5.2.4.34: UserName has maximum DOOR_LOCK_MAX_USER_NAME_SIZE (10) characters excluding NUL terminator in it.
if (!userName.IsNull() && userName.Value().size() > DOOR_LOCK_MAX_USER_NAME_SIZE)
{
ChipLogProgress(Zcl, "[SetUser] Unable to set user: userName too long [endpointId=%d,userIndex=%d,userNameSize=%u]",
commandPath.mEndpointId, userIndex, static_cast<unsigned int>(userName.Value().size()));
sendClusterResponse(commandObj, commandPath, ClusterStatusCode(Status::InvalidCommand));
return;
}
if (!IsValidUserStatusForSet(userStatus))
{
ChipLogProgress(Zcl,
"[SetUser] Unable to set the user: user status is out of range [endpointId=%d,userIndex=%d,userStatus=%u]",
commandPath.mEndpointId, userIndex, to_underlying(userStatus.Value()));
sendClusterResponse(commandObj, commandPath, ClusterStatusCode(Status::InvalidCommand));
return;
}
if (userType == UserTypeEnum::kUnknownEnumValue)
{
ChipLogProgress(Zcl, "[SetUser] Unable to set the user: user type is unknown [endpointId=%d,userIndex=%d,userType=%u]",
commandPath.mEndpointId, userIndex, to_underlying(userType.Value()));
sendClusterResponse(commandObj, commandPath, ClusterStatusCode(Status::InvalidCommand));
return;
}
ClusterStatusCode status(Status::Success);
switch (operationType)
{
case DataOperationTypeEnum::kAdd:
status = createUser(commandPath.mEndpointId, fabricIdx, sourceNodeId, userIndex, userName, userUniqueId, userStatus,
userType, credentialRule);
break;
case DataOperationTypeEnum::kModify:
status = ClusterStatusCode(modifyUser(commandPath.mEndpointId, fabricIdx, sourceNodeId, userIndex, userName, userUniqueId,
userStatus, userType, credentialRule));
break;
case DataOperationTypeEnum::kClear:
default:
// appclusters, 5.2.4.34: SetUser command allow only kAdd/kModify, we should respond with INVALID_COMMAND if we got kClear
// or anything else
status = ClusterStatusCode(Status::InvalidCommand);
ChipLogProgress(Zcl, "[SetUser] Invalid operation type [endpointId=%d,operationType=%u]", commandPath.mEndpointId,
to_underlying(operationType));
break;
}
sendClusterResponse(commandObj, commandPath, status);
}
void DoorLockServer::getUserCommandHandler(chip::app::CommandHandler * commandObj,
const chip::app::ConcreteCommandPath & commandPath, uint16_t userIndex)
{
ChipLogProgress(Zcl, "[GetUser] Incoming command [endpointId=%d,userIndex=%d]", commandPath.mEndpointId, userIndex);
if (!SupportsUSR(commandPath.mEndpointId))
{
ChipLogProgress(Zcl, "[GetUser] User management is not supported [endpointId=%d]", commandPath.mEndpointId);
commandObj->AddStatus(commandPath, Status::UnsupportedCommand);
return;
}
uint16_t maxNumberOfUsers = 0;
if (!userIndexValid(commandPath.mEndpointId, userIndex, maxNumberOfUsers))
{
ChipLogProgress(Zcl, "[GetUser] User index out of bounds [userIndex=%d,numberOfTotalUsersSupported=%d]", userIndex,
maxNumberOfUsers);
commandObj->AddStatus(commandPath, Status::InvalidCommand);
return;
}
Commands::GetUserResponse::Type response;
// appclusters, 5.2.4.36.1: We need to add next occupied user after userIndex if any.
//
// We want to do this before we call emberAfPluginDoorLockGetUser, because this will
// make its own emberAfPluginDoorLockGetUser calls, and a
// EmberAfPluginDoorLockUserInfo might be pointing into some application-static
// buffers (for its credentials and whatnot).
uint16_t nextAvailableUserIndex = 0;
if (findOccupiedUserSlot(commandPath.mEndpointId, static_cast<uint16_t>(userIndex + 1), nextAvailableUserIndex))
{
response.nextUserIndex.SetNonNull(nextAvailableUserIndex);
}
EmberAfPluginDoorLockUserInfo user;
if (!emberAfPluginDoorLockGetUser(commandPath.mEndpointId, userIndex, user))
{
ChipLogProgress(Zcl, "[GetUser] Could not get user info [userIndex=%d]", userIndex);
commandObj->AddStatus(commandPath, Status::Failure);
return;
}
response.userIndex = userIndex;
// appclusters, 5.2.4.36: we should not set user-specific fields to non-null if the user status is set to Available
if (UserStatusEnum::kAvailable != user.userStatus)
{
ChipLogProgress(Zcl,
"Found user in storage: "
"[userIndex=%d,userName=\"%.*s\",userStatus=%u,userType=%u"
",credentialRule=%u,createdBy=%u,modifiedBy=%u]",
userIndex, static_cast<int>(user.userName.size()), user.userName.data(), to_underlying(user.userStatus),
to_underlying(user.userType), to_underlying(user.credentialRule), user.createdBy, user.lastModifiedBy);
response.userName.SetNonNull(user.userName);
if (0xFFFFFFFFU != user.userUniqueId)
{
response.userUniqueID.SetNonNull(user.userUniqueId);
}
response.userStatus.SetNonNull(user.userStatus);
response.userType.SetNonNull(user.userType);
response.credentialRule.SetNonNull(user.credentialRule);
response.credentials.SetNonNull(user.credentials);
// Set fabric indices only if the user was created/modified by matter.
if (user.creationSource == DlAssetSource::kMatterIM)
{
response.creatorFabricIndex.SetNonNull(user.createdBy);
}
if (user.modificationSource == DlAssetSource::kMatterIM)
{
response.lastModifiedFabricIndex.SetNonNull(user.lastModifiedBy);
}
}
else
{
ChipLogProgress(Zcl, "[GetUser] User not found [userIndex=%d]", userIndex);
}
commandObj->AddResponse(commandPath, response);
}
void DoorLockServer::clearUserCommandHandler(chip::app::CommandHandler * commandObj,
const chip::app::ConcreteCommandPath & commandPath, uint16_t userIndex)
{
ChipLogProgress(Zcl, "[ClearUser] Incoming command [endpointId=%d,userIndex=%d]", commandPath.mEndpointId, userIndex);
if (!SupportsUSR(commandPath.mEndpointId))
{
ChipLogProgress(Zcl, "[ClearUser] User management is not supported [endpointId=%d]", commandPath.mEndpointId);
commandObj->AddStatus(commandPath, Status::UnsupportedCommand);
return;
}
auto fabricIdx = getFabricIndex(commandObj);
if (chip::kUndefinedFabricIndex == fabricIdx)
{
ChipLogError(Zcl, "[ClearUser] Unable to get the fabric IDX [endpointId=%d,userIndex=%d]", commandPath.mEndpointId,
userIndex);
commandObj->AddStatus(commandPath, Status::Failure);
return;
}
auto sourceNodeId = getNodeId(commandObj);
if (chip::kUndefinedNodeId == sourceNodeId)
{
ChipLogError(Zcl, "[ClearUser] Unable to get the source node index [endpointId=%d,userIndex=%d]", commandPath.mEndpointId,
userIndex);
commandObj->AddStatus(commandPath, Status::Failure);
return;
}
uint16_t maxNumberOfUsers = 0;
if (!userIndexValid(commandPath.mEndpointId, userIndex, maxNumberOfUsers) && userIndex != 0xFFFE)
{
ChipLogProgress(Zcl, "[ClearUser] User index out of bounds [userIndex=%d,numberOfTotalUsersSupported=%d]", userIndex,
maxNumberOfUsers);
commandObj->AddStatus(commandPath, Status::InvalidCommand);
return;
}
if (0xFFFE != userIndex)
{
auto status = clearUser(commandPath.mEndpointId, fabricIdx, sourceNodeId, userIndex, true);
if (Status::Success != status)
{
ChipLogError(Zcl, "[ClearUser] App reported failure when resetting the user [userIndex=%d,status=0x%x]", userIndex,
to_underlying(status));
}
commandObj->AddStatus(commandPath, status);
return;
}
ChipLogProgress(Zcl, "[ClearUser] Removing all users from storage");
for (uint16_t i = 1; i <= maxNumberOfUsers; ++i)
{
auto status = clearUser(commandPath.mEndpointId, fabricIdx, sourceNodeId, i, false);
if (Status::Success != status)
{
ChipLogError(Zcl, "[ClearUser] App reported failure when resetting the user [userIndex=%d,status=0x%x]", i,
to_underlying(status));
commandObj->AddStatus(commandPath, Status::Failure);
return;
}
}
ChipLogProgress(Zcl, "[ClearUser] Removed all users from storage [users=%d]", maxNumberOfUsers);
sendRemoteLockUserChange(commandPath.mEndpointId, LockDataTypeEnum::kUserIndex, DataOperationTypeEnum::kClear, sourceNodeId,
fabricIdx, 0xFFFE, 0xFFFE);
commandObj->AddStatus(commandPath, Status::Success);
}
void DoorLockServer::setCredentialCommandHandler(
chip::app::CommandHandler * commandObj, const chip::app::ConcreteCommandPath & commandPath,
const chip::app::Clusters::DoorLock::Commands::SetCredential::DecodableType & commandData)
{
ChipLogProgress(Zcl, "[SetCredential] Incoming command [endpointId=%d]", commandPath.mEndpointId);
auto fabricIdx = getFabricIndex(commandObj);
if (kUndefinedFabricIndex == fabricIdx)
{
ChipLogError(Zcl, "[SetCredential] Unable to get the fabric IDX [endpointId=%d]", commandPath.mEndpointId);
commandObj->AddStatus(commandPath, Status::Failure);
return;
}
auto sourceNodeId = getNodeId(commandObj);
if (chip::kUndefinedNodeId == sourceNodeId)
{
ChipLogError(Zcl, "[SetCredential] Unable to get the source node index [endpointId=%d]", commandPath.mEndpointId);
commandObj->AddStatus(commandPath, Status::Failure);
return;
}
auto & operationType = commandData.operationType;
auto & credentialType = commandData.credential.credentialType;
auto & credentialIndex = commandData.credential.credentialIndex;
auto & credentialData = commandData.credentialData;
auto & userIndex = commandData.userIndex;
auto & userStatus = commandData.userStatus;
auto & userType = commandData.userType;
if (!credentialTypeSupported(commandPath.mEndpointId, credentialType))
{
ChipLogProgress(Zcl, "[SetCredential] Credential type is not supported [endpointId=%d,credentialType=%u]",
commandPath.mEndpointId, to_underlying(credentialType));
commandObj->AddStatus(commandPath, Status::UnsupportedCommand);
return;
}
// appclusters, 5.2.4.41: response should contain next available credential slot
uint16_t nextAvailableCredentialSlot = 0;
findUnoccupiedCredentialSlot(commandPath.mEndpointId, credentialType, static_cast<uint16_t>(credentialIndex + 1),
nextAvailableCredentialSlot);
uint16_t maxNumberOfCredentials = 0;
if (!credentialIndexValid(commandPath.mEndpointId, credentialType, credentialIndex, maxNumberOfCredentials))
{
ChipLogProgress(Zcl,
"[SetCredential] Credential index is out of range [endpointId=%d,credentialType=%u"
",credentialIndex=%d]",
commandPath.mEndpointId, to_underlying(credentialType), credentialIndex);
sendSetCredentialResponse(commandObj, commandPath, DlStatus::kInvalidField, 0, nextAvailableCredentialSlot);
return;
}
// appclusters, 5.2.4.40.3: If the credential data length is out of bounds we should return INVALID_COMMAND
auto status = credentialLengthWithinRange(commandPath.mEndpointId, credentialType, credentialData);
if (DlStatus::kSuccess != status)
{
sendSetCredentialResponse(commandObj, commandPath, status, 0, nextAvailableCredentialSlot);
return;
}
// appclusters, 5.2.4.41.1: we should return DUPLICATE in the response if we're trying to create duplicated credential entry
for (uint16_t i = 1; CredentialTypeEnum::kProgrammingPIN != credentialType && (i <= maxNumberOfCredentials); ++i)
{
EmberAfPluginDoorLockCredentialInfo currentCredential;
if (!emberAfPluginDoorLockGetCredential(commandPath.mEndpointId, i, credentialType, currentCredential))
{
ChipLogProgress(Zcl,
"[SetCredential] Unable to get the credential to exclude duplicated entry "
"[endpointId=%d,credentialType=%u,credentialIndex=%d]",
commandPath.mEndpointId, to_underlying(credentialType), i);
sendSetCredentialResponse(commandObj, commandPath, DlStatus::kFailure, 0, nextAvailableCredentialSlot);
return;
}
if (DlCredentialStatus::kAvailable != currentCredential.status && currentCredential.credentialType == credentialType &&
currentCredential.credentialData.data_equal(credentialData))
{
ChipLogProgress(Zcl,
"[SetCredential] Credential with the same data and type already exist "
"[endpointId=%d,credentialType=%u,dataLength=%u,existingCredentialIndex=%d,credentialIndex=%d]",
commandPath.mEndpointId, to_underlying(credentialType),
static_cast<unsigned int>(credentialData.size()), i, credentialIndex);
sendSetCredentialResponse(commandObj, commandPath, DlStatus::kDuplicate, 0, nextAvailableCredentialSlot);
return;
}
}
EmberAfPluginDoorLockCredentialInfo existingCredential;
if (!emberAfPluginDoorLockGetCredential(commandPath.mEndpointId, credentialIndex, credentialType, existingCredential))
{
ChipLogProgress(Zcl, "[SetCredential] Unable to check if credential exists: app error [endpointId=%d,credentialIndex=%d]",
commandPath.mEndpointId, credentialIndex);
sendSetCredentialResponse(commandObj, commandPath, DlStatus::kFailure, 0, nextAvailableCredentialSlot);
return;
}
if (!IsValidUserStatusForSet(userStatus))
{
ChipLogProgress(Zcl,
"[SetCredential] Unable to set the credential: user status is out of range "
"[endpointId=%d,credentialIndex=%d,userStatus=%u]",
commandPath.mEndpointId, credentialIndex, to_underlying(userStatus.Value()));
sendSetCredentialResponse(commandObj, commandPath, DlStatus::kInvalidField, 0, nextAvailableCredentialSlot);
return;
}
if (userType == UserTypeEnum::kUnknownEnumValue)
{
ChipLogProgress(Zcl,
"[SetCredential] Unable to set the credential: user type is unknown "
"[endpointId=%d,credentialIndex=%d,userType=%u]",
commandPath.mEndpointId, credentialIndex, to_underlying(userType.Value()));
sendSetCredentialResponse(commandObj, commandPath, DlStatus::kInvalidField, 0, nextAvailableCredentialSlot);
return;
}
switch (operationType)
{
case DataOperationTypeEnum::kAdd: {
uint16_t createdUserIndex = 0;
status = createCredential(commandPath.mEndpointId, fabricIdx, sourceNodeId, credentialIndex, credentialType,
existingCredential, credentialData, userIndex, userStatus, userType, createdUserIndex);
sendSetCredentialResponse(commandObj, commandPath, status, createdUserIndex, nextAvailableCredentialSlot);
return;
}
case DataOperationTypeEnum::kModify: {
// appclusters, 5.2.4.41.1: should send the INVALID_COMMAND in the response when the credential is in use
if (DlCredentialStatus::kAvailable == existingCredential.status)
{
ChipLogProgress(Zcl,
"[SetCredential] Unable to modify the credential: credential slot is not occupied "
"[endpointId=%d,credentialIndex=%d]",
commandPath.mEndpointId, credentialIndex);
sendSetCredentialResponse(commandObj, commandPath, DlStatus::kInvalidField, 0, nextAvailableCredentialSlot);
return;
}
// return INVALID_COMMAND if the accessing fabric index doesn’t match the
// CreatorFabricIndex of the credential being modified
if (existingCredential.createdBy != fabricIdx)
{
ChipLogProgress(Zcl,
"[createCredential] Unable to modify credential. Fabric index differs from creator fabric "
"[endpointId=%d,credentialIndex=%d,creatorIdx=%d,modifierIdx=%d]",
commandPath.mEndpointId, credentialIndex, existingCredential.createdBy, fabricIdx);
sendSetCredentialResponse(commandObj, commandPath, DlStatus::kInvalidField, 0, nextAvailableCredentialSlot);
return;
}
// if userIndex is NULL then we're changing the programming user PIN
if (userIndex.IsNull())
{
if (!userStatus.IsNull() || userType != UserTypeEnum::kProgrammingUser)
{
ChipLogProgress(Zcl,
"[SetCredential] Unable to modify programming PIN: invalid argument "
"[endpointId=%d,credentialIndex=%d]",
commandPath.mEndpointId, credentialIndex);
}
status = modifyProgrammingPIN(commandPath.mEndpointId, fabricIdx, sourceNodeId, credentialIndex, credentialType,
existingCredential, credentialData);
sendSetCredentialResponse(commandObj, commandPath, status, 0, nextAvailableCredentialSlot);
return;
}
status = modifyCredential(commandPath.mEndpointId, fabricIdx, sourceNodeId, credentialIndex, credentialType,
existingCredential, credentialData, userIndex.Value(), userStatus, userType);
sendSetCredentialResponse(commandObj, commandPath, status, 0, nextAvailableCredentialSlot);
return;
}
case DataOperationTypeEnum::kClear:
default:
// appclusters, 5.2.4.40: set credential command supports only Add and Modify operational type.
sendSetCredentialResponse(commandObj, commandPath, DlStatus::kInvalidField, 0, nextAvailableCredentialSlot);
}
}
void DoorLockServer::getCredentialStatusCommandHandler(chip::app::CommandHandler * commandObj,
const chip::app::ConcreteCommandPath & commandPath,
CredentialTypeEnum credentialType, uint16_t credentialIndex)
{
ChipLogProgress(Zcl, "[GetCredentialStatus] Incoming command [endpointId=%d]", commandPath.mEndpointId);
if (!credentialTypeSupported(commandPath.mEndpointId, credentialType))
{
ChipLogProgress(Zcl,
"[GetCredentialStatus] Credential type is not supported [endpointId=%d,credentialType=%u"
"]",
commandPath.mEndpointId, to_underlying(credentialType));
commandObj->AddStatus(commandPath, Status::UnsupportedCommand);
return;
}
// Our response will need to include the index of the next occupied credential slot
// after credentialIndex, if there is one.
//
// We want to figure this out before we call emberAfPluginDoorLockGetCredential, because to do
// so we will also need to call emberAfPluginDoorLockGetCredential, and the
// EmberAfPluginDoorLockCredentialInfo we get might be pointing into some application-static
// buffers (for its credential data and whatnot).
DataModel::Nullable<uint16_t> nextCredentialIndex;
{
uint16_t foundNextCredentialIndex;
if (findOccupiedCredentialSlot(commandPath.mEndpointId, credentialType, static_cast<uint16_t>(credentialIndex + 1),
foundNextCredentialIndex))
{
nextCredentialIndex.SetNonNull(foundNextCredentialIndex);
}
}
uint16_t maxNumberOfCredentials = 0;
if (!credentialIndexValid(commandPath.mEndpointId, credentialType, credentialIndex, maxNumberOfCredentials))
{
sendGetCredentialResponse(commandObj, commandPath, credentialType, credentialIndex, nextCredentialIndex, 0, nullptr, false);
return;
}
EmberAfPluginDoorLockCredentialInfo credentialInfo;
if (!emberAfPluginDoorLockGetCredential(commandPath.mEndpointId, credentialIndex, credentialType, credentialInfo))
{
ChipLogProgress(Zcl,
"[GetCredentialStatus] Unable to get the credential: app error "
"[endpointId=%d,credentialIndex=%d,credentialType=%u,creator=%u,modifier=%u]",
commandPath.mEndpointId, credentialIndex, to_underlying(credentialType), credentialInfo.createdBy,
credentialInfo.lastModifiedBy);
commandObj->AddStatus(commandPath, Status::Failure);
return;
}
bool credentialExists = DlCredentialStatus::kAvailable != credentialInfo.status;
uint16_t userIndexWithCredential = 0;
if (credentialExists)
{
if (!findUserIndexByCredential(commandPath.mEndpointId, credentialType, credentialIndex, userIndexWithCredential))
{
// That means that there's some kind of error in our database -- there is an unassociated credential. I'm not sure how
// to handle that properly other than panic in the log.
ChipLogError(Zcl,
"[GetCredentialStatus] Database possibly corrupted - credential exists without user assigned "
"[endpointId=%d,credentialType=%u,credentialIndex=%d]",
commandPath.mEndpointId, to_underlying(credentialType), credentialIndex);
commandObj->AddStatus(commandPath, Status::Failure);
return;
}
}
sendGetCredentialResponse(commandObj, commandPath, credentialType, credentialIndex, nextCredentialIndex,
userIndexWithCredential, &credentialInfo, credentialExists);
}
namespace {
bool IsAliroCredentialType(CredentialTypeEnum credentialType)
{
switch (credentialType)
{
case CredentialTypeEnum::kAliroCredentialIssuerKey:
case CredentialTypeEnum::kAliroEvictableEndpointKey:
case CredentialTypeEnum::kAliroNonEvictableEndpointKey:
return true;
default:
return false;
}
}
} // anonymous namespace
void DoorLockServer::sendGetCredentialResponse(chip::app::CommandHandler * commandObj,
const chip::app::ConcreteCommandPath & commandPath,
CredentialTypeEnum credentialType, uint16_t credentialIndex,
DataModel::Nullable<uint16_t> nextCredentialIndex, uint16_t userIndexWithCredential,
EmberAfPluginDoorLockCredentialInfo * credentialInfo, bool credentialExists)
{
// Important: We have to make sure nothing in this function calls
// emberAfPluginDoorLockGetCredential, because that might stomp on the data
// pointed to by credentialInfo.
Commands::GetCredentialStatusResponse::Type response{ .credentialExists = credentialExists };
if (credentialExists && !(nullptr == credentialInfo))
{
if (0 != userIndexWithCredential)
{
response.userIndex.SetNonNull(userIndexWithCredential);
}
if (credentialInfo->creationSource == DlAssetSource::kMatterIM)
{
response.creatorFabricIndex.SetNonNull(credentialInfo->createdBy);
}
if (credentialInfo->modificationSource == DlAssetSource::kMatterIM)
{
response.lastModifiedFabricIndex.SetNonNull(credentialInfo->lastModifiedBy);
}
if (IsAliroCredentialType(credentialType))
{
response.credentialData.Emplace(credentialInfo->credentialData);
}
}
else
{
response.userIndex.SetNull();
if (IsAliroCredentialType(credentialType))
{
response.credentialData.Emplace(NullNullable);
}
}
response.nextCredentialIndex = nextCredentialIndex;
commandObj->AddResponse(commandPath, response);
ChipLogProgress(Zcl,
"[GetCredentialStatus] Prepared credential status "
"[endpointId=%d,credentialType=%u,credentialIndex=%d,userIndex=%d,nextCredentialIndex=%d]",
commandPath.mEndpointId, to_underlying(credentialType), credentialIndex, userIndexWithCredential,
nextCredentialIndex.ValueOr(0));
}
void DoorLockServer::clearCredentialCommandHandler(
chip::app::CommandHandler * commandObj, const chip::app::ConcreteCommandPath & commandPath,
const chip::app::Clusters::DoorLock::Commands::ClearCredential::DecodableType & commandData)
{
ChipLogProgress(Zcl, "[ClearCredential] Incoming command [endpointId=%d]", commandPath.mEndpointId);
auto modifier = getFabricIndex(commandObj);
if (kUndefinedFabricIndex == modifier)
{
commandObj->AddStatus(commandPath, Status::Failure);
return;
}
auto sourceNodeId = getNodeId(commandObj);
if (chip::kUndefinedNodeId == sourceNodeId)
{
commandObj->AddStatus(commandPath, Status::Failure);
return;
}