keychain/ckks/CKKSIncomingQueueOperation.h

   1 /*
   2  * Copyright (c) 2016 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 "keychain/ckks/CKKSGroupOperation.h"
  26 #if OCTAGON
  27
  28 #import "keychain/ckks/CKKSOperationDependencies.h"
  29 #import "keychain/ot/OctagonStateMachineHelpers.h"
  30
  31 NS_ASSUME_NONNULL_BEGIN
  32
  33 @class CKKSKeychainView;
  34 @class CKKSItem;
  35
  36 @interface CKKSIncomingQueueOperation : CKKSResultOperation <OctagonStateTransitionOperationProtocol>
  37 @property CKKSOperationDependencies* deps;
  38 @property (weak) CKKSKeychainView* ckks;
  39
  40 // Set this to true if this instance of CKKSIncomingQueueOperation
  41 // should error if it can't process class A items due to the keychain being locked.
  42 @property bool errorOnClassAFailure;
  43
  44 // Set this to true if you're pretty sure that the policy set on the CKKS object
  45 // should be considered authoritative, and items that do not match this policy should
  46 // be moved.
  47 @property bool handleMismatchedViewItems;
  48
  49 @property size_t successfulItemsProcessed;
  50 @property size_t errorItemsProcessed;
  51
  52 - (instancetype)init NS_UNAVAILABLE;
  53 - (instancetype)initWithDependencies:(CKKSOperationDependencies*)dependencies
  54                                 ckks:(CKKSKeychainView*)ckks
  55                            intending:(OctagonState*)intending
  56                           errorState:(OctagonState*)errorState
  57                 errorOnClassAFailure:(bool)errorOnClassAFailure
  58                handleMismatchedViewItems:(bool)handleMismatchedViewItems;
  59
  60 // Use this to turn a CKKS item into a keychain dictionary suitable for keychain insertion
  61 + (NSDictionary* _Nullable)decryptCKKSItemToAttributes:(CKKSItem*)item error:(NSError**)error;
  62
  63 @end
  64
  65 NS_ASSUME_NONNULL_END
  66 #endif  // OCTAGON