OSX/sec/SOSCircle/SecureObjectSync/SOSCloudCircleInternal.h

   1 /*
   2  * Copyright (c) 2012-2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24
  25 #ifndef _SECURITY_SOSCLOUDCIRCLEINTERNAL_H_
  26 #define _SECURITY_SOSCLOUDCIRCLEINTERNAL_H_
  27
  28 #include <Security/SecureObjectSync/SOSCloudCircle.h>
  29 #include <Security/SecureObjectSync/SOSPeerInfo.h>
  30
  31 #include <xpc/xpc.h>
  32 #include <Security/SecKey.h>
  33
  34 __BEGIN_DECLS
  35
  36 // Use the kSecAttrViewHint* constants in SecItemPriv.h instead
  37
  38 extern const CFStringRef kSOSViewHintPCSMasterKey DEPRECATED_ATTRIBUTE;
  39 extern const CFStringRef kSOSViewHintPCSiCloudDrive DEPRECATED_ATTRIBUTE;
  40 extern const CFStringRef kSOSViewHintPCSPhotos DEPRECATED_ATTRIBUTE;
  41 extern const CFStringRef kSOSViewHintPCSCloudKit DEPRECATED_ATTRIBUTE;
  42 extern const CFStringRef kSOSViewHintPCSEscrow DEPRECATED_ATTRIBUTE;
  43 extern const CFStringRef kSOSViewHintPCSFDE DEPRECATED_ATTRIBUTE;
  44 extern const CFStringRef kSOSViewHintPCSMailDrop DEPRECATED_ATTRIBUTE;
  45 extern const CFStringRef kSOSViewHintPCSiCloudBackup DEPRECATED_ATTRIBUTE;
  46 extern const CFStringRef kSOSViewHintPCSNotes DEPRECATED_ATTRIBUTE;
  47 extern const CFStringRef kSOSViewHintPCSiMessage DEPRECATED_ATTRIBUTE;
  48
  49 extern const CFStringRef kSOSViewHintAppleTV DEPRECATED_ATTRIBUTE;
  50 extern const CFStringRef kSOSViewHintHomeKit DEPRECATED_ATTRIBUTE;
  51
  52 CFArrayRef SOSCCCopyConcurringPeerPeerInfo(CFErrorRef* error);
  53
  54 bool SOSCCPurgeUserCredentials(CFErrorRef* error);
  55
  56 CFStringRef SOSCCGetStatusDescription(SOSCCStatus status);
  57 CFStringRef SOSCCGetViewResultDescription(SOSViewResultCode vrc);
  58 bool SOSCCAccountHasPublicKey(CFErrorRef *error);
  59 bool SOSCCAccountIsNew(CFErrorRef *error);
  60
  61 /*!
  62  @function SOSCCHandleIDSMessage
  63  @abstract Handles an IDS message from KeychainSyncingOverIDSProxy
  64  @param IDS The incoming IDS message
  65  @param error What went wrong if we returned false
  66  */
  67 HandleIDSMessageReason SOSCCHandleIDSMessage(CFDictionaryRef IDS, CFErrorRef* error);
  68
  69 /*!
  70  @function SOSCCProcessSyncWithPeers
  71  @abstract Returns the peers for whom we handled syncing from the list send to us.
  72  @param peers Set of peerIDs to sync with
  73  @param backupPeers Set of backup peerIDs to sync with
  74  */
  75 CFSetRef /* CFString */ SOSCCProcessSyncWithPeers(CFSetRef peers, CFSetRef backupPeers, CFErrorRef* error);
  76
  77 /*!
  78  @function SOSCCProcessSyncWithAllPeers
  79  @abstract Returns the information (string, hopefully URL) that will lead to an explanation of why you have an incompatible circle.
  80  @param error What went wrong if we returned NULL.
  81  */
  82 SyncWithAllPeersReason SOSCCProcessSyncWithAllPeers(CFErrorRef* error);
  83
  84 bool SOSCCProcessEnsurePeerRegistration(CFErrorRef* error);
  85
  86 //Rings
  87 CFStringRef SOSCCGetAllTheRings(CFErrorRef *error);
  88
  89 bool SOSCCApplyToARing(CFStringRef ringName, CFErrorRef* error);
  90 bool SOSCCWithdrawlFromARing(CFStringRef ringName, CFErrorRef* error);
  91 int SOSCCRingStatus(CFStringRef ringName, CFErrorRef* error);   // TODO: this returns SOSRingStatus
  92 bool SOSCCEnableRing(CFStringRef ringName, CFErrorRef* error);
  93
  94 bool SOSCCCleanupKVSKeys(CFErrorRef *error);
  95
  96
  97 /*!
  98  @function SOSCCCopyMyPeerInfo
  99  @abstract Returns a copy of my peer info
 100  @param error What went wrong if we returned NULL
 101  */
 102 SOSPeerInfoRef SOSCCCopyMyPeerInfo(CFErrorRef *error);
 103
 104 /*!
 105  @function SOSCCIDSServiceRegistrationTest
 106  @abstract Attempts to send a message over IDS to test IDS service set up
 107  @param message The message to send over IDS
 108  @param error What went wrong if we returned false
 109  */
 110 bool SOSCCIDSServiceRegistrationTest(CFStringRef message, CFErrorRef *error);
 111
 112 /*!
 113  @function SOSCCIDSPingTest
 114  @abstract Attempts to ping devices within an IDS Account, check device availability
 115  @param message The message to send over IDS
 116  @param error What went wrong if we returned false
 117  */
 118 bool SOSCCIDSPingTest(CFStringRef message, CFErrorRef *error);
 119
 120 /*!
 121  @function SOSCCIDSDeviceIDIsAvailableTest
 122  @abstract Attempts to communicate with KeychainSyncingOverIDSProxy to retrieve the device ID using IDS framework
 123  @param error What went wrong if we returned false
 124  */
 125 bool SOSCCIDSDeviceIDIsAvailableTest(CFErrorRef *error);
 126
 127 /*!
 128  @function SOSWrapToBackupSliceKeyBagForView
 129  @abstract Encrypts the given plaintext, and wraps the encryption key to the backup slice keybag for this view
 130  @param viewName The view to wrap to
 131  @param input The plaintext to encrypt
 132  @param output The ciphertext
 133  @param bskbEncoded The encoded backup slice keybag used to wrap the data
 134  @param error What went wrong if we returned false
 135  */
 136 bool SOSWrapToBackupSliceKeyBagForView(CFStringRef viewName, CFDataRef input, CFDataRef* output, CFDataRef* bskbEncoded, CFErrorRef* error);
 137
 138 //
 139 // Security Tool calls
 140 //
 141 CFDataRef SOSCCCopyAccountState(CFErrorRef* error);
 142 bool SOSCCDeleteAccountState(CFErrorRef *error);
 143 CFDataRef SOSCCCopyEngineData(CFErrorRef* error);
 144 bool SOSCCDeleteEngineState(CFErrorRef *error);
 145 bool SOSCCRequestSyncWithPeerOverKVS( CFStringRef peerID, CFDataRef message, CFErrorRef *error);
 146 bool SOSCCClearPeerMessageKeyInKVS(CFStringRef peerID, CFErrorRef *error);
 147 CFDataRef SOSCCCopyRecoveryPublicKey(CFErrorRef *error);
 148 CFDictionaryRef SOSCCCopyBackupInformation(CFErrorRef *error);
 149 bool SOSCCRequestSyncWithPeerOverKVSUsingIDOnly(CFStringRef peerID, CFErrorRef *error);
 150 bool SOSCCTestPopulateKVSWithBadKeys(CFErrorRef *error);
 151 CFDataRef SOSCCCopyInitialSyncData(CFErrorRef *error);
 152
 153 void SOSCCForEachEngineStateAsStringFromArray(CFArrayRef states, void (^block)(CFStringRef oneStateString));
 154
 155 __END_DECLS
 156
 157 #endif