-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathMTRPerControllerStorageTests.m
3397 lines (2811 loc) · 169 KB
/
MTRPerControllerStorageTests.m
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) 2023 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.
*/
#import <Matter/Matter.h>
#import <dns_sd.h>
#import <os/lock.h>
#import "MTRDefines_Internal.h"
#import "MTRDeviceClusterData.h"
#import "MTRDeviceControllerLocalTestStorage.h"
#import "MTRDeviceStorageBehaviorConfiguration.h"
#import "MTRDeviceTestDelegate.h"
#import "MTRDevice_Internal.h"
#import "MTRErrorTestUtils.h"
#import "MTRFabricInfoChecker.h"
#import "MTRTestCase+ServerAppRunner.h"
#import "MTRTestCase.h"
#import "MTRTestDeclarations.h"
#import "MTRTestKeys.h"
#import "MTRTestPerControllerStorage.h"
#import "MTRTestResetCommissioneeHelper.h"
static const uint16_t kPairingTimeoutInSeconds = 30;
static const uint16_t kTimeoutInSeconds = 3;
static const uint16_t kSubscriptionTimeoutInSeconds = 60;
static NSString * kOnboardingPayload = @"MT:-24J0AFN00KA0648G00";
static const uint16_t kTestVendorId = 0xFFF1u;
static const uint16_t kSubscriptionPoolBaseTimeoutInSeconds = 30;
@interface MTRPerControllerStorageTestsControllerDelegate : NSObject <MTRDeviceControllerDelegate>
@property (nonatomic, strong) XCTestExpectation * expectation;
@property (nonatomic, strong) NSNumber * deviceID;
@end
@implementation MTRPerControllerStorageTestsControllerDelegate
- (id)initWithExpectation:(XCTestExpectation *)expectation newNodeID:(NSNumber *)newNodeID
{
self = [super init];
if (self) {
_expectation = expectation;
_deviceID = newNodeID;
}
return self;
}
- (void)controller:(MTRDeviceController *)controller commissioningSessionEstablishmentDone:(NSError *)error
{
XCTAssertEqual(error.code, 0);
__auto_type * params = [[MTRCommissioningParameters alloc] init];
NSError * commissionError = nil;
[controller commissionNodeWithID:self.deviceID commissioningParams:params error:&commissionError];
XCTAssertNil(commissionError);
// Keep waiting for controller:commissioningComplete:
}
- (void)controller:(MTRDeviceController *)controller commissioningComplete:(NSError *)error
{
XCTAssertEqual(error.code, 0);
[_expectation fulfill];
_expectation = nil;
}
@end
@interface MTRPerControllerStorageTestsSuspensionDelegate : NSObject <MTRDeviceControllerDelegate>
@property (nonatomic, strong) XCTestExpectation * expectation;
@property (nonatomic, assign) BOOL expectedSuspensionState;
@end
@implementation MTRPerControllerStorageTestsSuspensionDelegate
- (id)initWithExpectation:(XCTestExpectation *)expectation expectedSuspensionState:(BOOL)expectedSuspensionState
{
self = [super init];
if (self) {
_expectation = expectation;
_expectedSuspensionState = expectedSuspensionState;
}
return self;
}
- (void)controller:(MTRDeviceController *)controller
suspendedChangedTo:(BOOL)suspended
{
XCTAssertEqual(suspended, self.expectedSuspensionState);
[self.expectation fulfill];
}
@end
@interface MTRPerControllerStorageTestsCertificateIssuer : NSObject <MTROperationalCertificateIssuer>
- (instancetype)initWithRootCertificate:(MTRCertificateDERBytes)rootCertificate
intermediateCertificate:(MTRCertificateDERBytes _Nullable)intermediateCertificate
signingKey:(id<MTRKeypair>)signingKey
fabricID:(NSNumber *)fabricID;
@property (nonatomic, readonly) MTRCertificateDERBytes rootCertificate;
@property (nonatomic, readonly, nullable) MTRCertificateDERBytes intermediateCertificate;
@property (nonatomic, readonly) id<MTRKeypair> signingKey;
@property (nonatomic, readonly) NSNumber * fabricID;
// The node ID to use for the next operational certificate we issue. This will
// be set to null after every certificate issuance.
@property (nonatomic, nullable) NSNumber * nextNodeID;
@property (nonatomic, readonly) BOOL shouldSkipAttestationCertificateValidation;
@end
@implementation MTRPerControllerStorageTestsCertificateIssuer
- (instancetype)initWithRootCertificate:(MTRCertificateDERBytes)rootCertificate
intermediateCertificate:(MTRCertificateDERBytes _Nullable)intermediateCertificate
signingKey:(id<MTRKeypair>)signingKey
fabricID:(NSNumber *)fabricID
{
if (!(self = [super init])) {
return nil;
}
_rootCertificate = rootCertificate;
_intermediateCertificate = intermediateCertificate;
_signingKey = signingKey;
_fabricID = fabricID;
_nextNodeID = nil;
_shouldSkipAttestationCertificateValidation = NO;
return self;
}
- (void)issueOperationalCertificateForRequest:(MTROperationalCSRInfo *)csrInfo
attestationInfo:(MTRDeviceAttestationInfo *)attestationInfo
controller:(MTRDeviceController *)controller
completion:(void (^)(MTROperationalCertificateChain * _Nullable info,
NSError * _Nullable error))completion
{
if (self.nextNodeID == nil) {
completion(nil, [NSError errorWithDomain:@"TestError" code:0 userInfo:@{ @"reason" : @"nextNodeID is nil" }]);
return;
}
MTRCertificateDERBytes signingCertificate;
if (self.intermediateCertificate != nil) {
signingCertificate = self.intermediateCertificate;
} else {
signingCertificate = self.rootCertificate;
}
__auto_type * csr = csrInfo.csr;
XCTAssertNotNil(csr);
NSError * error;
__auto_type * rawPublicKey = [MTRCertificates publicKeyFromCSR:csr error:&error];
XCTAssertNil(error);
XCTAssertNotNil(rawPublicKey);
if (error != nil) {
completion(nil, error);
return;
}
NSDictionary * attributes = @{
(__bridge NSString *) kSecAttrKeyType : (__bridge NSString *) kSecAttrKeyTypeECSECPrimeRandom,
(__bridge NSString *) kSecAttrKeyClass : (__bridge NSString *) kSecAttrKeyClassPublic
};
CFErrorRef keyCreationError = NULL;
SecKeyRef publicKey
= SecKeyCreateWithData((__bridge CFDataRef) rawPublicKey, (__bridge CFDictionaryRef) attributes, &keyCreationError);
XCTAssertNil((__bridge id) keyCreationError);
XCTAssertNotNil((__bridge id) publicKey);
__auto_type * operationalCert = [MTRCertificates createOperationalCertificate:self.signingKey
signingCertificate:signingCertificate
operationalPublicKey:publicKey
fabricID:self.fabricID
nodeID:self.nextNodeID
caseAuthenticatedTags:nil
error:&error];
// Release no-longer-needed key before we do anything else.
CFRelease(publicKey);
XCTAssertNil(error);
XCTAssertNotNil(operationalCert);
if (error != nil) {
completion(nil, error);
return;
}
__auto_type * certChain = [[MTROperationalCertificateChain alloc] initWithOperationalCertificate:operationalCert
intermediateCertificate:self.intermediateCertificate
rootCertificate:self.rootCertificate
adminSubject:nil];
completion(certChain, nil);
}
@end
@interface MTRPerControllerStorageTestsOperationalBrowser : NSObject
// expectedNodeID should be a 16-char uppercase hex string encoding the 64-bit
// node ID.
- (instancetype)initWithNodeID:(NSString *)expectedNodeID;
- (void)shutdown;
@property (nonatomic, readwrite) NSString * expectedNodeID;
@property (nonatomic, readwrite, nullable) XCTestExpectation * addedExpectation;
@property (nonatomic, readwrite, nullable) XCTestExpectation * removedExpectation;
- (void)onBrowse:(DNSServiceFlags)flags error:(DNSServiceErrorType)error instanceName:(const char *)instanceName;
@end
static void OnBrowse(DNSServiceRef serviceRef, DNSServiceFlags flags, uint32_t interfaceId,
DNSServiceErrorType error, const char * name, const char * type, const char * domain, void * context)
{
__auto_type * self = (__bridge MTRPerControllerStorageTestsOperationalBrowser *) context;
[self onBrowse:flags error:error instanceName:name];
}
@implementation MTRPerControllerStorageTestsOperationalBrowser {
DNSServiceRef _browseRef;
}
- (instancetype)initWithNodeID:(NSString *)expectedNodeID
{
if (!(self = [super init])) {
return nil;
}
_expectedNodeID = expectedNodeID;
__auto_type queue = dispatch_get_main_queue();
__auto_type err = DNSServiceBrowse(&_browseRef, /* DNSServiceFlags = */ 0, kDNSServiceInterfaceIndexAny, "_matter._tcp", "local.", OnBrowse, (__bridge void *) self);
XCTAssertEqual(err, kDNSServiceErr_NoError);
if (err != kDNSServiceErr_NoError) {
return nil;
}
err = DNSServiceSetDispatchQueue(_browseRef, queue);
XCTAssertEqual(err, kDNSServiceErr_NoError);
if (err != kDNSServiceErr_NoError) {
DNSServiceRefDeallocate(_browseRef);
_browseRef = nil;
return nil;
}
return self;
}
- (void)shutdown
{
if (_browseRef) {
DNSServiceRefDeallocate(_browseRef);
_browseRef = nil;
}
}
- (void)onBrowse:(DNSServiceFlags)flags error:(DNSServiceErrorType)error instanceName:(const char *)instanceName
{
XCTAssertEqual(error, kDNSServiceErr_NoError);
if (error != kDNSServiceErr_NoError) {
DNSServiceRefDeallocate(_browseRef);
_browseRef = nil;
return;
}
__auto_type len = strlen(instanceName);
XCTAssertEqual(len, 33); // Matter instance names are 33 chars.
if (len != 33) {
return;
}
// Skip over compressed fabric id and dash.
// TODO: Consider checking the compressed fabric ID? That's a bit hard to
// do, in general, since it depends on our keys.
const char * nodeID = &instanceName[17];
NSString * browsedNode = [NSString stringWithUTF8String:nodeID];
if (![browsedNode isEqual:self.expectedNodeID]) {
return;
}
if (flags & kDNSServiceFlagsAdd) {
if (self.addedExpectation) {
XCTestExpectation * expectation = self.addedExpectation;
self.addedExpectation = nil;
[expectation fulfill];
}
} else {
if (self.removedExpectation) {
XCTestExpectation * expectation = self.removedExpectation;
self.removedExpectation = nil;
[expectation fulfill];
}
}
}
@end
@interface MTRPerControllerStorageTests : MTRTestCase
@end
@implementation MTRPerControllerStorageTests {
dispatch_queue_t _storageQueue;
BOOL _localTestStorageEnabledBeforeUnitTest;
}
- (void)setUp
{
// Set detectLeaks true first, in case our superclass wants to do something
// in setUp when it's set.
self.detectLeaks = YES;
// Per-test setup, runs before each test.
[super setUp];
[self setContinueAfterFailure:NO];
// Make sure local test storage is off, because we assume that the storage
// delegate we provide is in fact used for local storage as part of our
// tests.
_localTestStorageEnabledBeforeUnitTest = MTRDeviceControllerLocalTestStorage.localTestStorageEnabled;
MTRDeviceControllerLocalTestStorage.localTestStorageEnabled = NO;
_storageQueue = dispatch_queue_create("test.storage.queue", DISPATCH_QUEUE_SERIAL_WITH_AUTORELEASE_POOL);
}
- (void)tearDown
{
// Per-test teardown, runs after each test.
[self stopFactory];
_storageQueue = nil;
// Restore local test storage setting to previous state.
MTRDeviceControllerLocalTestStorage.localTestStorageEnabled = _localTestStorageEnabledBeforeUnitTest;
[super tearDown];
}
- (void)stopFactory
{
__auto_type * factory = [MTRDeviceControllerFactory sharedInstance];
[factory stopControllerFactory];
XCTAssertFalse(factory.isRunning);
}
// Test helpers
- (void)commissionWithController:(MTRDeviceController *)controller newNodeID:(NSNumber *)newNodeID
{
[self commissionWithController:controller newNodeID:newNodeID onboardingPayload:kOnboardingPayload];
}
- (void)commissionWithController:(MTRDeviceController *)controller newNodeID:(NSNumber *)newNodeID onboardingPayload:(NSString *)onboardingPayload
{
XCTestExpectation * expectation = [self expectationWithDescription:@"Pairing Complete"];
__auto_type * deviceControllerDelegate = [[MTRPerControllerStorageTestsControllerDelegate alloc] initWithExpectation:expectation
newNodeID:newNodeID];
dispatch_queue_t callbackQueue = dispatch_queue_create("com.chip.device_controller_delegate", DISPATCH_QUEUE_SERIAL);
[controller setDeviceControllerDelegate:deviceControllerDelegate queue:callbackQueue];
NSError * error;
__auto_type * payload = [MTRSetupPayload setupPayloadWithOnboardingPayload:onboardingPayload error:&error];
XCTAssertNil(error);
XCTAssertNotNil(payload);
[controller setupCommissioningSessionWithPayload:payload newNodeID:newNodeID error:&error];
XCTAssertNil(error);
[self waitForExpectations:@[ expectation ] timeout:kPairingTimeoutInSeconds];
}
- (nullable MTRDeviceController *)startControllerWithRootKeys:(MTRTestKeys *)rootKeys
operationalKeys:(MTRTestKeys *)operationalKeys
fabricID:(NSNumber *)fabricID
nodeID:(NSNumber *)nodeID
storage:(MTRTestPerControllerStorage *)storage
caseAuthenticatedTags:(NSSet * _Nullable)caseAuthenticatedTags
paramsModifier:(void (^_Nullable)(MTRDeviceControllerExternalCertificateParameters *))paramsModifier
error:(NSError * __autoreleasing *)error
{
XCTAssertTrue(error != NULL);
// Specify a fixed issuerID, so we get the same cert if we use the same keys.
__auto_type * root = [MTRCertificates createRootCertificate:rootKeys issuerID:@(1) fabricID:nil error:error];
XCTAssertNil(*error);
XCTAssertNotNil(root);
__auto_type * operational = [MTRCertificates createOperationalCertificate:rootKeys
signingCertificate:root
operationalPublicKey:operationalKeys.publicKey
fabricID:fabricID
nodeID:nodeID
caseAuthenticatedTags:caseAuthenticatedTags
error:error];
XCTAssertNil(*error);
XCTAssertNotNil(operational);
__auto_type * params = [[MTRDeviceControllerExternalCertificateParameters alloc] initWithStorageDelegate:storage
storageDelegateQueue:_storageQueue
uniqueIdentifier:storage.controllerID
ipk:rootKeys.ipk
vendorID:@(kTestVendorId)
operationalKeypair:operationalKeys
operationalCertificate:operational
intermediateCertificate:nil
rootCertificate:root];
XCTAssertNotNil(params);
if (paramsModifier) {
paramsModifier(params);
}
return [[MTRDeviceController alloc] initWithParameters:params error:error];
}
- (nullable MTRDeviceController *)startControllerWithRootKeys:(MTRTestKeys *)rootKeys
operationalKeys:(MTRTestKeys *)operationalKeys
fabricID:(NSNumber *)fabricID
nodeID:(NSNumber *)nodeID
storage:(MTRTestPerControllerStorage *)storage
caseAuthenticatedTags:(NSSet * _Nullable)caseAuthenticatedTags
error:(NSError * __autoreleasing *)error
certificateIssuer:
(MTRPerControllerStorageTestsCertificateIssuer * __autoreleasing *)certificateIssuer
concurrentSubscriptionPoolSize:(NSUInteger)concurrentSubscriptionPoolSize
storageBehaviorConfiguration:(MTRDeviceStorageBehaviorConfiguration * _Nullable)storageBehaviorConfiguration
{
return [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storage
caseAuthenticatedTags:caseAuthenticatedTags
paramsModifier:^(MTRDeviceControllerExternalCertificateParameters * params) {
// TODO: This is only used by testControllerServer. If that moves
// elsewhere, take this back out again.
params.shouldAdvertiseOperational = YES;
__auto_type * ourCertificateIssuer = [[MTRPerControllerStorageTestsCertificateIssuer alloc] initWithRootCertificate:params.rootCertificate
intermediateCertificate:nil
signingKey:rootKeys
fabricID:fabricID];
XCTAssertNotNil(ourCertificateIssuer);
if (certificateIssuer) {
*certificateIssuer = ourCertificateIssuer;
}
[params setOperationalCertificateIssuer:ourCertificateIssuer queue:dispatch_get_main_queue()];
if (concurrentSubscriptionPoolSize > 0) {
params.concurrentSubscriptionEstablishmentsAllowedOnThread = concurrentSubscriptionPoolSize;
}
if (storageBehaviorConfiguration) {
params.storageBehaviorConfiguration = storageBehaviorConfiguration;
}
}
error:error];
}
- (nullable MTRDeviceController *)startControllerWithRootKeys:(MTRTestKeys *)rootKeys
operationalKeys:(MTRTestKeys *)operationalKeys
fabricID:(NSNumber *)fabricID
nodeID:(NSNumber *)nodeID
storage:(MTRTestPerControllerStorage *)storage
caseAuthenticatedTags:(nullable NSSet *)caseAuthenticatedTags
error:(NSError * __autoreleasing *)error
certificateIssuer:
(MTRPerControllerStorageTestsCertificateIssuer * __autoreleasing *)certificateIssuer
{
return [self startControllerWithRootKeys:rootKeys operationalKeys:operationalKeys fabricID:fabricID nodeID:nodeID storage:storage caseAuthenticatedTags:caseAuthenticatedTags error:error certificateIssuer:certificateIssuer concurrentSubscriptionPoolSize:0 storageBehaviorConfiguration:nil];
}
- (nullable MTRDeviceController *)startControllerWithRootKeys:(MTRTestKeys *)rootKeys
operationalKeys:(MTRTestKeys *)operationalKeys
fabricID:(NSNumber *)fabricID
nodeID:(NSNumber *)nodeID
storage:(MTRTestPerControllerStorage *)storage
error:(NSError * __autoreleasing *)error
certificateIssuer:
(MTRPerControllerStorageTestsCertificateIssuer * __autoreleasing *)certificateIssuer
concurrentSubscriptionPoolSize:(NSUInteger)concurrentSubscriptionPoolSize
{
return [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storage
caseAuthenticatedTags:nil
error:error
certificateIssuer:certificateIssuer
concurrentSubscriptionPoolSize:concurrentSubscriptionPoolSize
storageBehaviorConfiguration:nil];
}
- (nullable MTRDeviceController *)startControllerWithRootKeys:(MTRTestKeys *)rootKeys
operationalKeys:(MTRTestKeys *)operationalKeys
fabricID:(NSNumber *)fabricID
nodeID:(NSNumber *)nodeID
storage:(MTRTestPerControllerStorage *)storage
error:(NSError * __autoreleasing *)error
certificateIssuer:
(MTRPerControllerStorageTestsCertificateIssuer * __autoreleasing *)certificateIssuer
storageBehaviorConfiguration:(MTRDeviceStorageBehaviorConfiguration * _Nullable)storageBehaviorConfiguration
{
return [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storage
caseAuthenticatedTags:nil
error:error
certificateIssuer:certificateIssuer
concurrentSubscriptionPoolSize:0
storageBehaviorConfiguration:storageBehaviorConfiguration];
}
- (nullable MTRDeviceController *)startControllerWithRootKeys:(MTRTestKeys *)rootKeys
operationalKeys:(MTRTestKeys *)operationalKeys
fabricID:(NSNumber *)fabricID
nodeID:(NSNumber *)nodeID
storage:(MTRTestPerControllerStorage *)storage
error:(NSError * __autoreleasing *)error
certificateIssuer:
(MTRPerControllerStorageTestsCertificateIssuer * __autoreleasing *)certificateIssuer
{
return [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storage
caseAuthenticatedTags:nil
error:error
certificateIssuer:certificateIssuer
concurrentSubscriptionPoolSize:0
storageBehaviorConfiguration:nil];
}
- (nullable MTRDeviceController *)startControllerWithRootKeys:(MTRTestKeys *)rootKeys
operationalKeys:(MTRTestKeys *)operationalKeys
fabricID:(NSNumber *)fabricID
nodeID:(NSNumber *)nodeID
storage:(MTRTestPerControllerStorage *)storage
caseAuthenticatedTags:(nullable NSSet *)caseAuthenticatedTags
error:(NSError * __autoreleasing *)error
{
return [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storage
caseAuthenticatedTags:caseAuthenticatedTags
error:error
certificateIssuer:nil
concurrentSubscriptionPoolSize:0
storageBehaviorConfiguration:nil];
}
- (nullable MTRDeviceController *)startControllerWithRootKeys:(MTRTestKeys *)rootKeys
operationalKeys:(MTRTestKeys *)operationalKeys
fabricID:(NSNumber *)fabricID
nodeID:(NSNumber *)nodeID
storage:(MTRTestPerControllerStorage *)storage
error:(NSError * __autoreleasing *)error
{
return [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storage
error:error
certificateIssuer:nil];
}
- (void)test001_BasicControllerStartup
{
__auto_type * factory = [MTRDeviceControllerFactory sharedInstance];
XCTAssertNotNil(factory);
__auto_type * rootKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(rootKeys);
__auto_type * operationalKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(operationalKeys);
__auto_type * storageDelegate = [[MTRTestPerControllerStorage alloc] initWithControllerID:[NSUUID UUID]];
NSNumber * nodeID = @(123);
NSNumber * fabricID = @(456);
NSError * error;
MTRDeviceController * controller = [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storageDelegate
error:&error];
XCTAssertNil(error);
XCTAssertNotNil(controller);
XCTAssertTrue([controller isRunning]);
XCTAssertFalse(controller.suspended);
XCTAssertEqualObjects(controller.controllerNodeID, nodeID);
// This was the first controller we brought up, so it should have come up
// with fabric index 1.
__auto_type * fabricInfoList = factory.knownFabrics;
CheckFabricInfo(fabricInfoList, [NSMutableSet setWithArray:@[
@{
@"rootPublicKey" : rootKeys.publicKeyData,
@"vendorID" : @(kTestVendorId),
@"fabricID" : fabricID,
@"nodeID" : nodeID,
@"label" : @"",
@"hasIntermediateCertificate" : @(NO),
@"fabricIndex" : @(1),
},
]]);
[controller shutdown];
XCTAssertFalse([controller isRunning]);
}
- (void)test002_TryStartingTwoControllersWithSameNodeID
{
__auto_type * rootKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(rootKeys);
__auto_type * operationalKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(operationalKeys);
__auto_type * storageDelegate = [[MTRTestPerControllerStorage alloc] initWithControllerID:[NSUUID UUID]];
NSNumber * nodeID = @(123);
NSNumber * fabricID = @(456);
NSError * error;
MTRDeviceController * controller = [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storageDelegate
error:&error];
XCTAssertNil(error);
XCTAssertNotNil(controller);
XCTAssertTrue([controller isRunning]);
XCTAssertEqualObjects(controller.controllerNodeID, nodeID);
// Try to bring up another controller with the same identity. This should
// fail, since our controller is still running
MTRDeviceController * otherController = [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storageDelegate
error:&error];
XCTAssertNil(otherController);
XCTAssertNotNil(error);
// Our controller should still be running.
XCTAssertTrue([controller isRunning]);
[controller shutdown];
XCTAssertFalse([controller isRunning]);
}
- (void)test003_TestTwoControllersSameUUID
{
__auto_type * rootKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(rootKeys);
__auto_type * operationalKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(operationalKeys);
XCTAssertEqual(operationalKeys.signatureCount, 0);
__auto_type * storageDelegate = [[MTRTestPerControllerStorage alloc] initWithControllerID:[NSUUID UUID]];
NSNumber * fabricID = @(456);
NSNumber * nodeID1 = @(123);
NSError * error;
MTRDeviceController * controller = [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID1
storage:storageDelegate
error:&error];
XCTAssertNil(error);
XCTAssertNotNil(controller);
XCTAssertTrue([controller isRunning]);
XCTAssertEqualObjects(controller.controllerNodeID, nodeID1);
// Try to bring up another controller with the same uniqueIdentifier (but a different
// node identity). This should fail, since our controller is still running.
NSNumber * nodeID2 = @(789);
MTRDeviceController * otherController = [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID2
storage:storageDelegate
error:&error];
XCTAssertNil(otherController);
XCTAssertNotNil(error);
// Our controller should still be running.
XCTAssertTrue([controller isRunning]);
[controller shutdown];
XCTAssertFalse([controller isRunning]);
}
- (void)test004_TestBasicSessionResumption
{
__auto_type * factory = [MTRDeviceControllerFactory sharedInstance];
XCTAssertNotNil(factory);
__auto_type queue = dispatch_get_main_queue();
__auto_type * rootKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(rootKeys);
__auto_type * operationalKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(operationalKeys);
XCTAssertEqual(operationalKeys.signatureCount, 0);
__auto_type * storageDelegate = [[MTRTestPerControllerStorage alloc] initWithControllerID:[NSUUID UUID]];
NSNumber * nodeID = @(123);
NSNumber * fabricID = @(456);
NSError * error;
MTRPerControllerStorageTestsCertificateIssuer * certificateIssuer;
MTRDeviceController * controller = [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storageDelegate
error:&error
certificateIssuer:&certificateIssuer];
XCTAssertNil(error);
XCTAssertNotNil(controller);
XCTAssertTrue([controller isRunning]);
XCTAssertEqualObjects(controller.controllerNodeID, nodeID);
// Now commission the device, to test that that works.
NSNumber * deviceID = @(17);
certificateIssuer.nextNodeID = deviceID;
[self commissionWithController:controller newNodeID:deviceID];
// We should have established CASE using our operational key.
XCTAssertEqual(operationalKeys.signatureCount, 1);
[controller shutdown];
XCTAssertFalse([controller isRunning]);
// Start the controller again using the same identity. This should work,
// because we cleared out the fabric info when the controller shut down.
controller = [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storageDelegate
error:&error];
XCTAssertNil(error);
XCTAssertNotNil(controller);
XCTAssertTrue([controller isRunning]);
XCTAssertEqualObjects(controller.controllerNodeID, nodeID);
// Now we should have come up with fabric index 2.
__auto_type * fabricInfoList = factory.knownFabrics;
CheckFabricInfo(fabricInfoList, [NSMutableSet setWithArray:@[
@{
@"rootPublicKey" : rootKeys.publicKeyData,
@"vendorID" : @(kTestVendorId),
@"fabricID" : fabricID,
@"nodeID" : nodeID,
@"label" : @"",
@"hasIntermediateCertificate" : @(NO),
@"fabricIndex" : @(2),
},
]]);
// Try sending an attribute read and make sure it works.
__auto_type * device = [MTRBaseDevice deviceWithNodeID:deviceID controller:controller];
__auto_type * onOffCluster = [[MTRBaseClusterOnOff alloc] initWithDevice:device endpointID:@(1) queue:queue];
__auto_type * readExpectation = [self expectationWithDescription:@"Read OnOff attribute"];
[onOffCluster readAttributeOnOffWithCompletion:^(NSNumber * value, NSError * _Nullable error) {
XCTAssertNil(error);
// We expect the device to be off.
XCTAssertEqualObjects(value, @(0));
[readExpectation fulfill];
}];
[self waitForExpectations:@[ readExpectation ] timeout:kTimeoutInSeconds];
// We should have done CASE resumption, so not done any new signing using
// our keys.
XCTAssertEqual(operationalKeys.signatureCount, 1);
// Reset our commissionee.
ResetCommissionee(device, queue, self, kTimeoutInSeconds);
[controller shutdown];
XCTAssertFalse([controller isRunning]);
}
- (void)test005_TestSessionResumptionDataClearingNodeIDChanged
{
__auto_type * factory = [MTRDeviceControllerFactory sharedInstance];
XCTAssertNotNil(factory);
__auto_type queue = dispatch_get_main_queue();
__auto_type * rootKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(rootKeys);
__auto_type * operationalKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(operationalKeys);
XCTAssertEqual(operationalKeys.signatureCount, 0);
__auto_type * storageDelegate = [[MTRTestPerControllerStorage alloc] initWithControllerID:[NSUUID UUID]];
NSNumber * nodeID1 = @(123);
NSNumber * nodeID2 = @(246);
NSNumber * fabricID = @(456);
NSError * error;
MTRPerControllerStorageTestsCertificateIssuer * certificateIssuer;
MTRDeviceController * controller = [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID1
storage:storageDelegate
error:&error
certificateIssuer:&certificateIssuer];
XCTAssertNil(error);
XCTAssertNotNil(controller);
XCTAssertTrue([controller isRunning]);
XCTAssertEqualObjects(controller.controllerNodeID, nodeID1);
NSNumber * deviceID = @(17);
certificateIssuer.nextNodeID = deviceID;
[self commissionWithController:controller newNodeID:deviceID];
// We should have established CASE using our operational key.
XCTAssertEqual(operationalKeys.signatureCount, 1);
__auto_type * device1 = [MTRBaseDevice deviceWithNodeID:deviceID controller:controller];
// Now change ACLs so that nodeID2 has access and nodeID1 does not.
__auto_type * admin = [[MTRAccessControlClusterAccessControlEntryStruct alloc] init];
admin.privilege = @(MTRAccessControlEntryPrivilegeAdminister);
admin.authMode = @(MTRAccessControlEntryAuthModeCASE);
admin.subjects = @[ nodeID2 ];
__auto_type * aclCluster = [[MTRBaseClusterAccessControl alloc] initWithDevice:device1 endpointID:@(0) queue:queue];
XCTestExpectation * aclWriteExpectation = [self expectationWithDescription:@"ACLs changed so new node ID can administer"];
[aclCluster writeAttributeACLWithValue:@[ admin ]
completion:^(NSError * _Nullable err) {
XCTAssertNil(err);
[aclWriteExpectation fulfill];
}];
[self waitForExpectations:@[ aclWriteExpectation ] timeout:kTimeoutInSeconds];
[controller shutdown];
XCTAssertFalse([controller isRunning]);
// There should have been no more CASE establishment going on.
XCTAssertEqual(operationalKeys.signatureCount, 1);
// Bring up a controller with the same storage and keys and so on but nodeID2.
controller = [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID2
storage:storageDelegate
error:&error];
XCTAssertNil(error);
XCTAssertNotNil(controller);
XCTAssertTrue([controller isRunning]);
XCTAssertEqualObjects(controller.controllerNodeID, nodeID2);
// Try sending an attribute read and make sure it works.
__auto_type * device2 = [MTRBaseDevice deviceWithNodeID:deviceID controller:controller];
__auto_type * onOffCluster = [[MTRBaseClusterOnOff alloc] initWithDevice:device2 endpointID:@(1) queue:queue];
__auto_type * readExpectation = [self expectationWithDescription:@"Read OnOff attribute"];
[onOffCluster readAttributeOnOffWithCompletion:^(NSNumber * value, NSError * _Nullable error) {
XCTAssertNil(error);
// We expect the device to be off.
XCTAssertEqualObjects(value, @(0));
[readExpectation fulfill];
}];
[self waitForExpectations:@[ readExpectation ] timeout:kTimeoutInSeconds];
// We should note have done CASE resumption, since our identity changed.
XCTAssertEqual(operationalKeys.signatureCount, 2);
// Reset our commissionee.
ResetCommissionee(device2, queue, self, kTimeoutInSeconds);
[controller shutdown];
XCTAssertFalse([controller isRunning]);
}
- (void)test006_TestSessionResumptionDataClearingCATsChanged
{
__auto_type * factory = [MTRDeviceControllerFactory sharedInstance];
XCTAssertNotNil(factory);
__auto_type queue = dispatch_get_main_queue();
__auto_type * rootKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(rootKeys);
__auto_type * operationalKeys = [[MTRTestKeys alloc] init];
XCTAssertNotNil(operationalKeys);
XCTAssertEqual(operationalKeys.signatureCount, 0);
__auto_type * storageDelegate = [[MTRTestPerControllerStorage alloc] initWithControllerID:[NSUUID UUID]];
NSNumber * nodeID = @(123);
NSNumber * fabricID = @(456);
NSError * error;
MTRPerControllerStorageTestsCertificateIssuer * certificateIssuer;
MTRDeviceController * controller = [self startControllerWithRootKeys:rootKeys
operationalKeys:operationalKeys
fabricID:fabricID
nodeID:nodeID
storage:storageDelegate
error:&error
certificateIssuer:&certificateIssuer];
XCTAssertNil(error);
XCTAssertNotNil(controller);
XCTAssertTrue([controller isRunning]);
XCTAssertEqualObjects(controller.controllerNodeID, nodeID);
NSNumber * deviceID = @(17);
certificateIssuer.nextNodeID = deviceID;
[self commissionWithController:controller newNodeID:deviceID];
// We should have established CASE using our operational key.
XCTAssertEqual(operationalKeys.signatureCount, 1);
__auto_type * device1 = [MTRBaseDevice deviceWithNodeID:deviceID controller:controller];
// Now change ACLs so that CAT 0x12340001 has access and nodeID does not.
uint32_t cat = 0x12340001;
NSNumber * catSubject = @(0xFFFFFFFD00000000 | cat);
__auto_type * admin = [[MTRAccessControlClusterAccessControlEntryStruct alloc] init];
admin.privilege = @(MTRAccessControlEntryPrivilegeAdminister);
admin.authMode = @(MTRAccessControlEntryAuthModeCASE);
admin.subjects = @[ catSubject ];
__auto_type * aclCluster = [[MTRBaseClusterAccessControl alloc] initWithDevice:device1 endpointID:@(0) queue:queue];
XCTestExpectation * aclWriteExpectation = [self expectationWithDescription:@"ACLs changed so new node ID can administer"];
[aclCluster writeAttributeACLWithValue:@[ admin ]
completion:^(NSError * _Nullable err) {
XCTAssertNil(err);
[aclWriteExpectation fulfill];
}];
[self waitForExpectations:@[ aclWriteExpectation ] timeout:kTimeoutInSeconds];
[controller shutdown];
XCTAssertFalse([controller isRunning]);
// There should have been no more CASE establishment going on.
XCTAssertEqual(operationalKeys.signatureCount, 1);