2 * Copyright (c) 2012-2014 Apple Inc. All Rights Reserved.
4 * @APPLE_LICENSE_HEADER_START@
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
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.
21 * @APPLE_LICENSE_HEADER_END@
25 #ifndef _SECURITY_SOSCLOUDCIRCLEINTERNAL_H_
26 #define _SECURITY_SOSCLOUDCIRCLEINTERNAL_H_
28 #include <Security/SecureObjectSync/SOSCloudCircle.h>
29 #include <Security/SecureObjectSync/SOSPeerInfo.h>
32 #include <Security/SecKey.h>
36 // Use the kSecAttrViewHint* constants in SecItemPriv.h instead
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
;
49 extern const CFStringRef kSOSViewHintAppleTV DEPRECATED_ATTRIBUTE
;
50 extern const CFStringRef kSOSViewHintHomeKit DEPRECATED_ATTRIBUTE
;
52 CFArrayRef
SOSCCCopyConcurringPeerPeerInfo(CFErrorRef
* error
);
54 bool SOSCCPurgeUserCredentials(CFErrorRef
* error
);
56 CFStringRef
SOSCCGetStatusDescription(SOSCCStatus status
);
57 CFStringRef
SOSCCGetViewResultDescription(SOSViewResultCode vrc
);
58 bool SOSCCAccountHasPublicKey(CFErrorRef
*error
);
59 bool SOSCCAccountIsNew(CFErrorRef
*error
);
62 @function SOSCCProcessSyncWithPeers
63 @abstract Returns the peers for whom we handled syncing from the list send to us.
64 @param peers Set of peerIDs to sync with
65 @param backupPeers Set of backup peerIDs to sync with
67 CFSetRef
/* CFString */ SOSCCProcessSyncWithPeers(CFSetRef peers
, CFSetRef backupPeers
, CFErrorRef
* error
);
70 @function SOSCCProcessSyncWithAllPeers
71 @abstract Returns the information (string, hopefully URL) that will lead to an explanation of why you have an incompatible circle.
72 @param error What went wrong if we returned NULL.
74 SyncWithAllPeersReason
SOSCCProcessSyncWithAllPeers(CFErrorRef
* error
);
76 bool SOSCCProcessEnsurePeerRegistration(CFErrorRef
* error
);
79 CFStringRef
SOSCCGetAllTheRings(CFErrorRef
*error
);
81 bool SOSCCApplyToARing(CFStringRef ringName
, CFErrorRef
* error
);
82 bool SOSCCWithdrawlFromARing(CFStringRef ringName
, CFErrorRef
* error
);
83 int SOSCCRingStatus(CFStringRef ringName
, CFErrorRef
* error
); // TODO: this returns SOSRingStatus
84 bool SOSCCEnableRing(CFStringRef ringName
, CFErrorRef
* error
);
86 bool SOSCCCleanupKVSKeys(CFErrorRef
*error
);
90 @function SOSCCCopyMyPeerInfo
91 @abstract Returns a copy of my peer info
92 @param error What went wrong if we returned NULL
94 SOSPeerInfoRef
SOSCCCopyMyPeerInfo(CFErrorRef
*error
);
97 @function SOSWrapToBackupSliceKeyBagForView
98 @abstract Encrypts the given plaintext, and wraps the encryption key to the backup slice keybag for this view
99 @param viewName The view to wrap to
100 @param input The plaintext to encrypt
101 @param output The ciphertext
102 @param bskbEncoded The encoded backup slice keybag used to wrap the data
103 @param error What went wrong if we returned false
105 bool SOSWrapToBackupSliceKeyBagForView(CFStringRef viewName
, CFDataRef input
, CFDataRef
* output
, CFDataRef
* bskbEncoded
, CFErrorRef
* error
);
108 // Security Tool calls
110 CFDataRef
SOSCCCopyAccountState(CFErrorRef
* error
);
111 bool SOSCCDeleteAccountState(CFErrorRef
*error
);
112 CFDataRef
SOSCCCopyEngineData(CFErrorRef
* error
);
113 bool SOSCCDeleteEngineState(CFErrorRef
*error
);
114 CFDataRef
SOSCCCopyRecoveryPublicKey(CFErrorRef
*error
);
115 CFDictionaryRef
SOSCCCopyBackupInformation(CFErrorRef
*error
);
116 bool SOSCCTestPopulateKVSWithBadKeys(CFErrorRef
*error
);
117 CFDataRef
SOSCCCopyInitialSyncData(CFErrorRef
*error
);
119 void SOSCCForEachEngineStateAsStringFromArray(CFArrayRef states
, void (^block
)(CFStringRef oneStateString
));