keychain/ot/OTClientStateMachine.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 <ApplePushService/ApplePushService.h>
  26 #import <Foundation/Foundation.h>
  27
  28 #import "keychain/ckks/OctagonAPSReceiver.h"
  29 #import "keychain/TrustedPeersHelper/TrustedPeersHelperProtocol.h"
  30
  31 #import "keychain/ot/OTDefines.h"
  32 #import "keychain/ot/OTSOSAdapter.h"
  33 #import "keychain/ot/OctagonStateMachineHelpers.h"
  34 #import "keychain/ot/OTCuttlefishContext.h"
  35 #import "keychain/ot/proto/generated_source/OTAccountMetadataClassC.h"
  36 #import <KeychainCircle/PairingChannel.h>
  37
  38 NS_ASSUME_NONNULL_BEGIN
  39
  40 /* Piggybacking and ProximitySetup as Acceptor, Octagon only */
  41 extern OctagonState* const OctagonStateAcceptorBeginClientJoin;
  42 extern OctagonState* const OctagonStateAcceptorEpochPrepared;
  43 extern OctagonState* const OctagonStateAcceptorAwaitingIdentity;
  44 extern OctagonState* const OctagonStateAcceptorVoucherPrepared;
  45 extern OctagonState* const OctagonStateAcceptorDone;
  46
  47 NSDictionary<OctagonState*, NSNumber*>* OctagonClientStateMap(void);
  48
  49 @interface OTClientStateMachine : NSObject
  50
  51 @property (readonly) id<NSXPCProxyCreating> cuttlefishXPCConnection;
  52
  53 @property (readonly) NSString* containerName;
  54 @property (readonly) NSString* contextID;
  55 @property (readonly) NSString* clientName;
  56
  57 @property (readonly) OctagonState* currentState;
  58 @property NSMutableDictionary<OctagonState*, CKKSCondition*>* stateConditions;
  59
  60 - (instancetype)initWithContainerName:(NSString*)containerName
  61                             contextID:(NSString*)contextID
  62                             clientName:(NSString*)clientName
  63                            cuttlefish:(id<NSXPCProxyCreating>)cuttlefish;
  64
  65 - (void)startOctagonStateMachine;
  66 - (void)notifyContainerChange;
  67
  68 - (void)rpcEpoch:(OTCuttlefishContext*)cuttlefishContext
  69            reply:(void (^)(uint64_t epoch,
  70                            NSError * _Nullable error))reply;
  71
  72 - (void)rpcVoucher:(OTCuttlefishContext*)cuttlefishContext
  73             peerID:(NSString*)peerID
  74      permanentInfo:(NSData *)permanentInfo
  75   permanentInfoSig:(NSData *)permanentInfoSig
  76         stableInfo:(NSData *)stableInfo
  77      stableInfoSig:(NSData *)stableInfoSig
  78              reply:(void (^)(NSData* voucher, NSData* voucherSig, NSError * _Nullable error))reply;
  79 @end
  80
  81 NS_ASSUME_NONNULL_END
  82 #endif
  83