2 * Copyright (c) 2012-2017 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@
26 * SOSEngine.c - Implementation of a secure object syncing engine
29 #include <Security/SecureObjectSync/SOSChangeTracker.h>
30 #include <Security/SecureObjectSync/SOSEnginePriv.h>
31 #include <Security/SecureObjectSync/SOSDigestVector.h>
32 #include <Security/SecureObjectSync/SOSInternal.h>
33 #include <Security/SecureObjectSync/SOSPeer.h>
34 #include <Security/SecureObjectSync/SOSViews.h>
35 #include <Security/SecureObjectSync/SOSBackupEvent.h>
36 #include <Security/SecureObjectSync/SOSPersist.h>
37 #include <Security/SecureObjectSync/SOSCloudCircleInternal.h>
39 #include <corecrypto/ccder.h>
42 #include <utilities/array_size.h>
43 #include <utilities/SecCFCCWrappers.h>
44 #include <utilities/SecCFError.h>
45 #include <utilities/SecCFRelease.h>
46 #include <utilities/SecCFWrappers.h>
47 #include <utilities/der_plist.h>
48 #include <utilities/der_plist_internal.h>
49 #include <utilities/debugging.h>
50 #include <utilities/iCloudKeychainTrace.h>
51 #include <utilities/SecCoreCrypto.h>
52 #include <utilities/SecFileLocations.h>
53 #include <utilities/SecADWrapper.h>
54 #include <utilities/SecTrace.h>
57 #include <AssertMacros.h>
58 #include <CoreFoundation/CoreFoundation.h>
60 #include <securityd/SecItemServer.h> // TODO: We can't leave this here.
61 #include <securityd/SOSCloudCircleServer.h> // TODO: We can't leave this here.
62 #include <Security/SecItem.h> // TODO: We can't leave this here.
63 #include <Security/SecItemPriv.h> // TODO: We can't leave this here.
64 #include <securityd/SecItemSchema.h>
65 #include <securityd/iCloudTrace.h>
67 #include <keychain/ckks/CKKS.h>
69 #include <CoreFoundation/CFURL.h>
71 #include <Security/SecureObjectSync/SOSEnsureBackup.h>
74 // MARK: SOSEngine The Keychain database with syncable keychain support.
77 //----------------------------------------------------------------------------------------
78 // MARK: Engine state v0
79 //----------------------------------------------------------------------------------------
81 // Key in dataSource for general engine state file.
82 // This file only has digest entries in it, no manifests.
83 static const CFStringRef kSOSEngineState
= CFSTR("engine-state");
85 // Keys in state dictionary
86 static CFStringRef kSOSEngineManifestCacheKey
= CFSTR("manifestCache");
87 static CFStringRef kSOSEnginePeerStateKey
= CFSTR("peerState");
88 static CFStringRef kSOSEnginePeerIDsKey
= CFSTR("peerIDs");
89 static CFStringRef kSOSEngineIDKey
= CFSTR("id");
90 static CFStringRef kSOSEngineTraceDateKey
= CFSTR("traceDate");
92 //----------------------------------------------------------------------------------------
93 // MARK: Engine state v2
94 //----------------------------------------------------------------------------------------
96 #if !TARGET_IPHONE_SIMULATOR
97 static const CFIndex kCurrentEngineVersion
= 2;
99 // Keychain/datasource items
100 // Used for the kSecAttrAccount when saving in the datasource with dsSetStateWithKey
101 // Class D [kSecAttrAccessibleAlwaysPrivate/kSecAttrAccessibleAlwaysThisDeviceOnly]
102 CFStringRef kSOSEngineStatev2
= CFSTR("engine-state-v2");
103 CFStringRef kSOSEnginePeerStates
= CFSTR("engine-peer-states");
104 CFStringRef kSOSEngineManifestCache
= CFSTR("engine-manifest-cache");
105 CFStringRef kSOSEngineCoders
= CFSTR("engine-coders");
106 #define kSOSEngineProtectionDomainClassA kSecAttrAccessibleWhenUnlockedThisDeviceOnly
108 // Keys for individual dictionaries
110 CFStringRef kSOSEngineStateVersionKey
= CFSTR("engine-stateVersion");
112 // Current save/load routines
113 // SOSEngineCreate/SOSEngineLoad/SOSEngineSetState
114 // SOSEngineSave/SOSEngineDoSave/SOSEngineCopyState
115 // no save/load functions external to this file
118 Divide engine state into five pieces:
120 - General engine state
122 - List of other (trusted) peer IDs
124 - Coder data (formerly in peer state)
125 - Backup Keybags (backup peers only)
126 - Peer state (including manifest hashes -- just keys into ManifestCache)
127 [__OpaqueSOSPeer/SOSPeerRef]
140 - local manifest hashes (copy of local keychain)
141 - peer manifest hashes
143 These divisions are based on size, frequency of update, and protection domain
145 The Manifest Cache is a dictionary where each key is a hash over its entry,
146 which is a concatenation of 20 byte hashes of the keychain items. The local
147 keychain is present as one entry. The other entries are subsets of that, one
148 for each confirmed/pending/missing/unwanted shared with a peer. The local
149 keychain entry can be re-created by iterating over the databse, whereas the
150 others are built up through communicating with other peers.
152 83:d=2 hl=2 l= 13 prim: UTF8STRING :manifestCache
153 98:d=2 hl=4 l= 912 cons: SET
154 102:d=3 hl=2 l= 24 cons: SEQUENCE
155 104:d=4 hl=2 l= 20 prim: OCTET STRING [HEX DUMP]:DA39A3EE5E6B4B0D3255BFEF95601890AFD80709
156 126:d=4 hl=2 l= 0 prim: OCTET STRING
157 128:d=3 hl=2 l= 124 cons: SEQUENCE
158 130:d=4 hl=2 l= 20 prim: OCTET STRING [HEX DUMP]:F9B59370A4733F0D174E8D220C5BE3AF062C775B
159 152:d=4 hl=2 l= 100 prim: OCTET STRING [HEX DUMP]:5A574BB4EC90C3BBCC69EE73CBFE039133AE807265D6A58003B8D205997EAB96390AAB207E63A2E270A476CAB5B2D9D2F7B0E55512AA957B58D5658E7EF907B069B83AA6BA941790A3C3C4A68292D59DABA3CA342966EFF82E1ACAEB691FD6E20772E17E
160 254:d=3 hl=4 l= 366 cons: SEQUENCE
161 258:d=4 hl=2 l= 20 prim: OCTET STRING [HEX DUMP]:2E69C2F7F3E014075B30004CE0EC6C1AD419EBF5
162 280:d=4 hl=4 l= 340 prim: OCTET STRING [HEX DUMP]:07571E9678FD7D68812E409CC96C1F54834A099A0C3A2D12CCE2EA95F4505EA52F2C982B2ADEE3DA14D4712C000309BF63D54A98B61AA1D963C40E0E2531C83B28CA5BE6DA0D26400C3C77A618F711DD3CC0BF86CCBAF8AA3332973268B30EEBF21CD8184D9C8427CA13DECCC7BB83C80009A2EF45CCC07F586315C80CEEEEF5D5352FD000AAE6D9CBB4294D5959FD00198225AF9ABD09B341A2FDC278E9FD1465D6A58003B8D205997EAB96390AAB207E63A2E270A476CAB5B2D9D2F7B0E55512AA957B58D5658E7EF907B069B83AA6BA941790A3C3C4A68292D59D95C9D4D8A8BCA2E8242AB0D409F671F298B6DCAE9BC4238C09E07548CEFB300098606F9E4F230C99ABA3CA342966EFF82E1ACAEB691FD6E20772E17EB4FEFB84F8CF75C0C69C59532C354D175A59F961BA4D4DFA017FD8192288F14278AE76712E127D65FE616C7E4FD0713644F7C9A7ABA1CE065694A968
163 624:d=3 hl=4 l= 386 cons: SEQUENCE
164 628:d=4 hl=2 l= 20 prim: OCTET STRING [HEX DUMP]:CCF179FF718C10F151E7409EDF1A06F0DF10DCAD
165 650:d=4 hl=4 l= 360 prim: OCTET STRING [HEX DUMP]:07571E9678FD7D68812E409CC96C1F54834A099A0C3A2D12CCE2EA95F4505EA52F2C982B2ADEE3DA14D4712C000309BF63D54A98B61AA1D963C40E0E2531C83B28CA5BE6DA0D26400C3C77A618F711DD3CC0BF86CCBAF8AA3332973268B30EEBF21CD8184D9C8427CA13DECCC7BB83C80009A2EF45CCC07F586315C80CEEEEF5D5352FD000AAE6D9CBB4294D5959FD00198225AF9ABD09B341A2FDC278E9FD145A574BB4EC90C3BBCC69EE73CBFE039133AE807265D6A58003B8D205997EAB96390AAB207E63A2E270A476CAB5B2D9D2F7B0E55512AA957B58D5658E7EF907B069B83AA6BA941790A3C3C4A68292D59D95C9D4D8A8BCA2E8242AB0D409F671F298B6DCAE9BC4238C09E07548CEFB300098606F9E4F230C99ABA3CA342966EFF82E1ACAEB691FD6E20772E17EB4FEFB84F8CF75C0C69C59532C354D175A59F961BA4D4DFA017FD8192288F14278AE76712E127D65FE616C7E4FD0713644F7C9A7ABA1CE065694A968
171 static bool SOSEngineLoad(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
);
172 static bool SOSEngineSetPeers_locked(SOSEngineRef engine
, SOSPeerMetaRef myPeerMeta
, CFArrayRef trustedPeerMetas
, CFArrayRef untrustedPeerMetas
);
173 static void SOSEngineApplyPeerState(SOSEngineRef engine
, CFDictionaryRef peerStateMap
);
174 static void SOSEngineSynthesizePeerMetas(SOSEngineRef engine
, CFMutableArrayRef trustedPeersMetas
, CFMutableArrayRef untrustedPeers
);
175 static bool SOSEngineLoadCoders(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
);
176 #if !TARGET_IPHONE_SIMULATOR
177 static bool SOSEngineDeleteV0State(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
);
180 static CFStringRef
SOSPeerIDArrayCreateString(CFArrayRef peerIDs
) {
181 return peerIDs
? CFStringCreateByCombiningStrings(kCFAllocatorDefault
, peerIDs
, CFSTR(" ")) : CFSTR("");
184 static CFStringRef
SOSEngineCopyFormattingDesc(CFTypeRef cf
, CFDictionaryRef formatOptions
) {
185 SOSEngineRef engine
= (SOSEngineRef
)cf
;
186 CFStringRef tpDesc
= SOSPeerIDArrayCreateString(engine
->peerIDs
);
187 CFStringRef desc
= CFStringCreateWithFormat(kCFAllocatorDefault
, formatOptions
, CFSTR("<Engine %@ peers %@ MC[%d] PS[%d]>"), engine
->myID
, tpDesc
, engine
->manifestCache
? (int)CFDictionaryGetCount(engine
->manifestCache
) : 0, engine
->peerMap
? (int)CFDictionaryGetCount(engine
->peerMap
) : 0);
188 CFReleaseSafe(tpDesc
);
192 static CFStringRef
SOSEngineCopyDebugDesc(CFTypeRef cf
) {
193 return SOSEngineCopyFormattingDesc(cf
, NULL
);
196 static dispatch_queue_t sEngineQueue
;
197 static CFDictionaryRef sEngineMap
;
199 CFGiblisWithFunctions(SOSEngine
, NULL
, NULL
, NULL
, NULL
, NULL
, SOSEngineCopyFormattingDesc
, SOSEngineCopyDebugDesc
, NULL
, NULL
, ^{
200 sEngineQueue
= dispatch_queue_create("SOSEngine queue", DISPATCH_QUEUE_SERIAL
);
201 sEngineMap
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
204 #define _LOG_RAW_MESSAGES 0
205 void logRawMessage(CFDataRef message
, bool sending
, uint64_t seqno
)
207 #if _LOG_RAW_MESSAGES
208 CFStringRef hexMessage
= NULL
;
210 hexMessage
= CFDataCopyHexString(message
);
212 secnoticeq("engine", "%s RAW%1d %@", sending
? "send" : "recv", seqno
?2:0, hexMessage
);
214 secnoticeq("engine", "%s RAWx %@", sending
? "send" : "recv", hexMessage
); // we don't know vers of received msg here
216 CFReleaseSafe(hexMessage
);
221 // Peer state layout. WRONG! It's an array now
222 // The peer state is an array.
223 // The first element of the array is a dictionary with any number of keys and
224 // values in it (for future expansion) such as changing the digest size or type
225 // or remembering boolean flags for a peers sake.
226 // The next three are special in that they are manifest digests with special
227 // meaning and rules as to how they are treated (These are dynamically updated
228 // based on database activity so they have a fully history of all changes made
229 // to the local db. The first is the manifest representing the pendingObjects
230 // to send to the other peer. This is normally only ever appending to, and in
231 // particular with transactions originating from the Keychain API that affect
232 // syncable items will need to add the new objects digests to the pendingObjects list
233 // while adding the digests of any tombstones encountered to the extra list.
235 CFStringRef
SOSEngineGetMyID(SOSEngineRef engine
) {
236 // TODO: this should not be needed
240 // TEMPORARY: Get the list of IDs for cleanup, this shouldn't be used instead it should iterate KVS.
241 CFArrayRef
SOSEngineGetPeerIDs(SOSEngineRef engine
) {
242 if(!engine
) return NULL
;
243 return engine
->peerIDs
;
246 void SOSEngineClearCache(SOSEngineRef engine
){
247 CFReleaseNull(engine
->manifestCache
);
248 CFReleaseNull(engine
->localMinusUnreadableDigest
);
249 if (engine
->save_timer
)
250 dispatch_source_cancel(engine
->save_timer
);
251 dispatch_release(engine
->queue
);
252 engine
->queue
= NULL
;
255 static SOSPeerRef
SOSEngineCopyPeerWithMapEntry_locked(SOSEngineRef engine
, CFStringRef peerID
, CFTypeRef mapEntry
, CFErrorRef
*error
) {
256 SOSPeerRef peer
= NULL
;
257 if (mapEntry
&& CFGetTypeID(mapEntry
) == SOSPeerGetTypeID()) {
258 // The mapEntry is an SOSPeer, so we're done.
259 peer
= (SOSPeerRef
)CFRetain(mapEntry
);
261 // The mapEntry is a peerState, attempt to initialize a new
262 // peer iff peerID is in the set of trusted peerIDs
263 if (engine
->peerIDs
&& CFArrayContainsValue(engine
->peerIDs
, CFRangeMake(0, CFArrayGetCount(engine
->peerIDs
)), peerID
)) {
264 CFErrorRef localError
= NULL
;
265 peer
= SOSPeerCreateWithState(engine
, peerID
, mapEntry
, &localError
);
267 secerror("error inflating peer: %@: %@ from state: %@", peerID
, localError
, mapEntry
);
268 CFReleaseNull(localError
);
269 peer
= SOSPeerCreateWithState(engine
, peerID
, NULL
, error
);
272 // Replace the map entry with the inflated peer.
273 CFDictionarySetValue(engine
->peerMap
, peerID
, peer
);
276 SOSErrorCreate(kSOSErrorPeerNotFound
, error
, NULL
, CFSTR("peer: %@ is untrusted inflating not allowed"), peerID
);
282 static SOSPeerRef
SOSEngineCopyPeerWithID_locked(SOSEngineRef engine
, CFStringRef peerID
, CFErrorRef
*error
) {
283 CFTypeRef mapEntry
= CFDictionaryGetValue(engine
->peerMap
, peerID
);
284 SOSPeerRef peer
= NULL
;
286 peer
= SOSEngineCopyPeerWithMapEntry_locked(engine
, peerID
, mapEntry
, error
);
289 secerror("peer: %@ not found, peerMap: %@, engine: %@", peerID
, engine
->peerMap
, engine
);
290 SOSErrorCreate(kSOSErrorPeerNotFound
, error
, NULL
, CFSTR("peer: %@ not found"), peerID
);
295 struct SOSEngineWithPeerContext
{
297 void (^with
)(SOSPeerRef peer
);
300 static void SOSEngineWithPeerMapEntry_locked(const void *peerID
, const void *mapEntry
, void *context
) {
301 struct SOSEngineWithPeerContext
*ewp
= context
;
302 SOSPeerRef peer
= SOSEngineCopyPeerWithMapEntry_locked(ewp
->engine
, peerID
, mapEntry
, NULL
);
309 static void SOSEngineForEachPeer_locked(SOSEngineRef engine
, void (^with
)(SOSPeerRef peer
)) {
310 struct SOSEngineWithPeerContext ewp
= { .engine
= engine
, .with
= with
};
311 CFDictionaryRef peerMapCopy
= CFDictionaryCreateCopy(NULL
, engine
->peerMap
);
312 CFDictionaryApplyFunction(peerMapCopy
, SOSEngineWithPeerMapEntry_locked
, &ewp
);
313 CFRelease(peerMapCopy
);
316 static void SOSEngineWithBackupPeerMapEntry_locked(const void *peerID
, const void *mapEntry
, void *context
) {
317 struct SOSEngineWithPeerContext
*ewp
= context
;
318 // v0 backup peer is always in map but we only consider it a backup peer if it has a keybag.
319 if (SOSPeerMapEntryIsBackup(mapEntry
)) {
320 SOSPeerRef peer
= SOSEngineCopyPeerWithMapEntry_locked(ewp
->engine
, peerID
, mapEntry
, NULL
);
328 static void SOSEngineForEachBackupPeer_locked(SOSEngineRef engine
, void (^with
)(SOSPeerRef peer
)) {
329 struct SOSEngineWithPeerContext ewp
= { .engine
= engine
, .with
= with
};
330 CFDictionaryRef peerMapCopy
= CFDictionaryCreateCopy(NULL
, engine
->peerMap
);
331 CFDictionaryApplyFunction(peerMapCopy
, SOSEngineWithBackupPeerMapEntry_locked
, &ewp
);
332 CFRelease(peerMapCopy
);
338 SOSManifestRef
SOSEngineGetManifestForDigest(SOSEngineRef engine
, CFDataRef digest
) {
339 if (!engine
->manifestCache
|| !digest
) return NULL
;
340 SOSManifestRef manifest
= (SOSManifestRef
)CFDictionaryGetValue(engine
->manifestCache
, digest
);
341 if (!manifest
) return NULL
;
342 if (CFGetTypeID(manifest
) != SOSManifestGetTypeID()) {
343 secerror("dropping corrupt manifest for %@ from cache", digest
);
344 CFDictionaryRemoveValue(engine
->manifestCache
, digest
);
351 void SOSEngineAddManifest(SOSEngineRef engine
, SOSManifestRef manifest
) {
352 CFDataRef digest
= SOSManifestGetDigest(manifest
, NULL
);
354 if (!engine
->manifestCache
)
355 engine
->manifestCache
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
356 CFDictionaryAddValue(engine
->manifestCache
, digest
, manifest
);
360 CFDataRef
SOSEnginePatchRecordAndCopyDigest(SOSEngineRef engine
, SOSManifestRef base
, SOSManifestRef removals
, SOSManifestRef additions
, CFErrorRef
*error
) {
361 CFDataRef digest
= NULL
;
362 SOSManifestRef manifest
= SOSManifestCreateWithPatch(base
, removals
, additions
, error
);
364 SOSEngineAddManifest(engine
, manifest
);
365 digest
= CFRetainSafe(SOSManifestGetDigest(manifest
, NULL
));
367 CFReleaseSafe(manifest
);
371 SOSManifestRef
SOSEngineCopyPersistedManifest(SOSEngineRef engine
, CFDictionaryRef persisted
, CFStringRef key
) {
372 return CFRetainSafe(SOSEngineGetManifestForDigest(engine
, asData(CFDictionaryGetValue(persisted
, key
), NULL
)));
375 CFMutableArrayRef
SOSEngineCopyPersistedManifestArray(SOSEngineRef engine
, CFDictionaryRef persisted
, CFStringRef key
, CFErrorRef
*error
) {
376 CFMutableArrayRef manifests
= NULL
;
377 CFArrayRef digests
= NULL
;
379 if (asArrayOptional(CFDictionaryGetValue(persisted
, key
), &digests
, error
))
380 manifests
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
381 if (digests
) CFArrayForEachC(digests
, digest
) {
382 SOSManifestRef manifest
= SOSEngineGetManifestForDigest(engine
, digest
);
384 CFArrayAppendValue(manifests
, manifest
);
389 #if !TARGET_IPHONE_SIMULATOR
390 static CFDictionaryRef
SOSEngineCopyEncodedManifestCache_locked(SOSEngineRef engine
, CFErrorRef
*error
) {
391 CFMutableDictionaryRef mfc
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
392 SOSEngineForEachPeer_locked(engine
, ^(SOSPeerRef peer
) {
393 SOSPeerAddManifestsInUse(peer
, mfc
);
400 // End of Manifest cache
403 //----------------------------------------------------------------------------------------
405 //----------------------------------------------------------------------------------------
408 Each peer has an associated coder, whcih the engine keeps track of in a
409 CFDictionary indexed by peerID. The coders are read from disk when first needed,
410 then kept in memory as SOSCoders.
412 N.B. Don't rollback coder in memory if a transaction is rolled back, since this
413 might lead to reuse of an IV.
416 static bool SOSEngineCopyCoderData(SOSEngineRef engine
, CFStringRef peerID
, CFDataRef
*coderData
, CFErrorRef
*error
) {
418 SOSCoderRef coder
= (SOSCoderRef
)CFDictionaryGetValue(engine
->coders
, peerID
);
419 if (coder
&& (CFGetTypeID(coder
) == SOSCoderGetTypeID())) {
420 CFErrorRef localError
= NULL
;
421 ok
= *coderData
= SOSCoderCopyDER(coder
, &localError
);
423 secerror("failed to der encode coder for peer %@, dropping it: %@", peerID
, localError
);
424 CFDictionaryRemoveValue(engine
->coders
, peerID
);
425 CFErrorPropagate(localError
, error
);
433 static SOSCoderRef
SOSEngineGetCoderInTx_locked(SOSEngineRef engine
, SOSTransactionRef txn
, CFStringRef peerID
, CFErrorRef
*error
) {
434 if (!engine
->haveLoadedCoders
) {
435 engine
->haveLoadedCoders
= SOSEngineLoadCoders(engine
, txn
, error
);
437 if (!engine
->haveLoadedCoders
) {
442 SOSCoderRef coder
= (SOSCoderRef
)CFDictionaryGetValue(engine
->coders
, peerID
);
443 if (!coder
|| (CFGetTypeID(coder
) != SOSCoderGetTypeID())) {
444 SOSErrorCreate(kSOSErrorPeerNotFound
, error
, NULL
, CFSTR("No coder for peer: %@"), peerID
);
449 static bool SOSEngineEnsureCoder_locked(SOSEngineRef engine
, SOSTransactionRef txn
, CFStringRef peerID
, SOSFullPeerInfoRef myPeerInfo
, SOSPeerInfoRef peerInfo
, SOSCoderRef ourCoder
, CFErrorRef
*error
) {
450 //have to have caused coder loading, transactions do this.
451 if (!ourCoder
|| !SOSCoderIsFor(ourCoder
, peerInfo
, myPeerInfo
)) {
452 secinfo("coder", "New coder for id %@.", peerID
);
453 CFErrorRef localError
= NULL
;
454 SOSCoderRef coder
= SOSCoderCreate(peerInfo
, myPeerInfo
, kCFBooleanFalse
, &localError
);
456 secerror("Failed to create coder for %@: %@", peerID
, localError
);
457 CFErrorPropagate(localError
, error
);
460 CFDictionarySetValue(engine
->coders
, peerID
, coder
);
461 secdebug("coder", "setting coder for peerid: %@, coder: %@", peerID
, coder
);
462 CFReleaseNull(coder
);
463 engine
->codersNeedSaving
= true;
468 bool SOSEngineInitializePeerCoder(SOSEngineRef engine
, SOSFullPeerInfoRef myPeerInfo
, SOSPeerInfoRef peerInfo
, CFErrorRef
*error
) {
469 __block
bool ok
= true;
470 CFStringRef peerID
= SOSPeerInfoGetPeerID(peerInfo
);
472 ok
&= SOSEngineWithPeerID(engine
, peerID
, error
, ^(SOSPeerRef peer
, SOSCoderRef coder
, SOSDataSourceRef dataSource
, SOSTransactionRef txn
, bool *forceSaveState
) {
473 ok
= SOSEngineEnsureCoder_locked(engine
, txn
, peerID
, myPeerInfo
, peerInfo
, coder
, error
);
474 *forceSaveState
= ok
;
480 static bool SOSEngineGCPeerState_locked(SOSEngineRef engine
, CFErrorRef
*error
) {
483 //require_quiet(ok = SOSEngineGCManifests_locked(engine, error), exit);
488 #if !TARGET_IPHONE_SIMULATOR
489 static CFMutableDictionaryRef
SOSEngineCopyPeerState_locked(SOSEngineRef engine
, CFErrorRef
*error
) {
490 CFMutableDictionaryRef peerState
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
491 CFDictionaryForEach(engine
->peerMap
, ^(const void *key
, const void *value
) {
492 CFDictionaryRef state
= NULL
;
493 if (value
&& CFGetTypeID(value
) == SOSPeerGetTypeID()) {
494 CFErrorRef localError
= NULL
;
496 state
= SOSPeerCopyState((SOSPeerRef
)value
, &localError
);
498 secnotice("engine", "%@ failed to encode peer: %@", key
, localError
);
499 CFReleaseNull(localError
);
500 // TODO: Potentially replace inflated peer with deflated peer in peerMap
502 // We have a deflated peer.
503 state
= CFRetainSafe(value
);
507 CFDictionarySetValue(peerState
, key
, state
);
508 CFReleaseSafe(state
);
514 static CFMutableDictionaryRef
SOSEngineCopyPeerCoders_locked(SOSEngineRef engine
, CFErrorRef
*error
) {
515 CFMutableDictionaryRef coders
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
516 CFDictionaryForEach(engine
->peerMap
, ^(const void *key
, const void *value
) {
517 CFDataRef coderData
= NULL
;
518 CFErrorRef localError
= NULL
;
519 bool ok
= SOSEngineCopyCoderData(engine
, (CFStringRef
)key
, &coderData
, &localError
);
522 secnotice("engine", "%@ no coder for peer: %@", key
, localError
);
524 if (ok
&& coderData
) {
525 CFDictionarySetValue(coders
, key
, coderData
);
527 CFReleaseNull(coderData
);
528 CFReleaseNull(localError
);
533 //----------------------------------------------------------------------------------------
534 // MARK: Engine state v2 Save
535 //----------------------------------------------------------------------------------------
537 // Coders and keybags
539 static CFDataRef
SOSEngineCopyCoders(SOSEngineRef engine
, CFErrorRef
*error
) {
540 // Copy the CFDataRef version of the coders into a dictionary, which is then DER-encoded for saving
541 CFDictionaryRef coders
= SOSEngineCopyPeerCoders_locked(engine
, error
);
542 secdebug("coders", "copying coders! %@", coders
);
543 CFDataRef der
= CFPropertyListCreateDERData(kCFAllocatorDefault
, coders
, error
);
544 CFReleaseSafe(coders
);
548 #pragma clang diagnostic push
549 #pragma clang diagnostic fatal "-Wshadow"
550 static bool SOSEngineSaveCoders(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
) {
551 // MUST hold engine lock
552 // Device must be unlocked for this to succeed
554 if(!engine
->haveLoadedCoders
){
555 secdebug("coders", "attempting to save coders before we have loaded them!");
559 if (engine
->codersNeedSaving
) {
560 CFDataRef derCoders
= SOSEngineCopyCoders(engine
, error
);
561 ok
= derCoders
&& SOSDataSourceSetStateWithKey(engine
->dataSource
, txn
, kSOSEngineCoders
,
562 kSOSEngineProtectionDomainClassA
, derCoders
, error
);
564 engine
->codersNeedSaving
= false;
565 secnotice("coder", "saved coders: %@", engine
->coders
);
567 CFReleaseSafe(derCoders
);
571 #pragma clang diagnostic pop
573 bool SOSTestEngineSaveCoders(CFTypeRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
){
574 return SOSEngineSaveCoders((SOSEngineRef
)engine
, txn
, error
);
576 #if !TARGET_IPHONE_SIMULATOR
578 static CFDictionaryRef
SOSEngineCopyBasicState(SOSEngineRef engine
, CFErrorRef
*error
) {
579 // Create a version of the in-memory engine state for saving to disk
580 CFMutableDictionaryRef state
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
582 CFDictionarySetValue(state
, kSOSEngineIDKey
, engine
->myID
);
584 CFDictionarySetValue(state
, kSOSEnginePeerIDsKey
, engine
->peerIDs
);
585 if (engine
->lastTraceDate
)
586 CFDictionarySetValue(state
, kSOSEngineTraceDateKey
, engine
->lastTraceDate
);
588 SOSPersistCFIndex(state
, kSOSEngineStateVersionKey
, kCurrentEngineVersion
);
592 static bool SOSEngineDoSaveOneState(SOSEngineRef engine
, SOSTransactionRef txn
, CFStringRef key
, CFStringRef pdmn
,
593 CFDictionaryRef state
, CFErrorRef
*error
) {
594 CFDataRef derState
= CFPropertyListCreateDERData(kCFAllocatorDefault
, state
, error
);
595 bool ok
= derState
&& SOSDataSourceSetStateWithKey(engine
->dataSource
, txn
, key
, pdmn
, derState
, error
);
596 CFReleaseSafe(derState
);
600 static bool SOSEngineDoSave(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
) {
603 CFDictionaryRef state
= SOSEngineCopyBasicState(engine
, error
);
604 ok
&= state
&& SOSEngineDoSaveOneState(engine
, txn
, kSOSEngineStatev2
, kSOSEngineProtectionDomainClassD
, state
, error
);
605 CFReleaseNull(state
);
607 state
= SOSEngineCopyPeerState_locked(engine
, error
);
608 ok
&= state
&& SOSEngineDoSaveOneState(engine
, txn
, kSOSEnginePeerStates
, kSOSEngineProtectionDomainClassD
, state
, error
);
609 CFReleaseNull(state
);
611 state
= SOSEngineCopyEncodedManifestCache_locked(engine
, error
);
612 ok
&= state
&& SOSEngineDoSaveOneState(engine
, txn
, kSOSEngineManifestCache
, kSOSEngineProtectionDomainClassD
, state
, error
);
613 CFReleaseNull(state
);
615 ok
&= SOSEngineSaveCoders(engine
, txn
, error
);
617 SOSEngineDeleteV0State(engine
, txn
, NULL
);
623 static bool SOSEngineSave(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
) {
624 // Don't save engine state from tests
625 if (!engine
->dataSource
)
627 #if !TARGET_IPHONE_SIMULATOR
628 return SOSEngineDoSave(engine
, txn
, error
);
633 //----------------------------------------------------------------------------------------
634 // MARK: Engine state v2 Load/Restore
635 //----------------------------------------------------------------------------------------
637 // Restore the in-memory state of engine from saved state loaded from the db
638 static bool SOSEngineSetManifestCacheWithDictionary(SOSEngineRef engine
, CFDictionaryRef manifestCache
, CFErrorRef
*error
) {
639 __block
bool ok
= true;
640 CFReleaseNull(engine
->manifestCache
);
642 engine
->manifestCache
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
643 CFDictionaryForEach(manifestCache
, ^(const void *key
, const void *value
) {
644 CFDataRef data
= (CFDataRef
)value
;
646 SOSManifestRef mf
= SOSManifestCreateWithData(data
, NULL
);
648 CFDictionarySetValue(engine
->manifestCache
, key
, mf
);
657 static bool SOSEngineUpdateStateWithDictionary(SOSEngineRef engine
, CFDictionaryRef stateDict
, CFErrorRef
*error
) {
661 // If kCurrentEngineVersion > 2, uncomment and fill in code below
662 CFIndex engineVersion
= 0 ;
663 bool versionPresent
= SOSPeerGetOptionalPersistedCFIndex(stateDict
, kSOSEngineStateVersionKey
, &engineVersion
);
664 if (versionPresent
&& (engineVersion
!= kCurrentEngineVersion
)) {
672 static bool SOSEngineSetStateWithDictionary(SOSEngineRef engine
, CFDictionaryRef stateDict
, CFErrorRef
*error
) {
675 SOSEngineUpdateStateWithDictionary(engine
, stateDict
, error
);
676 CFRetainAssign(engine
->myID
, asString(CFDictionaryGetValue(stateDict
, kSOSEngineIDKey
), NULL
));
677 CFRetainAssign(engine
->peerIDs
, asArray(CFDictionaryGetValue(stateDict
, kSOSEnginePeerIDsKey
), NULL
));
678 CFRetainAssign(engine
->lastTraceDate
, asDate(CFDictionaryGetValue(stateDict
, kSOSEngineTraceDateKey
), NULL
));
681 secnotice("engine", "%@", engine
);
685 static bool SOSEngineSetPeerStateWithDictionary(SOSEngineRef engine
, CFDictionaryRef peerStateDict
, CFErrorRef
*error
) {
686 // Set the in-memory peer state using the dictionary version of the DER-encoded version from disk
687 CFMutableArrayRef untrustedPeers
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
688 CFMutableArrayRef trustedPeersMetas
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
689 SOSEngineApplyPeerState(engine
, asDictionary(peerStateDict
, NULL
));
690 SOSEngineSynthesizePeerMetas(engine
, trustedPeersMetas
, untrustedPeers
);
691 SOSEngineSetPeers_locked(engine
, engine
->myID
, trustedPeersMetas
, untrustedPeers
);
692 CFReleaseNull(trustedPeersMetas
);
693 CFReleaseNull(untrustedPeers
);
697 CFMutableDictionaryRef
derStateToDictionaryCopy(CFDataRef state
, CFErrorRef
*error
) {
699 CFMutableDictionaryRef stateDict
= NULL
;
701 const uint8_t *der
= CFDataGetBytePtr(state
);
702 const uint8_t *der_end
= der
+ CFDataGetLength(state
);
703 ok
= der
= der_decode_dictionary(kCFAllocatorDefault
, kCFPropertyListMutableContainers
, (CFDictionaryRef
*)&stateDict
, error
, der
, der_end
);
704 if (der
&& der
!= der_end
) {
705 ok
= SOSErrorCreate(kSOSErrorDecodeFailure
, error
, NULL
, CFSTR("trailing %td bytes at end of state"), der_end
- der
);
708 CFReleaseNull(stateDict
);
713 bool TestSOSEngineLoadCoders(CFTypeRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
)
715 return SOSEngineLoadCoders((SOSEngineRef
)engine
, txn
, error
);
718 static bool SOSEngineLoadCoders(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
) {
719 // Read the serialized engine state from the datasource (aka keychain) and populate the in-memory engine
720 __block
bool needPeerRegistration
= false;
722 CFDataRef derCoders
= NULL
;
723 CFMutableDictionaryRef codersDict
= NULL
;
724 derCoders
= SOSDataSourceCopyStateWithKey(engine
->dataSource
, kSOSEngineCoders
, kSOSEngineProtectionDomainClassA
, txn
, error
);
725 require_quiet(derCoders
, xit
);
726 codersDict
= derStateToDictionaryCopy(derCoders
, error
);
727 require_quiet(codersDict
, xit
);
730 * Make sure all peer have coders
732 CFDictionaryForEach(engine
->peerMap
, ^(const void *peerID
, const void *peerState
) {
734 * Skip backup peer since they will never have coders
736 if (isString(peerID
) && CFStringHasSuffix(peerID
, CFSTR("-tomb"))) {
737 secnotice("coder", "Skipping coder check for peer: %@", peerID
);
741 CFTypeRef coderRef
= CFDictionaryGetValue(codersDict
, peerID
);
743 CFDataRef coderData
= asData(coderRef
, NULL
);
745 CFErrorRef createError
= NULL
;
746 SOSCoderRef coder
= SOSCoderCreateFromData(coderData
, &createError
);
748 CFDictionaryAddValue(engine
->coders
, peerID
, coder
);
749 secnotice("coder", "adding coder: %@ for peerid: %@", coder
, peerID
);
751 secnotice("coder", "Coder for '%@' failed to create: %@", peerID
, createError
);
753 CFReleaseNull(createError
);
754 CFReleaseNull(coder
);
756 // Needed a coder, didn't find one, notify the account to help us out.
757 // Next attempt to sync will fix this
758 secnotice("coder", "coder for %@ was not cf data: %@", peerID
, coderData
);
759 needPeerRegistration
= true;
762 secnotice("coder", "didn't find coder for peer: %@ engine dictionary: %@", peerID
, codersDict
);
763 needPeerRegistration
= true;
767 secnotice("coder", "Will force peer registration: %s",needPeerRegistration
? "yes" : "no");
769 if (needPeerRegistration
) {
770 dispatch_queue_t queue
= dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT
, 0);
772 dispatch_async(queue
, ^{
773 CFErrorRef eprError
= NULL
;
774 if (!SOSCCProcessEnsurePeerRegistration_Server(&eprError
)) {
775 secnotice("coder", "SOSCCProcessEnsurePeerRegistration failed with: %@", eprError
);
777 CFReleaseNull(eprError
);
781 engine
->haveLoadedCoders
= true;
784 CFReleaseNull(derCoders
);
785 CFReleaseNull(codersDict
);
788 #if !TARGET_IPHONE_SIMULATOR
789 static bool SOSEngineDeleteV0State(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
) {
790 // SOSDataSourceDeleteStateWithKey(engine->dataSource, kSOSEngineState, kSOSEngineProtectionDomainClassD, txn, error);
792 // Create effectively empty state until delete is working
793 CFMutableDictionaryRef state
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
795 CFDictionarySetValue(state
, kSOSEngineIDKey
, engine
->myID
);
796 CFDataRef derState
= CFPropertyListCreateDERData(kCFAllocatorDefault
, state
, error
);
797 CFReleaseNull(state
);
799 bool ok
= derState
&& SOSDataSourceSetStateWithKey(engine
->dataSource
, txn
, kSOSEngineState
, kSOSEngineProtectionDomainClassD
, derState
, error
);
800 CFReleaseSafe(derState
);
804 static bool SOSEngineLoad(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
) {
805 // Read the serialized engine state from the datasource (aka keychain) and populate the in-memory engine
807 CFDataRef basicEngineState
= NULL
;
808 CFMutableDictionaryRef engineState
= NULL
;
809 CFDictionaryRef manifestCache
= NULL
;
810 CFDictionaryRef peerStateDict
= NULL
;
811 CFMutableDictionaryRef codersDict
= NULL
;
812 // Look for the v2 engine state first
813 basicEngineState
= SOSDataSourceCopyStateWithKey(engine
->dataSource
, kSOSEngineStatev2
, kSOSEngineProtectionDomainClassD
, txn
, error
);
814 if (basicEngineState
) {
815 CFDataRef data
= NULL
;
816 engineState
= derStateToDictionaryCopy(basicEngineState
, error
);
818 data
= SOSDataSourceCopyStateWithKey(engine
->dataSource
, kSOSEngineManifestCache
, kSOSEngineProtectionDomainClassD
, txn
, error
);
819 manifestCache
= derStateToDictionaryCopy(data
, error
);
822 data
= SOSDataSourceCopyStateWithKey(engine
->dataSource
, kSOSEnginePeerStates
, kSOSEngineProtectionDomainClassD
, txn
, error
);
823 peerStateDict
= derStateToDictionaryCopy(data
, error
);
826 // Look for original V0 engine state next
827 CFDataRef v0EngineStateData
= SOSDataSourceCopyStateWithKey(engine
->dataSource
, kSOSEngineState
, kSOSEngineProtectionDomainClassD
, txn
, error
);
828 if (v0EngineStateData
) {
829 engineState
= derStateToDictionaryCopy(v0EngineStateData
, error
);
831 manifestCache
= CFRetainSafe(asDictionary(CFDictionaryGetValue(engineState
, kSOSEngineManifestCacheKey
), NULL
));
832 peerStateDict
= CFRetainSafe(asDictionary(CFDictionaryGetValue(engineState
, kSOSEnginePeerStateKey
), NULL
));
834 CFReleaseNull(v0EngineStateData
);
836 secnotice("coder", "Migrating from v0 engine state; dropping coders and forcing re-negotiation");
837 SOSCCEnsurePeerRegistration();
839 if (engine
->peerIDs
) {
840 SOSCCRequestSyncWithPeersList(engine
->peerIDs
);
844 ok
= engineState
&& SOSEngineSetStateWithDictionary(engine
, engineState
, error
);
846 ok
&= SOSEngineSetManifestCacheWithDictionary(engine
, manifestCache
, error
);
848 ok
&= peerStateDict
&& SOSEngineSetPeerStateWithDictionary(engine
, peerStateDict
, error
);
850 CFReleaseSafe(basicEngineState
);
851 CFReleaseSafe(engineState
);
852 CFReleaseSafe(manifestCache
);
853 CFReleaseSafe(peerStateDict
);
854 CFReleaseSafe(codersDict
);
858 bool SOSTestEngineSaveWithDER(SOSEngineRef engine
, CFDataRef derState
, CFErrorRef
*error
) {
863 bool SOSTestEngineSave(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
) {
864 bool bx
= SOSEngineSave(engine
, txn
, error
);
865 secnotice("test", "saved engine: %@", engine
);
869 bool SOSTestEngineLoad(SOSEngineRef engine
, SOSTransactionRef txn
, CFErrorRef
*error
) {
870 bool bx
= SOSEngineLoad(engine
, txn
, error
);
871 secnotice("test", "loaded engine: %@", engine
);
875 //----------------------------------------------------------------------------------------
876 // MARK: Change Trackers and Peer Manifests
877 //----------------------------------------------------------------------------------------
879 static SOSManifestRef
SOSEngineCreateManifestWithViewNameSet_locked(SOSEngineRef engine
, CFSetRef viewNameSet
, CFErrorRef
*error
) {
880 // TODO: Potentially tell all changeTrackers to track manifests ( //forall ct do SOSChangeTrackerSetConcrete(ct, true);
881 // and read the entire dataSource and pass all objects though the filter here, instead of
882 // forcing the datasource to be able to do "smart" queries
883 return SOSDataSourceCopyManifestWithViewNameSet(engine
->dataSource
, viewNameSet
, error
);
886 static SOSChangeTrackerRef
SOSEngineCopyChangeTrackerWithViewNameSet_locked(SOSEngineRef engine
, CFSetRef viewNameSet
, CFErrorRef
*error
) {
887 SOSChangeTrackerRef ct
= (SOSChangeTrackerRef
)CFDictionaryGetValue(engine
->viewNameSet2ChangeTracker
, viewNameSet
);
889 SOSErrorCreate(kSOSErrorPeerNotFound
, error
, NULL
, CFSTR("no change tracker for view set %@"), viewNameSet
);
890 return CFRetainSafe(ct
);
893 static SOSManifestRef
SOSEngineCopyManifestWithViewNameSet_locked(SOSEngineRef engine
, CFSetRef viewNameSet
, CFErrorRef
*error
) {
894 SOSChangeTrackerRef ct
= SOSEngineCopyChangeTrackerWithViewNameSet_locked(engine
, viewNameSet
, error
);
898 SOSManifestRef manifest
= SOSChangeTrackerCopyManifest(ct
, NULL
);
900 manifest
= SOSEngineCreateManifestWithViewNameSet_locked(engine
, viewNameSet
, error
); // Do the SQL query
901 SOSChangeTrackerSetManifest(ct
, manifest
);
907 SOSManifestRef
SOSEngineCopyLocalPeerManifest_locked(SOSEngineRef engine
, SOSPeerRef peer
, CFErrorRef
*error
) {
908 return SOSEngineCopyManifestWithViewNameSet_locked(engine
, SOSPeerGetViewNameSet(peer
), error
);
911 #define withViewAndBackup(VIEW) do { with(VIEW); if (!isTomb) with(VIEW ## _tomb); } while(0)
914 // Invoke with once for each view an object is in.
915 // TODO: Move this function into the DataSource
916 static void SOSEngineObjectWithView(SOSEngineRef engine
, SOSObjectRef object
, void (^with
)(CFStringRef view
)) {
917 // Filter items into v0 only view here
918 SecDbItemRef item
= (SecDbItemRef
)object
; // TODO: Layer violation, breaks tests
919 if (isDictionary(object
)) {
920 CFTypeRef isTombValue
= CFDictionaryGetValue((CFDictionaryRef
)object
, kSecAttrTombstone
);
921 bool isTomb
= isTombValue
&& CFBooleanGetValue(isTombValue
);
922 // We are in the test just assume v0 and v2 views.
923 withViewAndBackup(kSOSViewKeychainV0
);
924 } else if (SecDbItemIsSyncableOrCorrupted(item
)) {
925 const SecDbClass
*iclass
= SecDbItemGetClass(item
);
926 CFTypeRef pdmn
= SecDbItemGetCachedValueWithName(item
, kSecAttrAccessible
);
927 if ((iclass
== genp_class() || iclass
== inet_class() || iclass
== keys_class() || iclass
== cert_class())
929 && (CFEqual(pdmn
, kSecAttrAccessibleWhenUnlocked
)
930 || CFEqual(pdmn
, kSecAttrAccessibleAfterFirstUnlock
)
931 || CFEqual(pdmn
, kSecAttrAccessibleAlwaysPrivate
)
932 || CFEqual(pdmn
, kSecAttrAccessibleWhenUnlockedThisDeviceOnly
)
933 || CFEqual(pdmn
, kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly
)
934 || CFEqual(pdmn
, kSecAttrAccessibleAlwaysThisDeviceOnlyPrivate
)))
936 CFTypeRef tomb
= SecDbItemGetCachedValueWithName(item
, kSecAttrTombstone
);
938 bool isTomb
= (isNumber(tomb
) && CFNumberGetValue(tomb
, kCFNumberCharType
, &cvalue
) && cvalue
== 1);
939 CFTypeRef viewHint
= SecDbItemGetCachedValueWithName(item
, kSecAttrSyncViewHint
);
941 // Intecept CKKS-handled items here and short-circuit function
942 if(SOSViewHintInCKKSSystem(viewHint
)) {
946 if (viewHint
== NULL
) {
947 if (iclass
== cert_class()) {
948 withViewAndBackup(kSOSViewOtherSyncable
);
950 if (!SecDbItemGetCachedValueWithName(item
, kSecAttrTokenID
)) {
951 withViewAndBackup(kSOSViewKeychainV0
);
953 CFTypeRef agrp
= SecDbItemGetCachedValueWithName(item
, kSecAttrAccessGroup
);
954 if (iclass
== keys_class() && CFEqualSafe(agrp
, CFSTR("com.apple.security.sos"))) {
955 withViewAndBackup(kSOSViewiCloudIdentity
);
956 } else if (CFEqualSafe(agrp
, CFSTR("com.apple.cfnetwork"))) {
957 withViewAndBackup(kSOSViewAutofillPasswords
);
958 } else if (CFEqualSafe(agrp
, CFSTR("com.apple.safari.credit-cards"))) {
959 withViewAndBackup(kSOSViewSafariCreditCards
);
960 } else if (iclass
== genp_class()) {
961 if (CFEqualSafe(agrp
, CFSTR("apple")) &&
962 CFEqualSafe(SecDbItemGetCachedValueWithName(item
, kSecAttrService
), CFSTR("AirPort"))) {
963 withViewAndBackup(kSOSViewWiFi
);
964 } else if (CFEqualSafe(agrp
, CFSTR("com.apple.sbd"))) {
965 withViewAndBackup(kSOSViewBackupBagV0
);
967 withViewAndBackup(kSOSViewOtherSyncable
); // (genp)
970 withViewAndBackup(kSOSViewOtherSyncable
); // (inet || keys)
976 CFStringRef viewHintTomb
= CFStringCreateWithFormat(kCFAllocatorDefault
, NULL
, CFSTR("%@-tomb"), viewHint
);
979 CFRelease(viewHintTomb
);
985 // TODO: general queries
988 CFArrayForEachC(engine
->views
, view
) {
989 bool inView
= SOSViewQueryMatchItem(view
, item
);
991 CFStringRef viewName
= SOSViewCopyName(view
);
993 CFReleaseSafe(viewName
);
1001 // Deliver delayed notifiations of changes in keychain
1005 SOSSendViewNotification(CFSetRef viewNotifications
)
1007 CFNotificationCenterRef center
= CFNotificationCenterGetDarwinNotifyCenter();
1009 CFSetForEach(viewNotifications
, ^(const void *value
) {
1010 secinfo("view", "Sending view notification for view %@", value
);
1012 CFStringRef str
= CFStringCreateWithFormat(NULL
, NULL
, CFSTR("com.apple.security.view-change.%@"), value
);
1016 CFNotificationCenterPostNotificationWithOptions(center
, str
, NULL
, NULL
, 0);
1023 SOSArmViewNotificationEvents(CFSetRef viewNotifications
)
1025 static CFMutableSetRef pendingViewNotifications
;
1026 static dispatch_once_t onceToken
;
1027 static dispatch_queue_t queue
;
1029 dispatch_once(&onceToken
, ^{
1030 queue
= dispatch_queue_create("ViewNotificationQueue", NULL
);
1032 if (queue
== NULL
|| CFSetGetCount(viewNotifications
) == 0)
1036 * PendingViewNotifications is only modified on queue.
1037 * PendingViewNotifications is used as a signal if a timer is running.
1039 * If a timer is running, new events are just added to the existing
1040 * pendingViewNotifications.
1043 #define DELAY_OF_NOTIFICATION_IN_NS (NSEC_PER_SEC)
1045 CFRetain(viewNotifications
);
1047 dispatch_async(queue
, ^{
1048 if (pendingViewNotifications
== NULL
) {
1049 pendingViewNotifications
= CFSetCreateMutableCopy(NULL
, 0, viewNotifications
);
1051 dispatch_after(dispatch_time(DISPATCH_TIME_NOW
, (int64_t)DELAY_OF_NOTIFICATION_IN_NS
), queue
, ^{
1052 SOSSendViewNotification(pendingViewNotifications
);
1054 // when timer hits, clear out set of modified views
1055 CFRelease(pendingViewNotifications
);
1056 pendingViewNotifications
= NULL
;
1059 CFSetUnion(pendingViewNotifications
, viewNotifications
);
1061 CFRelease(viewNotifications
);
1067 // SOSChangeMapper - Helper for SOSEngineUpdateChanges_locked
1069 struct SOSChangeMapper
{
1070 SOSEngineRef engine
;
1071 SOSTransactionRef txn
;
1072 SOSDataSourceTransactionPhase phase
;
1073 SOSDataSourceTransactionSource source
;
1074 CFMutableDictionaryRef ct2changes
;
1075 CFMutableSetRef viewNotifications
;
1078 static void SOSChangeMapperInit(struct SOSChangeMapper
*cm
, SOSEngineRef engine
, SOSTransactionRef txn
, SOSDataSourceTransactionPhase phase
, SOSDataSourceTransactionSource source
) {
1079 cm
->engine
= engine
;
1082 cm
->source
= source
;
1083 cm
->ct2changes
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
1084 cm
->viewNotifications
= CFSetCreateMutableForCFTypes(kCFAllocatorDefault
);
1087 static void SOSChangeMapperSendNotifications(struct SOSChangeMapper
*cm
)
1089 SOSArmViewNotificationEvents(cm
->viewNotifications
);
1092 static void SOSChangeMapperFree(struct SOSChangeMapper
*cm
) {
1093 CFReleaseSafe(cm
->ct2changes
);
1094 CFReleaseSafe(cm
->viewNotifications
);
1097 static void SOSChangeMapperAddViewNotification(struct SOSChangeMapper
*cm
, CFStringRef view
)
1099 assert(isString(view
));
1101 // aggregate the PCS view into one notification
1102 if (CFStringHasPrefix(view
, CFSTR("PCS-"))) {
1103 view
= CFSTR("PCS");
1105 CFSetSetValue(cm
->viewNotifications
, view
);
1108 static void SOSChangeMapperAppendObject(struct SOSChangeMapper
*cm
, SOSChangeTrackerRef ct
, bool isAdd
, CFTypeRef object
) {
1109 CFMutableArrayRef changes
= (CFMutableArrayRef
)CFDictionaryGetValue(cm
->ct2changes
, ct
);
1111 changes
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
1112 CFDictionarySetValue(cm
->ct2changes
, ct
, changes
);
1113 CFReleaseSafe(changes
);
1115 isAdd
? SOSChangesAppendAdd(changes
, object
) : SOSChangesAppendDelete(changes
, object
);
1118 static bool SOSChangeMapperIngestChange(struct SOSChangeMapper
*cm
, bool isAdd
, CFTypeRef change
) {
1119 bool someoneCares
= false;
1120 if (isData(change
)) {
1121 // TODO: Reenable assertion once the tests have been updated
1123 // We got a digest for a deleted object. Our dataSource probably couldn't find
1124 // an object with this digest, probably because it went missing, or it was
1125 // discovered to be corrupted.
1126 // Tell all our changeTrackers about this digest since we don't know who might need it.
1127 CFDictionaryForEach(cm
->engine
->viewNameSet2ChangeTracker
, ^(const void *viewNameSet
, const void *ct
) {
1128 SOSChangeMapperAppendObject(cm
, (SOSChangeTrackerRef
)ct
, isAdd
, change
);
1130 someoneCares
= CFDictionaryGetCount(cm
->engine
->viewNameSet2ChangeTracker
);
1132 // We got an object let's figure out which views it's in and schedule it for
1133 // delivery to all changeTrackers interested in any of those views.
1134 SOSObjectRef object
= (SOSObjectRef
)change
;
1135 CFMutableSetRef changeTrackerSet
= CFSetCreateMutableForCFTypes(kCFAllocatorDefault
);
1136 // First gather all the changeTrackers interested in this object (eliminating dupes by collecting them in a set)
1137 SOSEngineObjectWithView(cm
->engine
, object
, ^(CFStringRef viewName
) {
1138 const void *ctorset
= CFDictionaryGetValue(cm
->engine
->viewName2ChangeTracker
, viewName
);
1139 if (isSet(ctorset
)) {
1140 CFSetForEach((CFSetRef
)ctorset
, ^(const void *ct
) { CFSetAddValue(changeTrackerSet
, ct
); });
1141 } else if (ctorset
) {
1142 CFSetAddValue(changeTrackerSet
, ctorset
);
1146 SOSChangeMapperAddViewNotification(cm
, viewName
);
1148 // Then append the object to the changes array in the ct2changes dictionary keyed by viewSet
1149 CFSetForEach(changeTrackerSet
, ^(const void *ct
) {
1150 SOSChangeMapperAppendObject(cm
, (SOSChangeTrackerRef
)ct
, isAdd
, object
);
1152 someoneCares
= CFSetGetCount(changeTrackerSet
);
1153 CFReleaseSafe(changeTrackerSet
);
1155 return someoneCares
;
1158 static bool SOSChangeMapperSend(struct SOSChangeMapper
*cm
, CFErrorRef
*error
) {
1159 __block
bool ok
= true;
1160 CFDictionaryForEach(cm
->ct2changes
, ^(const void *ct
, const void *changes
) {
1161 ok
&= SOSChangeTrackerTrackChanges((SOSChangeTrackerRef
)ct
, cm
->engine
, cm
->txn
, cm
->source
, cm
->phase
, (CFArrayRef
)changes
, error
);
1166 static bool SOSEngineUpdateChanges_locked(SOSEngineRef engine
, SOSTransactionRef txn
, SOSDataSourceTransactionPhase phase
, SOSDataSourceTransactionSource source
, CFArrayRef changes
, CFErrorRef
*error
)
1168 secnoticeq("engine", "%@: %s %s %ld changes, txn=%@, %p", engine
->myID
, phase
== kSOSDataSourceTransactionWillCommit
? "will-commit" : phase
== kSOSDataSourceTransactionDidCommit
? "did-commit" : "did-rollback",
1169 source
== kSOSDataSourceSOSTransaction
? "sos" :
1170 source
== kSOSDataSourceCKKSTransaction
? "ckks" :
1171 source
== kSOSDataSourceAPITransaction
? "api" :
1173 CFArrayGetCount(changes
), txn
, txn
);
1176 case kSOSDataSourceTransactionDidRollback
:
1177 ok
&= SOSEngineLoad(engine
, txn
, error
);
1179 case kSOSDataSourceTransactionDidCommit
: // Corruption causes us to process items at DidCommit
1180 case kSOSDataSourceTransactionWillCommit
:
1182 bool mappedItemChanged
= false;
1184 struct SOSChangeMapper cm
;
1185 SOSChangeMapperInit(&cm
, engine
, txn
, phase
, source
);
1186 SecDbEventRef event
;
1187 CFArrayForEachC(changes
, event
) {
1188 CFTypeRef deleted
= NULL
;
1189 CFTypeRef inserted
= NULL
;
1190 SecDbEventGetComponents(event
, &deleted
, &inserted
, error
);
1192 bool someoneCares
= SOSChangeMapperIngestChange(&cm
, false, deleted
);
1194 #if TARGET_OS_EMBEDDED
1195 SecADAddValueForScalarKey(CFSTR("com.apple.security.sos.delete"), 1);
1197 mappedItemChanged
= true;
1201 bool someoneCares
= SOSChangeMapperIngestChange(&cm
, true, inserted
);
1203 #if TARGET_OS_EMBEDDED
1204 if (deleted
== NULL
) {
1205 SecADAddValueForScalarKey(CFSTR("com.apple.security.sos.add"), 1);
1207 SecADAddValueForScalarKey(CFSTR("com.apple.security.sos.update"), 1);
1210 mappedItemChanged
= true;
1212 if (!someoneCares
&& !isData(inserted
) && SecDbItemIsTombstone((SecDbItemRef
)inserted
) && !CFEqualSafe(SecDbItemGetValue((SecDbItemRef
)inserted
, &v7utomb
, NULL
), kCFBooleanTrue
)) {
1213 CFErrorRef localError
= NULL
;
1214 // A tombstone was inserted but there is no changetracker that
1216 if (!SecDbItemDoDeleteSilently((SecDbItemRef
)inserted
, (SecDbConnectionRef
)txn
, &localError
)) {
1217 secerror("failed to delete tombstone %@ that no one cares about: %@", inserted
, localError
);
1218 CFReleaseNull(localError
);
1224 ok
&= SOSChangeMapperSend(&cm
, error
);
1225 SOSChangeMapperSendNotifications(&cm
); // Trigger notifications for view that changes changed
1226 SOSChangeMapperFree(&cm
);
1228 if (ok
&& phase
== kSOSDataSourceTransactionWillCommit
) {
1229 // Only consider writing if we're in the WillCommit phase.
1230 // DidCommit phases happen outside the database lock and
1231 // writing to the DBConn will cause deadlocks.
1232 if (mappedItemChanged
|| source
== kSOSDataSourceSOSTransaction
) {
1233 // Write SOSEngine and SOSPeer state to disk
1235 if(!SecCKKSTestDisableSOS()) {
1237 secnotice("engine", "saving engine state");
1238 ok
&= SOSEngineSave(engine
, txn
, error
);
1240 if (kSOSDataSourceAPITransaction
== source
|| kSOSDataSourceCKKSTransaction
== source
)
1241 SOSCCRequestSyncWithPeersList(engine
->peerIDs
);
1246 secinfo("engine", "Not saving engine state, nothing changed.");
1256 static void SOSEngineSetNotifyPhaseBlock(SOSEngineRef engine
) {
1257 SOSDataSourceAddNotifyPhaseBlock(engine
->dataSource
, ^(SOSDataSourceRef ds
, SOSTransactionRef txn
, SOSDataSourceTransactionPhase phase
, SOSDataSourceTransactionSource source
, CFArrayRef changes
) {
1258 dispatch_sync(engine
->queue
, ^{
1259 CFErrorRef localError
= NULL
;
1260 if (!SOSEngineUpdateChanges_locked(engine
, txn
, phase
, source
, changes
, &localError
)) {
1261 secerror("updateChanged failed: %@", localError
);
1263 CFReleaseSafe(localError
);
1268 #if 0 // TODO: update these checks
1269 static void SOSEngineCircleChanged_sanitycheck(SOSEngineRef engine
, CFStringRef myPeerID
, CFArrayRef trustedPeers
, CFArrayRef untrustedPeers
) {
1271 CFMutableArrayRef addedPeers
= CFArrayCreateDifference(kCFAllocatorDefault
, trustedPeers
, engine
->peerIDs
);
1272 CFMutableArrayRef deletedPeers
= CFArrayCreateDifference(kCFAllocatorDefault
, engine
->peerIDs
, trustedPeers
);
1273 CFMutableArrayRef addedUntrustedPeers
= CFArrayCreateDifference(kCFAllocatorDefault
, untrustedPeers
, engine
->peerIDs
);
1274 CFMutableArrayRef deletedUntrustedPeers
= CFArrayCreateDifference(kCFAllocatorDefault
, engine
->peerIDs
, untrustedPeers
);
1276 CFStringRef tpDesc
= SOSPeerIDArrayCreateString(trustedPeers
);
1277 CFStringRef apDesc
= SOSPeerIDArrayCreateString(addedPeers
);
1278 CFStringRef dpDesc
= SOSPeerIDArrayCreateString(deletedPeers
);
1279 CFStringRef aupDesc
= SOSPeerIDArrayCreateString(addedUntrustedPeers
);
1280 CFStringRef dupDesc
= SOSPeerIDArrayCreateString(deletedUntrustedPeers
);
1281 secnotice("engine", "trusted %@ added %@ removed %@ add ut: %@ rem ut: %@", tpDesc
, apDesc
, dpDesc
, aupDesc
, dupDesc
);
1282 CFReleaseSafe(dupDesc
);
1283 CFReleaseSafe(aupDesc
);
1284 CFReleaseSafe(dpDesc
);
1285 CFReleaseSafe(apDesc
);
1286 CFReleaseSafe(tpDesc
);
1289 // Ensure SOSAccount isn't giving us the runaround.
1290 // Assert that trustedPeers, untrustedPeers and myPeerId are disjoint sets
1292 CFMutableArrayRef allTrustedPeers
= CFArrayCreateDifference(kCFAllocatorDefault
, trustedPeers
, untrustedPeers
);
1293 assert(CFEqual(trustedPeers
, allTrustedPeers
));
1294 CFReleaseSafe(allTrustedPeers
);
1295 assert(!CFArrayContainsValue(trustedPeers
, CFRangeMake(0, CFArrayGetCount(trustedPeers
)), myPeerID
));
1297 if (untrustedPeers
) {
1298 CFMutableArrayRef allUntrustedPeers
= CFArrayCreateDifference(kCFAllocatorDefault
, untrustedPeers
, trustedPeers
);
1299 assert(CFEqual(untrustedPeers
, allUntrustedPeers
));
1300 CFReleaseSafe(allUntrustedPeers
);
1301 assert(!CFArrayContainsValue(untrustedPeers
, CFRangeMake(0, CFArrayGetCount(trustedPeers
)), myPeerID
));
1304 CFReleaseNull(deletedUntrustedPeers
);
1305 CFReleaseNull(addedUntrustedPeers
);
1306 CFReleaseNull(deletedPeers
);
1307 CFReleaseNull(addedPeers
);
1309 // End of logging and asertions, actual code here.
1313 static SOSChangeTrackerRef
SOSReferenceAndGetChangeTracker(CFDictionaryRef lookup
, CFMutableDictionaryRef referenced
, CFSetRef viewNameSet
) {
1314 SOSChangeTrackerRef ct
= (SOSChangeTrackerRef
)CFDictionaryGetValue(referenced
, viewNameSet
);
1316 ct
= (SOSChangeTrackerRef
)CFDictionaryGetValue(lookup
, viewNameSet
);
1318 SOSChangeTrackerResetRegistration(ct
);
1319 CFDictionarySetValue(referenced
, viewNameSet
, ct
);
1321 ct
= SOSChangeTrackerCreate(kCFAllocatorDefault
, false, NULL
, NULL
);
1322 CFDictionarySetValue(referenced
, viewNameSet
, ct
);
1329 static void CFStringAppendPeerIDAndViews(CFMutableStringRef desc
, CFStringRef peerID
, CFSetRef vns
) {
1330 CFStringSetPerformWithDescription(vns
, ^(CFStringRef description
) {
1331 CFStringAppendFormat(desc
, NULL
, CFSTR(" %@ (%@)"), peerID
, description
);
1335 // Must be called after updating viewNameSet2ChangeTracker
1336 static void SOSEngineUpdateViewName2ChangeTracker(SOSEngineRef engine
) {
1337 // Create the mapping from viewName -> ChangeTracker used for lookup during change notification
1338 CFMutableDictionaryRef newViewName2ChangeTracker
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
1339 CFDictionaryForEach(engine
->viewNameSet2ChangeTracker
, ^(const void *viewNameSet
, const void *ct
) {
1340 CFSetForEach(viewNameSet
, ^(const void *viewName
) {
1341 const void *ctorset
= NULL
;
1342 if (CFDictionaryGetValueIfPresent(newViewName2ChangeTracker
, viewName
, &ctorset
)) {
1343 if (isSet(ctorset
)) {
1344 CFSetAddValue((CFMutableSetRef
)ctorset
, ct
);
1345 } else if (!CFEqual(ct
, ctorset
)) {
1346 CFMutableSetRef set
= CFSetCreateMutableForCFTypes(kCFAllocatorDefault
);
1347 CFSetAddValue(set
, ctorset
);
1348 CFSetAddValue(set
, ct
);
1349 CFDictionaryReplaceValue(newViewName2ChangeTracker
, viewName
, set
);
1353 CFDictionarySetValue(newViewName2ChangeTracker
, viewName
, ct
);
1357 CFAssignRetained(engine
->viewName2ChangeTracker
, newViewName2ChangeTracker
);
1360 static void SOSEngineSetBackupBag(SOSEngineRef engine
, SOSObjectRef bagItem
);
1362 // This is called only if we are in a circle and we should listen for keybag changes
1363 static void SOSEngineRegisterBackupBagV0Tracker(SOSEngineRef engine
, CFMutableDictionaryRef newViewNameSet2ChangeTracker
, CFMutableStringRef desc
) {
1364 SOSChangeTrackerRef bbct
= SOSReferenceAndGetChangeTracker(engine
->viewNameSet2ChangeTracker
, newViewNameSet2ChangeTracker
, SOSViewsGetV0BackupBagViewSet());
1365 SOSChangeTrackerRegisterChangeUpdate(bbct
, ^bool(SOSChangeTrackerRef ct
, SOSEngineRef engine
, SOSTransactionRef txn
, SOSDataSourceTransactionSource source
, SOSDataSourceTransactionPhase phase
, CFArrayRef changes
, CFErrorRef
*error
) {
1366 SOSChangeRef change
;
1367 CFArrayForEachC(changes
, change
) {
1368 CFTypeRef object
= NULL
;
1369 bool isAdd
= SOSChangeGetObject(change
, &object
);
1370 SecDbItemRef dbi
= (SecDbItemRef
)object
;
1371 if (!isData(object
) &&
1372 CFEqualSafe(SecDbItemGetCachedValueWithName(dbi
, kSecAttrService
), CFSTR("SecureBackupService")) &&
1373 CFEqualSafe(SecDbItemGetCachedValueWithName(dbi
, kSecAttrAccessible
), kSecAttrAccessibleWhenUnlocked
) &&
1374 CFEqualSafe(SecDbItemGetCachedValueWithName(dbi
, kSecAttrAccount
), CFSTR("SecureBackupPublicKeybag"))) {
1375 SOSEngineSetBackupBag(engine
, isAdd
? (SOSObjectRef
)object
: NULL
);
1382 static void SOSEngineReferenceBackupPeer(SOSEngineRef engine
, CFStringRef peerID
, CFSetRef viewNameSet
, CFDataRef keyBag
, CFMutableDictionaryRef newViewNameSet2ChangeTracker
, CFMutableDictionaryRef newPeerMap
) {
1383 CFTypeRef oldEntry
= CFDictionaryGetValue(engine
->peerMap
, peerID
);
1384 CFTypeRef newEntry
= SOSPeerOrStateSetViewsKeyBagAndCreateCopy(oldEntry
, viewNameSet
, keyBag
);
1386 if (isDictionary(newEntry
)) {
1387 // Backup peers, are always inflated
1388 CFAssignRetained(newEntry
, SOSPeerCreateWithState(engine
, peerID
, newEntry
, NULL
));
1389 // If !oldEntry this is an edge (first creation of a peer).
1391 SOSPeerKeyBagDidChange((SOSPeerRef
)newEntry
);
1394 CFDictionarySetValue(newPeerMap
, peerID
, newEntry
);
1395 CFRelease(newEntry
);
1398 SOSChangeTrackerRef ct
= SOSReferenceAndGetChangeTracker(engine
->viewNameSet2ChangeTracker
, newViewNameSet2ChangeTracker
, viewNameSet
);
1400 SOSChangeTrackerUpdatesChanges child
= Block_copy(^bool(SOSChangeTrackerRef ct
, SOSEngineRef engine
, SOSTransactionRef txn
, SOSDataSourceTransactionSource source
, SOSDataSourceTransactionPhase phase
, CFArrayRef changes
, CFErrorRef
*error
) {
1401 return SOSPeerDataSourceWillChange((SOSPeerRef
)newEntry
, SOSEngineGetDataSource(engine
), source
, changes
, error
);
1404 SOSChangeTrackerRegisterChangeUpdate(ct
, child
);
1405 Block_release(child
);
1410 static void SOSEngineReferenceSyncPeer(SOSEngineRef engine
, CFStringRef peerID
, CFSetRef viewNameSet
, CFMutableDictionaryRef newViewNameSet2ChangeTracker
, CFMutableDictionaryRef newPeerMap
) {
1411 CFTypeRef newEntry
= SOSPeerOrStateSetViewsKeyBagAndCreateCopy(CFDictionaryGetValue(engine
->peerMap
, peerID
), viewNameSet
, NULL
);
1413 SOSChangeTrackerRef ct
= SOSReferenceAndGetChangeTracker(engine
->viewNameSet2ChangeTracker
, newViewNameSet2ChangeTracker
, viewNameSet
);
1414 // Standard peer, inflated on demand
1415 SOSChangeTrackerUpdatesManifests trackManifest
;
1416 if (isDictionary(newEntry
)) {
1417 // Uninflated peer, inflate on first notification.
1418 trackManifest
= ^bool(SOSChangeTrackerRef ct
, SOSEngineRef engine
, SOSTransactionRef txn
, SOSDataSourceTransactionSource source
, SOSDataSourceTransactionPhase phase
, SOSManifestRef removals
, SOSManifestRef additions
, CFErrorRef
*error
) {
1419 CFErrorRef localError
= NULL
;
1420 SOSPeerRef peer
= SOSEngineCopyPeerWithID_locked(engine
, peerID
, &localError
);
1423 secerror("%@: peer failed to inflate: %@", peerID
, localError
);
1424 CFReleaseSafe(localError
);
1427 ok
= SOSPeerDataSourceWillCommit(peer
, source
, removals
, additions
, error
);
1429 CFReleaseSafe(peer
);
1433 // Inflated peer, just forward the changes to the peer
1434 trackManifest
= ^bool(SOSChangeTrackerRef ct
, SOSEngineRef engine
, SOSTransactionRef txn
, SOSDataSourceTransactionSource source
, SOSDataSourceTransactionPhase phase
, SOSManifestRef removals
, SOSManifestRef additions
, CFErrorRef
*error
) {
1435 return SOSPeerDataSourceWillCommit((SOSPeerRef
)newEntry
, source
, removals
, additions
, error
);
1438 SOSChangeTrackerUpdatesManifests trackManifestCopy
= Block_copy(trackManifest
);
1439 SOSChangeTrackerRegisterManifestUpdate(ct
, trackManifestCopy
);
1440 Block_release(trackManifestCopy
);
1442 CFDictionarySetValue(newPeerMap
, peerID
, newEntry
);
1443 CFRelease(newEntry
);
1448 static void SOSEngineReferenceTrustedPeer(SOSEngineRef engine
, SOSPeerMetaRef peerMeta
, CFMutableDictionaryRef newViewNameSet2ChangeTracker
, CFMutableDictionaryRef newPeerMap
, CFMutableArrayRef peerIDs
, CFMutableStringRef desc
) {
1449 CFSetRef viewNameSet
= NULL
;
1450 CFDataRef keyBag
= NULL
;
1451 CFStringRef peerID
= SOSPeerMetaGetComponents(peerMeta
, &viewNameSet
, &keyBag
, NULL
);
1452 // We trust peerID so append it to peerIDs
1453 CFArrayAppendValue(peerIDs
, peerID
);
1454 if (desc
) CFStringAppendPeerIDAndViews(desc
, peerID
, viewNameSet
);
1455 // Update the viewNameSet for this peer, to appease tests, default to a viewset of the V0 view.
1457 viewNameSet
= SOSViewsGetV0ViewSet();
1459 // Always inflate backup peers, since they need to register with their changeTrackers right away.
1461 SOSEngineReferenceBackupPeer(engine
, peerID
, viewNameSet
, keyBag
, newViewNameSet2ChangeTracker
, newPeerMap
);
1463 SOSEngineReferenceSyncPeer(engine
, peerID
, viewNameSet
, newViewNameSet2ChangeTracker
, newPeerMap
);
1467 static CFDataRef
SOSEngineCopyV0KeyBag(SOSEngineRef engine
, CFErrorRef
*error
) {
1468 // Return the keybag for the given peerID.
1471 kSecAttrAccessGroup ==> CFSTR("com.apple.sbd")
1472 kSecAttrAccessible ==> kSecAttrAccessibleWhenUnlocked
1473 kSecAttrAccount ==> CFSTR("SecureBackupPublicKeybag")
1474 kSecAttrService ==> CFSTR("SecureBackupService")
1477 CFMutableDictionaryRef keys
= CFDictionaryCreateMutableForCFTypesWith(kCFAllocatorDefault
,
1478 kSecAttrAccessGroup
, CFSTR("com.apple.sbd"),
1479 kSecAttrAccount
, CFSTR("SecureBackupPublicKeybag"),
1480 kSecAttrService
, CFSTR("SecureBackupService"),
1481 kSecAttrAccessible
, kSecAttrAccessibleWhenUnlocked
,
1482 kSecAttrSynchronizable
, kCFBooleanTrue
,
1485 CFDataRef keybag
= engine
->dataSource
->dsCopyItemDataWithKeys(engine
->dataSource
, keys
, error
);
1486 CFReleaseSafe(keys
);
1491 static void SOSEngineReferenceBackupV0Peer(SOSEngineRef engine
, CFMutableDictionaryRef newViewNameSet2ChangeTracker
, CFMutableDictionaryRef newPeerMap
, CFMutableArrayRef newPeerIDs
, CFMutableStringRef desc
) {
1492 SOSPeerRef backupPeer
= (SOSPeerRef
)CFDictionaryGetValue(engine
->peerMap
, kSOSViewKeychainV0_tomb
);
1493 CFDataRef bag
= NULL
;
1494 if (backupPeer
&& CFGetTypeID(backupPeer
) == SOSPeerGetTypeID()) {
1495 bag
= CFRetainSafe(SOSPeerGetKeyBag(backupPeer
));
1497 CFErrorRef localError
= NULL
;
1498 bag
= SOSEngineCopyV0KeyBag(engine
, &localError
);
1500 secnotice("engine", "No keybag found for v0 backup peer: %@", localError
);
1501 CFReleaseSafe(localError
);
1504 SOSEngineReferenceBackupPeer(engine
, kSOSViewKeychainV0_tomb
, SOSViewsGetV0BackupViewSet(), bag
, newViewNameSet2ChangeTracker
, newPeerMap
);
1508 static void SOSEngineReferenceTrustedPeers(SOSEngineRef engine
, CFMutableDictionaryRef newViewNameSet2ChangeTracker
, CFMutableDictionaryRef newPeerMap
, CFMutableArrayRef newPeerIDs
, CFArrayRef trustedPeerMetas
, CFMutableStringRef desc
) {
1509 // Then update the views for all trusted peers and add them to newPeerMap.
1510 if (trustedPeerMetas
!= NULL
&& CFArrayGetCount(trustedPeerMetas
) != 0) {
1511 if (desc
) CFStringAppend(desc
, CFSTR(" trusted"));
1512 // Remake engine->peerIDs
1513 SOSPeerMetaRef peerMeta
;
1514 CFArrayForEachC(trustedPeerMetas
, peerMeta
) {
1515 SOSEngineReferenceTrustedPeer(engine
, peerMeta
, newViewNameSet2ChangeTracker
, newPeerMap
, newPeerIDs
, desc
);
1520 static void SOSEngineReferenceUntrustedPeers(SOSEngineRef engine
, CFMutableDictionaryRef newPeerMap
, CFArrayRef untrustedPeerMetas
, CFMutableStringRef description
) {
1521 // Copy any untrustedPeers to newPeerMap as well if we have a state
1522 // for them, if not no big deal. We also serialize all the untrustedPeers
1523 // since they don't need to be deserializable
1524 if (untrustedPeerMetas
!= NULL
&& CFArrayGetCount(untrustedPeerMetas
) != 0) {
1525 if (description
) CFStringAppend(description
, CFSTR(" untrusted"));
1526 SOSPeerMetaRef peerMeta
;
1527 CFArrayForEachC(untrustedPeerMetas
, peerMeta
) {
1528 CFSetRef views
= NULL
;
1529 CFStringRef peerID
= SOSPeerMetaGetComponents(peerMeta
, &views
, NULL
, NULL
);
1530 if (description
) CFStringAppendPeerIDAndViews(description
, peerID
, views
);
1531 CFSetRef nviews
= NULL
;
1533 views
= nviews
= CFSetCreate(kCFAllocatorDefault
, NULL
, 0, &kCFTypeSetCallBacks
);
1534 CFTypeRef newEntry
= SOSPeerOrStateSetViewsAndCopyState(CFDictionaryGetValue(engine
->peerMap
, peerID
), views
);
1535 CFReleaseSafe(nviews
);
1537 CFDictionarySetValue(newPeerMap
, peerID
, newEntry
);
1538 CFReleaseSafe(newEntry
);
1544 static void SOSEngineReferenceChangeTrackers(SOSEngineRef engine
, CFArrayRef trustedPeerMetas
, CFArrayRef untrustedPeerMetas
, CFMutableStringRef desc
) {
1545 CFMutableArrayRef newPeerIDs
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
1546 CFMutableDictionaryRef newPeerMap
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
1547 CFMutableDictionaryRef newViewNameSet2ChangeTracker
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
1550 // We have an engineID => in a circle (with 0 or more peers)
1551 // Ensure we have a v0 backup peer and it's listening for backup bag changes
1552 SOSEngineReferenceBackupV0Peer(engine
, newViewNameSet2ChangeTracker
, newPeerMap
, newPeerIDs
, desc
);
1553 SOSEngineRegisterBackupBagV0Tracker(engine
, newViewNameSet2ChangeTracker
, desc
);
1555 SOSEngineReferenceTrustedPeers(engine
, newViewNameSet2ChangeTracker
, newPeerMap
, newPeerIDs
, trustedPeerMetas
, desc
);
1556 SOSEngineReferenceUntrustedPeers(engine
, newPeerMap
, untrustedPeerMetas
, desc
);
1558 CFAssignRetained(engine
->peerIDs
, newPeerIDs
);
1559 CFAssignRetained(engine
->peerMap
, newPeerMap
);
1560 CFAssignRetained(engine
->viewNameSet2ChangeTracker
, newViewNameSet2ChangeTracker
);
1561 SOSEngineUpdateViewName2ChangeTracker(engine
);
1564 // Return true iff peers or views changed
1565 static bool SOSEngineSetPeers_locked(SOSEngineRef engine
, SOSPeerMetaRef myPeerMeta
, CFArrayRef trustedPeerMetas
, CFArrayRef untrustedPeerMetas
) {
1566 CFErrorRef error
= NULL
;
1567 CFSetRef myViews
= NULL
;
1568 CFDataRef myKeyBag
= NULL
;
1569 CFMutableStringRef desc
= CFStringCreateMutableCopy(kCFAllocatorDefault
, 0, CFSTR("me"));
1570 CFStringRef myPeerID
= myPeerMeta
? SOSPeerMetaGetComponents(myPeerMeta
, &myViews
, &myKeyBag
, &error
) : NULL
;
1571 if (desc
) CFStringAppendPeerIDAndViews(desc
, myPeerID
, myViews
);
1573 // Start with no coders
1574 CFMutableDictionaryRef codersToKeep
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
1576 if(engine
->haveLoadedCoders
){
1577 // If we're the same peerID we keep known peers (both trusted and untrusted)
1578 if (CFEqualSafe(myPeerID
, engine
->myID
)) {
1579 void (^copyPeerMetasCoder
)(const void *value
) = ^(const void*element
) {
1580 SOSPeerMetaRef peerMeta
= (SOSPeerMetaRef
) element
;
1582 CFStringRef currentID
= SOSPeerMetaGetComponents(peerMeta
, NULL
, NULL
, NULL
);
1584 SOSCoderRef coder
= (SOSCoderRef
) CFDictionaryGetValue(engine
->coders
, currentID
);
1586 CFDictionarySetValue(codersToKeep
, currentID
, coder
);
1591 if (trustedPeerMetas
) {
1592 CFArrayForEach(trustedPeerMetas
, copyPeerMetasCoder
);
1594 if (untrustedPeerMetas
) {
1595 CFArrayForEach(untrustedPeerMetas
, copyPeerMetasCoder
);
1599 engine
->codersNeedSaving
= true;
1601 CFRetainAssign(engine
->myID
, myPeerID
);
1602 CFTransferRetained(engine
->coders
, codersToKeep
);
1604 // Remake engine->peerMap from both trusted and untrusted peers
1605 SOSEngineReferenceChangeTrackers(engine
, trustedPeerMetas
, untrustedPeerMetas
, desc
);
1607 secnotice("engine", "%@", desc
);
1608 CFReleaseSafe(desc
);
1612 static void SOSEngineApplyPeerState(SOSEngineRef engine
, CFDictionaryRef peerStateMap
) {
1613 if (peerStateMap
) CFDictionaryForEach(peerStateMap
, ^(const void *peerID
, const void *peerState
) {
1614 CFTypeRef mapEntry
= CFDictionaryGetValue(engine
->peerMap
, peerID
);
1615 if (mapEntry
&& CFGetTypeID(mapEntry
) == SOSPeerGetTypeID()) {
1616 // Update the state of any already inflated peers
1617 SOSPeerRef peer
= (SOSPeerRef
)mapEntry
;
1618 CFErrorRef localError
= NULL
;
1619 if (!SOSPeerSetState(peer
, engine
, peerState
, &localError
)) {
1620 CFStringRef stateHex
= NULL
;
1621 stateHex
= CFDataCopyHexString(peerState
);
1622 secerror("peer: %@: bad state: %@ in engine state: %@", peerID
, localError
, stateHex
);
1623 CFReleaseSafe(stateHex
);
1624 CFReleaseNull(localError
);
1625 // Possibly ask for an ensurePeerRegistration so we have a good list of peers again.
1628 // Just record the state for non inflated peers for now.
1629 CFDictionarySetValue(engine
->peerMap
, peerID
, peerState
);
1634 static void SOSEngineSynthesizePeerMetas(SOSEngineRef engine
, CFMutableArrayRef trustedPeersMetas
, CFMutableArrayRef untrustedPeers
) {
1635 CFSetRef trustedPeerSet
= engine
->peerIDs
? CFSetCreateCopyOfArrayForCFTypes(engine
->peerIDs
) : NULL
;
1636 CFDictionaryForEach(engine
->peerMap
, ^(const void *peerID
, const void *peerState
) {
1637 SOSPeerMetaRef meta
= NULL
;
1638 if (peerState
&& CFGetTypeID(peerState
) == SOSPeerGetTypeID()) {
1639 SOSPeerRef peer
= (SOSPeerRef
)peerState
;
1640 meta
= SOSPeerMetaCreateWithComponents(peerID
, SOSPeerGetViewNameSet(peer
), SOSPeerGetKeyBag(peer
));
1642 // We don't need to add the meta for the backup case, since
1643 // SOSEngineReferenceBackupV0Peer will do the right thing
1644 if (!CFEqualSafe(peerID
, kSOSViewKeychainV0_tomb
)) {
1645 meta
= SOSPeerMetaCreateWithState(peerID
, peerState
);
1648 // Any peer in peerStateMap that is not in trustedPeers is an untrustedPeer unless it's the v0 backup peer
1649 if ((trustedPeerSet
&& CFSetContainsValue(trustedPeerSet
, peerID
)) || CFEqualSafe(peerID
, kSOSViewKeychainV0_tomb
)) {
1651 CFArrayAppendValue(trustedPeersMetas
, meta
);
1654 CFArrayAppendValue(untrustedPeers
, peerID
);
1656 CFReleaseNull(meta
);
1658 CFReleaseNull(trustedPeerSet
);
1661 static void SOSEngineSetBackupBag(SOSEngineRef engine
, SOSObjectRef bagItem
) {
1662 CFMutableStringRef desc
= NULL
;
1663 SOSPeerRef backupPeer
= SOSEngineCopyPeerWithID_locked(engine
, kSOSViewKeychainV0_tomb
, NULL
);
1664 CFDataRef keybag
= NULL
;
1666 keybag
= SecDbItemGetValue((SecDbItemRef
)bagItem
, &v6v_Data
, NULL
);
1669 // Since SOSPeerSetKeyBag() doesn't notify on the edge from NULL->initial keybag, since
1670 // that is the right behaviour for non v0 backup peers, we need to do it here for the v0 peer.
1671 bool hadBag
= SOSPeerGetKeyBag(backupPeer
);
1672 SOSPeerSetKeyBag(backupPeer
, keybag
);
1674 SOSPeerKeyBagDidChange(backupPeer
);
1676 CFReleaseSafe(backupPeer
);
1678 CFMutableArrayRef untrustedPeerMetas
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
1679 CFMutableArrayRef trustedPeersMetas
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
1680 SOSEngineSynthesizePeerMetas(engine
, trustedPeersMetas
, untrustedPeerMetas
);
1681 SOSEngineReferenceChangeTrackers(engine
, trustedPeersMetas
, untrustedPeerMetas
, desc
);
1682 CFReleaseSafe(trustedPeersMetas
);
1683 CFReleaseSafe(untrustedPeerMetas
);
1686 #define SECONDS_PER_DAY (86400.0)
1688 #if (TARGET_OS_MAC && !(TARGET_OS_EMBEDDED || TARGET_OS_IPHONE))
1689 #define TRACE_INTERVAL (7 * SECONDS_PER_DAY)
1690 #elif (TARGET_OS_IPHONE && !TARGET_IPHONE_SIMULATOR)
1691 #define TRACE_INTERVAL (1 * SECONDS_PER_DAY)
1694 #ifdef TRACE_INTERVAL
1695 static void SOSEngineCloudKeychainTrace(SOSEngineRef engine
, CFAbsoluteTime now
) {
1696 CFAssignRetained(engine
->lastTraceDate
, CFDateCreate(kCFAllocatorDefault
, now
));
1697 CFIndex num_peers
= engine
->peerIDs
? 1 + CFArrayGetCount(engine
->peerIDs
) : 1;
1698 SOSManifestRef manifest
= SOSEngineCopyManifestWithViewNameSet_locked(engine
, SOSViewsGetV0ViewSet(), NULL
);
1700 manifest
= SOSDataSourceCopyManifestWithViewNameSet(engine
->dataSource
, SOSViewsGetV0ViewSet(), NULL
);
1701 size_t num_items
= SOSManifestGetCount(manifest
);
1702 CFReleaseSafe(manifest
);
1704 struct _SecServerKeyStats genpStats
= { };
1705 struct _SecServerKeyStats inetStats
= { };
1706 struct _SecServerKeyStats keysStats
= { };
1708 _SecServerGetKeyStats(genp_class(), &genpStats
);
1709 _SecServerGetKeyStats(inet_class(), &inetStats
);
1710 _SecServerGetKeyStats(keys_class(), &keysStats
);
1712 dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT
, 0), ^{
1713 CloudKeychainTrace(num_peers
, num_items
, &genpStats
, &inetStats
, &keysStats
);
1718 static void SOSEngineCloudKeychainTraceIfNeeded(SOSEngineRef engine
) {
1719 #ifdef TRACE_INTERVAL
1722 CFAbsoluteTime now
= CFAbsoluteTimeGetCurrent();
1723 if (engine
->lastTraceDate
) {
1724 CFAbsoluteTime lastTraceTime
= CFDateGetAbsoluteTime(engine
->lastTraceDate
);
1725 if ((now
- lastTraceTime
) >= TRACE_INTERVAL
) {
1726 SOSEngineCloudKeychainTrace(engine
, now
);
1729 SOSEngineCloudKeychainTrace(engine
, now
);
1735 static bool SOSEngineCircleChanged_locked(SOSEngineRef engine
, SOSPeerMetaRef myPeerMeta
, CFArrayRef trustedPeers
, CFArrayRef untrustedPeers
) {
1736 // Sanity check params
1737 // SOSEngineCircleChanged_sanitycheck(engine, myPeerID, trustedPeers, untrustedPeers);
1739 // Transform from SOSPeerInfoRefs to CFDictionaries with the info we want per peer.
1740 // Or, Tell the real SOSPeerRef what the SOSPeerInfoRef is and have it copy out the data it needs.
1741 bool peersOrViewsChanged
= SOSEngineSetPeers_locked(engine
, myPeerMeta
, trustedPeers
, untrustedPeers
);
1743 // Run though all peers and only cache manifests for peers we still have
1744 CFErrorRef localError
= NULL
;
1745 if (!SOSEngineGCPeerState_locked(engine
, &localError
)) {
1746 secerror("SOSEngineGCPeerState_locked failed: %@", localError
);
1747 CFReleaseNull(localError
);
1749 return peersOrViewsChanged
;
1752 // Initialize the engine if a load fails. Basically this is our first time setup
1753 static bool SOSEngineInit(SOSEngineRef engine
, CFErrorRef
*error
) {
1755 secnotice("engine", "new engine for datasource named %@", SOSDataSourceGetName(engine
->dataSource
));
1756 CFAssignRetained(engine
->peerMap
, CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
));
1757 CFAssignRetained(engine
->viewNameSet2ChangeTracker
, CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
));
1758 CFAssignRetained(engine
->viewName2ChangeTracker
, CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
));
1759 CFReleaseNull(engine
->manifestCache
);
1760 CFReleaseNull(engine
->peerIDs
);
1761 // TODO: We shouldn't need to load the backup bag if there was no engine
1762 // state (load failed), since that means there was no circle nor were we an applicant.
1764 // Set up change trackers so we know when a backup peer needs to be created?
1765 // no, since myID is not set, we are not in a circle, so no need to back up
1766 SOSEngineSetPeers_locked(engine
, NULL
, NULL
, NULL
);
1770 // Called by our DataSource in its constructor
1771 SOSEngineRef
SOSEngineCreate(SOSDataSourceRef dataSource
, CFErrorRef
*error
) {
1772 SOSEngineRef engine
= NULL
;
1773 engine
= CFTypeAllocate(SOSEngine
, struct __OpaqueSOSEngine
, kCFAllocatorDefault
);
1774 engine
->dataSource
= dataSource
;
1775 engine
->queue
= dispatch_queue_create("engine", DISPATCH_QUEUE_SERIAL
);
1777 engine
->peerMap
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
1778 engine
->viewNameSet2ChangeTracker
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
1779 engine
->viewName2ChangeTracker
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
1780 //engine->syncCompleteQueue = NULL;
1781 engine
->syncCompleteListener
= NULL
;
1782 engine
->coders
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
1783 engine
->haveLoadedCoders
= false;
1784 engine
->codersNeedSaving
= false;
1786 CFErrorRef engineError
= NULL
;
1787 if (!SOSEngineLoad(engine
, NULL
, &engineError
)) {
1788 secwarning("engine failed load state starting with nothing %@", engineError
);
1789 CFReleaseNull(engineError
);
1790 if (!SOSEngineInit(engine
, error
)) {
1791 secerror("engine failed to initialze %@ giving up", error
? *error
: NULL
);
1794 // Successfully loaded engine state, let's trace if we haven't in a while
1795 SOSEngineCloudKeychainTraceIfNeeded(engine
);
1797 SOSEngineSetNotifyPhaseBlock(engine
);
1801 // --- Called from off the queue, need to move to on the queue
1803 static void SOSEngineDoOnQueue(SOSEngineRef engine
, dispatch_block_t action
)
1805 dispatch_sync(engine
->queue
, action
);
1808 static bool SOSEngineDoTxnOnQueue(SOSEngineRef engine
, CFErrorRef
*error
, void(^transaction
)(SOSTransactionRef txn
, bool *commit
))
1810 return SOSDataSourceWithCommitQueue(engine
->dataSource
, error
, ^(SOSTransactionRef txn
, bool *commit
) {
1811 SOSEngineDoOnQueue(engine
, ^{ transaction(txn
, commit
); });
1816 // MARK: SOSEngine API
1819 void SOSEngineDispose(SOSEngineRef engine
) {
1820 // NOOP Engines stick around forever to monitor dataSource changes.
1821 engine
->dataSource
= NULL
;
1822 CFReleaseNull(engine
->coders
);
1825 void SOSEngineForEachPeer(SOSEngineRef engine
, void (^with
)(SOSPeerRef peer
)) {
1826 SOSEngineDoOnQueue(engine
, ^{
1827 SOSEngineForEachPeer_locked(engine
, with
);
1831 static void SOSEngineForEachBackupPeer(SOSEngineRef engine
, void (^with
)(SOSPeerRef peer
)) {
1832 SOSEngineDoOnQueue(engine
, ^{
1833 SOSEngineForEachBackupPeer_locked(engine
, with
);
1837 static const CFStringRef kSecADSecurityNewItemSyncTimeKey
= CFSTR("com.apple.security.secureobjectsync.itemtime.new");
1838 static const CFStringRef kSecADSecurityKnownItemSyncTimeKey
= CFSTR("com.apple.security.secureobjectsync.itemtime.known");
1841 static void ReportItemSyncTime(SOSDataSourceRef ds
, bool known
, SOSObjectRef object
)
1843 CFDateRef itemModDate
= SOSObjectCopyModificationDate(ds
, object
, NULL
);
1845 CFAbsoluteTime syncTime
= 0;
1846 CFAbsoluteTime now
= CFAbsoluteTimeGetCurrent();
1848 CFAbsoluteTime peerModificationAbsoluteTime
= CFDateGetAbsoluteTime(itemModDate
);
1849 if (peerModificationAbsoluteTime
> now
) {
1850 syncTime
= now
- peerModificationAbsoluteTime
;
1853 SecADClientPushValueForDistributionKey(known
? kSecADSecurityKnownItemSyncTimeKey
: kSecADSecurityNewItemSyncTimeKey
,
1854 SecBucket2Significant(syncTime
));
1856 CFReleaseNull(itemModDate
);
1859 /* Handle incoming message from peer p. Return false if there was an error, true otherwise. */
1860 bool SOSEngineHandleMessage_locked(SOSEngineRef engine
, CFStringRef peerID
, SOSMessageRef message
,
1861 SOSTransactionRef txn
, bool *commit
, bool *somethingChanged
, CFErrorRef
*error
) {
1862 SOSPeerRef peer
= SOSEngineCopyPeerWithID_locked(engine
, peerID
, error
);
1863 if (!peer
) return false;
1865 CFStringRef peerDesc
= NULL
;
1866 SOSManifestRef localManifest
= NULL
;
1867 SOSManifestRef allAdditions
= NULL
;
1868 SOSManifestRef unwanted
= NULL
;
1869 SOSManifestRef confirmed
= NULL
;
1870 SOSManifestRef base
= NULL
;
1871 SOSManifestRef confirmedRemovals
= NULL
, confirmedAdditions
= NULL
;
1872 __block
struct SOSDigestVector receivedObjects
= SOSDigestVectorInit
;
1873 __block
struct SOSDigestVector unwantedObjects
= SOSDigestVectorInit
;
1875 // Check for unknown criticial extensions in the message, and handle
1876 // any other extensions we support
1877 __block
bool ok
= true;
1878 CFMutableArrayRef changes
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
1880 require_action_quiet(peer
, exit
, ok
= SOSErrorCreate(errSecParam
, error
, NULL
, CFSTR("Couldn't create peer with Engine for %@"), peerID
));
1881 peerDesc
= CFCopyDescription(peer
);
1883 bool hadBeenInSyncAtStart
= SOSPeerHasBeenInSync(peer
);
1885 SOSMessageWithExtensions(message
, true, ^(CFDataRef oid
, bool isCritical
, CFDataRef extension
, bool *stop
) {
1886 // OMFG a Critical extension what shall I do!
1887 ok
= SOSErrorCreate(kSOSErrorNotReady
, error
, NULL
, CFSTR("Unknown criticial extension in peer message"));
1890 require_quiet(ok
, exit
);
1892 // Merge Objects from the message into our DataSource.
1893 // Should we move the transaction to the SOSAccount level?
1894 // TODO: Filter incoming objects
1895 //if (!SOSDataSourceForEachObjectInViewSet(engine->dataSource, pendingObjects, SOSPeerGetViewNameSet(peer), error, ^void(CFDataRef key, SOSObjectRef object, bool *stop) {
1896 require_quiet(ok
&= SOSMessageWithSOSObjects(message
, engine
->dataSource
, error
, ^(SOSObjectRef peersObject
, bool *stop
) {
1897 CFDataRef digest
= SOSObjectCopyDigest(engine
->dataSource
, peersObject
, error
);
1901 secerror("%@ peer sent bad object: %@, rolling back changes", SOSPeerGetID(peer
), error
? *error
: NULL
);
1904 SOSDigestVectorAppend(&receivedObjects
, CFDataGetBytePtr(digest
));
1905 SOSObjectRef mergedObject
= NULL
;
1906 SOSMergeResult mr
= SOSDataSourceMergeObject(engine
->dataSource
, txn
, peersObject
, &mergedObject
, error
);
1907 // TODO: If the mr is kSOSMergeLocalObject most of the time (or all of the time),
1908 // consider asking the peer to stop sending us objects, and send it objects instead.
1909 ok
&= (mr
!= kSOSMergeFailure
);
1913 // TODO: Might want to change to warning since the race of us locking after ckd sends us a message could cause db locked errors here.
1914 secerror("%@ SOSDataSourceMergeObject failed %@ rolling back changes", SOSPeerGetID(peer
), error
? *error
: NULL
);
1915 } else if (mr
==kSOSMergePeersObject
|| mr
==kSOSMergeCreatedObject
) {
1916 *somethingChanged
= true;
1918 // mr == kSOSMergeLocalObject
1919 if (!CFEqual(mergedObject
, peersObject
)) {
1920 // Record this object as something we don't want peer to ever send us again. By adding it to
1921 // unwantedObjects we'll falsely claim to peer we have it until they tell us they don't have it anymore.
1922 SOSDigestVectorAppend(&unwantedObjects
, CFDataGetBytePtr(digest
));
1924 // Ensure localObject is in local manifest (possible corruption) by posting an update when we are done.
1925 SOSChangesAppendAdd(changes
, mergedObject
);
1928 if (ok
&& hadBeenInSyncAtStart
) {
1929 ReportItemSyncTime(engine
->dataSource
,
1930 mr
== kSOSMergeLocalObject
,
1934 CFReleaseSafe(mergedObject
);
1935 CFReleaseSafe(digest
);
1937 struct SOSDigestVector dvunion
= SOSDigestVectorInit
;
1938 SOSDigestVectorSort(&receivedObjects
);
1939 SOSDigestVectorUnionSorted(SOSManifestGetDigestVector(SOSMessageGetAdditions(message
)), &receivedObjects
, &dvunion
);
1940 allAdditions
= SOSManifestCreateWithDigestVector(&dvunion
, error
);
1941 SOSDigestVectorFree(&receivedObjects
);
1942 SOSDigestVectorFree(&dvunion
);
1944 unwanted
= SOSManifestCreateWithDigestVector(&unwantedObjects
, error
);
1945 SOSDigestVectorFree(&unwantedObjects
);
1947 if (CFArrayGetCount(changes
)) {
1948 // NOTE: This is always notifiying of all additions that end up choosing local, which should be rare, since we shouldn't
1949 // be receiving objects we already have. When we do we tell ourselves to add them all again so our views will properly
1950 // reflect that we actually have these objects if we didn't already.
1952 // Ensure any objects that we received and have locally already are actually in our local manifest
1953 SOSEngineUpdateChanges_locked(engine
, txn
, kSOSDataSourceTransactionDidCommit
, kSOSDataSourceSOSTransaction
, changes
, error
);
1955 CFReleaseSafe(changes
);
1957 // ---- Don't use local or peer manifests from above this line,
1958 // ---- since commiting the SOSDataSourceWith transaction might change them ---
1960 // Take a snapshot of our dataSource's local manifest.
1961 require_quiet(ok
= localManifest
= SOSEngineCopyLocalPeerManifest_locked(engine
, peer
, error
), exit
);
1963 CFDataRef baseDigest
= SOSMessageGetBaseDigest(message
);
1964 CFDataRef proposedDigest
= SOSMessageGetProposedDigest(message
);
1967 // I believe this is no longer needed now that we have eliminated extra,
1968 // since this is handled below once we get a confirmed manifest from our
1971 // If we just received a L00 reset pendingObjects to localManifest
1972 if (!baseDigest
&& !proposedDigest
) {
1973 // TODO: This is definitely busted for v0 peers since v0 peers always send a
1974 // L00 (ManifestDigestMessage as an ack) whereas in v2 this is a protocol restart
1975 // However if we can still find a confirmed manifest below we probably
1976 // don't want to do this even for v2.
1977 // Also I don't think we will ever send a ManifestMessage right now in
1978 // response to a ManifestDigest
1979 SOSPeerSetPendingObjects(peer
, localManifest
);
1980 secnoticeq("engine", "%@:%@ SOSPeerSetPendingObjects: %@", engine
->myID
, peerID
, localManifest
);
1984 base
= SOSPeerCopyManifestForDigest(peer
, baseDigest
);
1986 // Note that the sender digest will only exist if we receive a SOSManifestDigestMessageType (since we never receive v2 messages)
1987 confirmed
= SOSPeerCopyManifestForDigest(peer
, SOSMessageGetSenderDigest(message
));
1989 if (SOSManifestGetCount(SOSMessageGetRemovals(message
)) || SOSManifestGetCount(allAdditions
)) {
1990 if (base
|| !baseDigest
) {
1992 secnotice("engine", "SOSEngineHandleMessage_locked (%@): creating a confirmed manifest via a patch (base %zu %@, +%zu, -%zu)", SOSPeerGetID(peer
),
1993 SOSManifestGetCount(base
), SOSManifestGetDigest(base
, NULL
),
1994 SOSManifestGetCount(allAdditions
), SOSManifestGetCount(SOSMessageGetRemovals(message
)));
1996 confirmed
= SOSManifestCreateWithPatch(base
, SOSMessageGetRemovals(message
), allAdditions
, error
);
1999 confirmedRemovals
= CFRetainSafe(SOSMessageGetRemovals(message
));
2000 confirmedAdditions
= CFRetainSafe(allAdditions
);
2002 } else if (baseDigest
) {
2003 confirmed
= CFRetainSafe(base
);
2004 secerror("%@:%@ Protocol error send L00 - figure out later base: %@", engine
->myID
, peerID
, base
);
2008 secnotice("engine", "SOSEngineHandleMessage_locked (%@): got a confirmed manifest by digest: (%zu, %@)", SOSPeerGetID(peer
), SOSManifestGetCount(confirmed
), SOSMessageGetSenderDigest(message
));
2010 secnoticeq("engine", "%@:%@ confirmed: %@ base: %@", engine
->myID
, peerID
, confirmed
, base
);
2012 ok
&= SOSManifestDiff(SOSPeerGetConfirmedManifest(peer
), confirmed
, &confirmedRemovals
, &confirmedAdditions
, error
);
2013 if (SOSManifestGetCount(SOSMessageGetRemovals(message
)))
2014 CFAssignRetained(confirmedRemovals
, SOSManifestCreateUnion(confirmedRemovals
, SOSMessageGetRemovals(message
), error
));
2016 if (SOSManifestGetCount(confirmedRemovals
) || SOSManifestGetCount(confirmedAdditions
) || SOSManifestGetCount(unwanted
)) {
2017 ok
&= SOSPeerDidReceiveRemovalsAndAdditions(peer
, confirmedRemovals
, confirmedAdditions
, unwanted
, localManifest
, error
);
2021 // TODO: We should probably remove the if below and always call SOSPeerSetConfirmedManifest,
2022 // since having a NULL confirmed will force us to send a manifest message to get in sync again.
2025 SOSManifestRef previousConfirmedManifest
= SOSPeerGetConfirmedManifest(peer
);
2026 if(previousConfirmedManifest
) {
2027 secnotice("engine", "SOSEngineHandleMessage_locked (%@): new confirmed manifest (%zu, %@) will replace existing confirmed manifest (%zu, %@)", SOSPeerGetID(peer
),
2028 SOSManifestGetCount(confirmed
), SOSManifestGetDigest(confirmed
, NULL
),
2029 SOSManifestGetCount(previousConfirmedManifest
), SOSManifestGetDigest(previousConfirmedManifest
, NULL
));
2031 secnotice("engine", "SOSEngineHandleMessage_locked (%@): new confirmed manifest (%zu, %@) is first manifest for peer", SOSPeerGetID(peer
),
2032 SOSManifestGetCount(confirmed
), SOSManifestGetDigest(confirmed
, NULL
));
2035 SOSPeerSetConfirmedManifest(peer
, confirmed
);
2036 } else if (SOSPeerGetConfirmedManifest(peer
)) {
2037 secnoticeq("engine", "%@:%@ unable to find confirmed in %@, sync protocol reset", engine
->myID
, peer
, message
);
2039 SOSPeerSetConfirmedManifest(peer
, NULL
);
2040 //SOSPeerSetSendObjects(peer, true);
2043 // ---- SendObjects and extra->pendingObjects promotion dance ----
2045 // The first block of code below sets peer.sendObjects to true when we receive a L00 and the second block
2046 // moves extra to pendingObjects once we receive a confirmed manifest in or after the L00.
2047 if (!baseDigest
&& !proposedDigest
) {
2048 SOSPeerSetSendObjects(peer
, true);
2051 if (0 /* confirmed && SOSPeerSendObjects(peer) */) {
2052 SOSManifestRef allExtra
= NULL
;
2053 ok
&= SOSManifestDiff(confirmed
, localManifest
, NULL
, &allExtra
, error
);
2054 secnoticeq("engine", "%@:%@ confirmed %@ (re)setting O:%@", engine
->myID
, SOSPeerGetID(peer
), confirmed
, allExtra
);
2055 SOSPeerSetPendingObjects(peer
, allExtra
);
2056 CFReleaseSafe(allExtra
);
2060 secnotice("engine", "recv %@:%@ %@", engine
->myID
, SOSPeerGetID(peer
), message
);
2061 secnotice("peer", "recv %@ -> %@", peerDesc
, peer
);
2063 CFReleaseNull(base
);
2064 CFReleaseSafe(confirmed
);
2065 CFReleaseSafe(localManifest
);
2066 CFReleaseSafe(peerDesc
);
2067 CFReleaseSafe(allAdditions
);
2068 CFReleaseSafe(unwanted
);
2069 CFReleaseSafe(confirmedRemovals
);
2070 CFReleaseSafe(confirmedAdditions
);
2071 CFReleaseSafe(peer
);
2075 static CFDataRef
SOSEngineCopyObjectDER(SOSEngineRef engine
, SOSObjectRef object
, CFErrorRef
*error
) {
2076 CFDataRef der
= NULL
;
2077 CFDictionaryRef plist
= SOSObjectCopyPropertyList(engine
->dataSource
, object
, error
);
2079 der
= CFPropertyListCreateDERData(kCFAllocatorDefault
, plist
, error
);
2088 +-----------------------------+_
2092 _+=============================+ } L
2096 / +==============================
2099 \ | M +------------|
2103 \_+-------------+---------------+
2115 static bool SOSAppendRemoveToPatch(CFTypeRef remove
, CFMutableDictionaryRef patch
, CFErrorRef
*error
) {
2118 static bool SOSAppendAddToPatch(CFTypeRef add
, CFMutableDictionaryRef patch
, CFErrorRef
*error
) {
2121 static bool SOSAppendDiffToPatch(CFTypeRef left
, CFTypeRef right
, CFMutableDictionaryRef patch
, CFErrorRef
*error
) {
2123 if (!left
&& right
) {
2124 SOSAppendAddToPatch(right
, patch
, error
);
2125 } else if (left
&& !right
) {
2126 SOSAppendRemoveToPatch(left
, patch
, error
);
2127 } else if (left
&& right
) {
2128 CFTypeID ltype
= CFGetTypeID(left
);
2129 CFTypeID rtype
= CFGetTypeID(right
);
2130 if (ltype
== rtype
) {
2131 if (CFArrayGetTypeID() == ltype
) {
2132 ok
= SecError(errSecParam
, error
, CFSTR("unsupported type array"), ltype
);
2133 } else if (CFBooleanGetTypeID
== ltype
) {
2134 ok
= SecError(errSecParam
, error
, CFSTR("unsupported type boolean"), ltype
);
2135 } else if (CFDataGetTypeID
== ltype
) {
2136 ok
= SecError(errSecParam
, error
, CFSTR("unsupported type data"), ltype
);
2137 } else if (CFDictionaryGetTypeID
== ltype
) {
2138 __block CFMutableDictionaryRef leftnotright
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
2139 __block CFMutableDictionaryRef rightnotleft
= CFDictionaryCreateMutableCopy(kCFAllocatorDefault
, 0, right
);
2141 CFDictionaryForEach(left
, ^(const void *key
, const void *lvalue
) {
2142 const void *rvalue
= NULL
;
2143 if (CFDictionaryGetValueIfPresent(right
, key
, &rvalue
)) {
2144 CFDictionaryRemoveValue(rightnotleft
, key
);
2146 CFMutableDictionaryRef subpatch
= CFDictionaryCreateForCFTypes(kCFAllocatorDefault
);
2147 CFDictionaryAddValue(patch
, key
, subpatch
);
2148 SOSAppendDiffToPatch(lvalue
, rvalue
, subpatch
, error
);
2149 CFReleaseSafe(subpatch
);
2151 CFDictionaryAddValue(leftnotright
, key
, lvalue
);
2154 // Proccess leftnotright and rightnotleft
2155 CFReleaseSafe(leftnotright
);
2156 CFReleaseSafe(rightnotleft
);
2157 } else if (SOSManifestGetTypeID
== ltype
) {
2158 SOSManifestRef removed
= NULL
, added
= NULL
;
2159 ok
&= SOSManifestDiff(left
, right
, &removed
, &added
, error
);
2160 if (SOSManifestGetCount(removed
) || SOSManifestGetCount(added
)) {
2161 SOSAppendDiffToPatch(lvalue
, rvalue
, subpatch
, error
);
2162 CFStringAppend(, <#CFStringRef appendedString#>)
2164 CFReleaseSafe(removed
);
2165 CFReleaseSafe(added
);
2166 } else if (CFNumberGetTypeID
== ltype
) {
2167 ok
= SecError(errSecParam
, error
, CFSTR("unsupported type number"), ltype
);
2168 } else if (CFSetGetTypeID
== ltype
) {
2169 ok
= SecError(errSecParam
, error
, CFSTR("unsupported type set"), ltype
);
2170 } else if (CFStringGetTypeID
== ltype
) {
2171 ok
= SecError(errSecParam
, error
, CFSTR("unsupported type string"), ltype
);
2173 ok
= SecError(errSecParam
, error
, CFSTR("unknown type %lu"), ltype
);
2176 } else if (!left
&& !right
) {
2182 static __unused
bool SOSEngineCheckPeerIntegrity(SOSEngineRef engine
, SOSPeerRef peer
, CFErrorRef
*error
) {
2184 //static CFMutableDictionaryRef p2amtu;
2185 if (!engine
->p2amtu
)
2186 engine
->p2amtu
= CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault
);
2187 CFDictionaryRef amtu
= CFDictionaryGetValue(engine
->p2amtu
, SOSPeerGetID(peer
));
2191 SOSManifestRef L
= SOSEngineCopyLocalPeerManifest_locked(engine
, peer
, error
);
2192 SOSManifestRef T
= SOSPeerGetPendingObjects(peer
);
2193 SOSManifestRef C
= SOSPeerGetConfirmedManifest(peer
);
2194 SOSManifestRef U
= SOSPeerGetUnwantedManifest(peer
);
2197 SOSManifestRef CunionU
= SOSManifestCreateUnion(C
, U
, error
);
2198 SOSManifestRef S
= SOSManifestCreateIntersection(L
, CunionU
, error
);
2200 SOSManifestRef AunionT
= NULL
, MunionU
= NULL
;
2201 SOSManifestDiff(L
, C
, &AunionT
, &MunionU
, error
);
2203 SOSManifestRef A
= SOSManifestCreateComplement(T
, AunionT
, error
);
2204 SOSManifestRef M
= SOSManifestCreateComplement(U
, MunionU
, error
);
2206 SOSManifestRef SunionAunionT
= SOSManifestCreateUnion(S
, AunionT
, error
);
2207 SOSManifestRef SunionMunionU
= SOSManifestCreateUnion(S
, MunionU
, error
);
2209 SOSManifestRef AintersectM
= SOSManifestCreateIntersection(A
, M
, error
);
2210 SOSManifestRef AintersectS
= SOSManifestCreateIntersection(A
, S
, error
);
2211 SOSManifestRef AintersectT
= SOSManifestCreateIntersection(A
, T
, error
);
2212 SOSManifestRef AintersectU
= SOSManifestCreateIntersection(A
, U
, error
);
2213 SOSManifestRef MintersectS
= SOSManifestCreateIntersection(M
, S
, error
);
2214 SOSManifestRef MintersectT
= SOSManifestCreateIntersection(M
, T
, error
);
2215 SOSManifestRef MintersectU
= SOSManifestCreateIntersection(M
, U
, error
);
2216 SOSManifestRef SintersectT
= SOSManifestCreateIntersection(S
, T
, error
);
2217 SOSManifestRef SintersectU
= SOSManifestCreateIntersection(S
, U
, error
);
2218 SOSManifestRef TintersectU
= SOSManifestCreateIntersection(T
, U
, error
);
2221 CFDictionaryRef newAmtu
= CFDictionaryCreateForCFTypes(kCFAllocatorDefault
, CFSTR("A"), A
, CFSTR("M"), M
, CFSTR("T"), T
, CFSTR("U") U
, NULL
);
2222 CFDictionarySetValue(engine
->p2amtu
, SOSPeerGetID(peer
), newAmtu
);
2223 CFMutableStringRef amtuChanges
= CFStringCreateMutable(kCFAllocatorDefault
, 0);
2224 SOSAppendDiffToString(amtu
, newAmtu
, amtuChanges
);
2225 secnotice("engine", "%@: %@", SOSPeerGetID(peer
), amtuChanges
);
2228 #define SOSASSERT(e) (__builtin_expect(!(e), 0) ? secnotice("engine", "state-assertion %s", #e), assert(e) : (void)0)
2230 SOSASSERT(L
? CFEqual(L
, SunionAunionT
) : SOSManifestGetCount(SunionAunionT
) == 0);
2231 SOSASSERT(C
? CFEqual(C
, SunionMunionU
) : SOSManifestGetCount(SunionMunionU
) == 0);
2233 SOSASSERT(SOSManifestGetCount(AintersectM
) == 0);
2234 SOSASSERT(SOSManifestGetCount(AintersectS
) == 0);
2235 SOSASSERT(SOSManifestGetCount(AintersectT
) == 0);
2236 SOSASSERT(SOSManifestGetCount(AintersectU
) == 0);
2237 SOSASSERT(SOSManifestGetCount(MintersectS
) == 0);
2238 SOSASSERT(SOSManifestGetCount(MintersectT
) == 0);
2239 SOSASSERT(SOSManifestGetCount(MintersectU
) == 0);
2240 SOSASSERT(SOSManifestGetCount(SintersectT
) == 0);
2241 SOSASSERT(SOSManifestGetCount(SintersectU
) == 0);
2242 SOSASSERT(SOSManifestGetCount(TintersectU
) == 0);
2244 CFReleaseSafe(AintersectM
);
2245 CFReleaseSafe(AintersectS
);
2246 CFReleaseSafe(AintersectT
);
2247 CFReleaseSafe(AintersectU
);
2248 CFReleaseSafe(MintersectS
);
2249 CFReleaseSafe(MintersectT
);
2250 CFReleaseSafe(MintersectU
);
2251 CFReleaseSafe(SintersectT
);
2252 CFReleaseSafe(SintersectU
);
2253 CFReleaseSafe(TintersectU
);
2255 CFReleaseSafe(AunionT
);
2256 CFReleaseSafe(MunionU
);
2257 CFReleaseSafe(CunionU
);
2259 CFReleaseNull(SunionAunionT
);
2260 CFReleaseNull(SunionMunionU
);
2265 //CFReleaseSafe(T); // Get
2266 //CFReleaseSafe(U); // Get
2267 //CFReleaseSafe(C); // Get
2272 void SOSEngineSetSyncCompleteListener(SOSEngineRef engine
, SOSEnginePeerInSyncBlock notify_block
) {
2273 SOSEngineDoOnQueue(engine
, ^{
2274 CFAssignRetained(engine
->syncCompleteListener
, Block_copy(notify_block
));
2278 void SOSEngineSetSyncCompleteListenerQueue(SOSEngineRef engine
, dispatch_queue_t notify_queue
) {
2279 SOSEngineDoOnQueue(engine
, ^{
2280 CFRetainAssign(engine
->syncCompleteQueue
, notify_queue
);
2284 static void SOSEngineCompletedSyncWithPeer(SOSEngineRef engine
, SOSPeerRef peer
) {
2285 SOSEnginePeerInSyncBlock block_to_call
= engine
->syncCompleteListener
;
2287 if (block_to_call
&& engine
->syncCompleteQueue
) {
2288 CFStringRef ID
= CFRetainSafe(SOSPeerGetID(peer
));
2289 CFSetRef views
= CFRetainSafe(SOSPeerGetViewNameSet(peer
));
2290 CFRetainSafe(block_to_call
);
2292 dispatch_async(engine
->syncCompleteQueue
, ^{
2293 block_to_call(ID
, views
);
2295 CFReleaseSafe(views
);
2296 CFReleaseSafe(block_to_call
);
2300 SOSPeerSetHasBeenInSync(peer
, true);
2304 CFDataRef
SOSEngineCreateMessage_locked(SOSEngineRef engine
, SOSTransactionRef txn
, SOSPeerRef peer
,
2305 CFMutableArrayRef
*attributeList
, CFErrorRef
*error
, SOSEnginePeerMessageSentCallback
**sent
) {
2306 SOSManifestRef local
= SOSEngineCopyLocalPeerManifest_locked(engine
, peer
, error
);
2307 __block SOSMessageRef message
= SOSMessageCreate(kCFAllocatorDefault
, SOSPeerGetMessageVersion(peer
), error
);
2308 SOSManifestRef confirmed
= SOSPeerGetConfirmedManifest(peer
);
2309 SOSManifestRef pendingObjects
= SOSPeerGetPendingObjects(peer
);
2310 SOSManifestRef objectsSent
= NULL
;
2311 SOSManifestRef proposed
= NULL
;
2312 SOSManifestRef allMissing
= NULL
;
2313 SOSManifestRef allExtra
= NULL
;
2314 SOSManifestRef extra
= NULL
;
2315 SOSManifestRef excessPending
= NULL
;
2316 SOSManifestRef missing
= NULL
;
2317 SOSManifestRef unwanted
= SOSPeerGetUnwantedManifest(peer
);
2318 SOSManifestRef excessUnwanted
= NULL
;
2319 CFDataRef result
= NULL
;
2321 // Given (C, L, T, U) compute (T, U, M, A)
2325 // U \ (C \ L) => EU
2326 // T \ (L \ C) => ET
2327 // And assert that both EU and ET are empty and if not remove them from U and T respectively
2328 SOSManifestDiff(confirmed
, local
, &allMissing
, &allExtra
, error
);
2329 SOSManifestDiff(allExtra
, pendingObjects
, &extra
, &excessPending
, error
);
2330 if (SOSManifestGetCount(excessPending
)) {
2331 // T \ (L \ C) => excessPending (items both in L and C or in neither that are still pending)
2332 // Can only happen if a member of T was removed from L without us having a chance to update T
2333 secerror("%@ ASSERTION FAILURE purging excess pendingObjects: %@", peer
, excessPending
);
2334 SOSManifestRef newPendingObjects
= SOSManifestCreateComplement(excessPending
, pendingObjects
, error
);
2335 SOSPeerSetPendingObjects(peer
, newPendingObjects
);
2336 CFReleaseSafe(newPendingObjects
);
2337 pendingObjects
= SOSPeerGetPendingObjects(peer
);
2339 SOSManifestDiff(allMissing
, unwanted
, &missing
, &excessUnwanted
, error
);
2340 if (SOSManifestGetCount(excessUnwanted
)) {
2341 // U \ (C \ L) => excessUnwanted (items both in L and C or in neither that are still unwanted)
2342 // Can only happen if a member of U was added to L without us having a chance to update U.
2343 // Since U only contains items the conflict resolver rejected, this implies L somehow got rolled back
2344 // The other option (and more likely) is a member of U was removed from C and not from U.
2345 secerror("%@ ASSERTION FAILURE purging excess unwanted: %@", peer
, excessUnwanted
);
2346 SOSManifestRef newUnwanted
= SOSManifestCreateComplement(excessUnwanted
, unwanted
, error
);
2347 SOSPeerSetUnwantedManifest(peer
, newUnwanted
);
2348 CFReleaseSafe(newUnwanted
);
2349 unwanted
= SOSPeerGetUnwantedManifest(peer
);
2352 CFReleaseNull(allExtra
);
2353 CFReleaseNull(excessPending
);
2354 CFReleaseNull(allMissing
);
2355 CFReleaseNull(excessUnwanted
);
2357 secnoticeq("engine", "%@:%@: send state for peer [%s%s%s][%s%s] local:%zu confirmed:%zu pending:%zu, extra:%zu, missing:%zu unwanted:%zu", engine
->myID
, SOSPeerGetID(peer
),
2359 confirmed
? "C":"0",
2360 pendingObjects
? "P":"0",
2361 SOSPeerSendObjects(peer
) ? "O":"o",
2362 SOSPeerMustSendMessage(peer
) ? "S":"s",
2363 SOSManifestGetCount(local
),
2364 SOSManifestGetCount(confirmed
),
2365 SOSManifestGetCount(pendingObjects
),
2366 SOSManifestGetCount(extra
),
2367 SOSManifestGetCount(missing
),
2368 SOSManifestGetCount(unwanted
)
2372 // TODO: Because of not letting things terminate while we have extra left
2373 // we might send objects when we didn't need to, but there is always an
2374 // extra roundtrip required for objects that we assume the other peer
2375 // should have already.
2376 // TODO: If there are extra objects left, calling this function is not
2377 // idempotent we should check if pending is what we are about to send and not send anything in this case.
2378 if (SOSManifestGetCount(pendingObjects
) == 0 && SOSManifestGetCount(extra
) == 0)
2379 SOSPeerSetSendObjects(peer
, false);
2381 // If we aren't missing anything, we've gotten all their data, so we're sync even if they haven't seen ours.
2382 if (missing
&& SOSManifestGetCount(missing
) == 0) {
2383 SOSEngineCompletedSyncWithPeer(engine
, peer
);
2386 if (CFEqualSafe(local
, SOSPeerGetProposedManifest(peer
)) && !SOSPeerMustSendMessage(peer
)) {
2388 if (CFEqual(confirmed
, local
)) {
2389 secnoticeq("engine", "synced <No MSG> %@:%@", engine
->myID
, peer
);
2390 } else if (SOSManifestGetCount(pendingObjects
) == 0 /* TODO: No entries moved from extra to pendingObjects. */
2391 && SOSManifestGetCount(missing
) == 0) {
2392 secnoticeq("engine", "waiting <MSG not resent> %@:%@ extra: %@", engine
->myID
, peer
, extra
);
2397 CFReleaseNull(local
);
2398 CFReleaseNull(message
);
2399 CFReleaseNull(extra
);
2400 CFReleaseNull(missing
);
2401 return CFDataCreate(kCFAllocatorDefault
, NULL
, 0);
2405 if (SOSManifestGetCount(pendingObjects
)) {
2406 // If we have additions and we need to send objects, do so.
2407 __block
size_t objectsSize
= 0;
2408 __block
struct SOSDigestVector dv
= SOSDigestVectorInit
;
2409 CFMutableArrayRef changes
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
2410 __block CFErrorRef dsfeError
= NULL
;
2412 if (!SOSDataSourceForEachObject(engine
->dataSource
, txn
, pendingObjects
, &dsfeError
, ^void(CFDataRef key
, SOSObjectRef object
, bool *stop
) {
2413 CFErrorRef localError
= NULL
;
2414 CFDataRef digest
= NULL
;
2415 CFDataRef der
= NULL
;
2416 #if !defined(NDEBUG)
2417 const uint8_t *d
= CFDataGetBytePtr(key
);
2419 secdebug("engine", "%@:%@ object %02X%02X%02X%02X error from SOSDataSourceForEachObject: %@",
2420 engine
->myID
, SOSPeerGetID(peer
), d
[0], d
[1], d
[2], d
[3], dsfeError
);
2422 const uint8_t *d
= CFDataGetBytePtr(key
);
2423 secerror("%@:%@ object %02X%02X%02X%02X dropping from manifest: not found in datasource: %@",
2424 engine
->myID
, SOSPeerGetID(peer
), d
[0], d
[1], d
[2], d
[3], dsfeError
);
2425 SOSChangesAppendDelete(changes
, key
);
2426 } else if (!(der
= SOSEngineCopyObjectDER(engine
, object
, &localError
))
2427 || !(digest
= SOSObjectCopyDigest(engine
->dataSource
, object
, &localError
))) {
2428 if (SecErrorGetOSStatus(localError
) == errSecDecode
) {
2429 // Decode error, we need to drop these objects from our manifests
2430 const uint8_t *d
= CFDataGetBytePtr(key
);
2431 secnoticeq("engine", "%@:%@ object %02X%02X%02X%02X dropping from manifest: %@",
2432 engine
->myID
, SOSPeerGetID(peer
), d
[0], d
[1], d
[2], d
[3], localError
);
2433 SOSChangesAppendDelete(changes
, key
);
2434 CFRelease(localError
);
2436 // Stop iterating and propagate out all other errors.
2437 const uint8_t *d
= CFDataGetBytePtr(key
);
2438 secnoticeq("engine", "%@:%@ object %02X%02X%02X%02X in SOSDataSourceForEachObject: %@",
2439 engine
->myID
, SOSPeerGetID(peer
), d
[0], d
[1], d
[2], d
[3], localError
);
2441 CFErrorPropagate(localError
, error
);
2442 CFReleaseNull(message
);
2445 if (!CFEqual(key
, digest
)) {
2446 const uint8_t *d
= CFDataGetBytePtr(key
);
2447 const uint8_t *e
= CFDataGetBytePtr(digest
);
2448 secnoticeq("engine", "%@:%@ object %02X%02X%02X%02X is really %02X%02X%02X%02X dropping from local manifest",
2449 engine
->myID
, SOSPeerGetID(peer
), d
[0], d
[1], d
[2], d
[3], e
[0], e
[1], e
[2], e
[3]);
2450 SOSChangesAppendDelete(changes
, key
);
2451 SOSChangesAppendAdd(changes
, object
); // This is new behaviour but we think it's more correct
2454 size_t objectLen
= (size_t)CFDataGetLength(der
);
2455 if (SOSMessageAppendObject(message
, der
, &localError
)) {
2456 SOSDigestVectorAppend(&dv
, CFDataGetBytePtr(digest
));
2458 *attributeList
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
2459 CFDictionaryRef itemPlist
= SOSObjectCopyPropertyList(engine
->dataSource
, object
, &localError
);
2460 if(itemPlist
&& !CFArrayContainsValue(*attributeList
, CFRangeMake(0, CFArrayGetCount(*attributeList
)), (CFStringRef
)CFDictionaryGetValue(itemPlist
, kSecAttrAccessGroup
))){
2461 CFArrayAppendValue(*attributeList
, (CFStringRef
)CFDictionaryGetValue(itemPlist
, kSecAttrAccessGroup
));
2462 }//copy access group to array
2463 CFReleaseNull(itemPlist
);
2465 const uint8_t *d
= CFDataGetBytePtr(digest
);
2466 CFStringRef hexder
= CFDataCopyHexString(der
);
2467 secnoticeq("engine", "%@:%@ object %02X%02X%02X%02X der: %@ dropping from manifest: %@",
2468 engine
->myID
, SOSPeerGetID(peer
), d
[0], d
[1], d
[2], d
[3], hexder
, localError
);
2469 CFReleaseNull(hexder
);
2470 CFReleaseNull(message
);
2471 // Since we can't send these objects let's assume they are bad too?
2472 SOSChangesAppendDelete(changes
, digest
);
2475 objectsSize
+= objectLen
;
2476 if (objectsSize
> kSOSMessageMaxObjectsSize
)
2479 CFErrorPropagate(dsfeError
, error
); // this also releases dsfeError
2482 CFReleaseSafe(digest
);
2484 CFReleaseNull(message
);
2487 objectsSent
= SOSManifestCreateWithDigestVector(&dv
, error
);
2489 if (CFArrayGetCount(changes
)) {
2490 CFErrorRef localError
= NULL
;
2491 if (!SOSEngineUpdateChanges_locked(engine
, NULL
, kSOSDataSourceTransactionDidCommit
, kSOSDataSourceSOSTransaction
, changes
, &localError
))
2492 secerror("SOSEngineUpdateChanges_locked: %@ failed: %@", changes
, localError
);
2493 CFReleaseSafe(localError
);
2494 CFAssignRetained(local
, SOSEngineCopyLocalPeerManifest_locked(engine
, peer
, error
));
2496 CFReleaseSafe(changes
);
2497 SOSDigestVectorFree(&dv
);
2498 CFReleaseNull(dsfeError
);
2501 // If we have no confirmed manifest, we want all pendedObjects going out as a manifest
2502 objectsSent
= CFRetainSafe(pendingObjects
);
2505 if (confirmed
|| SOSManifestGetCount(missing
) || SOSManifestGetCount(extra
) || objectsSent
) {
2506 SOSManifestRef allExtra
= SOSManifestCreateUnion(extra
, objectsSent
, error
);
2507 proposed
= SOSManifestCreateWithPatch(confirmed
, missing
, allExtra
, error
);
2508 CFReleaseNull(allExtra
);
2511 SOSManifestRef sender
= local
;
2512 // We actually send the remote peer its own digest.
2513 // Note that both pendingObjects and unwanted may have been changed, so we get them again
2514 if (SOSManifestGetCount(SOSPeerGetPendingObjects(peer
))==0 && SOSManifestGetCount(extra
)==0 &&
2515 SOSManifestGetCount(missing
)==0 && SOSManifestGetCount(SOSPeerGetUnwantedManifest(peer
))!=0) {
2516 secnoticeq("engine", "%@:%@: only have differences in unwanted set; lying to peer to stop sync",engine
->myID
, SOSPeerGetID(peer
));
2520 if (!SOSMessageSetManifests(message
, sender
, confirmed
, proposed
, proposed
, confirmed
? objectsSent
: NULL
, error
)) {
2521 secnoticeq("engine", "%@:%@: failed to set message manifests",engine
->myID
, SOSPeerGetID(peer
));
2522 CFReleaseNull(message
);
2525 CFReleaseNull(objectsSent
);
2528 result
= SOSMessageCreateData(message
, SOSPeerNextSequenceNumber(peer
), error
);
2532 SOSEnginePeerMessageSentCallback
* pmsc
= malloc(sizeof(SOSEnginePeerMessageSentCallback
));
2533 memset(pmsc
, 0, sizeof(SOSEnginePeerMessageSentCallback
));
2534 pmsc
->engine
= engine
; CFRetain(pmsc
->engine
);
2535 pmsc
->peer
= CFRetainSafe(peer
);
2536 pmsc
->local
= CFRetainSafe(local
);
2537 pmsc
->proposed
= CFRetainSafe(proposed
);
2538 pmsc
->message
= CFRetainSafe(message
);
2539 pmsc
->confirmed
= CFRetainSafe(confirmed
);
2541 SOSEngineMessageCallbackSetCallback(pmsc
, ^(bool success
) {
2542 // Have to copy pmsc so it'll still be around during the dispatch_async
2543 SOSEnginePeerMessageSentCallback
* pmsc2
= malloc(sizeof(SOSEnginePeerMessageSentCallback
));
2544 memset(pmsc2
, 0, sizeof(SOSEnginePeerMessageSentCallback
));
2545 pmsc2
->engine
= pmsc
->engine
; CFRetain(pmsc2
->engine
);
2546 pmsc2
->peer
= CFRetainSafe(pmsc
->peer
);
2547 pmsc2
->local
= CFRetainSafe(pmsc
->local
);
2548 pmsc2
->proposed
= CFRetainSafe(pmsc
->proposed
);
2549 pmsc2
->message
= CFRetainSafe(pmsc
->message
);
2550 pmsc2
->confirmed
= CFRetainSafe(pmsc
->confirmed
);
2552 dispatch_async(pmsc
->engine
->queue
, ^{
2554 SOSPeerSetMustSendMessage(pmsc2
->peer
, false);
2555 if (!pmsc2
->confirmed
&& !pmsc2
->proposed
) {
2556 SOSPeerSetSendObjects(pmsc2
->peer
, true);
2557 secnoticeq("engine", "%@:%@ sendObjects=true L:%@", pmsc2
->engine
->myID
, SOSPeerGetID(pmsc2
->peer
), pmsc2
->local
);
2559 SOSPeerAddLocalManifest(pmsc2
->peer
, pmsc2
->local
);
2560 SOSPeerAddProposedManifest(pmsc2
->peer
, pmsc2
->proposed
);
2561 secnoticeq("engine", "send %@:%@ %@", pmsc2
->engine
->myID
, SOSPeerGetID(pmsc2
->peer
), pmsc2
->message
);
2562 //SOSEngineCheckPeerIntegrity(engine, peer, NULL);
2564 secerror("%@:%@ failed to send %@", pmsc2
->engine
->myID
, SOSPeerGetID(pmsc2
->peer
), pmsc2
->message
);
2566 SOSEngineFreeMessageCallback(pmsc2
);
2573 CFReleaseNull(local
);
2574 CFReleaseNull(extra
);
2575 CFReleaseNull(missing
);
2576 CFReleaseNull(message
);
2577 CFReleaseNull(proposed
);
2578 if (error
&& *error
)
2579 secerror("%@:%@ error in send: %@", engine
->myID
, SOSPeerGetID(peer
), *error
);
2584 void SOSEngineMessageCallbackSetCallback(SOSEnginePeerMessageSentCallback
*sent
, SOSEnginePeerMessageSentBlock block
) {
2586 sent
->block
= Block_copy(block
);
2591 void SOSEngineMessageCallCallback(SOSEnginePeerMessageSentCallback
*sent
, bool ok
) {
2592 if (sent
&& sent
->block
) {
2597 void SOSEngineFreeMessageCallback(SOSEnginePeerMessageSentCallback
* psmc
) {
2599 CFReleaseNull(psmc
->engine
);
2600 CFReleaseNull(psmc
->peer
);
2601 CFReleaseNull(psmc
->coder
);
2602 CFReleaseNull(psmc
->local
);
2603 CFReleaseNull(psmc
->proposed
);
2604 CFReleaseNull(psmc
->message
);
2605 CFReleaseNull(psmc
->confirmed
);
2608 Block_release(psmc
->block
);
2615 static void SOSEngineLogItemError(SOSEngineRef engine
, CFStringRef peerID
, CFDataRef key
, CFDataRef optionalDigest
, const char *where
, CFErrorRef error
) {
2616 if (!optionalDigest
) {
2617 const uint8_t *d
= CFDataGetBytePtr(key
);
2618 secwarning("%@:%@ object %02X%02X%02X%02X %s: %@", engine
->myID
, peerID
, d
[0], d
[1], d
[2], d
[3], where
, error
? (CFTypeRef
)error
: CFSTR(""));
2620 const uint8_t *d
= CFDataGetBytePtr(key
);
2621 const uint8_t *e
= CFDataGetBytePtr(optionalDigest
);
2622 secwarning("%@:%@ object %02X%02X%02X%02X is really %02X%02X%02X%02X dropping from local manifest", engine
->myID
, peerID
, d
[0], d
[1], d
[2], d
[3], e
[0], e
[1], e
[2], e
[3]);
2626 static bool SOSEngineWriteToBackup_locked(SOSEngineRef engine
, SOSPeerRef peer
, bool rewriteComplete
, bool *didWrite
, bool *incomplete
, CFErrorRef
*error
) {
2627 __block
bool ok
= SOSPeerWritePendingReset(peer
, error
);
2628 if (!ok
|| !SOSPeerGetKeyBag(peer
))
2630 __block SOSManifestRef local
= SOSEngineCopyLocalPeerManifest_locked(engine
, peer
, error
);
2631 __block SOSManifestRef proposed
= SOSPeerGetProposedManifest(peer
);
2632 __block
bool notify
= true;
2633 SOSManifestRef pendingObjects
= NULL
;
2634 SOSManifestRef missing
= NULL
;
2635 CFStringRef peerID
= SOSPeerGetID(peer
);
2637 ok
&= SOSManifestDiff(proposed
, local
, &missing
, &pendingObjects
, error
);
2639 secnoticeq("engine", "%@:%@: Send state for peer [%s%s%s] O: %zu, M: %zu", engine
->myID
, peerID
,
2642 pendingObjects
? "O":"0",
2643 SOSManifestGetCount(pendingObjects
),
2644 SOSManifestGetCount(missing
));
2646 if (SOSManifestGetCount(missing
) == 0 && SOSManifestGetCount(pendingObjects
) == 0) {
2647 // proposed == local (faster test than CFEqualSafe above), since we
2648 // already did the SOSManifestDiff
2649 if (rewriteComplete
) {
2652 secnoticeq("engine", "%@:%@ backup still done", engine
->myID
, peer
);
2656 ok
&= SOSPeerAppendToJournal(peer
, error
, ^(FILE *journalFile
, keybag_handle_t kbhandle
) {
2657 SOSManifestRef objectsSent
= NULL
;
2658 __block
struct SOSDigestVector dvdel
= SOSDigestVectorInit
;
2659 __block
struct SOSDigestVector dvadd
= SOSDigestVectorInit
;
2660 SOSManifestForEach(missing
, ^(CFDataRef key
, bool *stop
) {
2661 CFErrorRef localError
= NULL
;
2662 if (ftello(journalFile
) > kSOSBackupMaxFileSize
) {
2663 // Highwatermark hit on file.
2665 } else if (SOSBackupEventWriteDelete(journalFile
, key
, &localError
)) {
2666 SOSDigestVectorAppend(&dvdel
, CFDataGetBytePtr(key
));
2668 SOSEngineLogItemError(engine
, peerID
, key
, NULL
, "in SOSPeerWriteDelete", localError
);
2669 CFErrorPropagate(localError
, error
);
2670 // TODO: Update of missing so proposed is updated properly
2671 *stop
= true; // Disk full?
2675 if (ok
&& SOSManifestGetCount(pendingObjects
)) {
2676 CFMutableArrayRef changes
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
2677 ok
&= SOSDataSourceForEachObject(engine
->dataSource
, NULL
, pendingObjects
, error
, ^void(CFDataRef key
, SOSObjectRef object
, bool *stop
) {
2678 CFErrorRef localError
= NULL
;
2679 CFDataRef digest
= NULL
;
2680 CFDictionaryRef backupItem
= NULL
;
2681 if (ftello(journalFile
) > kSOSBackupMaxFileSize
) {
2682 // Highwatermark hit on file.
2684 } else if (!object
) {
2685 SOSEngineLogItemError(engine
, peerID
, key
, NULL
, "dropping from manifest: not found in datasource", localError
);
2686 SOSChangesAppendDelete(changes
, key
);
2687 } else if (!(backupItem
= SOSObjectCopyBackup(engine
->dataSource
, object
, kbhandle
, &localError
))
2688 || !(digest
= SOSObjectCopyDigest(engine
->dataSource
, object
, &localError
))) {
2689 if (SecErrorGetOSStatus(localError
) == errSecDecode
) {
2690 // Decode error, we need to drop these objects from our manifests
2691 SOSEngineLogItemError(engine
, peerID
, key
, NULL
, "dropping from manifest", localError
);
2692 SOSChangesAppendDelete(changes
, key
);
2693 CFRelease(localError
);
2695 // Stop iterating and propagate out all other errors.
2696 SOSEngineLogItemError(engine
, peerID
, key
, NULL
, "in SOSDataSourceForEachObject", localError
);
2698 CFErrorPropagate(localError
, error
);
2702 if (!CFEqual(key
, digest
)) {
2703 SOSEngineLogItemError(engine
, peerID
, key
, digest
, "", NULL
);
2704 SOSChangesAppendDelete(changes
, key
);
2705 SOSChangesAppendAdd(changes
, object
); // This is new behaviour but we think it's more correct
2708 if (SOSBackupEventWriteAdd(journalFile
, backupItem
, &localError
)) {
2709 SOSDigestVectorAppend(&dvadd
, CFDataGetBytePtr(digest
));
2711 SOSEngineLogItemError(engine
, peerID
, key
, NULL
, "in SOSPeerWriteAdd", localError
);
2712 *stop
= true; // Disk full?
2713 CFErrorPropagate(localError
, error
);
2717 CFReleaseSafe(backupItem
);
2718 CFReleaseSafe(digest
);
2720 if (CFArrayGetCount(changes
)) {
2721 CFErrorRef localError
= NULL
;
2722 if (!SOSEngineUpdateChanges_locked(engine
, NULL
, kSOSDataSourceTransactionDidCommit
, kSOSDataSourceSOSTransaction
, changes
, &localError
))
2723 secerror("SOSEngineUpdateChanges_locked: %@ failed: %@", changes
, localError
);
2724 CFReleaseSafe(localError
);
2725 // Since calling SOSEngineUpdateChanges_locked might cause local to change and might cause the backup peer to update proposed, refetch them here.
2726 CFAssignRetained(local
, SOSEngineCopyLocalPeerManifest_locked(engine
, peer
, error
));
2727 proposed
= SOSPeerGetProposedManifest(peer
);
2729 CFReleaseSafe(changes
);
2732 if (dvadd
.count
|| (proposed
&& dvdel
.count
)) {
2734 SOSManifestRef deleted
= SOSManifestCreateWithDigestVector(&dvdel
, error
);
2735 SOSManifestRef objectsSent
= SOSManifestCreateWithDigestVector(&dvadd
, error
);
2736 SOSManifestRef newProposed
= SOSManifestCreateWithPatch(proposed
, deleted
, objectsSent
, error
);
2737 CFReleaseSafe(deleted
);
2738 CFReleaseSafe(objectsSent
);
2739 SOSPeerSetProposedManifest(peer
, newProposed
);
2740 CFReleaseSafe(newProposed
);
2741 proposed
= SOSPeerGetProposedManifest(peer
);
2743 SOSDigestVectorFree(&dvdel
);
2744 SOSDigestVectorFree(&dvadd
);
2746 // TODO: If proposed is NULL, and local is empty we should still consider ourselves done.
2747 // It so happens this can't happen in practice today since there is at least a backupbag
2748 // in the backup, but this is a bug waiting to rear its head in the future.
2749 if (ok
&& CFEqualSafe(local
, proposed
)) {
2750 CFErrorRef localError
= NULL
;
2751 if (SOSBackupEventWriteCompleteMarker(journalFile
, 899, &localError
)) {
2752 SOSPeerSetSendObjects(peer
, true);
2754 secnoticeq("backup", "%@:%@ backup done%s", engine
->myID
, peerID
, notify
? " notifying sbd" : "");
2755 // TODO: Now switch to changes based writing to backup sync.
2756 // Currently we leave changes enabled but we probably shouldn't
2758 secwarning("%@:%@ in SOSBackupPeerWriteCompleteMarker: %@", engine
->myID
, peerID
, localError
);
2761 CFErrorPropagate(localError
, error
);
2764 secnoticeq("backup", "%@:%@ backup incomplete [%zu/%zu]%s", engine
->myID
, peerID
, SOSManifestGetCount(local
), SOSManifestGetCount(proposed
), notify
? " notifying sbd" : "");
2767 CFReleaseNull(objectsSent
);
2770 SOSBackupPeerPostNotification("writing changes to backup");
2773 CFReleaseSafe(local
);
2774 CFReleaseNull(pendingObjects
);
2775 CFReleaseNull(missing
);
2780 CF_RETURNS_RETAINED CFSetRef
SOSEngineSyncWithBackupPeers(SOSEngineRef engine
, CFSetRef
/* CFStringRef */ peers
, bool forceReset
, CFErrorRef
*error
)
2782 __block
bool incomplete
= false;
2783 CFMutableSetRef handledSet
= CFSetCreateMutableForCFTypes(kCFAllocatorDefault
);
2785 bool ok
= SOSEngineDoTxnOnQueue(engine
, error
, ^(SOSTransactionRef txn
, bool *commit
) {
2786 __block
bool dirty
= false;
2787 CFSetForEach(peers
, ^(const void *value
) {
2788 bool report_handled
= true;
2789 CFErrorRef localError
= NULL
;
2790 SOSPeerRef peer
= NULL
;
2791 CFStringRef peerID
= asString(value
, &localError
);
2792 require_action_quiet(peerID
, done
, report_handled
= false);
2794 peer
= SOSEngineCopyPeerWithID_locked(engine
, peerID
, &localError
);
2795 require_quiet(peerID
, done
);
2797 if (SOSPeerMapEntryIsBackup(peer
)) {
2799 SOSPeerSetMustSendMessage(peer
, true);
2802 report_handled
= SOSEngineWriteToBackup_locked(engine
, peer
, false, &dirty
, &incomplete
, &localError
);
2807 secnotice("engine-sync", "Failed to process sync for %@: %@", peerID
, localError
);
2809 if (report_handled
) {
2810 CFSetAddValue(handledSet
, peerID
);
2812 CFReleaseNull(localError
);
2813 CFReleaseNull(peer
);
2817 CFErrorRef saveError
= NULL
;
2818 if (!SOSEngineSave(engine
, txn
, &saveError
)) {
2819 secnotice("engine-save", "Failed to save engine: %@", saveError
);
2824 // Ensure we get called again in a while (after a backup timeout)
2825 // sbd will do this since we never wrote a complete marker.
2826 // TODO: This relies on us not writing complete marker for update
2827 // event while we havn't finished a full backup, which we currently still do.
2830 CFReleaseNull(handledSet
);
2835 bool SOSEngineHandleMessage(SOSEngineRef engine
, CFStringRef peerID
,
2836 CFDataRef raw_message
, CFErrorRef
*error
)
2838 __block
bool result
= true;
2839 __block
bool somethingChanged
= false;
2840 SOSMessageRef message
= SOSMessageCreateWithData(kCFAllocatorDefault
, raw_message
, error
);
2841 result
&= message
&& SOSEngineDoTxnOnQueue(engine
, error
, ^(SOSTransactionRef txn
, bool *commit
) {
2842 result
= SOSEngineHandleMessage_locked(engine
, peerID
, message
, txn
, commit
, &somethingChanged
, error
);
2844 CFReleaseSafe(message
);
2845 if (somethingChanged
)
2846 SecKeychainChanged();
2850 void SOSEngineCircleChanged(SOSEngineRef engine
, CFStringRef myPeerID
, CFArrayRef trustedPeers
, CFArrayRef untrustedPeers
) {
2851 __block
bool peersOrViewsChanged
= false;
2852 SOSEngineDoOnQueue(engine
, ^{
2853 peersOrViewsChanged
= SOSEngineCircleChanged_locked(engine
, myPeerID
, trustedPeers
, untrustedPeers
);
2855 // We should probably get a more precise list of peers that actually need talking to
2856 if (peersOrViewsChanged
&& engine
->myID
&& CFArrayGetCount(engine
->peerIDs
) != 0)
2857 SOSCCRequestSyncWithPeersList(engine
->peerIDs
);
2860 __block
bool ok
= true;
2861 __block CFErrorRef localError
= NULL
;
2862 ok
&= SOSEngineDoTxnOnQueue(engine
, &localError
, ^(SOSTransactionRef txn
, bool *commit
) {
2863 ok
= *commit
= SOSEngineSave(engine
, txn
, &localError
);
2866 secerror("failed to save engine state: %@", localError
);
2867 CFReleaseSafe(localError
);
2872 SOSManifestRef
SOSEngineCopyManifest(SOSEngineRef engine
, CFErrorRef
*error
) {
2873 __block SOSManifestRef result
= NULL
;
2874 SOSEngineDoOnQueue(engine
, ^{
2875 result
= SOSEngineCopyManifestWithViewNameSet_locked(engine
, SOSViewsGetV0ViewSet(), error
);
2880 SOSManifestRef
SOSEngineCopyLocalPeerManifest(SOSEngineRef engine
, SOSPeerRef peer
, CFErrorRef
*error
) {
2881 __block SOSManifestRef result
= NULL
;
2882 SOSEngineDoOnQueue(engine
, ^{
2883 result
= SOSEngineCopyLocalPeerManifest_locked(engine
, peer
, error
);
2888 bool SOSEngineUpdateChanges(SOSEngineRef engine
, SOSDataSourceTransactionSource source
, CFArrayRef changes
, CFErrorRef
*error
) {
2889 __block
bool result
= true;
2890 SOSEngineDoOnQueue(engine
, ^{
2891 result
= SOSEngineUpdateChanges_locked(engine
, NULL
, kSOSDataSourceTransactionDidCommit
, source
, changes
, error
);
2897 // Peer state layout. WRONG! It's an array now
2898 // The peer state is an array.
2899 // The first element of the array is a dictionary with any number of keys and
2900 // values in it (for future expansion) such as changing the digest size or type
2901 // or remebering boolean flags for a peers sake.
2902 // The next three are special in that they are manifest digests with special
2903 // meaning and rules as to how they are treated (These are dynamically updated
2904 // based on database activity so they have a fully history of all changes made
2905 // to the local db. The first is the manifest representing the pendingObjects
2906 // to send to the other peer. This is normally only ever appending to, and in
2907 // particular with transactions originating from the Keychain API that affect
2908 // syncable items will need to add the new objects digests to the pendingObjects list
2909 // while adding the digests of any tombstones encountered to the extra list.
2911 SOSPeerRef
SOSEngineCopyPeerWithID(SOSEngineRef engine
, CFStringRef peer_id
, CFErrorRef
*error
) {
2912 __block SOSPeerRef peer
= NULL
;
2913 SOSEngineDoOnQueue(engine
, ^{
2914 peer
= SOSEngineCopyPeerWithID_locked(engine
, peer_id
, error
);
2919 bool SOSEngineForPeerID(SOSEngineRef engine
, CFStringRef peerID
, CFErrorRef
*error
, void (^forPeer
)(SOSTransactionRef txn
, SOSPeerRef peer
)) {
2920 __block
bool ok
= true;
2921 SOSDataSourceReadWithCommitQueue(engine
->dataSource
, error
, ^(SOSTransactionRef txn
) {
2922 SOSEngineDoOnQueue(engine
, ^{
2923 SOSPeerRef peer
= SOSEngineCopyPeerWithID_locked(engine
, peerID
, error
);
2936 bool SOSEngineWithPeerID(SOSEngineRef engine
, CFStringRef peerID
, CFErrorRef
*error
, void (^with
)(SOSPeerRef peer
, SOSCoderRef coder
, SOSDataSourceRef dataSource
, SOSTransactionRef txn
, bool *forceSaveState
)) {
2937 __block
bool result
= true;
2938 result
&= SOSEngineDoTxnOnQueue(engine
, error
, ^(SOSTransactionRef txn
, bool *commit
) {
2939 SOSPeerRef peer
= SOSEngineCopyPeerWithID_locked(engine
, peerID
, error
);
2941 result
= SOSErrorCreate(kSOSErrorPeerNotFound
, error
, NULL
, CFSTR("Engine has no peer for %@"), peerID
);
2943 bool saveState
= false;
2944 SOSCoderRef coder
= SOSEngineGetCoderInTx_locked(engine
, txn
, peerID
, NULL
);
2945 with(peer
, coder
, engine
->dataSource
, txn
, &saveState
);
2946 CFReleaseSafe(peer
);
2948 result
= SOSEngineSave(engine
, txn
, error
);
2949 // TODO: Don't commit if engineSave fails?
2956 CFDataRef
SOSEngineCreateMessageToSyncToPeer(SOSEngineRef engine
, CFStringRef peerID
, CFMutableArrayRef
*attributeList
, SOSEnginePeerMessageSentCallback
**sentCallback
, CFErrorRef
*error
){
2957 __block CFDataRef message
= NULL
;
2958 SOSEngineForPeerID(engine
, peerID
, error
, ^(SOSTransactionRef txn
, SOSPeerRef peer
) {
2959 message
= SOSEngineCreateMessage_locked(engine
, txn
, peer
, attributeList
, error
, sentCallback
);
2964 bool SOSEnginePeerDidConnect(SOSEngineRef engine
, CFStringRef peerID
, CFErrorRef
*error
) {
2965 return SOSEngineWithPeerID(engine
, peerID
, error
, ^(SOSPeerRef peer
, SOSCoderRef coder
, SOSDataSourceRef dataSource
, SOSTransactionRef txn
, bool *saveState
) {
2966 *saveState
= SOSPeerDidConnect(peer
);
2970 bool SOSEngineSetPeerConfirmedManifest(SOSEngineRef engine
, CFStringRef backupName
,
2971 CFDataRef keybagDigest
, CFDataRef manifestData
, CFErrorRef
*error
) {
2972 __block
bool ok
= true;
2974 ok
&= SOSEngineForPeerID(engine
, backupName
, error
, ^(SOSTransactionRef txn
, SOSPeerRef peer
) {
2976 bool incomplete
= false;
2977 SOSManifestRef confirmed
= NULL
;
2978 CFDataRef keybag
= SOSPeerGetKeyBag(peer
);
2979 CFDataRef computedKeybagDigest
= keybag
? CFDataCopySHA1Digest(keybag
, NULL
) : NULL
;
2980 if (CFEqualSafe(keybagDigest
, computedKeybagDigest
)) {
2981 ok
= confirmed
= SOSManifestCreateWithData(manifestData
, error
);
2983 // Set both confirmed and proposed (confirmed is just
2984 // for debug status, proposed is actually what's used
2985 // by the backup peer).
2986 SOSPeerSetConfirmedManifest(peer
, confirmed
);
2987 SOSPeerSetProposedManifest(peer
, confirmed
);
2990 // sbd missed a reset event, send it again
2991 // Force SOSEngineWriteToBackup_locked to call SOSPeerWriteReset, which clears
2992 // confirmed and proposed manifests and writes the keybag to the journal.
2993 SOSPeerSetMustSendMessage(peer
, true);
2996 // Stop changes from writing complete markers, unless SOSEngineWriteToBackup_locked() detects we are in sync
2997 SOSPeerSetSendObjects(peer
, false);
2998 // Write data for this peer if we can, technically not needed for non legacy protocol support all the time.
2999 ok
= SOSEngineWriteToBackup_locked(engine
, peer
, true, &dirty
, &incomplete
, error
);
3001 if (!ok
&& error
&& SecErrorGetOSStatus(*error
) == errSecInteractionNotAllowed
) {
3002 SOSEnsureBackupWhileUnlocked();
3005 CFReleaseSafe(confirmed
);
3006 CFReleaseSafe(computedKeybagDigest
);
3011 CFArrayRef
SOSEngineCopyBackupPeerNames(SOSEngineRef engine
, CFErrorRef
*error
) {
3012 __block CFMutableArrayRef backupNames
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
3013 SOSEngineForEachBackupPeer(engine
, ^(SOSPeerRef peer
) {
3014 CFArrayAppendValue(backupNames
, SOSPeerGetID(peer
));
3019 static CFMutableDictionaryRef
SOSEngineCreateStateDictionary(CFStringRef peerID
, SOSManifestRef manifest
, CFSetRef vns
, CFStringRef coderString
) {
3020 CFNumberRef manifestCount
= CFNumberCreateWithCFIndex(kCFAllocatorDefault
, SOSManifestGetCount(manifest
));
3021 CFDataRef manifestHash
= SOSManifestGetDigest(manifest
, NULL
);
3022 CFMutableDictionaryRef result
= CFDictionaryCreateMutableForCFTypesWithSafe(kCFAllocatorDefault
,
3023 kSOSCCEngineStatePeerIDKey
, peerID
,
3024 kSOSCCEngineStateManifestCountKey
, manifestCount
,
3025 kSOSCCEngineStateManifestHashKey
, manifestHash
,
3026 kSOSCCEngineStateSyncSetKey
, asSet(vns
, NULL
),
3027 kSOSCCEngineStateCoderKey
, coderString
,
3029 CFReleaseNull(manifestCount
);
3033 static void SOSEngineAppendStateDictionary(CFMutableArrayRef stateArray
, CFStringRef peerID
, SOSManifestRef manifest
, CFSetRef vns
, CFStringRef coderString
) {
3034 CFMutableDictionaryRef newState
= SOSEngineCreateStateDictionary(peerID
, manifest
, vns
, coderString
);
3035 CFArrayAppendValue(stateArray
, newState
);
3036 CFReleaseNull(newState
);
3039 static CFArrayRef
SOSEngineCopyPeerConfirmedDigests_locked(SOSEngineRef engine
, CFErrorRef
*error
) {
3040 CFMutableArrayRef result
= CFArrayCreateMutableForCFTypes(kCFAllocatorDefault
);
3041 CFDictionaryForEach(engine
->viewNameSet2ChangeTracker
, ^(const void *vns
, const void *ct
) {
3042 SOSManifestRef manifest
= SOSEngineCopyManifestWithViewNameSet_locked(engine
, vns
, error
);
3043 SOSEngineAppendStateDictionary(result
, NULL
, manifest
, vns
, NULL
);
3044 CFReleaseNull(manifest
);
3047 // Copy other peers even if we aren't in the circle, since we're observing it.
3048 SOSEngineForEachPeer_locked(engine
, ^(SOSPeerRef peer
) {
3049 CFTypeRef coderObject
= engine
->coders
? CFDictionaryGetValue(engine
->coders
, SOSPeerGetID(peer
)) : CFSTR("Coders not loaded.");
3050 CFStringRef coderState
= coderObject
? CFCopyDescription(coderObject
) : NULL
;
3051 SOSEngineAppendStateDictionary(result
, SOSPeerGetID(peer
), SOSPeerGetConfirmedManifest(peer
), SOSPeerGetViewNameSet(peer
), coderState
);
3052 CFReleaseNull(coderState
);
3057 CFArrayRef
SOSEngineCopyPeerConfirmedDigests(SOSEngineRef engine
, CFErrorRef
*error
) {
3058 __block CFArrayRef result
= NULL
;
3059 SOSEngineDoOnQueue(engine
, ^{
3060 result
= SOSEngineCopyPeerConfirmedDigests_locked(engine
, error
);
3065 SOSDataSourceRef
SOSEngineGetDataSource(SOSEngineRef engine
) {
3066 return engine
->dataSource
;
3069 #define ENGINELOGSTATE "engineLogState"
3070 void SOSEngineLogState(SOSEngineRef engine
) {
3071 CFErrorRef error
= NULL
;
3072 CFArrayRef confirmedDigests
= NULL
;
3074 secnotice(ENGINELOGSTATE
, "Start");
3076 require_action_quiet(engine
, retOut
, secnotice(ENGINELOGSTATE
, "No Engine Available"));
3077 confirmedDigests
= SOSEngineCopyPeerConfirmedDigests(engine
, &error
);
3078 require_action_quiet(confirmedDigests
, retOut
, secnotice(ENGINELOGSTATE
, "No engine peers: %@\n", error
));
3080 SOSCCForEachEngineStateAsStringFromArray(confirmedDigests
, ^(CFStringRef onePeerDescription
) {
3081 secnotice(ENGINELOGSTATE
, "%@", onePeerDescription
);
3085 CFReleaseNull(error
);
3086 CFReleaseNull(confirmedDigests
);
3087 secnotice(ENGINELOGSTATE
, "Finish");
3093 void TestSOSEngineDoOnQueue(CFTypeRef engine
, dispatch_block_t action
)
3095 dispatch_sync(((SOSEngineRef
)engine
)->queue
, action
);
3097 CFMutableDictionaryRef
TestSOSEngineGetCoders(CFTypeRef engine
){
3098 return ((SOSEngineRef
)engine
)->coders
;
3101 bool TestSOSEngineDoTxnOnQueue(CFTypeRef engine
, CFErrorRef
*error
, void(^transaction
)(SOSTransactionRef txn
, bool *commit
))
3103 return SOSDataSourceWithCommitQueue(((SOSEngineRef
)engine
)->dataSource
, error
, ^(SOSTransactionRef txn
, bool *commit
) {
3104 TestSOSEngineDoOnQueue((SOSEngineRef
)engine
, ^{ transaction(txn
, commit
); });
3107 bool SOSEngineGetCodersNeedSaving(SOSEngineRef engine
){
3108 return engine
->codersNeedSaving
;
3111 void SOSEngineSetCodersNeedSaving(SOSEngineRef engine
, bool saved
){
3112 engine
->codersNeedSaving
= saved
;