keychain/ckks/CKKSHealTLKSharesOperation.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 #import "keychain/ckks/CKKSGroupOperation.h"
  26 #import "keychain/ckks/CKKSCurrentKeyPointer.h"
  27 #import "keychain/ot/OctagonStateMachine.h"
  28
  29 #if OCTAGON
  30
  31 NS_ASSUME_NONNULL_BEGIN
  32
  33 @class CKKSKeychainView;
  34 @class CKKSOperationDependencies;
  35
  36 @interface CKKSHealTLKSharesOperation : CKKSGroupOperation <OctagonStateTransitionOperationProtocol>
  37 @property CKKSOperationDependencies* deps;
  38 @property (weak) CKKSKeychainView* ckks;
  39
  40 - (instancetype)init NS_UNAVAILABLE;
  41 - (instancetype)initWithOperationDependencies:(CKKSOperationDependencies*)operationDependencies
  42                                          ckks:(CKKSKeychainView*)ckks;
  43
  44
  45 // For this keyset, who doesn't yet have a CKKSTLKShare for its TLK, shared to their current Octagon keys?
  46 // Note that we really want a record sharing the TLK to ourselves, so this function might return
  47 // a non-empty set even if all peers have the TLK: it wants us to make a record for ourself.
  48 // If you pass in a non-empty set in afterUploading, those records will be included in the calculation.
  49 + (NSSet<CKKSTLKShareRecord*>* _Nullable)createMissingKeyShares:(CKKSCurrentKeySet*)keyset
  50                                                     trustStates:(NSArray<CKKSPeerProviderState*>*)trustStates
  51                                                           error:(NSError* __autoreleasing*)errore;
  52 @end
  53
  54 NS_ASSUME_NONNULL_END
  55 #endif  // OCTAGON