OSX/sec/Security/SecuritydXPC.c

   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 #include <Security/SecuritydXPC.h>
  26 #include <Security/SecCFAllocator.h>
  27 #include <ipc/securityd_client.h>
  28 #include <utilities/SecCFError.h>
  29 #include <utilities/SecDb.h>
  30 #include <utilities/SecCFWrappers.h>
  31 #include <utilities/der_plist.h>
  32
  33 // TODO Shorten these string values to save ipc bandwidth.
  34 const char *kSecXPCKeyOperation = "operation";
  35 const char *kSecXPCKeyResult = "status";
  36 const char *kSecXPCKeyEndpoint = "endpoint";
  37 const char *kSecXPCKeyError = "error";
  38 const char *kSecXPCKeyClientToken = "client";
  39 const char *kSecXPCKeyPeerInfoArray = "peer-infos";
  40 const char *kSecXPCKeyPeerInfo = "peer-info";
  41 const char *kSecXPCKeyUserLabel = "userlabel";
  42 const char *kSecXPCKeyBackup = "backup";
  43 const char *kSecXPCKeyKeybag = "keybag";
  44 const char *kSecXPCKeyUserPassword = "password";
  45 const char *kSecXPCKeyDSID = "dsid";
  46 const char *kSecXPCKeyQuery = "query";
  47 const char *kSecXPCKeyAttributesToUpdate = "attributesToUpdate";
  48 const char *kSecXPCKeyDomain = "domain";
  49 const char *kSecXPCKeyDigest = "digest";
  50 const char *kSecXPCKeyCertificate = "cert";
  51 const char *kSecXPCKeySettings = "settings";
  52 const char *kSecXPCKeyOTAFileDirectory = "path";
  53 const char *kSecXPCLimitInMinutes = "limitMinutes";
  54 const char *kSecXPCPublicPeerId = "publicPeerId"; // Public peer id
  55 const char *kSecXPCOTRSession = "otrsess"; // OTR session bytes
  56 const char *kSecXPCData = "data"; // Data to process
  57 const char *kSecXPCOTRReady = "otrrdy"; // OTR ready for messages
  58 const char *kSecXPCKeyDeviceID = "deviceID";
  59 const char *kSecXPCKeySendIDSMessage = "sendIDSMessageCommand";
  60 const char *kSecXPCKeyIDSMessage = "idsMessage";
  61 const char *kSecXPCKeyViewName = "viewname";
  62 const char *kSecXPCKeyViewActionCode = "viewactioncode";
  63 const char *kSecXPCKeyHSA2AutoAcceptInfo = "autoacceptinfo";
  64 const char *kSecXPCKeyString = "cfstring";
  65 const char *kSecXPCKeyArray = "cfarray";
  66 const char *kSecXPCKeySet = "cfset";
  67 const char *kSecXPCKeySet2 = "cfset2";
  68 const char *kSecXPCKeyNewPublicBackupKey = "newPublicBackupKey";
  69 const char *kSecXPCKeyRecoveryPublicKey = "RecoveryPublicKey";
  70 const char *kSecXPCKeyIncludeV0 = "includeV0";
  71 const char *kSecXPCKeyReason = "reason";
  72 const char *kSecXPCKeyEnabledViewsKey = "enabledViews";
  73 const char *kSecXPCKeyDisabledViewsKey = "disabledViews";
  74 const char *kSecXPCKeyEscrowLabel = "escrow";
  75 const char *kSecXPCKeyTriesLabel = "tries";
  76 const char *kSecXPCKeyFileDescriptor = "fileDescriptor";
  77 const char *kSecXPCKeyAccessGroups = "accessGroups";
  78 const char *kSecXPCKeyClasses = "classes";
  79 const char *kSecXPCKeyNormalizedIssuer = "normIssuer";
  80 const char *kSecXPCKeySerialNumber = "serialNum";
  81 const char *kSecXPCKeyBackupKeybagIdentifier = "backupKeybagID";
  82 const char *kSecXPCKeyBackupKeybagPath = "backupKeybagPath";
  83 const char *kSecXPCVersion = "version";
  84
  85 //
  86 // XPC Functions for both client and server.
  87 //
  88
  89
  90 CFStringRef SOSCCGetOperationDescription(enum SecXPCOperation op)
  91 {
  92     switch (op) {
  93         case kSecXPCOpAccountSetToNew:
  94             return CFSTR("AccountSetToNew");
  95         case kSecXPCOpOTAGetEscrowCertificates:
  96             return CFSTR("OTAGetEscrowCertificates");
  97         case kSecXPCOpOTAPKIGetNewAsset:
  98             return CFSTR("OTAPKIGetNewAsset");
  99         case kSecXPCOpAcceptApplicants:
 100             return CFSTR("AcceptApplicants");
 101         case kSecXPCOpApplyToARing:
 102             return CFSTR("ApplyToARing");
 103         case kSecXPCOpBailFromCircle:
 104             return CFSTR("BailFromCircle");
 105         case kSecXPCOpCanAuthenticate:
 106             return CFSTR("CanAuthenticate");
 107         case kSecXPCOpCopyApplicantPeerInfo:
 108             return CFSTR("CopyApplicantPeerInfo");
 109         case kSecXPCOpCopyConcurringPeerPeerInfo:
 110             return CFSTR("CopyConcurringPeerPeerInfo");
 111         case kSecXPCOpCopyEngineState:
 112             return CFSTR("CopyEngineState");
 113         case kSecXPCOpCopyGenerationPeerInfo:
 114             return CFSTR("CopyGenerationPeerInfo");
 115         case kSecXPCOpCopyIncompatibilityInfo:
 116             return CFSTR("CopyIncompatibilityInfo");
 117         case kSecXPCOpCopyMyPeerInfo:
 118             return CFSTR("CopyMyPeerInfo");
 119         case kSecXPCOpCopyNotValidPeerPeerInfo:
 120             return CFSTR("CopyNotValidPeerPeerInfo");
 121         case kSecXPCOpCopyPeerPeerInfo:
 122             return CFSTR("CopyPeerPeerInfo");
 123         case kSecXPCOpCopyRetirementPeerInfo:
 124             return CFSTR("CopyRetirementPeerInfo");
 125         case kSecXPCOpCopyValidPeerPeerInfo:
 126             return CFSTR("CopyValidPeerPeerInfo");
 127         case kSecXPCOpCopyViewUnawarePeerInfo:
 128             return CFSTR("CopyViewUnawarePeerInfo");
 129         case kSecXPCOpDeviceInCircle:
 130             return CFSTR("DeviceInCircle");
 131         case kSecXPCOpEnableRing:
 132             return CFSTR("EnableRing");
 133         case kSecXPCOpGetAllTheRings:
 134             return CFSTR("GetAllTheRings");
 135         case kSecXPCOpGetLastDepartureReason:
 136             return CFSTR("GetLastDepartureReason");
 137         case kSecXPCOpHandleIDSMessage:
 138             return CFSTR("HandleIDSMessage");
 139         case kSecXPCOpSyncWithKVSPeer:
 140             return CFSTR("SyncKVSPeer");
 141         case kSecXPCOpSyncWithIDSPeer:
 142             return CFSTR("SyncIDSPeer");
 143         case kSecXPCOpIDSDeviceID:
 144             return CFSTR("IDSDeviceID");
 145         case kSecXPCOpClearKVSPeerMessage:
 146             return CFSTR("kSecXPCOpClearKVSPeerMessage");
 147         case kSecXPCOpLoggedOutOfAccount:
 148             return CFSTR("LoggedOutOfAccount");
 149         case kSecXPCOpPingTest:
 150             return CFSTR("PingTest");
 151         case kSecXPCOpProcessSyncWithAllPeers:
 152             return CFSTR("ProcessSyncWithAllPeers");
 153         case kSecXPCOpProcessSyncWithPeers:
 154             return CFSTR("ProcessSyncWithPeers");
 155         case kSecXPCOpProcessUnlockNotification:
 156             return CFSTR("ProcessUnlockNotification");
 157         case kSecXPCOpPurgeUserCredentials:
 158             return CFSTR("PurgeUserCredentials");
 159         case kSecXPCOpRejectApplicants:
 160             return CFSTR("RejectApplicants");
 161         case kSecXPCOpRemoveThisDeviceFromCircle:
 162             return CFSTR("RemoveThisDeviceFromCircle");
 163         case kSecXPCOpRemovePeersFromCircle:
 164             return CFSTR("RemovePeersFromCircle");
 165         case kSecXPCOpRequestDeviceID:
 166             return CFSTR("RequestDeviceID");
 167         case kSecXPCOpRequestEnsureFreshParameters:
 168             return CFSTR("RequestEnsureFreshParameters");
 169         case kSecXPCOpRequestToJoin:
 170             return CFSTR("RequestToJoin");
 171         case kSecXPCOpRequestToJoinAfterRestore:
 172             return CFSTR("RequestToJoinAfterRestore");
 173         case kSecXPCOpResetToEmpty:
 174             return CFSTR("ResetToEmpty");
 175         case kSecXPCOpResetToOffering:
 176             return CFSTR("ResetToOffering");
 177         case kSecXPCOpRingStatus:
 178             return CFSTR("RingStatus");
 179         case kSecXPCOpRollKeys:
 180             return CFSTR("RollKeys");
 181         case kSecXPCOpSecurityProperty:
 182             return CFSTR("SecurityProperty");
 183         case kSecXPCOpSendIDSMessage:
 184             return CFSTR("SendIDSMessage");
 185         case kSecXPCOpSetBagForAllSlices:
 186             return CFSTR("SetBagForAllSlices");
 187         case kSecXPCOpSetDeviceID:
 188             return CFSTR("SetDeviceID");
 189         case kSecXPCOpSetLastDepartureReason:
 190             return CFSTR("SetLastDepartureReason");
 191         case kSecXPCOpSetNewPublicBackupKey:
 192             return CFSTR("SetNewPublicBackupKey");
 193         case kSecXPCOpSetUserCredentials:
 194             return CFSTR("SetUserCredentials");
 195         case kSecXPCOpSetUserCredentialsAndDSID:
 196             return CFSTR("SetUserCredentialsAndDSID");
 197         case kSecXPCOpTryUserCredentials:
 198             return CFSTR("TryUserCredentials");
 199         case kSecXPCOpValidateUserPublic:
 200             return CFSTR("ValidateUserPublic");
 201         case kSecXPCOpView:
 202             return CFSTR("View");
 203         case kSecXPCOpWithdrawlFromARing:
 204             return CFSTR("WithdrawlFromARing");
 205         case sec_add_shared_web_credential_id:
 206             return CFSTR("add_shared_web_credential");
 207         case sec_copy_shared_web_credential_id:
 208             return CFSTR("copy_shared_web_credential");
 209         case sec_delete_all_id:
 210             return CFSTR("delete_all");
 211         case sec_get_log_settings_id:
 212             return CFSTR("get_log_settings");
 213         case sec_item_add_id:
 214             return CFSTR("add");
 215         case sec_item_backup_copy_names_id:
 216             return CFSTR("backup_copy_names");
 217         case sec_item_backup_handoff_fd_id:
 218             return CFSTR("backup_handoff_fd");
 219         case sec_item_backup_restore_id:
 220             return CFSTR("backup_restore");
 221         case sec_item_backup_set_confirmed_manifest_id:
 222             return CFSTR("backup_set_confirmed_manifest");
 223         case sec_item_copy_matching_id:
 224             return CFSTR("copy_matching");
 225         case sec_item_delete_id:
 226             return CFSTR("delete");
 227         case sec_item_update_id:
 228             return CFSTR("update");
 229         case sec_keychain_backup_id:
 230             return CFSTR("keychain_backup");
 231         case sec_keychain_backup_syncable_id:
 232             return CFSTR("keychain_backup_syncable");
 233         case sec_keychain_restore_id:
 234             return CFSTR("keychain_restore");
 235         case sec_keychain_restore_syncable_id:
 236             return CFSTR("keychain_restore_syncable");
 237         case sec_keychain_sync_update_message_id:
 238             return CFSTR("keychain_sync_update_message");
 239         case sec_ota_pki_asset_version_id:
 240             return CFSTR("ota_pki_asset_version");
 241         case sec_otr_session_create_remote_id:
 242             return CFSTR("otr_session_create_remote");
 243         case sec_otr_session_process_packet_remote_id:
 244             return CFSTR("otr_session_process_packet_remote");
 245         case sec_set_circle_log_settings_id:
 246             return CFSTR("set_circle_log_settings");
 247         case sec_set_xpc_log_settings_id:
 248             return CFSTR("set_xpc_log_settings");
 249         case sec_trust_evaluate_id:
 250             return CFSTR("trust_evaluate");
 251         case sec_trust_store_contains_id:
 252             return CFSTR("trust_store_contains");
 253         case sec_trust_store_remove_certificate_id:
 254             return CFSTR("trust_store_remove_certificate");
 255         case sec_trust_store_set_trust_settings_id:
 256             return CFSTR("trust_store_set_trust_settings");
 257         case sec_trust_store_copy_all_id:
 258             return CFSTR("trust_store_copy_all");
 259         case sec_trust_store_copy_usage_constraints_id:
 260             return CFSTR("trust_store_copy_usage_constraints");
 261         case soscc_EnsurePeerRegistration_id:
 262             return CFSTR("EnsurePeerRegistration");
 263         case kSecXPCOpSetEscrowRecord:
 264             return CFSTR("SetEscrowRecord");
 265         case kSecXPCOpGetEscrowRecord:
 266             return CFSTR("GetEscrowRecord");
 267         case kSecXPCOpWhoAmI:
 268             return CFSTR("WhoAmI");
 269         case kSecXPCOpTransmogrifyToSyncBubble:
 270             return CFSTR("TransmogrifyToSyncBubble");
 271         case kSecXPCOpWrapToBackupSliceKeyBagForView:
 272             return CFSTR("WrapToBackupSliceKeyBagForView");
 273         case kSecXPCOpCopyAccountData:
 274             return CFSTR("CopyAccountDataFromKeychain");
 275         case kSecXPCOpDeleteAccountData:
 276             return CFSTR("DeleteAccountDataFromKeychain");
 277         case kSecXPCOpCopyEngineData:
 278             return CFSTR("CopyEngineDataFromKeychain");
 279         case kSecXPCOpDeleteEngineData:
 280             return CFSTR("DeleteEngineDataFromKeychain");
 281         case sec_item_update_token_items_id:
 282             return CFSTR("UpdateTokenItems");
 283         case sec_delete_items_with_access_groups_id:
 284             return CFSTR("sec_delete_items_with_access_groups_id");
 285         case kSecXPCOpPeersHaveViewsEnabled:
 286             return CFSTR("kSecXPCOpPeersHaveViewsEnabled");
 287         case kSecXPCOpRegisterRecoveryPublicKey:
 288             return CFSTR("RegisterRecoveryPublicKey");
 289         case kSecXPCOpGetRecoveryPublicKey:
 290             return CFSTR("GetRecoveryPublicKey");
 291         case kSecXPCOpCopyBackupInformation:
 292             return CFSTR("CopyBackupInformation");
 293         case kSecXPCOpMessageFromPeerIsPending:
 294             return CFSTR("MessageFromPeerIsPending");
 295         case kSecXPCOpSendToPeerIsPending:
 296             return CFSTR("SendToPeerIsPending");
 297         case sec_item_copy_parent_certificates_id:
 298             return CFSTR("copy_parent_certificates");
 299         case sec_item_certificate_exists_id:
 300             return CFSTR("certificate_exists");
 301         case kSecXPCOpCKKSEndpoint:
 302             return CFSTR("CKKSEndpoint");
 303         case kSecXPCOpSOSEndpoint:
 304             return CFSTR("SOSEndpoint");
 305         case kSecXPCOpSecuritydXPCServerEndpoint:
 306             return CFSTR("XPCServerEndpoint");
 307         case kSecXPCOpBackupKeybagAdd:
 308             return CFSTR("KeybagAdd");
 309         case kSecXPCOpBackupKeybagDelete:
 310             return CFSTR("KeybagDelete");
 311         default:
 312             return CFSTR("Unknown xpc operation");
 313     }
 314 }
 315
 316 bool SecXPCDictionarySetPList(xpc_object_t message, const char *key, CFTypeRef object, CFErrorRef *error)
 317 {
 318     if (!object)
 319         return SecError(errSecParam, error, CFSTR("object for key %s is NULL"), key);
 320
 321     size_t size = der_sizeof_plist(object, error);
 322     if (!size)
 323         return false;
 324     uint8_t *der = malloc(size);
 325     uint8_t *der_end = der + size;
 326     uint8_t *der_start = der_encode_plist(object, error, der, der_end);
 327     if (!der_start) {
 328         free(der);
 329         return false;
 330     }
 331
 332     assert(der == der_start);
 333     xpc_dictionary_set_data(message, key, der_start, der_end - der_start);
 334     free(der);
 335     return true;
 336 }
 337
 338 bool SecXPCDictionarySetPListOptional(xpc_object_t message, const char *key, CFTypeRef object, CFErrorRef *error) {
 339     return !object || SecXPCDictionarySetPList(message, key, object, error);
 340 }
 341
 342 bool SecXPCDictionarySetData(xpc_object_t message, const char *key, CFDataRef data, CFErrorRef *error)
 343 {
 344     if (!data)
 345         return SecError(errSecParam, error, CFSTR("data for key %s is NULL"), key);
 346
 347     xpc_dictionary_set_data(message, key, CFDataGetBytePtr(data), CFDataGetLength(data));
 348     return true;
 349 }
 350
 351 bool SecXPCDictionarySetBool(xpc_object_t message, const char *key, bool value, CFErrorRef *error)
 352 {
 353     xpc_dictionary_set_bool(message, key, value);
 354     return true;
 355 }
 356
 357 bool SecXPCDictionarySetString(xpc_object_t message, const char *key, CFStringRef string, CFErrorRef *error)
 358 {
 359     if (!string)
 360         return SecError(errSecParam, error, CFSTR("string for key %s is NULL"), key);
 361
 362     __block bool ok = true;
 363     CFStringPerformWithCString(string, ^(const char *utf8Str) {
 364         if (utf8Str)
 365             xpc_dictionary_set_string(message, key, utf8Str);
 366         else
 367             ok = SecError(errSecParam, error, CFSTR("failed to convert string for key %s to utf8"), key);
 368     });
 369     return ok;
 370 }
 371
 372 bool SecXPCDictionarySetStringOptional(xpc_object_t message, const char *key, CFStringRef string, CFErrorRef *error) {
 373     return !string || SecXPCDictionarySetString(message, key, string, error);
 374 }
 375
 376 bool SecXPCDictionarySetDataOptional(xpc_object_t message, const char *key, CFDataRef data, CFErrorRef *error) {
 377     return !data || SecXPCDictionarySetData(message, key, data, error);
 378 }
 379
 380 bool SecXPCDictionarySetInt64(xpc_object_t message, const char *key, int64_t value, CFErrorRef *error) {
 381     xpc_dictionary_set_int64(message, key, value);
 382     return true;
 383 }
 384
 385 bool SecXPCDictionarySetFileDescriptor(xpc_object_t message, const char *key, int fd, CFErrorRef *error) {
 386     xpc_dictionary_set_fd(message, key, fd);
 387     return true;
 388 }
 389
 390 int SecXPCDictionaryDupFileDescriptor(xpc_object_t message, const char *key, CFErrorRef *error) {
 391     int fd = xpc_dictionary_dup_fd(message, key);
 392     if (fd < 0)
 393         SecError(errSecParam, error, CFSTR("missing fd for key %s"), key);
 394
 395     return fd;
 396 }
 397
 398 CFSetRef SecXPCDictionaryCopySet(xpc_object_t message, const char *key, CFErrorRef *error) {
 399     CFTypeRef obj = SecXPCDictionaryCopyPList(message, key, error);
 400     CFSetRef set = copyIfSet(obj, error);
 401     if (obj && !set) {
 402         CFStringRef description = CFCopyTypeIDDescription(CFGetTypeID(obj));
 403         SecError(errSecParam, error, CFSTR("object for key %s not set but %@"), key, description);
 404         CFReleaseNull(description);
 405     }
 406     CFReleaseNull(obj);
 407     return set;
 408 }
 409
 410 CFArrayRef SecXPCDictionaryCopyArray(xpc_object_t message, const char *key, CFErrorRef *error) {
 411     CFTypeRef array = SecXPCDictionaryCopyPList(message, key, error);
 412     if (array) {
 413         CFTypeID type_id = CFGetTypeID(array);
 414         if (type_id != CFArrayGetTypeID()) {
 415             CFStringRef description = CFCopyTypeIDDescription(type_id);
 416             SecError(errSecParam, error, CFSTR("object for key %s not array but %@"), key, description);
 417             CFReleaseNull(description);
 418             CFReleaseNull(array);
 419         }
 420     }
 421     return (CFArrayRef)array;
 422 }
 423
 424 bool SecXPCDictionaryCopyArrayOptional(xpc_object_t message, const char *key, CFArrayRef *parray, CFErrorRef *error) {
 425     if (!xpc_dictionary_get_value(message, key)) {
 426         *parray = NULL;
 427         return true;
 428     }
 429     *parray = SecXPCDictionaryCopyArray(message, key, error);
 430     return *parray;
 431 }
 432
 433 CFDataRef SecXPCDictionaryCopyData(xpc_object_t message, const char *key, CFErrorRef *error) {
 434     CFDataRef data = NULL;
 435     size_t size = 0;
 436     const uint8_t *bytes = xpc_dictionary_get_data(message, key, &size);
 437     if (!bytes) {
 438         SecError(errSecParam, error, CFSTR("no data for key %s"), key);
 439         return NULL;
 440     }
 441
 442     data = CFDataCreate(kCFAllocatorDefault, bytes, size);
 443     if (!data)
 444         SecError(errSecParam, error, CFSTR("failed to create data for key %s"), key);
 445
 446     return data;
 447 }
 448
 449 bool SecXPCDictionaryGetBool(xpc_object_t message, const char *key, CFErrorRef *__unused error) {
 450     return xpc_dictionary_get_bool(message, key);
 451 }
 452
 453 bool SecXPCDictionaryGetDouble(xpc_object_t message, const char *key, double *pvalue, CFErrorRef *error) {
 454     *pvalue = xpc_dictionary_get_double(message, key);
 455     if (*pvalue == NAN) {
 456         return SecError(errSecParam, error, CFSTR("object for key %s bad double"), key);
 457     }
 458     return true;
 459 }
 460
 461 bool SecXPCDictionaryCopyDataOptional(xpc_object_t message, const char *key, CFDataRef *pdata, CFErrorRef *error) {
 462     size_t size = 0;
 463     if (!xpc_dictionary_get_data(message, key, &size)) {
 464         *pdata = NULL;
 465         return true;
 466     }
 467     *pdata = SecXPCDictionaryCopyData(message, key, error);
 468     return *pdata;
 469 }
 470
 471 bool SecXPCDictionaryCopyURLOptional(xpc_object_t message, const char *key, CFURLRef *purl, CFErrorRef *error) {
 472     size_t size = 0;
 473     if (!xpc_dictionary_get_data(message, key, &size)) {
 474         *purl = NULL;
 475         return true;
 476     }
 477     CFDataRef data = SecXPCDictionaryCopyData(message, key, error);
 478     if (data) {
 479         *purl = CFURLCreateWithBytes(kCFAllocatorDefault, CFDataGetBytePtr(data), CFDataGetLength(data), kCFStringEncodingUTF8, NULL);
 480     }
 481     CFReleaseNull(data);
 482     return *purl;
 483 }
 484
 485 CFDictionaryRef SecXPCDictionaryCopyDictionary(xpc_object_t message, const char *key, CFErrorRef *error) {
 486     CFTypeRef dict = SecXPCDictionaryCopyPList(message, key, error);
 487     if (dict) {
 488         CFTypeID type_id = CFGetTypeID(dict);
 489         if (type_id != CFDictionaryGetTypeID()) {
 490             CFStringRef description = CFCopyTypeIDDescription(type_id);
 491             SecError(errSecParam, error, CFSTR("object for key %s not dictionary but %@"), key, description);
 492             CFReleaseNull(description);
 493             CFReleaseNull(dict);
 494         }
 495     }
 496     return (CFDictionaryRef)dict;
 497 }
 498
 499 bool SecXPCDictionaryCopyDictionaryOptional(xpc_object_t message, const char *key, CFDictionaryRef *pdictionary, CFErrorRef *error) {
 500     if (!xpc_dictionary_get_value(message, key)) {
 501         *pdictionary = NULL;
 502         return true;
 503     }
 504     *pdictionary = SecXPCDictionaryCopyDictionary(message, key, error);
 505     return *pdictionary;
 506 }
 507
 508 CFTypeRef SecXPCDictionaryCopyPList(xpc_object_t message, const char *key, CFErrorRef *error)
 509 {
 510     CFTypeRef cfobject = NULL;
 511     size_t size = 0;
 512     const uint8_t *der = xpc_dictionary_get_data(message, key, &size);
 513     if (!der) {
 514         SecError(errSecParam, error, CFSTR("no object for key %s"), key);
 515         return NULL;
 516     }
 517
 518     const uint8_t *der_end = der + size;
 519     /* use the sensitive allocator so that the dictionary is zeroized upon deallocation */
 520     const uint8_t *decode_end = der_decode_plist(SecCFAllocatorZeroize(), kCFPropertyListImmutable,
 521                                           &cfobject, error, der, der_end);
 522     if (decode_end != der_end) {
 523         SecError(errSecParam, error, CFSTR("trailing garbage after der decoded object for key %s"), key);
 524         CFReleaseNull(cfobject);
 525     }
 526
 527     /* zeroize xpc value as it may have contained raw key material */
 528     cc_clear(size, (void *)der);
 529
 530     return cfobject;
 531 }
 532
 533 bool SecXPCDictionaryCopyPListOptional(xpc_object_t message, const char *key, CFTypeRef *pobject, CFErrorRef *error) {
 534     size_t size = 0;
 535     if (!xpc_dictionary_get_data(message, key, &size)) {
 536         *pobject = NULL;
 537         return true;
 538     }
 539     *pobject = SecXPCDictionaryCopyPList(message, key, error);
 540     return *pobject;
 541 }
 542
 543 CFStringRef SecXPCDictionaryCopyString(xpc_object_t message, const char *key, CFErrorRef *error) {
 544     const char *string = xpc_dictionary_get_string(message, key);
 545     if (string) {
 546         CFStringRef result = CFStringCreateWithCString(kCFAllocatorDefault, string, kCFStringEncodingUTF8);
 547         if (!result) {
 548             SecError(errSecAllocate, error, CFSTR("object for key %s failed to convert %s to CFString"), key, string);
 549         }
 550         return result;
 551     } else {
 552         SecError(errSecParam, error, CFSTR("object for key %s not string"), key);
 553         return NULL;
 554     }
 555 }
 556
 557 bool SecXPCDictionaryCopyStringOptional(xpc_object_t message, const char *key, CFStringRef *pstring, CFErrorRef *error) {
 558     if (!xpc_dictionary_get_value(message, key)) {
 559         *pstring = NULL;
 560         return true;
 561     }
 562     *pstring = SecXPCDictionaryCopyString(message, key, error);
 563     return *pstring;
 564 }
 565
 566 static CFDataRef CFDataCreateWithXPCArrayAtIndex(xpc_object_t xpc_data_array, size_t index, CFErrorRef *error) {
 567     CFDataRef data = NULL;
 568     size_t length = 0;
 569     const uint8_t *bytes = xpc_array_get_data(xpc_data_array, index, &length);
 570     if (bytes) {
 571         data = CFDataCreate(kCFAllocatorDefault, bytes, length);
 572     }
 573     if (!data)
 574         SecError(errSecParam, error, CFSTR("data_array[%zu] failed to decode"), index);
 575
 576     return data;
 577 }
 578
 579 static CFArrayRef CFDataXPCArrayCopyArray(xpc_object_t xpc_data_array, CFErrorRef *error) {
 580     CFMutableArrayRef data_array = NULL;
 581     require_action_quiet(xpc_get_type(xpc_data_array) == XPC_TYPE_ARRAY, exit,
 582                          SecError(errSecParam, error, CFSTR("data_array xpc value is not an array")));
 583     size_t count = xpc_array_get_count(xpc_data_array);
 584     require_action_quiet(data_array = CFArrayCreateMutable(kCFAllocatorDefault, count, &kCFTypeArrayCallBacks), exit,
 585                          SecError(errSecAllocate, error, CFSTR("failed to create CFArray of capacity %zu"), count));
 586
 587     size_t ix;
 588     for (ix = 0; ix < count; ++ix) {
 589         CFDataRef data = CFDataCreateWithXPCArrayAtIndex(xpc_data_array, ix, error);
 590         if (!data) {
 591             CFRelease(data_array);
 592             return NULL;
 593         }
 594         CFArraySetValueAtIndex(data_array, ix, data);
 595         CFRelease(data);
 596     }
 597
 598 exit:
 599     return data_array;
 600 }
 601
 602 bool SecXPCDictionaryCopyCFDataArrayOptional(xpc_object_t message, const char *key, CFArrayRef *data_array, CFErrorRef *error) {
 603     xpc_object_t xpc_data_array = xpc_dictionary_get_value(message, key);
 604     if (!xpc_data_array) {
 605         if (data_array)
 606             *data_array = NULL;
 607         return true;
 608     }
 609     *data_array = CFDataXPCArrayCopyArray(xpc_data_array, error);
 610     return *data_array != NULL;
 611 }