keychain/ckks/CKKSZoneChangeFetcher.h

   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
  26 #if OCTAGON
  27
  28 /* Fetch Reasons */
  29 @protocol SecCKKSFetchBecause
  30 @end
  31 typedef NSString<SecCKKSFetchBecause> CKKSFetchBecause;
  32 extern CKKSFetchBecause* const CKKSFetchBecauseAPNS;
  33 extern CKKSFetchBecause* const CKKSFetchBecauseAPIFetchRequest;
  34 extern CKKSFetchBecause* const CKKSFetchBecauseCurrentItemFetchRequest;
  35 extern CKKSFetchBecause* const CKKSFetchBecauseInitialStart;
  36 extern CKKSFetchBecause* const CKKSFetchBecauseSecuritydRestart;
  37 extern CKKSFetchBecause* const CKKSFetchBecausePreviousFetchFailed;
  38 extern CKKSFetchBecause* const CKKSFetchBecauseKeyHierarchy;
  39 extern CKKSFetchBecause* const CKKSFetchBecauseTesting;
  40
  41 @protocol CKKSChangeFetcherErrorOracle
  42 - (bool) isFatalCKFetchError: (NSError*) error;
  43 @end
  44
  45 /*
  46  * This class implements a CloudKit-fetch-with-retry.
  47  * In the case of network or other failures, it'll issue retries.
  48  * Only in the case of a clean fetch will its operation dependency resolve.
  49  */
  50
  51 @class CKKSKeychainView;
  52 #import "keychain/ckks/CKKSGroupOperation.h"
  53 #import <CloudKit/CloudKit.h>
  54
  55 @interface CKKSZoneChangeFetcher : NSObject
  56
  57 @property (weak) CKKSKeychainView* ckks;
  58 @property CKRecordZoneID* zoneID;
  59
  60 - (instancetype)init NS_UNAVAILABLE;
  61 - (instancetype)initWithCKKSKeychainView:(CKKSKeychainView*)ckks;
  62
  63 - (CKKSResultOperation*)requestSuccessfulFetch:(CKKSFetchBecause*)why;
  64 - (CKKSResultOperation*)requestSuccessfulResyncFetch:(CKKSFetchBecause*)why;
  65
  66 // We don't particularly care what this does, as long as it finishes
  67 - (void)holdFetchesUntil:(CKKSResultOperation*)holdOperation;
  68
  69 -(void)cancel;
  70 @end
  71
  72
  73 #endif
  74
  75