keychain/ot/OTFollowup.h

   1 /*
   2  * Copyright (c) 2019 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 #ifndef _OT_FOLLOWUP_H_
  25 #define _OT_FOLLOWUP_H_
  26
  27 #if OCTAGON
  28
  29 #import <Foundation/Foundation.h>
  30 #import <CoreCDP/CDPFollowUpController.h>
  31 #import "keychain/ckks/CKKSAnalytics.h"
  32
  33 NS_ASSUME_NONNULL_BEGIN
  34
  35 typedef NS_ENUM(uint8_t, OTFollowupContextType) {
  36     OTFollowupContextTypeNone,
  37     OTFollowupContextTypeRecoveryKeyRepair,
  38     OTFollowupContextTypeStateRepair,
  39     OTFollowupContextTypeOfflinePasscodeChange,
  40 };
  41 NSString* OTFollowupContextTypeToString(OTFollowupContextType contextType);
  42
  43 @protocol OctagonFollowUpControllerProtocol
  44 - (BOOL)postFollowUpWithContext:(CDPFollowUpContext *)context error:(NSError **)error;
  45 - (BOOL)clearFollowUpWithContext:(CDPFollowUpContext *)context error:(NSError **)error;
  46 @end
  47 @interface CDPFollowUpController (Octagon) <OctagonFollowUpControllerProtocol>
  48 @end
  49
  50 @interface OTFollowup : NSObject
  51 - (id)initWithFollowupController:(id<OctagonFollowUpControllerProtocol>)cdpFollowupController;
  52
  53 - (BOOL)postFollowUp:(OTFollowupContextType)contextType
  54                error:(NSError **)error;
  55 - (BOOL)clearFollowUp:(OTFollowupContextType)contextType
  56                 error:(NSError **)error;
  57
  58 - (NSDictionary *_Nullable)sysdiagnoseStatus;
  59 - (NSDictionary<NSString*,NSNumber*> *)sfaStatus;
  60 @end
  61
  62 @interface OTFollowup (Testing)
  63 // Reports on whether this individual OTFollowUp object has posted a CFU of this type.
  64 - (BOOL)hasPosted:(OTFollowupContextType)contextType;
  65 - (void)clearAllPostedFlags;
  66 @end
  67
  68 NS_ASSUME_NONNULL_END
  69
  70 #endif // OCTAGON
  71
  72 #endif // _OT_FOLLOWUP_H_