keychain/SecureObjectSync/SOSCloudCircleInternal.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
  25 #ifndef _SECURITY_SOSCLOUDCIRCLEINTERNAL_H_
  26 #define _SECURITY_SOSCLOUDCIRCLEINTERNAL_H_
  27
  28 #include <Security/SecureObjectSync/SOSCloudCircle.h>
  29 #include <Security/SecureObjectSync/SOSPeerInfo.h>
  30
  31 #include <xpc/xpc.h>
  32 #include <Security/SecKey.h>
  33
  34 #if TARGET_OS_TV
  35 #define SOS_AVAILABLE false
  36 #elif TARGET_OS_WATCH
  37 #define SOS_AVAILABLE false
  38 #elif TARGET_OS_BRIDGE
  39 #define SOS_AVAILABLE false
  40 #elif TARGET_OS_IOS
  41 #define SOS_AVAILABLE true
  42 #elif TARGET_OS_OSX
  43 #define SOS_AVAILABLE true
  44 #elif TARGET_OS_SIMULATOR
  45 #define SOS_AVAILABLE true
  46 #else
  47 #define SOS_AVAILABLE false
  48 #endif
  49
  50 #define IF_SOS_DISABLED if(!SOS_AVAILABLE)
  51
  52 __BEGIN_DECLS
  53
  54 // Use the kSecAttrViewHint* constants in SecItemPriv.h instead
  55
  56 extern const CFStringRef kSOSViewHintPCSMasterKey DEPRECATED_ATTRIBUTE;
  57 extern const CFStringRef kSOSViewHintPCSiCloudDrive DEPRECATED_ATTRIBUTE;
  58 extern const CFStringRef kSOSViewHintPCSPhotos DEPRECATED_ATTRIBUTE;
  59 extern const CFStringRef kSOSViewHintPCSCloudKit DEPRECATED_ATTRIBUTE;
  60 extern const CFStringRef kSOSViewHintPCSEscrow DEPRECATED_ATTRIBUTE;
  61 extern const CFStringRef kSOSViewHintPCSFDE DEPRECATED_ATTRIBUTE;
  62 extern const CFStringRef kSOSViewHintPCSMailDrop DEPRECATED_ATTRIBUTE;
  63 extern const CFStringRef kSOSViewHintPCSiCloudBackup DEPRECATED_ATTRIBUTE;
  64 extern const CFStringRef kSOSViewHintPCSNotes DEPRECATED_ATTRIBUTE;
  65 extern const CFStringRef kSOSViewHintPCSiMessage DEPRECATED_ATTRIBUTE;
  66
  67 extern const CFStringRef kSOSViewHintAppleTV DEPRECATED_ATTRIBUTE;
  68 extern const CFStringRef kSOSViewHintHomeKit DEPRECATED_ATTRIBUTE;
  69
  70 CFArrayRef SOSCCCopyConcurringPeerPeerInfo(CFErrorRef* error);
  71
  72 bool SOSCCPurgeUserCredentials(CFErrorRef* error);
  73
  74 CFStringRef SOSCCGetStatusDescription(SOSCCStatus status);
  75 CFStringRef SOSCCGetViewResultDescription(SOSViewResultCode vrc);
  76 bool SOSCCAccountHasPublicKey(CFErrorRef *error);
  77
  78 /*!
  79  @function SOSCCProcessSyncWithPeers
  80  @abstract Returns the peers for whom we handled syncing from the list send to us.
  81  @param peers Set of peerIDs to sync with
  82  @param backupPeers Set of backup peerIDs to sync with
  83  */
  84 CFSetRef /* CFString */ SOSCCProcessSyncWithPeers(CFSetRef peers, CFSetRef backupPeers, CFErrorRef* error);
  85
  86 /*!
  87  @function SOSCCProcessSyncWithAllPeers
  88  @abstract Returns the information (string, hopefully URL) that will lead to an explanation of why you have an incompatible circle.
  89  @param error What went wrong if we returned NULL.
  90  */
  91 SyncWithAllPeersReason SOSCCProcessSyncWithAllPeers(CFErrorRef* error);
  92
  93 bool SOSCCProcessEnsurePeerRegistration(CFErrorRef* error);
  94
  95 bool SOSCCCleanupKVSKeys(CFErrorRef *error);
  96
  97
  98 /*!
  99  @function SOSCCCopyMyPeerInfo
 100  @abstract Returns a copy of my peer info
 101  @param error What went wrong if we returned NULL
 102  */
 103 SOSPeerInfoRef SOSCCCopyMyPeerInfo(CFErrorRef *error);
 104
 105 //
 106 // Security Tool calls
 107 //
 108 CFDataRef SOSCCCopyRecoveryPublicKey(CFErrorRef *error);
 109 CFDataRef SOSCCCopyInitialSyncData(SOSInitialSyncFlags flags, CFErrorRef *error);
 110
 111 void SOSCCForEachEngineStateAsStringFromArray(CFArrayRef states, void (^block)(CFStringRef oneStateString));
 112
 113 __END_DECLS
 114
 115 #endif