OSX/sec/SOSCircle/SecureObjectSync/SOSEnsureBackup.m

   1 /*
   2  * Copyright (c) 2017 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 #import <Foundation/Foundation.h>
  25 #import "SOSEnsureBackup.h"
  26 #include <utilities/debugging.h>
  27
  28 #if OCTAGON
  29 #import "keychain/ckks/CKKSLockStateTracker.h"
  30 #import "keychain/ckks/NSOperationCategories.h"
  31 #include <Security/SecureObjectSync/SOSAccount.h>
  32 #import <WirelessDiagnostics/WirelessDiagnostics.h>
  33 #import "keychain/analytics/awd/AWDMetricIds_Keychain.h"
  34
  35 static NSOperationQueue *backupOperationQueue;
  36 static CKKSLockStateTracker *lockStateTracker;
  37
  38 void SOSEnsureBackupWhileUnlocked(void) {
  39     static dispatch_once_t onceToken;
  40     dispatch_once(&onceToken, ^{
  41         backupOperationQueue = [NSOperationQueue new];
  42         lockStateTracker = [CKKSLockStateTracker new];
  43     });
  44
  45     // CKKSLockStateTracker does not use @synchronized(self). If it ever starts to this needs to be updated.
  46     @synchronized(lockStateTracker) {
  47         if ([backupOperationQueue operationCount] > 0) {
  48             secnotice("engine", "SOSEnsureBackup: Backup already scheduled for next unlock");
  49         } else {
  50             secnotice("engine", "SOSEnsureBackup: Scheduling a backup for next unlock");
  51             NSBlockOperation *backupOperation = [NSBlockOperation blockOperationWithBlock:^{
  52                 secnotice("engine", "Performing keychain backup after unlock because backing up while locked failed");
  53                 SOSAccount *account = (__bridge SOSAccount *)(SOSKeychainAccountGetSharedAccount());
  54
  55                 [account performTransaction:^(SOSAccountTransaction *transaction) {
  56                     CFErrorRef error = NULL;
  57                     NSSet* set = CFBridgingRelease(SOSAccountCopyBackupPeersAndForceSync(transaction, &error));
  58                     if (set) {
  59                         secnotice("engine", "SOSEnsureBackup: SOS made a backup of views: %@", set);
  60                     } else {
  61                         secerror("engine: SOSEnsureBackup: encountered an error while making backup (%@)", error);
  62                     }
  63
  64                     CFReleaseNull(error);
  65                 }];
  66             }];
  67             [backupOperation addNullableDependency:lockStateTracker.unlockDependency];
  68             [backupOperationQueue addOperation:backupOperation];
  69             AWDPostSimpleMetric(AWDMetricId_Keychain_SOSKeychainBackupFailed);
  70         }
  71     }
  72 }
  73 #else
  74 void SOSEnsureBackupWhileUnlocked(void) {
  75     secnotice("engine", "SOSEnsureBackup not available on this platform");
  76 }
  77 #endif