keychain/ot/OTVouchWithBottleOperation.h

   1 /*
   2  * Copyright (c) 2018 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
  28 #import "keychain/ckks/CKKSGroupOperation.h"
  29 #import "keychain/ot/OctagonStateMachineHelpers.h"
  30 #import "keychain/ot/OTOperationDependencies.h"
  31
  32 @class OTCuttlefishContext;
  33
  34 NS_ASSUME_NONNULL_BEGIN
  35
  36 @interface OTVouchWithBottleOperation : CKKSGroupOperation <OctagonStateTransitionOperationProtocol>
  37 @property OctagonState* nextState;
  38 - (instancetype)init NS_UNAVAILABLE;
  39 - (instancetype)initWithDependencies:(OTOperationDependencies*)dependencies
  40                            intendedState:(OctagonState*)intendedState
  41                               errorState:(OctagonState*)errorState
  42                             bottleID:(NSString*)bottleID
  43                              entropy:(NSData*)entropy
  44                           bottleSalt:(NSString*)bottleSalt
  45                          saveVoucher:(BOOL)saveVoucher;
  46
  47 @property (weak) OTCuttlefishContext* cuttlefishContext;
  48 @property (nonatomic) NSString* bottleID;
  49 @property (nonatomic) NSData* entropy;
  50 @property (nonatomic) NSString* bottleSalt;
  51
  52 @property (nonatomic) NSData* voucher;
  53 @property (nonatomic) NSData* voucherSig;
  54
  55 // Controls whether or not to save the received voucher in the state handler.
  56 @property (readonly) BOOL saveVoucher;
  57 @end
  58
  59 NS_ASSUME_NONNULL_END
  60
  61 #endif // OCTAGON