keychain/ot/OTConstants.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 #ifndef OTConstants_h
  25 #define OTConstants_h
  26
  27 #include <stdbool.h>
  28
  29 bool OctagonIsEnabled(void);
  30
  31 #if __OBJC__
  32
  33 #import <Foundation/Foundation.h>
  34
  35 extern NSString* OTDefaultContext;
  36
  37 extern NSErrorDomain const OctagonErrorDomain;
  38
  39 /* used for defaults writes */
  40 extern NSString* OTDefaultsDomain;
  41 extern NSString* OTDefaultsOctagonEnable;
  42
  43 extern NSString* OTProtocolPairing;
  44 extern NSString* OTProtocolPiggybacking;
  45
  46 extern const char * OTTrustStatusChangeNotification;
  47
  48
  49 BOOL OctagonPlatformSupportsSOS(void);
  50
  51 // Used for testing.
  52 void OctagonSetIsEnabled(BOOL value);
  53 void OctagonSetPlatformSupportsSOS(BOOL value);
  54
  55 BOOL OctagonPerformSOSUpgrade(void);
  56 void OctagonSetSOSUpgrade(BOOL value);
  57
  58 BOOL OctagonRecoveryKeyIsEnabled(void);
  59 void OctagonRecoveryKeySetIsEnabled(BOOL value);
  60
  61 BOOL OctagonAuthoritativeTrustIsEnabled(void);
  62 void OctagonAuthoritativeTrustSetIsEnabled(BOOL value);
  63
  64 BOOL OctagonIsSOSFeatureEnabled(void);
  65 void OctagonSetSOSFeatureEnabled(BOOL value);
  66
  67 typedef NS_ENUM(NSInteger, CuttlefishResetReason) {
  68     CuttlefishResetReasonUnknown = 0,
  69     CuttlefishResetReasonUserInitiatedReset = 1,
  70     CuttlefishResetReasonHealthCheck = 2,
  71     CuttlefishResetReasonNoBottleDuringEscrowRecovery = 3,
  72     CuttlefishResetReasonLegacyJoinCircle = 4,
  73     CuttlefishResetReasonRecoveryKey = 5,
  74     CuttlefishResetReasonTestGenerated = 6,
  75 };
  76
  77 #endif // __OBJC__
  78
  79 #endif /* OTConstants_h */