OSX/sec/securityd/SOSCloudCircleServer.h

   1 /*
   2  * Copyright (c) 2012-2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24
  25 #ifndef _SECURITY_SOSCLOUDCIRCLESERVER_H_
  26 #define _SECURITY_SOSCLOUDCIRCLESERVER_H_
  27
  28 #include <Security/SecureObjectSync/SOSCloudCircle.h>
  29 #include <Security/SecureObjectSync/SOSAccount.h>
  30
  31
  32 __BEGIN_DECLS
  33
  34 //
  35 // MARK: Server versions of our SPI
  36 //
  37 bool SOSCCTryUserCredentials_Server(CFStringRef user_label, CFDataRef user_password, CFErrorRef *error);
  38 bool SOSCCSetUserCredentials_Server(CFStringRef user_label, CFDataRef user_password, CFErrorRef *error);
  39 bool SOSCCSetUserCredentialsAndDSID_Server(CFStringRef user_label, CFDataRef user_password, CFStringRef dsid, CFErrorRef *error);
  40
  41 bool SOSCCCanAuthenticate_Server(CFErrorRef *error);
  42 bool SOSCCPurgeUserCredentials_Server(CFErrorRef *error);
  43
  44 SOSCCStatus SOSCCThisDeviceIsInCircle_Server(CFErrorRef *error);
  45 bool SOSCCRequestToJoinCircle_Server(CFErrorRef* error);
  46 bool SOSCCRequestToJoinCircleAfterRestore_Server(CFErrorRef* error);
  47 CFStringRef SOSCCCopyDeviceID_Server(CFErrorRef *error);
  48 bool SOSCCSetDeviceID_Server(CFStringRef IDS, CFErrorRef *error);
  49 HandleIDSMessageReason SOSCCHandleIDSMessage_Server(CFDictionaryRef messageDict, CFErrorRef* error);
  50 bool SOSCCRequestSyncWithPeerOverKVS_Server(CFStringRef peerID, CFDataRef message, CFErrorRef *error);
  51 bool SOSCCClearPeerMessageKeyInKVS_Server(CFStringRef peerID, CFErrorRef *error);
  52
  53 bool SOSCCIDSServiceRegistrationTest_Server(CFStringRef message, CFErrorRef *error);
  54 bool SOSCCIDSPingTest_Server(CFStringRef message, CFErrorRef *error);
  55 bool SOSCCIDSDeviceIDIsAvailableTest_Server(CFErrorRef *error);
  56
  57 bool SOSCCRemoveThisDeviceFromCircle_Server(CFErrorRef* error);
  58 bool SOSCCRemovePeersFromCircle_Server(CFArrayRef peers, CFErrorRef* error);
  59 bool SOSCCLoggedOutOfAccount_Server(CFErrorRef *error);
  60 bool SOSCCBailFromCircle_Server(uint64_t limit_in_seconds, CFErrorRef* error);
  61 bool SOSCCRequestEnsureFreshParameters_Server(CFErrorRef* error);
  62
  63
  64 bool SOSCCApplyToARing_Server(CFStringRef ringName, CFErrorRef *error);
  65 bool SOSCCWithdrawlFromARing_Server(CFStringRef ringName, CFErrorRef *error);
  66 SOSRingStatus SOSCCRingStatus_Server(CFStringRef ringName, CFErrorRef *error);
  67 CFStringRef SOSCCGetAllTheRings_Server(CFErrorRef *error);
  68 bool SOSCCEnableRing_Server(CFStringRef ringName, CFErrorRef *error);
  69
  70
  71 CFArrayRef SOSCCCopyGenerationPeerInfo_Server(CFErrorRef* error);
  72 CFArrayRef SOSCCCopyApplicantPeerInfo_Server(CFErrorRef* error);
  73 CFArrayRef SOSCCCopyValidPeerPeerInfo_Server(CFErrorRef* error);
  74 bool SOSCCValidateUserPublic_Server(CFErrorRef* error);
  75
  76 CFArrayRef SOSCCCopyNotValidPeerPeerInfo_Server(CFErrorRef* error);
  77 CFArrayRef SOSCCCopyRetirementPeerInfo_Server(CFErrorRef* error);
  78 CFArrayRef SOSCCCopyViewUnawarePeerInfo_Server(CFErrorRef* error);
  79 bool SOSCCRejectApplicants_Server(CFArrayRef applicants, CFErrorRef* error);
  80 bool SOSCCAcceptApplicants_Server(CFArrayRef applicants, CFErrorRef* error);
  81
  82 SOSPeerInfoRef SOSCCCopyMyPeerInfo_Server(CFErrorRef* error);
  83 CFArrayRef SOSCCCopyEngineState_Server(CFErrorRef* error);
  84
  85 CFArrayRef SOSCCCopyPeerPeerInfo_Server(CFErrorRef* error);
  86 CFArrayRef SOSCCCopyConcurringPeerPeerInfo_Server(CFErrorRef* error);
  87 bool SOSCCCheckPeerAvailability_Server(CFErrorRef *error);
  88 bool SOSCCkSecXPCOpIsThisDeviceLastBackup_Server(CFErrorRef *error);
  89 bool SOSCCkSecXPCOpIsThisDeviceLastBackup_Server(CFErrorRef *error);
  90 bool SOSCCAccountSetToNew_Server(CFErrorRef *error);
  91 bool SOSCCResetToOffering_Server(CFErrorRef* error);
  92 bool SOSCCResetToEmpty_Server(CFErrorRef* error);
  93
  94 CFBooleanRef SOSCCPeersHaveViewsEnabled_Server(CFArrayRef viewNames, CFErrorRef *error);
  95
  96 SOSViewResultCode SOSCCView_Server(CFStringRef view, SOSViewActionCode action, CFErrorRef *error);
  97 bool SOSCCViewSet_Server(CFSetRef enabledView, CFSetRef disabledViews);
  98
  99 SOSSecurityPropertyResultCode SOSCCSecurityProperty_Server(CFStringRef property, SOSSecurityPropertyActionCode action, CFErrorRef *error);
 100
 101 CFStringRef SOSCCCopyIncompatibilityInfo_Server(CFErrorRef* error);
 102 enum DepartureReason SOSCCGetLastDepartureReason_Server(CFErrorRef* error);
 103 bool SOSCCSetLastDepartureReason_Server(enum DepartureReason reason, CFErrorRef *error);
 104 bool SOSCCSetHSA2AutoAcceptInfo_Server(CFDataRef pubKey, CFErrorRef *error);
 105
 106 bool SOSCCProcessEnsurePeerRegistration_Server(CFErrorRef* error);
 107
 108 CF_RETURNS_RETAINED CFSetRef SOSCCProcessSyncWithPeers_Server(CFSetRef peers, CFSetRef backupPeers, CFErrorRef *error);
 109 SyncWithAllPeersReason SOSCCProcessSyncWithAllPeers_Server(CFErrorRef* error);
 110 bool SOSCCRequestSyncWithPeerOverKVSUsingIDOnly_Server(CFStringRef deviceID, CFErrorRef *error);
 111
 112 SOSPeerInfoRef SOSCCSetNewPublicBackupKey_Server(CFDataRef newPublicBackup, CFErrorRef *error);
 113 bool SOSCCRegisterSingleRecoverySecret_Server(CFDataRef backupSlice, bool setupV0Only, CFErrorRef *error);
 114
 115 bool SOSCCWaitForInitialSync_Server(CFErrorRef*);
 116 CFArrayRef SOSCCCopyYetToSyncViewsList_Server(CFErrorRef*);
 117
 118 bool SOSWrapToBackupSliceKeyBagForView_Server(CFStringRef viewName, CFDataRef input, CFDataRef* output, CFDataRef* bskbEncoded, CFErrorRef* error);
 119
 120 SOSBackupSliceKeyBagRef SOSBackupSliceKeyBagForView(CFStringRef viewName, CFErrorRef* error);
 121 CF_RETURNS_RETAINED CFDataRef SOSWrapToBackupSliceKeyBag(SOSBackupSliceKeyBagRef bskb, CFDataRef input, CFErrorRef* error);
 122
 123 //
 124 // MARK: Internal kicks.
 125 //
 126 CF_RETURNS_RETAINED CFArrayRef SOSCCHandleUpdateMessage(CFDictionaryRef updates);
 127 void sync_the_last_data_to_kvs(SOSAccountRef account, bool waitForeverForSynchronization);
 128
 129
 130 // Expected to be called when the data source changes.
 131 void SOSCCRequestSyncWithPeer(CFStringRef peerID);
 132 void SOSCCRequestSyncWithPeers(CFSetRef /*SOSPeerInfoRef/CFStringRef*/ peerIDs);
 133 void SOSCCRequestSyncWithPeersList(CFArrayRef /*CFStringRef*/ peerIDs);
 134 void SOSCCRequestSyncWithBackupPeer(CFStringRef backupPeerId);
 135
 136 bool SOSCCIsSyncPendingFor(CFStringRef peerID, CFErrorRef *error);
 137
 138 void SOSCCEnsurePeerRegistration(void);
 139 void SOSCCAddSyncablePeerBlock(CFStringRef ds_name, SOSAccountSyncablePeersBlock changeBlock);
 140 dispatch_queue_t SOSCCGetAccountQueue(void);
 141
 142 //
 143 // MARK: Internal access to local account for tests.
 144 //
 145 typedef SOSDataSourceFactoryRef (^SOSCCAccountDataSourceFactoryBlock)();
 146
 147 SOSAccountRef SOSKeychainAccountGetSharedAccount(void);
 148 bool SOSKeychainAccountSetFactoryForAccount(SOSCCAccountDataSourceFactoryBlock factory);
 149
 150 //
 151 // MARK: Internal SPIs for testing
 152 //
 153 CFStringRef CopyOSVersion(void);
 154 CFDataRef SOSCCCopyAccountState_Server(CFErrorRef* error);
 155 CFDataRef SOSCCCopyEngineData_Server(CFErrorRef* error);
 156 bool SOSCCDeleteEngineState_Server(CFErrorRef* error);
 157 bool SOSCCDeleteAccountState_Server(CFErrorRef* error);
 158
 159
 160 //
 161 // MARK: Testing operations, dangerous to call in normal operation.
 162 //
 163 bool SOSKeychainSaveAccountDataAndPurge(CFErrorRef *error);
 164
 165 //
 166 // MARK: Constants for where we store persistent information in the keychain
 167 //
 168
 169 extern CFStringRef kSOSInternalAccessGroup;
 170
 171 extern CFStringRef kSOSAccountLabel;
 172 extern CFStringRef kSOSPeerDataLabel;
 173
 174 CFDataRef SOSItemCopy(CFStringRef label, CFErrorRef* error);
 175 bool SOSItemUpdateOrAdd(CFStringRef label, CFStringRef accessibility, CFDataRef data, CFErrorRef *error);
 176
 177 bool SOSCCSetEscrowRecord_Server(CFStringRef escrow_label, uint64_t tries, CFErrorRef *error);
 178 CFDictionaryRef SOSCCCopyEscrowRecord_Server(CFErrorRef *error);
 179 bool SOSCCRegisterRecoveryPublicKey_Server(CFDataRef recovery_key, CFErrorRef *error);
 180 CFDataRef SOSCCCopyRecoveryPublicKey_Server(CFErrorRef *error);
 181
 182 CFDictionaryRef SOSCCCopyBackupInformation_Server(CFErrorRef *error);
 183
 184 SOSPeerInfoRef SOSCCCopyApplication_Server(CFErrorRef *error);
 185 CFDataRef SOSCCCopyCircleJoiningBlob_Server(SOSPeerInfoRef applicant, CFErrorRef *error);
 186 bool SOSCCJoinWithCircleJoiningBlob_Server(CFDataRef joiningBlob, CFErrorRef *error);
 187
 188 bool SOSCCAccountHasPublicKey_Server(CFErrorRef *error);
 189 bool SOSCCAccountIsNew_Server(CFErrorRef *error);
 190
 191 bool SOSCCMessageFromPeerIsPending_Server(SOSPeerInfoRef peer, CFErrorRef *error);
 192 bool SOSCCSendToPeerIsPending_Server(SOSPeerInfoRef peer, CFErrorRef *error);
 193
 194 __END_DECLS
 195
 196 #endif