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 __BEGIN_DECLS
  35
  36 // Use the kSecAttrViewHint* constants in SecItemPriv.h instead
  37
  38 extern const CFStringRef kSOSViewHintPCSMasterKey DEPRECATED_ATTRIBUTE;
  39 extern const CFStringRef kSOSViewHintPCSiCloudDrive DEPRECATED_ATTRIBUTE;
  40 extern const CFStringRef kSOSViewHintPCSPhotos DEPRECATED_ATTRIBUTE;
  41 extern const CFStringRef kSOSViewHintPCSCloudKit DEPRECATED_ATTRIBUTE;
  42 extern const CFStringRef kSOSViewHintPCSEscrow DEPRECATED_ATTRIBUTE;
  43 extern const CFStringRef kSOSViewHintPCSFDE DEPRECATED_ATTRIBUTE;
  44 extern const CFStringRef kSOSViewHintPCSMailDrop DEPRECATED_ATTRIBUTE;
  45 extern const CFStringRef kSOSViewHintPCSiCloudBackup DEPRECATED_ATTRIBUTE;
  46 extern const CFStringRef kSOSViewHintPCSNotes DEPRECATED_ATTRIBUTE;
  47 extern const CFStringRef kSOSViewHintPCSiMessage DEPRECATED_ATTRIBUTE;
  48
  49 extern const CFStringRef kSOSViewHintAppleTV DEPRECATED_ATTRIBUTE;
  50 extern const CFStringRef kSOSViewHintHomeKit DEPRECATED_ATTRIBUTE;
  51
  52 CFArrayRef SOSCCCopyConcurringPeerPeerInfo(CFErrorRef* error);
  53
  54 bool SOSCCPurgeUserCredentials(CFErrorRef* error);
  55
  56 CFStringRef SOSCCGetStatusDescription(SOSCCStatus status);
  57 CFStringRef SOSCCGetViewResultDescription(SOSViewResultCode vrc);
  58 bool SOSCCAccountHasPublicKey(CFErrorRef *error);
  59
  60 /*!
  61  @function SOSCCProcessSyncWithPeers
  62  @abstract Returns the peers for whom we handled syncing from the list send to us.
  63  @param peers Set of peerIDs to sync with
  64  @param backupPeers Set of backup peerIDs to sync with
  65  */
  66 CFSetRef /* CFString */ SOSCCProcessSyncWithPeers(CFSetRef peers, CFSetRef backupPeers, CFErrorRef* error);
  67
  68 /*!
  69  @function SOSCCProcessSyncWithAllPeers
  70  @abstract Returns the information (string, hopefully URL) that will lead to an explanation of why you have an incompatible circle.
  71  @param error What went wrong if we returned NULL.
  72  */
  73 SyncWithAllPeersReason SOSCCProcessSyncWithAllPeers(CFErrorRef* error);
  74
  75 bool SOSCCProcessEnsurePeerRegistration(CFErrorRef* error);
  76
  77 bool SOSCCCleanupKVSKeys(CFErrorRef *error);
  78
  79
  80 /*!
  81  @function SOSCCCopyMyPeerInfo
  82  @abstract Returns a copy of my peer info
  83  @param error What went wrong if we returned NULL
  84  */
  85 SOSPeerInfoRef SOSCCCopyMyPeerInfo(CFErrorRef *error);
  86
  87 //
  88 // Security Tool calls
  89 //
  90 CFDataRef SOSCCCopyRecoveryPublicKey(CFErrorRef *error);
  91 CFDataRef SOSCCCopyInitialSyncData(SOSInitialSyncFlags flags, CFErrorRef *error);
  92
  93 void SOSCCForEachEngineStateAsStringFromArray(CFArrayRef states, void (^block)(CFStringRef oneStateString));
  94
  95 __END_DECLS
  96
  97 #endif