keychain/ot/OctagonStateMachineHelpers.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 #import "keychain/ckks/CKKSResultOperation.h"
  28 #import "keychain/ckks/CKKSGroupOperation.h"
  29 #import "keychain/ckks/CKKSAnalytics.h"
  30
  31 NS_ASSUME_NONNULL_BEGIN
  32
  33 @protocol OctagonStateString <NSObject>
  34 @end
  35 typedef NSString<OctagonStateString> OctagonState;
  36
  37 @protocol OctagonFlagString <NSObject>
  38 @end
  39 typedef NSString<OctagonFlagString> OctagonFlag;
  40
  41 // NotStarted indicates that this state machine is not yet started
  42 extern OctagonState* const OctagonStateMachineNotStarted;
  43
  44 // Halted indicates that the state machine is halted, and won't move again
  45 extern OctagonState* const OctagonStateMachineHalted;
  46
  47 @protocol OctagonStateTransitionOperationProtocol
  48 // Holds this operation's opinion of the next state, given that this operation just ran
  49 @property OctagonState* nextState;
  50
  51 // Hold the state this operation was originally hoping to enter
  52 @property (readonly) OctagonState* intendedState;
  53 @end
  54
  55
  56 @interface OctagonStateTransitionOperation : CKKSResultOperation <OctagonStateTransitionOperationProtocol>
  57 @property OctagonState* nextState;
  58 @property (readonly) OctagonState* intendedState;
  59
  60 + (instancetype)named:(NSString*)name
  61             intending:(OctagonState*)intendedState
  62            errorState:(OctagonState*)errorState
  63   withBlockTakingSelf:(void(^)(OctagonStateTransitionOperation* op))block;
  64
  65 // convenience constructor. Will always succeed at entering the state.
  66 + (instancetype)named:(NSString*)name
  67              entering:(OctagonState*)intendedState NS_SWIFT_NAME(init(name:entering:));
  68 @end
  69
  70 // Just like OctagonStateTransitionOperation, but as a Group Operation
  71 @interface OctagonStateTransitionGroupOperation : CKKSGroupOperation <OctagonStateTransitionOperationProtocol>
  72 @property OctagonState* nextState;
  73 @property (readonly) OctagonState* intendedState;
  74
  75 + (instancetype)named:(NSString*)name
  76             intending:(OctagonState*)intendedState
  77            errorState:(OctagonState*)errorState
  78   withBlockTakingSelf:(void(^)(OctagonStateTransitionGroupOperation* op))block;
  79 @end
  80
  81
  82 @interface OctagonStateTransitionRequest<__covariant OperationType : CKKSResultOperation<OctagonStateTransitionOperationProtocol>*> : NSObject
  83 @property (readonly) NSString* name;
  84 @property (readonly) NSSet<OctagonState*>* sourceStates;
  85 @property (readonly) OperationType transitionOperation;
  86
  87 - (instancetype)timeout:(dispatch_time_t)timeout;
  88 - (OperationType _Nullable)_onqueueStart;
  89
  90 - (instancetype)init:(NSString*)name
  91         sourceStates:(NSSet<OctagonState*>*)sourceStates
  92          serialQueue:(dispatch_queue_t)queue
  93              timeout:(dispatch_time_t)timeout
  94         transitionOp:(OperationType)transitionOp;
  95 @end
  96
  97 NS_ASSUME_NONNULL_END
  98
  99 #endif // OCTAGON