OSX/sec/SOSCircle/SecureObjectSync/SOSEngine.h

   1 /*
   2  * Copyright (c) 2012-2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24
  25 /*!
  26  @header SOSEngine.h - Manifest managent engine and decision making for
  27  object syncing protocol.
  28  */
  29
  30 #ifndef _SEC_SOSENGINE_H_
  31 #define _SEC_SOSENGINE_H_
  32
  33 #include <Security/SecureObjectSync/SOSDataSource.h>
  34 #include <Security/SecureObjectSync/SOSMessage.h>
  35 #include <Security/SecureObjectSync/SOSPeer.h>
  36 #include <dispatch/dispatch.h>
  37
  38 __BEGIN_DECLS
  39
  40 // TODO: Move this to SOSPeer.h?
  41 typedef void (^SOSEnginePeerMessageSentBlock)(bool success);
  42
  43 // Return a new engine instance for a given data source.
  44 SOSEngineRef SOSEngineCreate(SOSDataSourceRef dataSource, CFErrorRef *error);
  45
  46 // TODO: Nuke from orbit
  47 SOSManifestRef SOSEngineCopyManifest(SOSEngineRef engine, CFErrorRef *error);
  48
  49 // Return a snapshot of the current manifest of the engines data source for the views that the given peer is in.
  50 SOSManifestRef SOSEngineCopyLocalPeerManifest(SOSEngineRef engine, SOSPeerRef peer, CFErrorRef *error);
  51 SOSManifestRef SOSEngineCopyLocalPeerManifest_locked(SOSEngineRef engine, SOSPeerRef peer, CFErrorRef *error);
  52
  53 // Apply changes to all views manifests, and update all peers accordingly
  54 bool SOSEngineUpdateChanges(SOSEngineRef engine, SOSDataSourceTransactionSource source, CFArrayRef changes, CFErrorRef *error);
  55
  56 // Store manifest indexed by it's own digest.  Can be retrieved with SOSEngineGetManifestForDigest()
  57 void SOSEngineAddManifest(SOSEngineRef engine, SOSManifestRef manifest);
  58
  59 // Retrive a digest stored with SOSEngineAddManifest()
  60 SOSManifestRef SOSEngineGetManifestForDigest(SOSEngineRef engine, CFDataRef digest);
  61
  62 // Return the digest for a patched manifest (which is stored in the cache already).
  63 CFDataRef SOSEnginePatchRecordAndCopyDigest(SOSEngineRef engine, SOSManifestRef base, SOSManifestRef removals, SOSManifestRef additions, CFErrorRef *error);
  64
  65 // Copy a manifest for a key persisted in a persisted dictionary
  66 SOSManifestRef SOSEngineCopyPersistedManifest(SOSEngineRef engine, CFDictionaryRef persisted, CFStringRef key);
  67
  68 // Copy a manifest for a key persisted in a persisted dictionary
  69 CFMutableArrayRef SOSEngineCopyPersistedManifestArray(SOSEngineRef engine, CFDictionaryRef persisted, CFStringRef key, CFErrorRef *error);
  70
  71 void SOSEngineClearCache(SOSEngineRef engine);
  72
  73 // Dispose of an engine when it's no longer needed.
  74 void SOSEngineDispose(SOSEngineRef engine);
  75
  76 // Handle incoming message from a remote peer.
  77 bool SOSEngineHandleMessage(SOSEngineRef engine, CFStringRef peerID,
  78                             CFDataRef message, CFErrorRef *error);
  79
  80 // Change the set of peers we know about.  trustedPeers and untrustedPeers are arrays of SOSPeerMetaRef
  81 // trustedPeers is an array of SOSPeerMetaRef (peer SOSPeer.h), untrustedpeers is redundant as the engine
  82 // treats a trustedPeer with no views and no publicKey the same as an untrustedPeer.
  83 // TODO: Fix the documentation above this line.
  84 void SOSEngineCircleChanged(SOSEngineRef engine, CFStringRef myPeerID, CFArrayRef trustedPeers, CFArrayRef untrustedPeers);
  85
  86 // Iterate over all peers.
  87 void SOSEngineForEachPeer(SOSEngineRef engine, void (^with)(SOSPeerRef peer));
  88
  89 // TODO: Move SOSTransportMessageIDSRef declarations somewhere we can get to them here.
  90 //void SOSEngineSyncWithPeers(SOSEngineRef engine, SOSTransportMessageIDSRef ids, SOSTransportMessageKVSRef kvs, CFErrorRef *error);
  91 bool SOSEngineSyncWithPeers(SOSEngineRef engine, CFTypeRef ids, CFTypeRef kvs, CFErrorRef *error);
  92
  93 // Don't call this unless you know what you are doing.  If you do then still don't call it.
  94 bool SOSEngineHandleMessage_locked(SOSEngineRef engine, CFStringRef peerID, SOSMessageRef message,
  95                                    SOSTransactionRef txn, bool *commit, bool *somethingChanged, CFErrorRef *error);
  96
  97 CFDataRef SOSEngineCreateMessage_locked(SOSEngineRef engine, SOSPeerRef peer,
  98                                         CFErrorRef *error, SOSEnginePeerMessageSentBlock *sent);
  99
 100 // Return a SOSPeerRef for a given peer_id.
 101 SOSPeerRef SOSEngineCopyPeerWithID(SOSEngineRef engine, CFStringRef peer_id, CFErrorRef *error);
 102
 103 // Operate on a peer with a given peer_id under the engine lock
 104 bool SOSEngineForPeerID(SOSEngineRef engine, CFStringRef peer_id, CFErrorRef *error, void (^forPeer)(SOSPeerRef peer));
 105
 106 // Modify a peer inside a transaction under then engine lock and optionally force an engine state save when done.
 107 bool SOSEngineWithPeerID(SOSEngineRef engine, CFStringRef peer_id, CFErrorRef *error, void (^with)(SOSPeerRef peer, SOSDataSourceRef dataSource, SOSTransactionRef txn, bool *forceSaveState));
 108
 109 // Return a message to be sent for the current state.  Returns NULL on errors,
 110 // return a zero length CFDataRef if there is nothing to send.
 111 // If *ProposedManifest is set the caller is responsible for updating their
 112 // proposed manifest upon successful transmission of the message.
 113 CFDataRef SOSEngineCreateMessageToSyncToPeer(SOSEngineRef engine, CFStringRef peerID, SOSEnginePeerMessageSentBlock *sentBlock, CFErrorRef *error);
 114
 115 CFStringRef SOSEngineGetMyID(SOSEngineRef engine);
 116 bool SOSEnginePeerDidConnect(SOSEngineRef engine, CFStringRef peerID, CFErrorRef *error);
 117 bool SOSEngineSetPeerConfirmedManifest(SOSEngineRef engine, CFStringRef backupName,
 118                                        CFDataRef keybagDigest, CFDataRef manifestData, CFErrorRef *error);
 119 CFArrayRef SOSEngineCopyBackupPeerNames(SOSEngineRef engine, CFErrorRef *error);
 120
 121 void logRawMessage(CFDataRef message, bool sending, uint64_t seqno);
 122
 123 // TODO: TEMPORARY: Get the list of IDs for cleanup, this shouldn't be used instead transport should iterate KVS.
 124 CFArrayRef SOSEngineGetPeerIDs(SOSEngineRef engine);
 125
 126 CFArrayRef SOSEngineCopyPeerConfirmedDigests(SOSEngineRef engine, CFErrorRef *error);
 127
 128 // Private do not use!
 129 SOSDataSourceRef SOSEngineGetDataSource(SOSEngineRef engine);
 130
 131 // MARK: Sync completion notification registration
 132
 133 void SOSEngineSetSyncCompleteListener(SOSEngineRef engine, CFStringRef peerID, dispatch_block_t notify_block);
 134 void SOSEngineSetSyncCompleteListenerQueue(SOSEngineRef engine, dispatch_queue_t notify_queue);
 135
 136
 137 __END_DECLS
 138
 139 #endif /* !_SEC_SOSENGINE_H_ */