keychain/ckks/CKKSFixups.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
  26 #import <Foundation/Foundation.h>
  27 #import "keychain/ckks/CKKSGroupOperation.h"
  28 #import "keychain/ckks/CKKSKeychainView.h"
  29 #import "keychain/ckks/CKKSResultOperation.h"
  30
  31 NS_ASSUME_NONNULL_BEGIN
  32
  33 // Sometimes things go wrong.
  34 // Sometimes you have to clean up after your past self.
  35 // This contains the fixes.
  36
  37 typedef NS_ENUM(NSUInteger, CKKSFixup) {
  38     CKKSFixupNever,
  39     CKKSFixupRefetchCurrentItemPointers,
  40     CKKSFixupFetchTLKShares,
  41     CKKSFixupLocalReload,
  42     CKKSFixupResaveDeviceStateEntries,
  43     CKKSFixupDeleteAllCKKSTombstones,
  44 };
  45 #define CKKSCurrentFixupNumber (CKKSFixupDeleteAllCKKSTombstones)
  46
  47 @interface CKKSFixups : NSObject
  48 +(nullable CKKSGroupOperation*)fixup:(CKKSFixup)lastfixup for:(CKKSKeychainView*)keychainView;
  49 @end
  50
  51 // Fixup declarations. You probably don't need to look at these
  52 @interface CKKSFixupRefetchAllCurrentItemPointers : CKKSGroupOperation
  53 @property (weak) CKKSKeychainView* ckks;
  54 - (instancetype)initWithCKKSKeychainView:(CKKSKeychainView*)keychainView ckoperationGroup:(CKOperationGroup*)ckoperationGroup;
  55 @end
  56
  57 @interface CKKSFixupFetchAllTLKShares : CKKSGroupOperation
  58 @property (weak) CKKSKeychainView* ckks;
  59 - (instancetype)initWithCKKSKeychainView:(CKKSKeychainView*)keychainView ckoperationGroup:(CKOperationGroup*)ckoperationGroup;
  60 @end
  61
  62 @interface CKKSFixupLocalReloadOperation : CKKSGroupOperation
  63 @property (weak) CKKSKeychainView* ckks;
  64 - (instancetype)initWithCKKSKeychainView:(CKKSKeychainView*)keychainView
  65                              fixupNumber:(CKKSFixup)fixupNumber
  66                         ckoperationGroup:(CKOperationGroup*)ckoperationGroup;
  67 @end
  68
  69 @interface CKKSFixupResaveDeviceStateEntriesOperation: CKKSGroupOperation
  70 @property (weak) CKKSKeychainView* ckks;
  71 - (instancetype)initWithCKKSKeychainView:(CKKSKeychainView*)keychainView;
  72 @end
  73
  74 NS_ASSUME_NONNULL_END
  75
  76 #endif  // OCTAGON