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