5 #import <Foundation/Foundation.h>
6 #import <Foundation/NSXPCConnection_Private.h>
7 #import <Security/Security.h>
8 #import <Security/SecItemPriv.h>
12 #import "keychain/ckks/CKKS.h"
13 #import "keychain/ckks/CKKSControl.h"
15 #include "lib/SecArgParse.h"
17 static void nsprintf(NSString *fmt, ...) NS_FORMAT_FUNCTION(1, 2);
18 static void print_result(NSDictionary *dict, bool json_flag);
19 static void print_dict(NSDictionary *dict, int ind);
20 static void print_array(NSArray *array, int ind);
21 static void print_entry(id k, id v, int ind);
23 static void nsprintf(NSString *fmt, ...)
27 NSString *str = [[NSString alloc] initWithFormat:fmt arguments:ap];
30 puts([str UTF8String]);
31 #if !__has_feature(objc_arc)
36 // Mutual recursion to set up an object for jsonification
37 static NSDictionary* cleanDictionaryForJSON(NSDictionary* dict);
39 static id cleanObjectForJSON(id obj) {
43 if([obj isKindOfClass:[NSError class]]) {
44 NSError* obje = (NSError*) obj;
45 NSMutableDictionary* newErrorDict = [@{@"code": @(obje.code), @"domain": obje.domain} mutableCopy];
46 newErrorDict[@"userInfo"] = cleanDictionaryForJSON(obje.userInfo);
48 } else if([NSJSONSerialization isValidJSONObject:obj]) {
51 } else if ([obj isKindOfClass: [NSNumber class]]) {
54 } else if([obj isKindOfClass: [NSData class]]) {
55 NSData* dataObj = (NSData*)obj;
56 return [dataObj base64EncodedStringWithOptions:0];
58 } else if ([obj isKindOfClass: [NSDictionary class]]) {
59 return cleanDictionaryForJSON((NSDictionary*) obj);
61 } else if ([obj isKindOfClass: [NSArray class]]) {
62 NSArray* arrayObj = (NSArray*)obj;
63 NSMutableArray* cleanArray = [NSMutableArray arrayWithCapacity:arrayObj.count];
65 for(id x in arrayObj) {
66 [cleanArray addObject: cleanObjectForJSON(x)];
71 return [obj description];
75 static NSDictionary* cleanDictionaryForJSON(NSDictionary* dict) {
79 NSMutableDictionary* mutDict = [dict mutableCopy];
80 for(id key in mutDict.allKeys) {
81 id obj = mutDict[key];
82 mutDict[key] = cleanObjectForJSON(obj);
87 static void print_result(NSDictionary *dict, bool json_flag)
92 NSData *json = [NSJSONSerialization dataWithJSONObject:cleanDictionaryForJSON(dict)
93 options:(NSJSONWritingPrettyPrinted | NSJSONWritingSortedKeys)
96 NSLog(@"error: %@", err.localizedDescription);
98 printf("%s", [[[NSString alloc] initWithData:json encoding:NSUTF8StringEncoding] UTF8String]);
105 static void print_dict(NSDictionary *dict, int ind)
107 NSArray *sortedKeys = [[dict allKeys] sortedArrayUsingSelector:@selector(localizedCaseInsensitiveCompare:)];
108 for (id k in sortedKeys) {
110 print_entry(k, v, ind);
114 static void print_array(NSArray *array, int ind)
116 [array enumerateObjectsUsingBlock:^(id v, NSUInteger i, BOOL *stop __unused) {
117 print_entry(@(i), v, ind);
121 static void print_entry(id k, id v, int ind)
123 if ([v isKindOfClass:[NSDictionary class]]) {
125 nsprintf(@"\n%*s%@ -", ind * 4, "", k);
126 nsprintf(@"%*s========================", ind * 4, "");
127 } else if (ind == 1) {
128 nsprintf(@"\n%*s%@ -", ind * 4, "", k);
129 nsprintf(@"%*s------------------------", ind * 4, "");
131 nsprintf(@"%*s%@ -", ind * 4, "", k);
134 print_dict(v, ind + 1);
135 } else if ([v isKindOfClass:[NSArray class]]) {
136 nsprintf(@"%*s%@ -", ind * 4, "", k);
137 print_array(v, ind + 1);
139 nsprintf(@"%*s%@: %@", ind * 4, "", k, v);
143 @interface CKKSControlCLI : NSObject
144 @property CKKSControl* control;
147 @implementation CKKSControlCLI
149 - (instancetype) initWithCKKSControl:(CKKSControl*)control {
150 if ((self = [super init])) {
157 - (NSDictionary<NSString *, id> *)fetchPerformanceCounters
159 NSMutableDictionary *perfDict = [[NSMutableDictionary alloc] init];
161 dispatch_semaphore_t sema = dispatch_semaphore_create(0);
163 [self.control rpcPerformanceCounters:^(NSDictionary<NSString *,NSNumber *> * counters, NSError * error) {
165 perfDict[@"error"] = [error description];
168 [counters enumerateKeysAndObjectsUsingBlock:^(NSString * key, NSNumber * obj, BOOL *stop) {
172 dispatch_semaphore_signal(sema);
175 if(dispatch_semaphore_wait(sema, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 60)) != 0) {
176 perfDict[@"error"] = @"timed out waiting for response";
183 - (long)resetLocal:(NSString*)view {
184 __block long ret = 0;
186 printf("Beginning local reset for %s...\n", view ? [[view description] UTF8String] : "all zones");
187 dispatch_semaphore_t sema = dispatch_semaphore_create(0);
189 [self.control rpcResetLocal:view
190 reply:^(NSError *error) {
192 printf("reset complete.\n");
195 nsprintf(@"reset error: %@\n", error);
198 dispatch_semaphore_signal(sema);
201 if(dispatch_semaphore_wait(sema, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 60 * 2)) != 0) {
202 printf("\n\nError: timed out waiting for response\n");
209 - (long)resetCloudKit:(NSString*)view {
210 __block long ret = 0;
212 printf("Beginning CloudKit reset for %s...\n", view ? [[view description] UTF8String] : "all zones");
213 dispatch_semaphore_t sema = dispatch_semaphore_create(0);
215 [self.control rpcResetCloudKit:view reason:@"ckksctl" reply:^(NSError* error){
217 printf("CloudKit Reset complete.\n");
220 nsprintf(@"Reset error: %@\n", error);
223 dispatch_semaphore_signal(sema);
226 if(dispatch_semaphore_wait(sema, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 60 * 5)) != 0) {
227 printf("\n\nError: timed out waiting for response\n");
234 - (long)resync:(NSString*)view {
235 __block long ret = 0;
237 printf("Beginning resync for %s...\n", view ? [[view description] UTF8String] : "all zones");
238 dispatch_semaphore_t sema = dispatch_semaphore_create(0);
240 [self.control rpcResync:view reply:^(NSError* error){
242 printf("resync success.\n");
245 nsprintf(@"resync errored: %@\n", error);
248 dispatch_semaphore_signal(sema);
251 if(dispatch_semaphore_wait(sema, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 60 * 2)) != 0) {
252 printf("\n\nError: timed out waiting for response\n");
259 - (NSDictionary<NSString *, id> *)fetchStatus: (NSString*) view {
260 NSMutableDictionary *status = [[NSMutableDictionary alloc] init];
262 dispatch_semaphore_t sema = dispatch_semaphore_create(0);
264 [self.control rpcStatus: view reply: ^(NSArray<NSDictionary*>* result, NSError* error) {
266 status[@"error"] = [error description];
269 if(result.count <= 1u) {
270 printf("No CKKS views are active.\n");
274 for(NSDictionary* viewStatus in result) {
275 status[viewStatus[@"view"]] = viewStatus;
277 dispatch_semaphore_signal(sema);
280 if(dispatch_semaphore_wait(sema, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 30)) != 0) {
281 status[@"error"] = @"timed out";
287 - (void)printHumanReadableStatus: (NSString*) view {
289 dispatch_semaphore_t sema = dispatch_semaphore_create(0);
291 [self.control rpcStatus: view reply: ^(NSArray<NSDictionary*>* result, NSError* error) {
293 printf("ERROR FETCHING STATUS: %s\n", [[error description] UTF8String]);
296 #define pop(d, key, cls) ({ id x = d[key]; d[key] = nil; [x isKindOfClass: [cls class]] ? x : nil; })
298 // First result is always global state
299 // Ideally, this would come in another parameter, but we can't change the protocol until
300 // <rdar://problem/33583242> CKKS: remove PCS's use of CKKSControlProtocol
301 NSMutableDictionary* global = [result[0] mutableCopy];
303 NSString* reachability = pop(global, @"reachability", NSString);
304 NSString* ckdeviceID = pop(global, @"ckdeviceID", NSString);
305 NSString* ckdeviceIDError = pop(global, @"ckdeviceIDError", NSString);
306 NSString* lockStateTracker = pop(global,@"lockstatetracker", NSString);
307 NSString* retry = pop(global,@"cloudkitRetryAfter", NSString);
309 printf("================================================================================\n\n");
310 printf("Global state:\n\n");
311 printf("Reachability: %s\n", [[reachability description] UTF8String]);
312 printf("Retry: %s\n", [[retry description] UTF8String]);
313 printf("CK DeviceID: %s\n", [[ckdeviceID description] UTF8String]);
314 printf("CK DeviceID Error: %s\n", [[ckdeviceIDError description] UTF8String]);
315 printf("Lock state: %s\n", [[lockStateTracker description] UTF8String]);
320 NSArray* remainingViews = result.count > 1 ? [result subarrayWithRange:NSMakeRange(1, result.count-1)] : @[];
322 if(remainingViews.count == 0u) {
323 printf("No CKKS views are active.\n");
326 for(NSDictionary* viewStatus in remainingViews) {
327 NSMutableDictionary* status = [viewStatus mutableCopy];
329 NSString* viewName = pop(status,@"view", NSString);
330 NSString* accountStatus = pop(status,@"ckaccountstatus", NSString);
331 NSString* accountTracker = pop(status,@"accounttracker", NSString);
332 NSString* fetcher = pop(status,@"fetcher", NSString);
333 NSString* zoneCreated = pop(status,@"zoneCreated", NSString);
334 NSString* zoneCreatedError = pop(status,@"zoneCreatedError", NSString);
335 NSString* zoneSubscribed = pop(status,@"zoneSubscribed", NSString);
336 NSString* zoneSubscribedError = pop(status,@"zoneSubscribedError", NSString);
337 NSString* zoneInitializeScheduler = pop(status,@"zoneInitializeScheduler", NSString);
338 NSString* keystate = pop(status,@"keystate", NSString);
339 NSString* keyStateError = pop(status,@"keyStateError", NSString);
340 NSString* statusError = pop(status,@"statusError", NSString);
341 NSString* currentTLK = pop(status,@"currentTLK", NSString);
342 NSString* currentClassA = pop(status,@"currentClassA", NSString);
343 NSString* currentClassC = pop(status,@"currentClassC", NSString);
344 NSString* currentTLKPtr = pop(status,@"currentTLKPtr", NSString);
345 NSString* currentClassAPtr = pop(status,@"currentClassAPtr", NSString);
346 NSString* currentClassCPtr = pop(status,@"currentClassCPtr", NSString);
347 NSString* currentManifestGeneration = pop(status,@"currentManifestGen", NSString);
348 NSArray* launchSequence = pop(status, @"launchSequence", NSArray);
350 NSDictionary* oqe = pop(status,@"oqe", NSDictionary);
351 NSDictionary* iqe = pop(status,@"iqe", NSDictionary);
352 NSDictionary* keys = pop(status,@"keys", NSDictionary);
353 NSDictionary* ckmirror = pop(status,@"ckmirror", NSDictionary);
354 NSArray* devicestates = pop(status, @"devicestates", NSArray);
355 NSArray* tlkshares = pop(status, @"tlkshares", NSArray);
357 NSString* zoneSetupOperation = pop(status,@"zoneSetupOperation", NSString);
358 NSString* keyStateOperation = pop(status,@"keyStateOperation", NSString);
359 NSString* lastIncomingQueueOperation = pop(status,@"lastIncomingQueueOperation", NSString);
360 NSString* lastNewTLKOperation = pop(status,@"lastNewTLKOperation", NSString);
361 NSString* lastOutgoingQueueOperation = pop(status,@"lastOutgoingQueueOperation", NSString);
362 NSString* lastProcessReceivedKeysOperation = pop(status,@"lastProcessReceivedKeysOperation", NSString);
363 NSString* lastReencryptOutgoingItemsOperation = pop(status,@"lastReencryptOutgoingItemsOperation", NSString);
364 NSString* lastScanLocalItemsOperation = pop(status,@"lastScanLocalItemsOperation", NSString);
366 printf("================================================================================\n\n");
368 printf("View: %s\n\n", [viewName UTF8String]);
370 if(statusError != nil) {
371 printf("ERROR FETCHING STATUS: %s\n\n", [statusError UTF8String]);
374 printf("CloudKit account: %s\n", [accountStatus UTF8String]);
375 printf("Account tracker: %s\n", [accountTracker UTF8String]);
377 if(!([zoneCreated isEqualToString:@"yes"] && [zoneSubscribed isEqualToString:@"yes"])) {
378 printf("CK Zone Created: %s\n", [[zoneCreated description] UTF8String]);
379 printf("CK Zone Created error: %s\n", [[zoneCreatedError description] UTF8String]);
381 printf("CK Zone Subscribed: %s\n", [[zoneSubscribed description] UTF8String]);
382 printf("CK Zone Subscription error: %s\n", [[zoneSubscribedError description] UTF8String]);
383 printf("CK Zone initialize retry: %s\n", [[zoneInitializeScheduler description] UTF8String]);
387 printf("Key state: %s\n", [keystate UTF8String]);
388 if(keyStateError != nil) {
389 printf("Key State Error: %s\n", [keyStateError UTF8String]);
391 printf("Current TLK: %s\n", currentTLK != nil
392 ? [currentTLK UTF8String]
393 : [[NSString stringWithFormat:@"missing; pointer is %@", currentTLKPtr] UTF8String]);
394 printf("Current ClassA: %s\n", currentClassA != nil
395 ? [currentClassA UTF8String]
396 : [[NSString stringWithFormat:@"missing; pointer is %@", currentClassAPtr] UTF8String]);
397 printf("Current ClassC: %s\n", currentClassC != nil
398 ? [currentClassC UTF8String]
399 : [[NSString stringWithFormat:@"missing; pointer is %@", currentClassCPtr] UTF8String]);
401 printf("TLK shares: %s\n", [[tlkshares description] UTF8String]);
403 printf("Outgoing Queue counts: %s\n", [[oqe description] UTF8String]);
404 printf("Incoming Queue counts: %s\n", [[iqe description] UTF8String]);
405 printf("Key counts: %s\n", [[keys description] UTF8String]);
406 printf("latest manifest generation: %s\n", currentManifestGeneration == nil ? "null" : currentManifestGeneration.UTF8String);
408 printf("Item counts (by key): %s\n", [[ckmirror description] UTF8String]);
409 printf("Peer states: %s\n", [[devicestates description] UTF8String]);
411 printf("zone change fetcher: %s\n", [[fetcher description] UTF8String]);
412 printf("zoneSetupOperation: %s\n", zoneSetupOperation == nil ? "never" : [zoneSetupOperation UTF8String]);
413 printf("keyStateOperation: %s\n", keyStateOperation == nil ? "never" : [keyStateOperation UTF8String]);
414 printf("lastIncomingQueueOperation: %s\n", lastIncomingQueueOperation == nil ? "never" : [lastIncomingQueueOperation UTF8String]);
415 printf("lastNewTLKOperation: %s\n", lastNewTLKOperation == nil ? "never" : [lastNewTLKOperation UTF8String]);
416 printf("lastOutgoingQueueOperation: %s\n", lastOutgoingQueueOperation == nil ? "never" : [lastOutgoingQueueOperation UTF8String]);
417 printf("lastProcessReceivedKeysOperation: %s\n", lastProcessReceivedKeysOperation == nil ? "never" : [lastProcessReceivedKeysOperation UTF8String]);
418 printf("lastReencryptOutgoingItemsOperation: %s\n", lastReencryptOutgoingItemsOperation == nil ? "never" : [lastReencryptOutgoingItemsOperation UTF8String]);
419 printf("lastScanLocalItemsOperation: %s\n", lastScanLocalItemsOperation == nil ? "never" : [lastScanLocalItemsOperation UTF8String]);
421 printf("Launch sequence:\n");
422 for (NSString *event in launchSequence) {
423 printf("\t%s\n", [[event description] UTF8String]);
426 if(status.allKeys.count > 0u) {
427 printf("\nExtra information: %s\n", [[status description] UTF8String]);
431 dispatch_semaphore_signal(sema);
434 if(dispatch_semaphore_wait(sema, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 30)) != 0) {
435 printf("\n\nError: timed out waiting for response\n");
440 - (long)fetch:(NSString*)view {
441 __block long ret = 0;
443 dispatch_semaphore_t sema = dispatch_semaphore_create(0);
445 [self.control rpcFetchAndProcessChanges:view reply:^(NSError* error) {
447 printf("Error fetching: %s\n", [[error description] UTF8String]);
448 ret = (error.code == 0 ? -1 : error.code);
450 printf("Complete.\n");
454 dispatch_semaphore_signal(sema);
457 if(dispatch_semaphore_wait(sema, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 65)) != 0) {
458 printf("\n\nError: timed out waiting for response\n");
465 - (long)push:(NSString*)view {
466 __block long ret = 0;
468 dispatch_semaphore_t sema = dispatch_semaphore_create(0);
470 [self.control rpcPushOutgoingChanges:view reply:^(NSError* error) {
472 printf("Error pushing: %s\n", [[error description] UTF8String]);
473 ret = (error.code == 0 ? -1 : error.code);
475 printf("Complete.\n");
478 dispatch_semaphore_signal(sema);
481 if(dispatch_semaphore_wait(sema, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 65)) != 0) {
482 printf("\n\nError: timed out waiting for response\n");
491 __block long ret = 0;
493 dispatch_semaphore_t sema = dispatch_semaphore_create(0);
495 [self.control rpcCKMetric:@"testMetric" attributes:@{ @"testAttribute" : @"value" } reply:^(NSError* error) {
497 printf("Error sending metric: %s\n", [[error description] UTF8String]);
498 ret = (error.code == 0 ? -1 : error.code);
500 printf("Complete.\n");
503 dispatch_semaphore_signal(sema);
506 if(dispatch_semaphore_wait(sema, dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC * 65)) != 0) {
507 printf("\n\nError: timed out waiting for response\n");
518 static int perfCounters = false;
519 static int status = false;
520 static int resync = false;
521 static int reset = false;
522 static int resetCloudKit = false;
523 static int fetch = false;
524 static int push = false;
525 static int json = false;
526 static int ckmetric = false;
528 static char* viewArg = NULL;
530 int main(int argc, char **argv)
532 static struct argument options[] = {
533 { .shortname='p', .longname="perfcounters", .flag=&perfCounters, .flagval=true, .description="Print CKKS performance counters"},
534 { .shortname='j', .longname="json", .flag=&json, .flagval=true, .description="Output in JSON format"},
535 { .shortname='v', .longname="view", .argument=&viewArg, .description="Operate on a single view"},
537 { .command="status", .flag=&status, .flagval=true, .description="Report status on CKKS views"},
538 { .command="fetch", .flag=&fetch, .flagval=true, .description="Fetch all new changes in CloudKit and attempt to process them"},
539 { .command="push", .flag=&push, .flagval=true, .description="Push all pending local changes to CloudKit"},
540 { .command="resync", .flag=&resync, .flagval=true, .description="Resync all data with what's in CloudKit"},
541 { .command="reset", .flag=&reset, .flagval=true, .description="All local data will be wiped, and data refetched from CloudKit"},
542 { .command="reset-cloudkit", .flag=&resetCloudKit, .flagval=true, .description="All data in CloudKit will be removed and replaced with what's local"},
543 { .command="ckmetric", .flag=&ckmetric, .flagval=true, .description="Push CloudKit metric"},
547 static struct arguments args = {
548 .programname="ckksctl",
549 .description="Control and report on CKKS",
550 .arguments = options,
553 if(!options_parse(argc, argv, &args)) {
560 NSError* error = nil;
562 CKKSControl* rpc = [CKKSControl CKKSControlObject:false error:&error];
564 errx(1, "no CKKSControl failed: %s", [[error description] UTF8String]);
567 CKKSControlCLI* ctl = [[CKKSControlCLI alloc] initWithCKKSControl:rpc];
569 NSString* view = viewArg ? [NSString stringWithCString: viewArg encoding: NSUTF8StringEncoding] : nil;
572 // Complicated logic, but you can choose any combination of (json, perfcounters) that you like.
573 NSMutableDictionary *statusDict = [[NSMutableDictionary alloc] init];
575 statusDict[@"performance"] = [ctl fetchPerformanceCounters];
578 statusDict[@"status"] = [ctl fetchStatus:view];
580 if(json || perfCounters) {
581 print_result(statusDict, true);
586 [ctl printHumanReadableStatus:view];
589 } else if(perfCounters) {
590 NSMutableDictionary *statusDict = [[NSMutableDictionary alloc] init];
591 statusDict[@"performance"] = [ctl fetchPerformanceCounters];
592 print_result(statusDict, false);
595 return (int)[ctl fetch:view];
597 return (int)[ctl push:view];
599 return (int)[ctl resetLocal:view];
600 } else if(resetCloudKit) {
601 return (int)[ctl resetCloudKit:view];
603 return (int)[ctl resync:view];
604 } else if(ckmetric) {
605 return (int)[ctl ckmetric];