OSX/sec/SOSCircle/SecureObjectSync/SOSPeerInfo.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 _SOSPEERINFO_H_
  26 #define _SOSPEERINFO_H_
  27
  28 #include <CoreFoundation/CoreFoundation.h>
  29 #include <Security/SecKey.h>
  30 #include <CommonCrypto/CommonDigestSPI.h>
  31 #include <corecrypto/ccdigest.h>
  32
  33 #include <Security/SecureObjectSync/SOSTypes.h>
  34
  35 __BEGIN_DECLS
  36
  37 typedef struct __OpaqueSOSPeerInfo   *SOSPeerInfoRef;
  38
  39 // Bumped to 3 from 2 so we can identify pre-iCDP peers and add the proper views.
  40 #define PEERINFO_CURRENT_VERSION 3
  41
  42 enum {
  43     kSOSPeerVersion = 2,
  44     kSOSPeerV2BaseVersion = 2,
  45 };
  46
  47
  48 enum {
  49     SOSPeerCmpPubKeyHash = 0,
  50     SOSPeerCmpName = 1,
  51 };
  52 typedef uint32_t SOSPeerInfoCmpSelect;
  53
  54 CFTypeID SOSPeerInfoGetTypeID(void);
  55
  56 static inline bool isSOSPeerInfo(CFTypeRef obj) {
  57     return obj && (CFGetTypeID(obj) == SOSPeerInfoGetTypeID());
  58 }
  59
  60 static inline SOSPeerInfoRef asSOSPeerInfo(CFTypeRef obj) {
  61     return isSOSPeerInfo(obj) ? (SOSPeerInfoRef) obj : NULL;
  62 }
  63
  64 SOSPeerInfoRef SOSPeerInfoCreate(CFAllocatorRef allocator, CFDictionaryRef gestalt, CFDataRef backup_key, SecKeyRef signingKey, CFErrorRef* error);
  65
  66 SOSPeerInfoRef SOSPeerInfoCreateWithTransportAndViews(CFAllocatorRef allocator, CFDictionaryRef gestalt, CFDataRef backup_key,
  67                                                       CFStringRef IDSID, CFStringRef transportType, CFBooleanRef preferIDS,
  68                                                       CFBooleanRef preferFragmentation, CFSetRef enabledViews,
  69                                                       SecKeyRef signingKey, CFErrorRef* error);
  70
  71 SOSPeerInfoRef SOSPeerInfoCreateCloudIdentity(CFAllocatorRef allocator, CFDictionaryRef gestalt, SecKeyRef signingKey, CFErrorRef* error);
  72
  73 SOSPeerInfoRef SOSPeerInfoCreateCopy(CFAllocatorRef allocator, SOSPeerInfoRef toCopy, CFErrorRef* error);
  74 SOSPeerInfoRef SOSPeerInfoCreateCurrentCopy(CFAllocatorRef allocator, SOSPeerInfoRef toCopy,
  75                                             CFStringRef IDSID, CFStringRef transportType, CFBooleanRef preferIDS, CFBooleanRef preferFragmentation, CFSetRef enabledViews,
  76                                             SecKeyRef signingKey, CFErrorRef* error);
  77 bool SOSPeerInfoVersionIsCurrent(SOSPeerInfoRef pi);
  78 bool SOSPeerInfoVersionHasV2Data(SOSPeerInfoRef pi);
  79 SOSPeerInfoRef SOSPeerInfoCopyWithGestaltUpdate(CFAllocatorRef allocator, SOSPeerInfoRef toCopy, CFDictionaryRef gestalt, SecKeyRef signingKey, CFErrorRef* error);
  80 SOSPeerInfoRef SOSPeerInfoCopyWithBackupKeyUpdate(CFAllocatorRef allocator, SOSPeerInfoRef toCopy, CFDataRef backupKey, SecKeyRef signingKey, CFErrorRef* error);
  81 SOSPeerInfoRef SOSPeerInfoCopyWithEscrowRecordUpdate(CFAllocatorRef allocator, SOSPeerInfoRef toCopy, CFStringRef dsid, CFDictionaryRef escrowRecord, SecKeyRef signingKey, CFErrorRef *error);
  82 SOSPeerInfoRef SOSPeerInfoCopyWithReplacedEscrowRecords(CFAllocatorRef allocator, SOSPeerInfoRef toCopy, CFDictionaryRef escrowRecords, SecKeyRef signingKey, CFErrorRef *error);
  83
  84
  85 SOSPeerInfoRef SOSPeerInfoCopyWithViewsChange(CFAllocatorRef allocator, SOSPeerInfoRef toCopy,
  86                                               SOSViewActionCode action, CFStringRef viewname, SOSViewResultCode *retval,
  87                                               SecKeyRef signingKey, CFErrorRef* error);
  88 SOSPeerInfoRef SOSPeerInfoCopyAsApplication(SOSPeerInfoRef pi, SecKeyRef userkey, SecKeyRef peerkey, CFErrorRef *error);
  89
  90 SOSPeerInfoRef SOSPeerInfoCopyWithSecurityPropertyChange(CFAllocatorRef allocator, SOSPeerInfoRef toCopy,
  91                                                         SOSSecurityPropertyActionCode action, CFStringRef property, SOSSecurityPropertyResultCode *retval,
  92                                                         SecKeyRef signingKey, CFErrorRef* error);
  93
  94 SOSPeerInfoRef SOSPeerInfoCopyWithPing(CFAllocatorRef allocator, SOSPeerInfoRef toCopy, SecKeyRef signingKey, CFErrorRef* error);
  95 SOSPeerInfoRef SOSPeerInfoCopyAsApplication(SOSPeerInfoRef pi, SecKeyRef userkey, SecKeyRef peerkey, CFErrorRef *error);
  96
  97 bool SOSPeerInfoUpdateDigestWithPublicKeyBytes(SOSPeerInfoRef peer, const struct ccdigest_info *di,
  98                                                ccdigest_ctx_t ctx, CFErrorRef *error);
  99 bool SOSPeerInfoUpdateDigestWithDescription(SOSPeerInfoRef peer, const struct ccdigest_info *di,
 100                                             ccdigest_ctx_t ctx, CFErrorRef *error);
 101
 102
 103 bool SOSPeerInfoApplicationVerify(SOSPeerInfoRef pi, SecKeyRef userkey, CFErrorRef *error);
 104
 105 CF_RETURNS_RETAINED CFDateRef SOSPeerInfoGetApplicationDate(SOSPeerInfoRef pi);
 106
 107 //
 108 // DER Import Export
 109 //
 110 SOSPeerInfoRef SOSPeerInfoCreateFromDER(CFAllocatorRef allocator, CFErrorRef* error,
 111                                         const uint8_t** der_p, const uint8_t *der_end);
 112
 113 SOSPeerInfoRef SOSPeerInfoCreateFromData(CFAllocatorRef allocator, CFErrorRef* error,
 114                                          CFDataRef peerinfo_data);
 115
 116 size_t      SOSPeerInfoGetDEREncodedSize(SOSPeerInfoRef peer, CFErrorRef *error);
 117 uint8_t*    SOSPeerInfoEncodeToDER(SOSPeerInfoRef peer, CFErrorRef* error,
 118                                    const uint8_t* der, uint8_t* der_end);
 119
 120 CFDataRef SOSPeerInfoCopyEncodedData(SOSPeerInfoRef peer, CFAllocatorRef allocator, CFErrorRef *error);
 121
 122 //
 123 // Transfered Data
 124 //
 125 bool SOSPeerInfoHasBackupKey(SOSPeerInfoRef peer);
 126 CFDataRef SOSPeerInfoCopyBackupKey(SOSPeerInfoRef peer);
 127 CFMutableDictionaryRef SOSPeerInfoCopyEscrowRecord(SOSPeerInfoRef peer);
 128
 129 //
 130 // DER Import Export
 131 //
 132 SOSPeerInfoRef SOSPeerInfoCreateFromDER(CFAllocatorRef allocator, CFErrorRef* error,
 133                                         const uint8_t** der_p, const uint8_t *der_end);
 134
 135 SOSPeerInfoRef SOSPeerInfoCreateFromData(CFAllocatorRef allocator, CFErrorRef* error,
 136                                          CFDataRef peerinfo_data);
 137
 138 size_t      SOSPeerInfoGetDEREncodedSize(SOSPeerInfoRef peer, CFErrorRef *error);
 139 uint8_t*    SOSPeerInfoEncodeToDER(SOSPeerInfoRef peer, CFErrorRef* error,
 140                                    const uint8_t* der, uint8_t* der_end);
 141
 142 CFDataRef SOSPeerInfoCopyEncodedData(SOSPeerInfoRef peer, CFAllocatorRef allocator, CFErrorRef *error);
 143
 144 //
 145 // Gestalt info about the peer. It was fetched by the implementation on the other side.
 146 // probably has what you're looking for..
 147 //
 148 CFTypeRef SOSPeerInfoLookupGestaltValue(SOSPeerInfoRef pi, CFStringRef key);
 149 CFDictionaryRef SOSPeerInfoCopyPeerGestalt(SOSPeerInfoRef pi);
 150 CFDictionaryRef SOSPeerGetGestalt(SOSPeerInfoRef pi);
 151 CFStringRef SOSPeerInfoGetPeerName(SOSPeerInfoRef peer);
 152
 153 //
 154 // Syntactic Sugar for some commone ones, might get deprectated at this level.
 155 //
 156
 157 CFStringRef SOSPeerInfoGetPeerDeviceType(SOSPeerInfoRef peer);
 158 CFIndex SOSPeerInfoGetPeerProtocolVersion(SOSPeerInfoRef peer);
 159
 160
 161 // Stringified ID for this peer, not human readable.
 162 CFStringRef SOSPeerInfoGetPeerID(SOSPeerInfoRef peer);
 163 bool SOSPeerInfoPeerIDEqual(SOSPeerInfoRef pi, CFStringRef myPeerID);
 164
 165 CFIndex SOSPeerInfoGetVersion(SOSPeerInfoRef peer);
 166
 167 //
 168 // Peer Info Gestalt Helpers
 169 //
 170 CFStringRef SOSPeerGestaltGetName(CFDictionaryRef gestalt);
 171
 172 // These are Mobile Gestalt questions. Not all Gestalt questions are carried.
 173 CFTypeRef SOSPeerGestaltGetAnswer(CFDictionaryRef gestalt, CFStringRef question);
 174
 175 SecKeyRef SOSPeerInfoCopyPubKey(SOSPeerInfoRef peer, CFErrorRef *error);
 176
 177 CFDataRef SOSPeerInfoGetAutoAcceptInfo(SOSPeerInfoRef peer);
 178
 179 CFComparisonResult SOSPeerInfoCompareByID(const void *val1, const void *val2, void *context);
 180
 181 SOSPeerInfoRef SOSPeerInfoCreateRetirementTicket(CFAllocatorRef allocator, SecKeyRef privKey, SOSPeerInfoRef peer, CFErrorRef *error);
 182
 183 CFStringRef SOSPeerInfoInspectRetirementTicket(SOSPeerInfoRef pi, CFErrorRef *error);
 184
 185 bool SOSPeerInfoRetireRetirementTicket(size_t max_days, SOSPeerInfoRef pi);
 186
 187 CF_RETURNS_RETAINED CFDateRef SOSPeerInfoGetRetirementDate(SOSPeerInfoRef pi);
 188
 189 bool SOSPeerInfoIsRetirementTicket(SOSPeerInfoRef pi);
 190
 191 bool SOSPeerInfoIsCloudIdentity(SOSPeerInfoRef pi);
 192
 193 SOSPeerInfoRef SOSPeerInfoUpgradeSignatures(CFAllocatorRef allocator, SecKeyRef privKey, SecKeyRef perKey, SOSPeerInfoRef peer, CFErrorRef *error);
 194
 195 SOSViewResultCode SOSPeerInfoViewStatus(SOSPeerInfoRef pi, CFStringRef view, CFErrorRef *error);
 196
 197 CFSetRef SOSPeerInfoGetPermittedViews(SOSPeerInfoRef peer);
 198 bool SOSPeerInfoIsEnabledView(SOSPeerInfoRef peer, CFStringRef viewName);
 199 CFMutableSetRef SOSPeerInfoCopyEnabledViews(SOSPeerInfoRef peer);
 200 void SOSPeerInfoWithEnabledViewSet(SOSPeerInfoRef pi, void (^operation)(CFSetRef enabled));
 201
 202 SOSSecurityPropertyResultCode SOSPeerInfoSecurityPropertyStatus(SOSPeerInfoRef pi, CFStringRef property, CFErrorRef *error);
 203
 204 //Transport
 205 CFBooleanRef SOSPeerInfoCopyIDSPreference(SOSPeerInfoRef peer);
 206 SOSPeerInfoRef SOSPeerInfoSetIDSPreference(CFAllocatorRef allocator, SOSPeerInfoRef toCopy, CFBooleanRef preference, SecKeyRef signingKey, CFErrorRef *error);
 207
 208 CFBooleanRef SOSPeerInfoCopyIDSFragmentationPreference(SOSPeerInfoRef peer);
 209 SOSPeerInfoRef SOSPeerInfoSetIDSFragmentationPreference(CFAllocatorRef allocator, SOSPeerInfoRef toCopy, CFBooleanRef preference, SecKeyRef signingKey, CFErrorRef *error);
 210
 211 CFStringRef SOSPeerInfoCopyTransportType(SOSPeerInfoRef peer);
 212 SOSPeerInfoRef SOSPeerInfoSetTransportType(CFAllocatorRef allocator, SOSPeerInfoRef toCopy, CFStringRef transportType, SecKeyRef signingKey, CFErrorRef *error);
 213 bool SOSPeerInfoKVSOnly(SOSPeerInfoRef pi);
 214
 215 // IDSs device ID
 216 bool SOSPeerInfoHasDeviceID(SOSPeerInfoRef peer);
 217 CFStringRef SOSPeerInfoCopyDeviceID(SOSPeerInfoRef peer);
 218 SOSPeerInfoRef SOSPeerInfoSetDeviceID(CFAllocatorRef allocator, SOSPeerInfoRef toCopy, CFStringRef IDS, SecKeyRef signingKey, CFErrorRef *error);
 219
 220 bool SOSPeerInfoShouldUseIDSTransport(SOSPeerInfoRef myPeer, SOSPeerInfoRef theirPeer);
 221 bool SOSPeerInfoShouldUseIDSMessageFragmentation(SOSPeerInfoRef myPeer, SOSPeerInfoRef theirPeer);
 222
 223 void SOSPeerInfoLogState(char *category, SOSPeerInfoRef pi, SecKeyRef pubKey, CFStringRef myPID, char sigchr);
 224
 225 __END_DECLS
 226
 227 #endif