OSX/sec/SOSCircle/SecureObjectSync/SOSTypes.h

   1 /*
   2  * Copyright (c) 2012-2014 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 _SECURITY_SOSTYPES_H_
  25 #define _SECURITY_SOSTYPES_H_
  26
  27 #include <sys/cdefs.h>
  28
  29 __BEGIN_DECLS
  30
  31 /*
  32  Reasons
  33  */
  34
  35 typedef enum SyncWithAllPeersReason {
  36     kSyncWithAllPeersOtherFail = 0,
  37     kSyncWithAllPeersSuccess,
  38     kSyncWithAllPeersLocked,
  39 } SyncWithAllPeersReason;
  40
  41 /*
  42  * Piggy backing codes
  43  */
  44
  45 typedef enum{
  46     kPiggyV0 = 0,
  47     kPiggyV1 = 1,
  48 } PiggyBackProtocolVersion;
  49
  50 typedef enum{
  51     kPiggyTLKs = 0,
  52     kPiggyiCloudIdentities = 1
  53 } PiggybackKeyTypes;
  54
  55 typedef enum {
  56     kTLKUnknown = 0,
  57     kTLKManatee = 1,
  58     kTLKEngram = 2,
  59     kTLKAutoUnlock = 3,
  60     kTLKHealth = 4,
  61 } kTLKTypes;
  62
  63 /*
  64  View Result Codes
  65  */
  66 enum {
  67     kSOSCCGeneralViewError    = 0,
  68     kSOSCCViewMember          = 1,
  69     kSOSCCViewNotMember       = 2,
  70     kSOSCCViewNotQualified    = 3,
  71     kSOSCCNoSuchView          = 4,
  72     kSOSCCViewPending         = 5,
  73     kSOSCCViewAuthErr         = 6,
  74 };
  75 typedef int SOSViewResultCode;
  76
  77
  78 /*
  79  View Action Codes
  80  */
  81 enum {
  82     kSOSCCViewEnable          = 1,
  83     kSOSCCViewDisable         = 2,
  84     kSOSCCViewQuery           = 3,
  85 };
  86 typedef int SOSViewActionCode;
  87
  88 #if __OBJC__
  89
  90 #import <Foundation/Foundation.h>
  91
  92 #define SOSControlInitialSyncFlagTLK                  (1 << 0)
  93 #define SOSControlInitialSyncFlagPCS                  (1 << 1)
  94 #define SOSControlInitialSyncFlagPCSNonCurrent        (1 << 2)
  95 #define SOSControlInitialSyncFlagBluetoothMigration   (1 << 3)
  96
  97 @protocol SOSControlProtocol <NSObject>
  98 - (void)userPublicKey:(void ((^))(BOOL trusted, NSData *spki, NSError *error))complete;
  99 - (void)kvsPerformanceCounters:(void(^)(NSDictionary <NSString *, NSNumber *> *))reply;
 100 - (void)rateLimitingPerformanceCounters:(void(^)(NSDictionary <NSString *, NSString *> *))reply;
 101
 102 - (void)stashedCredentialPublicKey:(void(^)(NSData *, NSError *error))complete;
 103 - (void)assertStashedAccountCredential:(void(^)(BOOL result, NSError *error))complete;
 104 - (void)validatedStashedAccountCredential:(void(^)(NSData *credential, NSError *error))complete;
 105 - (void)stashAccountCredential:(NSData *)credential complete:(void(^)(bool success, NSError *error))complete;
 106
 107 - (void)myPeerInfo:(void (^)(NSData *, NSError *))complete;
 108 - (void)circleJoiningBlob:(NSData *)applicant complete:(void (^)(NSData *blob, NSError *))complete;
 109 - (void)joinCircleWithBlob:(NSData *)blob version:(PiggyBackProtocolVersion)version complete:(void (^)(bool success, NSError *))complete;
 110 - (void)initialSyncCredentials:(uint32_t)flags complete:(void (^)(NSArray *, NSError *))complete;
 111 - (void)importInitialSyncCredentials:(NSArray *)items complete:(void (^)(bool success, NSError *))complete;
 112
 113 - (void)triggerSync:(NSArray <NSString *> *)peers complete:(void(^)(bool success, NSError *))complete;
 114
 115 - (void)getWatchdogParameters:(void (^)(NSDictionary* parameters, NSError* error))complete;
 116 - (void)setWatchdogParmeters:(NSDictionary*)parameters complete:(void (^)(NSError* error))complete;
 117 @end
 118 #endif
 119
 120
 121 __END_DECLS
 122
 123 #endif