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