keychain/ckks/tests/CKKSSQLTests.m

   1 /*
   2  * Copyright (c) 2016 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #if OCTAGON
  25
  26 #import <XCTest/XCTest.h>
  27 #import <Security/Security.h>
  28 #import <Security/SecItemPriv.h>
  29 #import "CloudKitMockXCTest.h"
  30
  31 #import "keychain/ckks/CKKS.h"
  32 #import "keychain/ckks/CKKSKey.h"
  33 #import "keychain/ckks/CKKSOutgoingQueueEntry.h"
  34 #import "keychain/ckks/CKKSZoneStateEntry.h"
  35 #import "keychain/ckks/CKKSDeviceStateEntry.h"
  36 #import "keychain/ckks/CKKSRateLimiter.h"
  37
  38 #include <securityd/SecItemServer.h>
  39
  40 @interface CloudKitKeychainSQLTests : CloudKitMockXCTest
  41 @end
  42
  43 @implementation CloudKitKeychainSQLTests
  44
  45 + (void)setUp {
  46     [super setUp];
  47 }
  48
  49 - (void)setUp {
  50     SecCKKSDisable();
  51     [super setUp];
  52 }
  53
  54 - (void)tearDown {
  55     [super tearDown];
  56     SecCKKSResetSyncing();
  57 }
  58
  59 - (void)addTestZoneEntries {
  60     CKKSOutgoingQueueEntry* one = [[CKKSOutgoingQueueEntry alloc] initWithCKKSItem:
  61                                    [[CKKSItem alloc] initWithUUID:[[NSUUID UUID] UUIDString]
  62                                                     parentKeyUUID:[[NSUUID UUID] UUIDString]
  63                                                            zoneID:self.testZoneID
  64                                                           encItem:[@"nonsense" dataUsingEncoding:NSUTF8StringEncoding]
  65                                                        wrappedkey:[[CKKSWrappedAESSIVKey alloc]initWithBase64: @"KFfL58XtugiYNoD859EjG0StfrYd6eakm0CQrgX7iO+DEo4kio3WbEeA1kctCU0GaeTGsRFpbdy4oo6jXhVu7cZqB0svhUPGq55aGnszUjI="]
  66                                                   generationCount:0
  67                                                            encver:0]
  68                                                                         action:SecCKKSActionAdd
  69                                                                          state:SecCKKSStateError
  70                                                                      waitUntil:nil
  71                                                                    accessGroup:@"nope"];
  72
  73
  74     CKKSOutgoingQueueEntry* two = [[CKKSOutgoingQueueEntry alloc] initWithCKKSItem:
  75                                    [[CKKSItem alloc] initWithUUID:[[NSUUID UUID] UUIDString]
  76                                                     parentKeyUUID:[[NSUUID UUID] UUIDString]
  77                                                            zoneID:self.testZoneID
  78                                                           encItem:[@"nonsense" dataUsingEncoding:NSUTF8StringEncoding]
  79                                                        wrappedkey:[[CKKSWrappedAESSIVKey alloc]initWithBase64: @"KFfL58XtugiYNoD859EjG0StfrYd6eakm0CQrgX7iO+DEo4kio3WbEeA1kctCU0GaeTGsRFpbdy4oo6jXhVu7cZqB0svhUPGq55aGnszUjI="]
  80                                                   generationCount:0
  81                                                            encver:0]
  82                                                                             action:SecCKKSActionAdd
  83                                                                              state:SecCKKSStateNew
  84                                                                          waitUntil:nil
  85                                                                        accessGroup:@"nope"];
  86
  87     CKKSOutgoingQueueEntry* three = [[CKKSOutgoingQueueEntry alloc] initWithCKKSItem:
  88                                    [[CKKSItem alloc] initWithUUID:[[NSUUID UUID] UUIDString]
  89                                                     parentKeyUUID:[[NSUUID UUID] UUIDString]
  90                                                            zoneID:self.testZoneID
  91                                                           encItem:[@"nonsense" dataUsingEncoding:NSUTF8StringEncoding]
  92                                                        wrappedkey:[[CKKSWrappedAESSIVKey alloc]initWithBase64: @"KFfL58XtugiYNoD859EjG0StfrYd6eakm0CQrgX7iO+DEo4kio3WbEeA1kctCU0GaeTGsRFpbdy4oo6jXhVu7cZqB0svhUPGq55aGnszUjI="]
  93                                                   generationCount:0
  94                                                            encver:0]
  95                                                                             action:SecCKKSActionModify
  96                                                                              state:SecCKKSStateError
  97                                                                          waitUntil:nil
  98                                                                        accessGroup:@"nope"];
  99
 100     NSError* error = nil;
 101     [one saveToDatabase:&error];
 102     [two saveToDatabase: &error];
 103     [three saveToDatabase: &error];
 104     XCTAssertNil(error, "no error saving ZoneStateEntries to database");
 105 }
 106
 107 - (void)testCKKSOutgoingQueueEntry {
 108     NSString* testUUID = @"157A3171-0677-451B-9EAE-0DDC4D4315B0";
 109     NSUUID* testKeyUUID = [[NSUUID alloc] init];
 110
 111     NSError * nserror;
 112     __block CFErrorRef error = NULL;
 113
 114     CKKSOutgoingQueueEntry* shouldFail = [CKKSOutgoingQueueEntry fromDatabase:testUUID state:SecCKKSStateInFlight zoneID:self.testZoneID error: &nserror];
 115     XCTAssertNil(shouldFail, "Can't find a nonexisting object");
 116     XCTAssertNotNil(nserror, "NSError exists when things break");
 117
 118     __weak __typeof(self) weakSelf = self;
 119     kc_with_dbt(true, &error, ^bool (SecDbConnectionRef dbconn) {
 120         __strong __typeof(weakSelf) strongSelf = weakSelf;
 121         XCTAssertNotNil(strongSelf, "called while self still exists");
 122
 123         NSString * sql = @"insert INTO outgoingqueue (UUID, parentKeyUUID, ckzone, action, state, accessgroup, gencount, encitem, wrappedkey, encver) VALUES (?,?,?,?,?,?,?,?,?,?);";
 124         SecDbPrepare(dbconn, (__bridge CFStringRef) sql, &error, ^void (sqlite3_stmt *stmt) {
 125             SecDbBindText(stmt, 1, [testUUID UTF8String], strlen([testUUID UTF8String]), NULL, &error);
 126             SecDbBindText(stmt, 2, [[testKeyUUID UUIDString] UTF8String], strlen([[testKeyUUID UUIDString] UTF8String]), NULL, &error);
 127             SecDbBindObject(stmt, 3, (__bridge CFStringRef) weakSelf.testZoneID.zoneName, &error);
 128             SecDbBindText(stmt, 4, "newitem", strlen("newitem"), NULL, &error);
 129             SecDbBindText(stmt, 5, "unprocessed", strlen("unprocessed"), NULL, &error);
 130             SecDbBindText(stmt, 6, "com.apple.access", strlen("com.apple.access"), NULL, &error);
 131             SecDbBindText(stmt, 7, "0", strlen("0"), NULL, &error);
 132             SecDbBindText(stmt, 8, "bm9uc2Vuc2UK", strlen("bm9uc2Vuc2UK"), NULL, &error);
 133             SecDbBindObject(stmt, 9, CFSTR("KFfL58XtugiYNoD859EjG0StfrYd6eakm0CQrgX7iO+DEo4kio3WbEeA1kctCU0GaeTGsRFpbdy4oo6jXhVu7cZqB0svhUPGq55aGnszUjI="), &error);
 134             SecDbBindText(stmt, 10, "0", strlen("0"), NULL, &error);
 135
 136             SecDbStep(dbconn, stmt, &error, ^(bool *stop) {
 137                 // don't do anything, I guess?
 138             });
 139
 140             XCTAssertNil((__bridge NSError*)error, @"no error occurred while adding row to database");
 141
 142             CFReleaseNull(error);
 143         });
 144         XCTAssertNil((__bridge NSError*)error, @"no error occurred preparing sql");
 145
 146         CFReleaseNull(error);
 147         return true;
 148     });
 149
 150     // Create another oqe with different values
 151     CKKSItem* baseitem = [[CKKSItem alloc] initWithUUID: [[NSUUID UUID] UUIDString]
 152                                           parentKeyUUID:[[NSUUID UUID] UUIDString]
 153                                                  zoneID:self.testZoneID
 154                                                 encItem:[@"nonsense" dataUsingEncoding:NSUTF8StringEncoding]
 155                                              wrappedkey:[[CKKSWrappedAESSIVKey alloc]initWithBase64: @"KFfL58XtugiYNoD859EjG0StfrYd6eakm0CQrgX7iO+DEo4kio3WbEeA1kctCU0GaeTGsRFpbdy4oo6jXhVu7cZqB0svhUPGq55aGnszUjI="]
 156                                         generationCount:0
 157                                                  encver:0];
 158     CKKSOutgoingQueueEntry* other = [[CKKSOutgoingQueueEntry alloc] initWithCKKSItem:baseitem
 159                                                                               action:SecCKKSActionAdd
 160                                                                                state:SecCKKSStateError
 161                                                                            waitUntil:[NSDate date]
 162                                                                          accessGroup:@"nope"];
 163     [other saveToDatabase:&nserror];
 164     XCTAssertNil(nserror, "no error occurred saving to database");
 165
 166     CKKSOutgoingQueueEntry * oqe = [CKKSOutgoingQueueEntry fromDatabase:testUUID state:@"unprocessed" zoneID:self.testZoneID error: &nserror];
 167     XCTAssertNil(nserror, "no error occurred creating from database");
 168
 169     XCTAssertNotNil(oqe, "load outgoing queue entry from database");
 170     XCTAssertEqualObjects(oqe.state, @"unprocessed", "state matches what was in the DB");
 171
 172     oqe.item.parentKeyUUID = @"not a parent key either";
 173     oqe.action = @"null";
 174     oqe.state = @"savedtocloud";
 175     oqe.accessgroup = @"com.evil.access";
 176     oqe.item.generationCount = (NSInteger) 1;
 177     oqe.item.base64encitem = @"bW9yZW5vbnNlbnNlCg==";
 178     oqe.item.encver = 1;
 179
 180     XCTAssertTrue([oqe saveToDatabase: &nserror], "saving to database");
 181
 182     CKKSOutgoingQueueEntry * oqe2 = [CKKSOutgoingQueueEntry fromDatabase:testUUID state:@"savedtocloud" zoneID:self.testZoneID error: &nserror];
 183     XCTAssertNil(nserror, "no error occurred");
 184
 185     XCTAssertEqualObjects(oqe2.item.parentKeyUUID, @"not a parent key either", @"parent key uuid persisted through db save and load");
 186     XCTAssertEqualObjects(oqe2.item.zoneID       , self.testZoneID           , @"zone id persisted through db save and load");
 187     XCTAssertEqualObjects(oqe2.action            , @"null"                   , @"action persisted through db save and load");
 188     XCTAssertEqualObjects(oqe2.state             , @"savedtocloud"           , @"state persisted through db save and load");
 189     XCTAssertEqual(       oqe2.waitUntil         , nil                       , @"no date when none given");
 190     XCTAssertEqualObjects(oqe2.accessgroup       , @"com.evil.access"        , @"accessgroup persisted through db save and load");
 191     XCTAssertEqual(       oqe2.item.generationCount, (NSUInteger) 1          , @"generationCount persisted through db save and load");
 192     XCTAssertEqualObjects(oqe2.item.base64encitem, @"bW9yZW5vbnNlbnNlCg=="   , @"encitem persisted through db save and load");
 193     XCTAssertEqual(       oqe2.item.encver,     1                            , @"encver persisted through db save and load");
 194     XCTAssertEqualObjects([oqe2.item.wrappedkey base64WrappedKey], @"KFfL58XtugiYNoD859EjG0StfrYd6eakm0CQrgX7iO+DEo4kio3WbEeA1kctCU0GaeTGsRFpbdy4oo6jXhVu7cZqB0svhUPGq55aGnszUjI=",
 195                                                                         @"wrapped key persisted through db save and load");
 196
 197     // Test 'all' methods
 198     NSArray<CKKSOutgoingQueueEntry*>* oqes = [CKKSOutgoingQueueEntry all:&nserror];
 199     XCTAssertNil(nserror, "no error occurred");
 200     XCTAssertNotNil(oqes, "receive oqes from database");
 201     XCTAssert([oqes count] == 2, "received 2 oqes from all");
 202
 203     NSArray<CKKSOutgoingQueueEntry*>* oqeswhere = [CKKSOutgoingQueueEntry allWhere: @{@"state": @"savedtocloud"}  error:&nserror];
 204     XCTAssertNil(nserror, "no error occurred");
 205     XCTAssertNotNil(oqeswhere, "receive oqes from database");
 206     XCTAssert([oqeswhere count] == 1, "received 1 oqe from allWhere");
 207
 208     // Test row deletion
 209     nserror = nil;
 210     [oqe2 deleteFromDatabase:&nserror];
 211     XCTAssertNil(nserror, "No NSError exists when deleting existing item");
 212     oqe2 = [CKKSOutgoingQueueEntry fromDatabase:testUUID state:@"savedtocloud" zoneID:self.testZoneID error: &nserror];
 213     XCTAssertNil(oqe2, "Can't find a nonexisting object");
 214     XCTAssertNotNil(nserror, "NSError exists when things break");
 215
 216     // Test loading other
 217     nserror = nil;
 218     CKKSOutgoingQueueEntry* other2 = [CKKSOutgoingQueueEntry fromDatabase: other.item.uuid state:SecCKKSStateError zoneID:self.testZoneID error:&nserror];
 219     XCTAssertNil(nserror, "No error loading other2 from database");
 220     XCTAssertNotNil(other2, "Able to re-load other.");
 221     XCTAssertEqualObjects(other, other2, "loaded object is equal to object");
 222 }
 223
 224 -(void)testCKKSZoneStateEntrySQL {
 225     CKKSZoneStateEntry* zse = [[CKKSZoneStateEntry alloc] initWithCKZone:@"sqltest"
 226                                                              zoneCreated:true
 227                                                           zoneSubscribed:true
 228                                                              changeToken:[@"nonsense" dataUsingEncoding:NSUTF8StringEncoding]
 229                                                                lastFetch:[NSDate date]
 230                                                                lastFixup:CKKSCurrentFixupNumber
 231                                                       encodedRateLimiter:nil];
 232     zse.rateLimiter = [[CKKSRateLimiter alloc] init];
 233
 234     CKKSZoneStateEntry* zseClone = [[CKKSZoneStateEntry alloc] initWithCKZone:@"sqltest"
 235                                                                   zoneCreated:true
 236                                                                zoneSubscribed:true
 237                                                                   changeToken:[@"nonsense" dataUsingEncoding:NSUTF8StringEncoding]
 238                                                                     lastFetch:zse.lastFetchTime
 239                                                                     lastFixup:CKKSCurrentFixupNumber
 240                                                            encodedRateLimiter:zse.encodedRateLimiter];
 241
 242     CKKSZoneStateEntry* zseDifferent = [[CKKSZoneStateEntry alloc] initWithCKZone:@"sqltest"
 243                                                                       zoneCreated:true
 244                                                                    zoneSubscribed:true
 245                                                                       changeToken:[@"allnonsense" dataUsingEncoding:NSUTF8StringEncoding]
 246                                                                         lastFetch:zse.lastFetchTime
 247                                                                         lastFixup:CKKSCurrentFixupNumber
 248                                                                encodedRateLimiter:zse.encodedRateLimiter];
 249     XCTAssertEqualObjects(zse, zseClone, "CKKSZoneStateEntry isEqual of equal objects seems sane");
 250     XCTAssertNotEqualObjects(zse, zseDifferent, "CKKSZoneStateEntry isEqual of nonequal objects seems sane");
 251
 252     NSError* error = nil;
 253     CKKSZoneStateEntry* loaded = [CKKSZoneStateEntry tryFromDatabase: @"sqltest" error:&error];
 254     XCTAssertNil(error, "No error trying to load nonexistent record");
 255     XCTAssertNil(loaded, "No record saved in database");
 256
 257     [zse saveToDatabase: &error];
 258     XCTAssertNil(error, "no error saving CKKSZoneStateEntry to database");
 259
 260     loaded = [CKKSZoneStateEntry tryFromDatabase: @"sqltest" error:&error];
 261     XCTAssertNil(error, "No error trying to load saved record");
 262     XCTAssertNotNil(loaded, "CKKSZoneStateEntry came back out of database");
 263
 264     XCTAssertEqualObjects(zse.ckzone,             loaded.ckzone,              "ckzone persisted through db save and load");
 265     XCTAssertEqual       (zse.ckzonecreated,      loaded.ckzonecreated,       "ckzonecreated persisted through db save and load");
 266     XCTAssertEqual       (zse.ckzonesubscribed,   loaded.ckzonesubscribed,    "ckzonesubscribed persisted through db save and load");
 267     XCTAssertEqualObjects(zse.encodedChangeToken, loaded.encodedChangeToken, "encodedChangeToken persisted through db save and load");
 268
 269     XCTAssert([[NSCalendar currentCalendar] isDate:zse.lastFetchTime equalToDate: loaded.lastFetchTime toUnitGranularity:NSCalendarUnitSecond],
 270                                                                    "lastFetchTime persisted through db save and load");
 271 }
 272
 273 -(void)testRoundtripCKKSDeviceStateEntry {
 274     // Very simple test: can these objects roundtrip through the db?
 275     NSString* testUUID = @"157A3171-0677-451B-9EAE-0DDC4D4315B0";
 276     CKKSDeviceStateEntry* cdse = [[CKKSDeviceStateEntry alloc] initForDevice:testUUID
 277                                                                    osVersion:@"faux-version"
 278                                                               lastUnlockTime:nil
 279                                                                 circlePeerID:@"asdf"
 280                                                                 circleStatus:kSOSCCInCircle
 281                                                                     keyState:SecCKKSZoneKeyStateReady
 282                                                               currentTLKUUID:@"tlk"
 283                                                            currentClassAUUID:@"classA"
 284                                                            currentClassCUUID:@"classC"
 285                                                                       zoneID:self.testZoneID
 286                                                              encodedCKRecord:nil];
 287     XCTAssertNotNil(cdse, "Constructor works");
 288     NSError* saveError = nil;
 289     [cdse saveToDatabase:&saveError];
 290     XCTAssertNil(saveError, "No error saving cdse to database");
 291
 292     NSError* loadError = nil;
 293     CKKSDeviceStateEntry* loadedCDSE = [CKKSDeviceStateEntry fromDatabase:testUUID zoneID:self.testZoneID error:&loadError];
 294     XCTAssertNil(loadError, "No error loading CDSE");
 295     XCTAssertNotNil(loadedCDSE, "Received a CDSE back");
 296
 297     XCTAssertEqualObjects(cdse, loadedCDSE, "Roundtripping CKKSDeviceStateEntry ends up with equivalent objects");
 298 }
 299
 300 // disabled, as CKKS syncing is disabled in this class.
 301 // To re-enable, need to add flags CKKS syncing to perform queue actions but not automatically start queue processing operations
 302 -(void)disabledtestItemAddCreatesCKKSOutgoingQueueEntry {
 303     CFMutableDictionaryRef              attrs;
 304     CFDataRef                                   data;
 305
 306     NSError* error;
 307
 308     NSArray* oqes = [CKKSOutgoingQueueEntry all: &error];
 309     XCTAssertEqual([oqes count], 0ul, @"Nothing in outgoing queue");
 310     XCTAssertNil(error, @"No error loading queue");
 311
 312     attrs = CFDictionaryCreateMutable( NULL, 0, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks );
 313     CFDictionarySetValue( attrs, kSecClass, kSecClassGenericPassword );
 314     CFDictionarySetValue( attrs, kSecAttrAccessible, kSecAttrAccessibleAlwaysPrivate );
 315     CFDictionarySetValue( attrs, kSecAttrLabel, CFSTR( "TestLabel" ) );
 316     CFDictionarySetValue( attrs, kSecAttrDescription, CFSTR( "TestDescription" ) );
 317     CFDictionarySetValue( attrs, kSecAttrAccount, CFSTR( "TestAccount" ) );
 318     CFDictionarySetValue( attrs, kSecAttrService, CFSTR( "TestService" ) );
 319     CFDictionarySetValue( attrs, kSecAttrAccessGroup, CFSTR("com.apple.lakitu"));
 320     data = CFDataCreate( NULL, (const uint8_t *) "important data", strlen("important data"));
 321     CFDictionarySetValue( attrs, kSecValueData, data );
 322     CFRelease( data );
 323
 324     XCTAssertEqual(SecItemAdd(attrs, NULL), errSecSuccess, @"Adding item works flawlessly");
 325
 326     oqes = [CKKSOutgoingQueueEntry all: &error];
 327     XCTAssertEqual([oqes count], 1ul, @"Single entry in outgoing queue after adding item");
 328     XCTAssertNil(error, @"No error loading queue");
 329
 330     CFDictionarySetValue( attrs, kSecAttrLabel, CFSTR( "TestLabel2" ) );
 331     CFDictionarySetValue( attrs, kSecAttrAccount, CFSTR( "TestAccount2" ) );
 332     CFDictionarySetValue( attrs, kSecAttrService, CFSTR( "TestService2" ) );
 333     XCTAssertEqual(SecItemAdd(attrs, NULL), errSecSuccess);
 334     CFRelease( attrs );
 335
 336     oqes = [CKKSOutgoingQueueEntry all: &error];
 337     XCTAssertEqual([oqes count], 2ul, @"Two entries in outgoing queue after adding item");
 338     XCTAssertNil(error, @"No error loading queue");
 339 }
 340
 341 - (void)testCKKSKey {
 342     CKKSKey* key = nil;
 343     NSString* testUUID = @"157A3171-0677-451B-9EAE-0DDC4D4315B0";
 344     NSString* testParentUUID = @"f5e7f20f-0885-48f9-b75d-9f0cfd2171b6";
 345
 346     NSData* testCKRecord = [@"nonsense" dataUsingEncoding:NSUTF8StringEncoding];
 347
 348     CKKSWrappedAESSIVKey* wrappedkey = [[CKKSWrappedAESSIVKey alloc] initWithBase64:@"KFfL58XtugiYNoD859EjG0StfrYd6eakm0CQrgX7iO+DEo4kio3WbEeA1kctCU0GaeTGsRFpbdy4oo6jXhVu7cZqB0svhUPGq55aGnszUjI="];
 349
 350     NSError* error = nil;
 351
 352     key = [CKKSKey fromDatabase:testUUID zoneID:self.testZoneID error:&error];
 353     XCTAssertNil(key, "key does not exist yet");
 354     XCTAssertNotNil(error, "error exists when things go wrong");
 355     error = nil;
 356
 357     key = [[CKKSKey alloc] initWithWrappedAESKey: wrappedkey
 358                                             uuid: testUUID
 359                                    parentKeyUUID:testParentUUID
 360                                         keyclass:SecCKKSKeyClassA
 361                                            state: SecCKKSProcessedStateLocal
 362                                           zoneID:self.testZoneID
 363                                  encodedCKRecord:testCKRecord
 364                                       currentkey:true];
 365     XCTAssertNotNil(key, "could create key");
 366
 367     [key saveToDatabase: &error];
 368     XCTAssertNil(error, "could save key to database");
 369     error = nil;
 370
 371     CKKSKey* key2 = [CKKSKey fromDatabase:testUUID zoneID:self.testZoneID error:&error];
 372     XCTAssertNil(error, "no error exists when loading key");
 373     XCTAssertNotNil(key2, "key was fetched properly");
 374
 375     XCTAssertEqualObjects(key.uuid, key2.uuid, "key uuids match");
 376     XCTAssertEqualObjects(key.parentKeyUUID, key2.parentKeyUUID, "parent key uuids match");
 377     XCTAssertEqualObjects(key.state, key2.state, "key states match");
 378     XCTAssertEqualObjects(key.encodedCKRecord, key2.encodedCKRecord, "encodedCKRecord match");
 379     XCTAssertEqualObjects(key.wrappedkey, key2.wrappedkey, "wrapped keys match");
 380     XCTAssertEqual(key.currentkey, key2.currentkey, "currentkey match");
 381 }
 382
 383 - (void)testWhere {
 384     NSError* error = nil;
 385
 386     NSData* testCKRecord = [@"nonsense" dataUsingEncoding:NSUTF8StringEncoding];
 387
 388     CKKSKey* tlk = [[CKKSKey alloc] initSelfWrappedWithAESKey: [[CKKSAESSIVKey alloc] initWithBase64: @"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=="]
 389                                                          uuid:@"8b2aeb7f-4af3-43e9-b6e6-70d5c728ebf7"
 390                                                      keyclass:SecCKKSKeyClassTLK
 391                                                         state: SecCKKSProcessedStateLocal
 392                                                        zoneID:self.testZoneID
 393                                               encodedCKRecord: testCKRecord
 394                                                    currentkey: true];
 395     XCTAssertTrue([tlk saveToDatabase: &error], "TLK saved to database");
 396     XCTAssertNil(error, "no error saving TLK to database");
 397
 398     CKKSKey* wrappedKey = [[CKKSKey alloc] initWrappedBy: tlk
 399                                                   AESKey:[CKKSAESSIVKey randomKey]
 400                                                     uuid:@"157A3171-0677-451B-9EAE-0DDC4D4315B0"
 401                                                 keyclass:SecCKKSKeyClassC
 402                                                    state: SecCKKSProcessedStateLocal
 403                                                   zoneID:self.testZoneID
 404                                          encodedCKRecord:testCKRecord
 405                                               currentkey:true];
 406     XCTAssertTrue([wrappedKey saveToDatabase: &error], "key saved to database");
 407     XCTAssertNil(error, "no error saving key to database");
 408
 409     NSArray<CKKSKey*>* tlks = [CKKSKey allWhere: @{@"UUID": @"8b2aeb7f-4af3-43e9-b6e6-70d5c728ebf7"} error: &error];
 410     XCTAssertNotNil(tlks, "Returned some array from allWhere");
 411     XCTAssertNil(error, "no error back from allWhere");
 412     XCTAssertEqual([tlks count], 1ul, "Received one row (and expected one row)");
 413
 414     NSArray<CKKSKey*>* selfWrapped = [CKKSKey allWhere: @{@"parentKeyUUID": [CKKSSQLWhereObject op:@"=" string:@"uuid"]} error: &error];
 415     XCTAssertNotNil(selfWrapped, "Returned some array from allWhere");
 416     XCTAssertNil(error, "no error back from allWhere");
 417     XCTAssertEqual([selfWrapped count], 1ul, "Received one row (and expected one row)");
 418
 419     // Try using CKKSSQLWhereObject alongside normal binds
 420     NSArray<CKKSKey*>* selfWrapped2 = [CKKSKey allWhere: @{@"parentKeyUUID": [CKKSSQLWhereObject op:@"=" string:@"uuid"],
 421                                                            @"uuid": @"8b2aeb7f-4af3-43e9-b6e6-70d5c728ebf7"}
 422                                                   error: &error];
 423     XCTAssertNotNil(selfWrapped2, "Returned some array from allWhere");
 424     XCTAssertNil(error, "no error back from allWhere");
 425     XCTAssertEqual([selfWrapped2 count], 1ul, "Received one row (and expected one row)");
 426 }
 427
 428 - (void)testGroupBy {
 429     [self addTestZoneEntries];
 430     NSError* error = nil;
 431
 432     __block NSMutableDictionary<NSString*, NSString*>* results = [[NSMutableDictionary alloc] init];
 433     NSDictionary* expectedResults = nil;
 434
 435     [CKKSSQLDatabaseObject queryDatabaseTable: [CKKSOutgoingQueueEntry sqlTable]
 436                                         where: nil
 437                                       columns: @[@"action", @"count(rowid)"]
 438                                       groupBy: @[@"action"]
 439                                       orderBy:nil
 440                                         limit: -1
 441                                    processRow: ^(NSDictionary* row) {
 442                                        results[row[@"action"]] = row[@"count(rowid)"];
 443                                    }
 444                                         error: &error];
 445
 446     XCTAssertNil(error, "no error doing group by query");
 447     expectedResults = @{
 448                       SecCKKSActionAdd: @"2",
 449                       SecCKKSActionModify: @"1"
 450                       };
 451     XCTAssertEqualObjects(results, expectedResults, "Recieved correct group by result");
 452
 453     // Now test with a where clause:
 454     results = [[NSMutableDictionary alloc] init];
 455     [CKKSSQLDatabaseObject queryDatabaseTable: [CKKSOutgoingQueueEntry sqlTable]
 456                                         where: @{@"state": SecCKKSStateError}
 457                                       columns: @[@"action", @"count(rowid)"]
 458                                       groupBy: @[@"action"]
 459                                       orderBy:nil
 460                                         limit: -1
 461                                    processRow: ^(NSDictionary* row) {
 462                                        results[row[@"action"]] = row[@"count(rowid)"];
 463                                    }
 464                                         error: &error];
 465
 466     XCTAssertNil(error, "no error doing where+group by query");
 467     expectedResults = @{
 468                       SecCKKSActionAdd: @"1",
 469                       SecCKKSActionModify: @"1"
 470                       };
 471     XCTAssertEqualObjects(results, expectedResults, "Recieved correct where+group by result");
 472 }
 473
 474 - (void)testOrderBy {
 475     [self addTestZoneEntries];
 476     NSError* error = nil;
 477
 478     __block NSMutableArray* rows = [[NSMutableArray alloc] init];
 479
 480     [CKKSSQLDatabaseObject queryDatabaseTable: [CKKSOutgoingQueueEntry sqlTable]
 481                                         where: nil
 482                                       columns: @[@"action", @"uuid"]
 483                                       groupBy:nil
 484                                       orderBy:@[@"uuid"]
 485                                         limit:-1
 486                                    processRow: ^(NSDictionary* row) {
 487                                        [rows addObject:row];
 488                                    }
 489                                         error: &error];
 490
 491     XCTAssertNil(error, "no error doing order by query");
 492     XCTAssertEqual(rows.count, 3u, "got three items");
 493
 494     XCTAssertEqual([rows[0][@"uuid"] compare: rows[1][@"uuid"]], NSOrderedAscending, "first order is fine");
 495     XCTAssertEqual([rows[1][@"uuid"] compare: rows[2][@"uuid"]], NSOrderedAscending, "second order is fine");
 496
 497     // Check that order-by + limit works to page
 498     __block NSString* lastUUID = nil;
 499     __block NSString* uuid = nil;
 500     uint64_t count = 0;
 501
 502     while(count == 0 || uuid != nil) {
 503         uuid = nil;
 504         [CKKSSQLDatabaseObject queryDatabaseTable: [CKKSOutgoingQueueEntry sqlTable]
 505                                             where: lastUUID ? @{@"UUID": [CKKSSQLWhereObject op:@">" stringValue:lastUUID]} : nil
 506                                           columns: @[@"action", @"UUID"]
 507                                           groupBy:nil
 508                                           orderBy:@[@"uuid"]
 509                                             limit:1
 510                                        processRow: ^(NSDictionary* row) {
 511                                            XCTAssertNil(uuid, "Only one row returned");
 512                                            uuid = row[@"UUID"];
 513                                        }
 514                                             error: &error];
 515         XCTAssertNil(error, "No error doing SQL");
 516         if(uuid && lastUUID) {
 517             XCTAssertEqual([lastUUID compare:uuid], NSOrderedAscending, "uuids returning in right order");
 518         }
 519         lastUUID = uuid;
 520         count += 1;
 521     }
 522     XCTAssertEqual(count, 4u, "Received 3 objects (and 1 nil)");
 523 }
 524
 525 - (void)testLimit {
 526     [self addTestZoneEntries];
 527     NSError* error = nil;
 528
 529     __block NSMutableDictionary<NSString*, NSString*>* results = [[NSMutableDictionary alloc] init];
 530
 531     [CKKSSQLDatabaseObject queryDatabaseTable: [CKKSOutgoingQueueEntry sqlTable]
 532                                         where: nil
 533                                       columns: @[@"uuid", @"action"]
 534                                       groupBy: nil
 535                                       orderBy:nil
 536                                         limit: -1
 537                                    processRow: ^(NSDictionary* row) {
 538                                        results[row[@"uuid"]] = row[@"action"];
 539                                    }
 540                                         error: &error];
 541
 542     XCTAssertNil(error, "no error doing vanilla query");
 543     XCTAssertEqual(results.count, 3u, "Received three elements in normal query");
 544     results = [[NSMutableDictionary alloc] init];
 545
 546     [CKKSSQLDatabaseObject queryDatabaseTable: [CKKSOutgoingQueueEntry sqlTable]
 547                                         where: nil
 548                                       columns: @[@"uuid", @"action"]
 549                                       groupBy: nil
 550                                       orderBy:nil
 551                                         limit: 1
 552                                    processRow: ^(NSDictionary* row) {
 553                                        results[row[@"uuid"]] = row[@"action"];
 554                                    }
 555                                         error: &error];
 556
 557     XCTAssertNil(error, "no error doing limit query");
 558     XCTAssertEqual(results.count, 1u, "Received one element in limited query");
 559     results = [[NSMutableDictionary alloc] init];
 560
 561     // Now test with a where clause:
 562     results = [[NSMutableDictionary alloc] init];
 563     [CKKSSQLDatabaseObject queryDatabaseTable: [CKKSOutgoingQueueEntry sqlTable]
 564                                         where: @{@"state": SecCKKSStateError}
 565                                       columns: @[@"uuid", @"action"]
 566                                       groupBy: nil
 567                                       orderBy:nil
 568                                         limit: 3
 569                                    processRow: ^(NSDictionary* row) {
 570                                        results[row[@"uuid"]] = row[@"action"];
 571                                    }
 572                                         error: &error];
 573
 574     XCTAssertNil(error, "no error doing limit+where query");
 575     XCTAssertEqual(results.count, 2u, "Received two elements in where+limited query");
 576     results = [[NSMutableDictionary alloc] init];
 577
 578     results = [[NSMutableDictionary alloc] init];
 579     [CKKSSQLDatabaseObject queryDatabaseTable: [CKKSOutgoingQueueEntry sqlTable]
 580                                         where: @{@"state": SecCKKSStateError}
 581                                       columns: @[@"uuid", @"action"]
 582                                       groupBy: nil
 583                                       orderBy:nil
 584                                         limit: 1
 585                                    processRow: ^(NSDictionary* row) {
 586                                        results[row[@"uuid"]] = row[@"action"];
 587                                    }
 588                                         error: &error];
 589
 590     XCTAssertNil(error, "no error doing limit+where query");
 591     XCTAssertEqual(results.count, 1u, "Received one element in where+limited query");
 592     results = [[NSMutableDictionary alloc] init];
 593 }
 594
 595 @end
 596
 597 #endif