OSX/sec/Security/SecKey.c

   1 /*
   2  * Copyright (c) 2006-2015 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  * SecKey.c - CoreFoundation based key object
  26  */
  27 #include <Security/SecBase.h>
  28
  29 #include <Security/SecKeyInternal.h>
  30 #include <Security/SecItem.h>
  31 #include <Security/SecItemPriv.h>
  32 #include <Security/SecItemShim.h>
  33 #include <Security/SecFramework.h>
  34
  35 #include <utilities/SecIOFormat.h>
  36
  37 #include <utilities/SecCFWrappers.h>
  38 #include <utilities/array_size.h>
  39
  40 #include "SecRSAKeyPriv.h"
  41 #include "SecECKeyPriv.h"
  42 #include "SecCTKKeyPriv.h"
  43 #include "SecBasePriv.h"
  44 #include <Security/SecKeyPriv.h>
  45
  46 #include <CoreFoundation/CFNumber.h>
  47 #include <CoreFoundation/CFString.h>
  48 #include <pthread.h>
  49 #include <string.h>
  50 #include <AssertMacros.h>
  51 #include <utilities/debugging.h>
  52 #include <utilities/SecCFError.h>
  53 #include <CommonCrypto/CommonDigest.h>
  54 #include <Security/SecAsn1Coder.h>
  55 #include <Security/oidsalg.h>
  56 #include <Security/SecInternal.h>
  57 #include <Security/SecRandom.h>
  58 #include <Security/SecureTransport.h> /* For error codes. */
  59
  60 #include <corecrypto/ccrng_system.h>
  61
  62 #include <asl.h>
  63 #include <stdlib.h>
  64 #include <syslog.h>
  65
  66 #include <libDER/asn1Types.h>
  67 #include <libDER/DER_Keys.h>
  68 #include <libDER/DER_Encode.h>
  69
  70 CFDataRef SecKeyCopyPublicKeyHash(SecKeyRef key)
  71 {
  72         CFDataRef pubKeyDigest = NULL, pubKeyBlob = NULL;
  73
  74         /* encode the public key. */
  75     require_noerr_quiet(SecKeyCopyPublicBytes(key, &pubKeyBlob), errOut);
  76     require_quiet(pubKeyBlob, errOut);
  77
  78         /* Calculate the digest of the public key. */
  79         require_quiet(pubKeyDigest = SecSHA1DigestCreate(CFGetAllocator(key),
  80                                                      CFDataGetBytePtr(pubKeyBlob), CFDataGetLength(pubKeyBlob)),
  81                         errOut);
  82 errOut:
  83     CFReleaseNull(pubKeyBlob);
  84     return pubKeyDigest;
  85 }
  86
  87
  88 /*
  89  */
  90 static CFDictionaryRef SecKeyCopyAttributeDictionaryWithLocalKey(SecKeyRef key,
  91                                                                  CFTypeRef keyType,
  92                                                                  CFDataRef privateBlob)
  93 {
  94         CFAllocatorRef allocator = CFGetAllocator(key);
  95         DICT_DECLARE(25);
  96         CFDataRef pubKeyDigest = NULL, pubKeyBlob = NULL;
  97         CFDictionaryRef dict = NULL;
  98
  99     size_t sizeValue = SecKeyGetSize(key, kSecKeyKeySizeInBits);
 100     CFNumberRef sizeInBits = CFNumberCreate(allocator, kCFNumberLongType, &sizeValue);
 101
 102         /* encode the public key. */
 103     require_noerr_quiet(SecKeyCopyPublicBytes(key, &pubKeyBlob), errOut);
 104     require_quiet(pubKeyBlob, errOut);
 105
 106         /* Calculate the digest of the public key. */
 107         require_quiet(pubKeyDigest = SecSHA1DigestCreate(allocator,
 108                                                      CFDataGetBytePtr(pubKeyBlob), CFDataGetLength(pubKeyBlob)),
 109                   errOut);
 110
 111         DICT_ADDPAIR(kSecClass, kSecClassKey);
 112         DICT_ADDPAIR(kSecAttrKeyClass, privateBlob ? kSecAttrKeyClassPrivate : kSecAttrKeyClassPublic);
 113         DICT_ADDPAIR(kSecAttrApplicationLabel, pubKeyDigest);
 114         DICT_ADDPAIR(kSecAttrIsPermanent, kCFBooleanTrue);
 115         DICT_ADDPAIR(kSecAttrIsPrivate, kCFBooleanTrue);
 116         DICT_ADDPAIR(kSecAttrIsModifiable, kCFBooleanTrue);
 117         DICT_ADDPAIR(kSecAttrKeyType, keyType);
 118         DICT_ADDPAIR(kSecAttrKeySizeInBits, sizeInBits);
 119         DICT_ADDPAIR(kSecAttrEffectiveKeySize, sizeInBits);
 120         DICT_ADDPAIR(kSecAttrIsSensitive, kCFBooleanFalse);
 121         DICT_ADDPAIR(kSecAttrWasAlwaysSensitive, kCFBooleanFalse);
 122         DICT_ADDPAIR(kSecAttrIsExtractable, kCFBooleanTrue);
 123         DICT_ADDPAIR(kSecAttrWasNeverExtractable, kCFBooleanFalse);
 124         DICT_ADDPAIR(kSecAttrCanEncrypt, privateBlob ? kCFBooleanFalse : kCFBooleanTrue);
 125         DICT_ADDPAIR(kSecAttrCanDecrypt, privateBlob ? kCFBooleanTrue : kCFBooleanFalse);
 126         DICT_ADDPAIR(kSecAttrCanDerive, kCFBooleanTrue);
 127         DICT_ADDPAIR(kSecAttrCanSign, privateBlob ? kCFBooleanTrue : kCFBooleanFalse);
 128         DICT_ADDPAIR(kSecAttrCanVerify, privateBlob ? kCFBooleanFalse : kCFBooleanTrue);
 129         DICT_ADDPAIR(kSecAttrCanSignRecover, kCFBooleanFalse);
 130         DICT_ADDPAIR(kSecAttrCanVerifyRecover, kCFBooleanFalse);
 131         DICT_ADDPAIR(kSecAttrCanWrap, privateBlob ? kCFBooleanFalse : kCFBooleanTrue);
 132         DICT_ADDPAIR(kSecAttrCanUnwrap, privateBlob ? kCFBooleanTrue : kCFBooleanFalse);
 133         DICT_ADDPAIR(kSecValueData, privateBlob ? privateBlob : pubKeyBlob);
 134     dict = CFDictionaryCreate(allocator, keys, values, numValues, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
 135
 136 errOut:
 137         // @@@ Zero out key material.
 138         CFReleaseSafe(pubKeyDigest);
 139         CFReleaseSafe(pubKeyBlob);
 140         CFReleaseSafe(sizeInBits);
 141
 142         return dict;
 143 }
 144
 145 CFDictionaryRef SecKeyGeneratePrivateAttributeDictionary(SecKeyRef key,
 146                                                          CFTypeRef keyType,
 147                                                          CFDataRef privateBlob)
 148 {
 149     return SecKeyCopyAttributeDictionaryWithLocalKey(key, keyType, privateBlob);
 150 }
 151
 152 CFDictionaryRef SecKeyGeneratePublicAttributeDictionary(SecKeyRef key, CFTypeRef keyType)
 153 {
 154     return SecKeyCopyAttributeDictionaryWithLocalKey(key, keyType, NULL);
 155 }
 156
 157 static CFStringRef SecKeyCopyDescription(CFTypeRef cf) {
 158     SecKeyRef key = (SecKeyRef)cf;
 159
 160     if(key->key_class->describe)
 161         return key->key_class->describe(key);
 162     else
 163         return CFStringCreateWithFormat(kCFAllocatorDefault,NULL,CFSTR("<SecKeyRef: %p>"), key);
 164 }
 165
 166 static void SecKeyDestroy(CFTypeRef cf) {
 167     SecKeyRef key = (SecKeyRef)cf;
 168 #if !TARGET_OS_IPHONE
 169     CFReleaseNull(key->cdsaKey);
 170 #endif
 171     if (key->key_class->destroy)
 172         key->key_class->destroy(key);
 173 }
 174
 175 static Boolean SecKeyEqual(CFTypeRef cf1, CFTypeRef cf2)
 176 {
 177     SecKeyRef key1 = (SecKeyRef)cf1;
 178     SecKeyRef key2 = (SecKeyRef)cf2;
 179     if (key1 == key2)
 180         return true;
 181     if (!key2 || key1->key_class != key2->key_class)
 182         return false;
 183     if (key1->key_class->version >= 4 && key1->key_class->isEqual)
 184         return key1->key_class->isEqual(key1, key2);
 185     if (key1->key_class->extraBytes)
 186         return !memcmp(key1->key, key2->key, key1->key_class->extraBytes);
 187
 188     /* TODO: Won't work when we get reference keys. */
 189     CFDictionaryRef d1, d2;
 190     d1 = SecKeyCopyAttributeDictionary(key1);
 191     d2 = SecKeyCopyAttributeDictionary(key2);
 192     // Returning NULL is an error; bail out of the equality check
 193     if(!d1 || !d2) {
 194         CFReleaseSafe(d1);
 195         CFReleaseSafe(d2);
 196         return false;
 197     }
 198     Boolean result = CFEqual(d1, d2);
 199     CFReleaseSafe(d1);
 200     CFReleaseSafe(d2);
 201     return result;
 202 }
 203
 204 struct ccrng_state *ccrng_seckey;
 205
 206 CFGiblisWithFunctions(SecKey, NULL, NULL, SecKeyDestroy, SecKeyEqual, NULL, NULL, SecKeyCopyDescription, NULL, NULL, ^{
 207     static struct ccrng_system_state ccrng_system_state_seckey;
 208     ccrng_seckey = (struct ccrng_state *)&ccrng_system_state_seckey;
 209     ccrng_system_init(&ccrng_system_state_seckey);
 210 })
 211
 212 static bool getBoolForKey(CFDictionaryRef dict, CFStringRef key, bool default_value) {
 213         CFTypeRef value = CFDictionaryGetValue(dict, key);
 214         if (value) {
 215                 if (CFGetTypeID(value) == CFBooleanGetTypeID()) {
 216                         return CFBooleanGetValue(value);
 217                 } else {
 218                         secwarning("Value %@ for key %@ is not bool", value, key);
 219                 }
 220         }
 221
 222         return default_value;
 223 }
 224
 225 static OSStatus add_ref(CFTypeRef item, CFMutableDictionaryRef dict) {
 226         CFDictionarySetValue(dict, kSecValueRef, item);
 227         return SecItemAdd(dict, NULL);
 228 }
 229
 230 static void merge_params_applier(const void *key, const void *value,
 231                                  void *context) {
 232         CFMutableDictionaryRef result = (CFMutableDictionaryRef)context;
 233         CFDictionaryAddValue(result, key, value);
 234 }
 235
 236 /* Create a mutable dictionary that is based on the subdictionary for key
 237  with any attributes from the top level dict merged in. */
 238 static CF_RETURNS_RETAINED CFMutableDictionaryRef merge_params(CFDictionaryRef dict,
 239                                                                CFStringRef key) {
 240         CFDictionaryRef subdict = CFDictionaryGetValue(dict, key);
 241         CFMutableDictionaryRef result;
 242
 243         if (subdict) {
 244                 result = CFDictionaryCreateMutableCopy(NULL, 0, subdict);
 245                 /* Add everything in dict not already in result to result. */
 246                 CFDictionaryApplyFunction(dict, merge_params_applier, result);
 247         } else {
 248                 result = CFDictionaryCreateMutableCopy(NULL, 0, dict);
 249         }
 250
 251         /* Remove values that only belong in the top level dict. */
 252         CFDictionaryRemoveValue(result, kSecPublicKeyAttrs);
 253         CFDictionaryRemoveValue(result, kSecPrivateKeyAttrs);
 254         CFDictionaryRemoveValue(result, kSecAttrKeyType);
 255         CFDictionaryRemoveValue(result, kSecAttrKeySizeInBits);
 256
 257         return result;
 258 }
 259
 260 CFIndex SecKeyGetAlgorithmIdentifier(SecKeyRef key) {
 261     if (!key || !key->key_class)  {
 262     // TBD: somehow, a key can be created with a NULL key_class in the
 263     // SecCertificateCopyPublicKey -> SecKeyCreatePublicFromDER code path
 264         return kSecNullAlgorithmID;
 265     }
 266     /* This method was added to version 1 keys. */
 267     if (key->key_class->version > 0 && key->key_class->getAlgorithmID) {
 268         return key->key_class->getAlgorithmID(key);
 269     }
 270     /* All version 0 keys were RSA. */
 271     return kSecRSAAlgorithmID;
 272 }
 273
 274 /* Generate a private/public keypair. */
 275 OSStatus SecKeyGeneratePair(CFDictionaryRef parameters,
 276                             SecKeyRef *publicKey, SecKeyRef *privateKey) {
 277     OSStatus result = errSecUnsupportedAlgorithm;
 278     SecKeyRef privKey = NULL;
 279         SecKeyRef pubKey = NULL;
 280     CFMutableDictionaryRef pubParams = merge_params(parameters, kSecPublicKeyAttrs),
 281     privParams = merge_params(parameters, kSecPrivateKeyAttrs);
 282         CFStringRef ktype = CFDictionaryGetValue(parameters, kSecAttrKeyType);
 283     CFStringRef tokenID = CFDictionaryGetValue(parameters, kSecAttrTokenID);
 284
 285     require_quiet(ktype, errOut);
 286
 287     if (tokenID != NULL) {
 288         result = SecCTKKeyGeneratePair(parameters, &pubKey, &privKey);
 289     } else if (CFEqual(ktype, kSecAttrKeyTypeECSECPrimeRandom)) {
 290         result = SecECKeyGeneratePair(parameters, &pubKey, &privKey);
 291     } else if (CFEqual(ktype, kSecAttrKeyTypeRSA)) {
 292         result = SecRSAKeyGeneratePair(parameters, &pubKey, &privKey);
 293     }
 294
 295     require_noerr_quiet(result, errOut);
 296
 297     // Store the keys in the keychain if they are marked as permanent. Governed by kSecAttrIsPermanent attribute, with default
 298     // to 'false' (ephemeral keys), except private token-based keys, in which case the default is 'true' (permanent keys).
 299     if (getBoolForKey(pubParams, kSecAttrIsPermanent, false)) {
 300         CFDictionaryRemoveValue(pubParams, kSecAttrTokenID);
 301         require_noerr_quiet(result = add_ref(pubKey, pubParams), errOut);
 302     }
 303     if (getBoolForKey(privParams, kSecAttrIsPermanent, CFDictionaryContainsKey(privParams, kSecAttrTokenID))) {
 304         require_noerr_quiet(result = add_ref(privKey, privParams), errOut);
 305     }
 306
 307     if (publicKey) {
 308         *publicKey = pubKey;
 309         pubKey = NULL;
 310     }
 311     if (privateKey) {
 312         *privateKey = privKey;
 313         privKey = NULL;
 314     }
 315
 316 errOut:
 317         CFReleaseSafe(pubParams);
 318         CFReleaseSafe(privParams);
 319     CFReleaseSafe(pubKey);
 320     CFReleaseSafe(privKey);
 321
 322     return result;
 323 }
 324
 325 SecKeyRef SecKeyCreatePublicFromPrivate(SecKeyRef privateKey) {
 326     return SecKeyCopyPublicKey(privateKey);
 327 }
 328
 329 CFDictionaryRef CreatePrivateKeyMatchingQuery(SecKeyRef publicKey, bool returnPersistentRef)
 330 {
 331     const CFTypeRef refType = (returnPersistentRef) ? kSecReturnPersistentRef: kSecReturnRef;
 332
 333     CFDataRef public_key_hash = SecKeyCopyPublicKeyHash(publicKey);
 334
 335     CFDictionaryRef query = CFDictionaryCreateForCFTypes(kCFAllocatorDefault,
 336                                                          kSecClass,                 kSecClassKey,
 337                                                          kSecAttrKeyClass,          kSecAttrKeyClassPrivate,
 338                                                          kSecAttrSynchronizable,    kSecAttrSynchronizableAny,
 339                                                          kSecAttrApplicationLabel,  public_key_hash,
 340                                                          refType,                   kCFBooleanTrue,
 341                                                          NULL);
 342     CFReleaseNull(public_key_hash);
 343
 344     return query;
 345 }
 346
 347 CFDataRef SecKeyCreatePersistentRefToMatchingPrivateKey(SecKeyRef publicKey, CFErrorRef *error) {
 348     CFTypeRef persistentRef = NULL;
 349     CFDictionaryRef query = CreatePrivateKeyMatchingQuery(publicKey, true);
 350
 351     require_quiet(SecError(SecItemCopyMatching(query, &persistentRef),error ,
 352                            CFSTR("Error finding persistent ref to key from public: %@"), publicKey), fail);
 353 fail:
 354     CFReleaseNull(query);
 355     return (CFDataRef)persistentRef;
 356 }
 357
 358 SecKeyRef SecKeyCopyMatchingPrivateKey(SecKeyRef publicKey, CFErrorRef *error) {
 359     SecKeyRef privateKey = NULL;
 360     CFTypeRef queryResult = NULL;
 361     CFDictionaryRef query = NULL;
 362
 363     require_action_quiet(publicKey != NULL, errOut, SecError(errSecParam, error, CFSTR("Null Public Key")));
 364
 365     query = CreatePrivateKeyMatchingQuery(publicKey, false);
 366
 367     require_quiet(SecError(SecItemCopyMatching(query, &queryResult), error,
 368                            CFSTR("Error finding private key from public: %@"), publicKey), errOut);
 369
 370     if (CFGetTypeID(queryResult) == SecKeyGetTypeID()) {
 371         privateKey = (SecKeyRef) queryResult;
 372         queryResult = NULL;
 373     }
 374
 375 errOut:
 376     CFReleaseNull(query);
 377     CFReleaseNull(queryResult);
 378     return privateKey;
 379 }
 380
 381 OSStatus SecKeyGetMatchingPrivateKeyStatus(SecKeyRef publicKey, CFErrorRef *error) {
 382     OSStatus retval = errSecParam;
 383     CFTypeRef private_key = NULL;
 384     CFDictionaryRef query = NULL;
 385
 386     require_action_quiet(publicKey != NULL, errOut, SecError(errSecParam, error, NULL, CFSTR("Null Public Key")));
 387
 388     query = CreatePrivateKeyMatchingQuery(publicKey, false);
 389
 390     retval = SecItemCopyMatching(query, &private_key);
 391
 392     if (!retval && CFGetTypeID(private_key) != SecKeyGetTypeID()) {
 393         retval = errSecInternalComponent;
 394     }
 395
 396 errOut:
 397     CFReleaseNull(query);
 398     CFReleaseNull(private_key);
 399     return retval;
 400 }
 401
 402
 403 SecKeyRef SecKeyCreatePublicFromDER(CFAllocatorRef allocator,
 404                                     const SecAsn1Oid *oid, const SecAsn1Item *params,
 405                                     const SecAsn1Item *keyData) {
 406     SecKeyRef publicKey = NULL;
 407         if (SecAsn1OidCompare(oid, &CSSMOID_RSA)) {
 408         /* pkcs1 1 */
 409         /* Note that we call SecKeyCreateRSAPublicKey_ios directly instead of
 410            SecKeyCreateRSAPublicKey, since on OS X the latter function will return
 411            a CSSM SecKeyRef, and we always want an iOS format SecKeyRef here.
 412          */
 413                 publicKey = SecKeyCreateRSAPublicKey_ios(allocator,
 414                                              keyData->Data, keyData->Length, kSecKeyEncodingPkcs1);
 415         } else if (SecAsn1OidCompare(oid, &CSSMOID_ecPublicKey)) {
 416         SecDERKey derKey = {
 417             .oid = oid->Data,
 418             .oidLength = oid->Length,
 419             .key = keyData->Data,
 420             .keyLength = keyData->Length,
 421         };
 422         if (params) {
 423             derKey.parameters = params->Data;
 424             derKey.parametersLength = params->Length;
 425         }
 426                 publicKey = SecKeyCreateECPublicKey(allocator,
 427                                             (const uint8_t *)&derKey, sizeof(derKey), kSecDERKeyEncoding);
 428     } else {
 429                 secwarning("Unsupported algorithm oid");
 430         }
 431
 432     return publicKey;
 433 }
 434
 435
 436 SecKeyRef SecKeyCreateFromSubjectPublicKeyInfoData(CFAllocatorRef allocator, CFDataRef subjectPublicKeyInfoData)
 437 {
 438     DERReturn drtn;
 439
 440     DERItem subjectPublicKeyInfoDER = {
 441         .data = (uint8_t *)CFDataGetBytePtr(subjectPublicKeyInfoData),
 442         .length = (DERSize)CFDataGetLength(subjectPublicKeyInfoData),
 443     };
 444     DERSubjPubKeyInfo subjectPublicKeyInfo;
 445     DERAlgorithmId algorithmId;
 446     DERItem pubKeyBytes;
 447
 448     drtn = DERParseSequence(&subjectPublicKeyInfoDER,
 449                             DERNumSubjPubKeyInfoItemSpecs, DERSubjPubKeyInfoItemSpecs,
 450                             &subjectPublicKeyInfo, sizeof(subjectPublicKeyInfo));
 451
 452     require_noerr_quiet(drtn, out);
 453
 454     drtn = DERParseSequenceContent(&subjectPublicKeyInfo.algId,
 455                                    DERNumAlgorithmIdItemSpecs, DERAlgorithmIdItemSpecs,
 456                                    &algorithmId, sizeof(algorithmId));
 457     require_noerr_quiet(drtn, out);
 458
 459     DERByte unusedBits;
 460     drtn = DERParseBitString(&subjectPublicKeyInfo.pubKey, &pubKeyBytes, &unusedBits);
 461     require_noerr_quiet(drtn, out);
 462
 463     /* Convert DERItem to SecAsn1Item : */
 464     const SecAsn1Oid oid = { .Data = algorithmId.oid.data, .Length = algorithmId.oid.length };
 465     const SecAsn1Item params = { .Data = algorithmId.params.data, .Length = algorithmId.params.length };
 466     const SecAsn1Item pubKey = { .Data = pubKeyBytes.data, .Length = pubKeyBytes.length };
 467
 468     return SecKeyCreatePublicFromDER(allocator, &oid, &params, &pubKey);
 469
 470 out:
 471
 472     return NULL;
 473 }
 474
 475 static const DERByte oidRSA[] = {
 476     0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x01, 0x01, 0x05, 0x00,
 477 };
 478 static const DERByte oidECsecp256[] = {
 479     0x06, 0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02, 0x01, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07,
 480 };
 481 static const DERByte oidECsecp384[] = {
 482     0x06, 0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02, 0x01, 0x06, 0x05, 0x2b, 0x81, 0x04, 0x00, 0x22,
 483 };
 484 static const DERByte oidECsecp521[] = {
 485     0x06, 0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02, 0x01, 0x06, 0x05, 0x2b, 0x81, 0x04, 0x00, 0x23,
 486 };
 487
 488
 489 CFDataRef SecKeyCopySubjectPublicKeyInfo(SecKeyRef key)
 490 {
 491     CFMutableDataRef data = NULL;
 492     CFDataRef publicKey = NULL;
 493     CFDataRef dataret = NULL;
 494     DERSubjPubKeyInfo spki;
 495     DERReturn drtn;
 496     size_t zeroPad = 0;
 497
 498     memset(&spki, 0, sizeof(spki));
 499
 500     /* encode the public key. */
 501     require_noerr(SecKeyCopyPublicBytes(key, &publicKey), errOut);
 502     require_quiet(publicKey, errOut);
 503
 504     require(CFDataGetLength(publicKey) != 0, errOut);
 505
 506     // Add prefix 00 is needed to avoid creating negative bit strings
 507     if (((uint8_t *)CFDataGetBytePtr(publicKey))[0] & 0x80)
 508         zeroPad = 1;
 509
 510
 511     CFMutableDataRef paddedKey = CFDataCreateMutable(NULL, 0);
 512     /* the bit strings bits used field first */
 513     CFDataAppendBytes(paddedKey, (const UInt8 *)"\x00", 1);
 514     if (zeroPad)
 515         CFDataAppendBytes(paddedKey, (const UInt8 *)"\x00", 1);
 516
 517     CFDataAppendBytes(paddedKey, CFDataGetBytePtr(publicKey), CFDataGetLength(publicKey));
 518     CFTransferRetained(publicKey, paddedKey);
 519
 520     spki.pubKey.data = (DERByte *)CFDataGetBytePtr(publicKey);
 521     spki.pubKey.length = CFDataGetLength(publicKey);
 522
 523     // Encode algId according to algorithm used.
 524     CFIndex algorithm = SecKeyGetAlgorithmIdentifier(key);
 525     if (algorithm == kSecRSAAlgorithmID) {
 526         spki.algId.data = (DERByte *)oidRSA;
 527         spki.algId.length = sizeof(oidRSA);
 528     } else if (algorithm == kSecECDSAAlgorithmID) {
 529         SecECNamedCurve curve = SecECKeyGetNamedCurve(key);
 530         switch(curve) {
 531             case kSecECCurveSecp256r1:
 532                 spki.algId.data = (DERByte *)oidECsecp256;
 533                 spki.algId.length = sizeof(oidECsecp256);
 534                 break;
 535             case kSecECCurveSecp384r1:
 536                 spki.algId.data = (DERByte *)oidECsecp384;
 537                 spki.algId.length = sizeof(oidECsecp384);
 538                 break;
 539             case kSecECCurveSecp521r1:
 540                 spki.algId.data = (DERByte *)oidECsecp521;
 541                 spki.algId.length = sizeof(oidECsecp521);
 542                 break;
 543             default:
 544                 goto errOut;
 545         }
 546     } else {
 547         goto errOut;
 548     }
 549
 550     DERSize size = DERLengthOfEncodedSequence(ASN1_CONSTR_SEQUENCE, &spki,
 551                                               DERNumSubjPubKeyInfoItemSpecs, DERSubjPubKeyInfoItemSpecs);
 552     data = CFDataCreateMutable(kCFAllocatorDefault, size);
 553     CFDataSetLength(data, size);
 554
 555     drtn = DEREncodeSequence(ASN1_CONSTR_SEQUENCE, &spki,
 556                              DERNumSubjPubKeyInfoItemSpecs,
 557                              DERSubjPubKeyInfoItemSpecs,
 558                              CFDataGetMutableBytePtr(data), &size);
 559     require(drtn == DR_Success, errOut);
 560     CFDataSetLength(data, size);
 561
 562     dataret = CFRetain(data);
 563 errOut:
 564     CFReleaseNull(data);
 565     CFReleaseNull(publicKey);
 566
 567     return dataret;
 568 }
 569
 570
 571
 572 SecKeyRef SecKeyCreate(CFAllocatorRef allocator,
 573                        const SecKeyDescriptor *key_class, const uint8_t *keyData,
 574                        CFIndex keyDataLength, SecKeyEncoding encoding) {
 575         if (!key_class) return NULL;
 576     size_t size = sizeof(struct __SecKey) + key_class->extraBytes;
 577     SecKeyRef result = (SecKeyRef)_CFRuntimeCreateInstance(allocator,
 578                                                            SecKeyGetTypeID(), size - sizeof(CFRuntimeBase), NULL);
 579         if (result) {
 580                 memset((char*)result + sizeof(result->_base), 0, size - sizeof(result->_base));
 581         result->key_class = key_class;
 582         if (key_class->extraBytes) {
 583             /* Make result->key point to the extraBytes we allocated. */
 584             result->key = ((char*)result) + sizeof(*result);
 585         }
 586         if (key_class->init) {
 587                         OSStatus status;
 588                         status = key_class->init(result, keyData, keyDataLength, encoding);
 589                         if (status) {
 590                                 secwarning("init %s key: %" PRIdOSStatus, key_class->name, status);
 591                                 CFRelease(result);
 592                                 result = NULL;
 593                         }
 594                 }
 595     }
 596     return result;
 597 }
 598
 599 static SecKeyAlgorithm SecKeyGetSignatureAlgorithmForPadding(SecKeyRef key, SecPadding padding) {
 600     switch (SecKeyGetAlgorithmIdentifier(key)) {
 601         case kSecRSAAlgorithmID:
 602             switch (padding) {
 603                 case kSecPaddingNone:
 604                     return kSecKeyAlgorithmRSASignatureRaw;
 605                 case kSecPaddingPKCS1:
 606                     return kSecKeyAlgorithmRSASignatureDigestPKCS1v15Raw;
 607 #if TARGET_OS_IPHONE
 608                 case kSecPaddingPKCS1SHA1:
 609                     return kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA1;
 610                 case kSecPaddingPKCS1SHA224:
 611                     return kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA224;
 612                 case kSecPaddingPKCS1SHA256:
 613                     return kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA256;
 614                 case kSecPaddingPKCS1SHA384:
 615                     return kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA384;
 616                 case kSecPaddingPKCS1SHA512:
 617                     return kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA512;
 618 #else
 619                     // On CSSM-based implementation, these functions actually did hash its input,
 620                     // so keep doing that for backward compatibility.
 621                 case kSecPaddingPKCS1SHA1:
 622                     return kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA1;
 623                 case kSecPaddingPKCS1SHA224:
 624                     return kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA224;
 625                 case kSecPaddingPKCS1SHA256:
 626                     return kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA256;
 627                 case kSecPaddingPKCS1SHA384:
 628                     return kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA384;
 629                 case kSecPaddingPKCS1SHA512:
 630                     return kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA512;
 631 #endif
 632                 default:
 633                     return NULL;
 634             }
 635         case kSecECDSAAlgorithmID:
 636             switch (padding) {
 637                 case kSecPaddingSigRaw:
 638                     return kSecKeyAlgorithmECDSASignatureRFC4754;
 639                 default:
 640                     // Although it is not very logical, previous SecECKey implementation really considered
 641                     // anything else than SigRaw (incl. None!) as PKCS1 (i.e. x962), so we keep the behaviour
 642                     // for backward compatibility.
 643                     return kSecKeyAlgorithmECDSASignatureDigestX962;
 644             }
 645         default:
 646             return NULL;
 647     }
 648 }
 649
 650 // Generic wrapper helper for invoking new-style CFDataRef-based operations with ptr/length arguments
 651 // used by legacy RawSign-style functions.
 652 static OSStatus SecKeyPerformLegacyOperation(SecKeyRef key,
 653                                              const uint8_t *in1Ptr, size_t in1Len,
 654                                              const uint8_t *in2Ptr, size_t in2Len,
 655                                              uint8_t *outPtr, size_t *outLen,
 656                                              CFTypeRef (^operation)(CFDataRef in1, CFDataRef in2, CFRange *resultRange, CFErrorRef *error)) {
 657     CFErrorRef error = NULL;
 658     OSStatus status = errSecSuccess;
 659     CFDataRef in1 = CFDataCreateWithBytesNoCopy(NULL, in1Ptr, in1Len, kCFAllocatorNull);
 660     CFDataRef in2 = CFDataCreateWithBytesNoCopy(NULL, in2Ptr, in2Len, kCFAllocatorNull);
 661     CFRange range = { 0, -1 };
 662     CFTypeRef output = operation(in1, in2, &range, &error);
 663     require_quiet(output, out);
 664     if (CFGetTypeID(output) == CFDataGetTypeID() && outLen != NULL) {
 665         if (range.length == -1) {
 666             range.length = CFDataGetLength(output);
 667         }
 668         require_action_quiet((size_t)range.length <= *outLen, out,
 669                              SecError(errSecParam, &error, CFSTR("buffer too small")));
 670         *outLen = range.length;
 671         CFDataGetBytes(output, range, outPtr);
 672     }
 673
 674 out:
 675     CFReleaseSafe(in1);
 676     CFReleaseSafe(in2);
 677     CFReleaseSafe(output);
 678     if (error != NULL) {
 679         status = SecErrorGetOSStatus(error);
 680         if (status == errSecVerifyFailed) {
 681             // Legacy functions used errSSLCrypto, while new implementation uses errSecVerifyFailed.
 682             status = errSSLCrypto;
 683         }
 684         CFRelease(error);
 685     }
 686     return status;
 687 }
 688
 689 OSStatus SecKeyRawSign(
 690                        SecKeyRef           key,            /* Private key */
 691                        SecPadding          padding,             /* kSecPaddingNone or kSecPaddingPKCS1 */
 692                        const uint8_t       *dataToSign, /* signature over this data */
 693                        size_t              dataToSignLen,       /* length of dataToSign */
 694                        uint8_t             *sig,                        /* signature, RETURNED */
 695                        size_t              *sigLen) {           /* IN/OUT */
 696     SecKeyAlgorithm algorithm = SecKeyGetSignatureAlgorithmForPadding(key, padding);
 697     if (algorithm == NULL) {
 698         return errSecParam;
 699     }
 700     return SecKeyPerformLegacyOperation(key, dataToSign, dataToSignLen, NULL, 0, sig, sigLen,
 701                                         ^CFTypeRef(CFDataRef in1, CFDataRef in2, CFRange *range, CFErrorRef *error) {
 702                                             return SecKeyCreateSignature(key, algorithm, in1, error);
 703                                         });
 704 }
 705
 706 OSStatus SecKeyRawVerify(
 707                          SecKeyRef           key,            /* Public key */
 708                          SecPadding          padding,           /* kSecPaddingNone or kSecPaddingPKCS1 */
 709                          const uint8_t       *signedData,       /* signature over this data */
 710                          size_t              signedDataLen,     /* length of dataToSign */
 711                          const uint8_t       *sig,                      /* signature */
 712                          size_t              sigLen) {          /* length of signature */
 713     SecKeyAlgorithm algorithm = SecKeyGetSignatureAlgorithmForPadding(key, padding);
 714     if (algorithm == NULL) {
 715         return errSecParam;
 716     }
 717     OSStatus status = SecKeyPerformLegacyOperation(key, signedData, signedDataLen, sig, sigLen, NULL, NULL,
 718                                                    ^CFTypeRef(CFDataRef in1, CFDataRef in2, CFRange *range, CFErrorRef *error) {
 719                                                        return SecKeyVerifySignature(key, algorithm, in1, in2, error)
 720                                                        ? kCFBooleanTrue : NULL;
 721                                                    });
 722     return status;
 723 }
 724
 725 static SecKeyAlgorithm SecKeyGetEncryptionAlgorithmForPadding(SecKeyRef key, SecPadding padding) {
 726     switch (SecKeyGetAlgorithmIdentifier(key)) {
 727         case kSecRSAAlgorithmID:
 728             switch (padding) {
 729                 case kSecPaddingNone:
 730                     return kSecKeyAlgorithmRSAEncryptionRaw;
 731                 case kSecPaddingPKCS1:
 732                     return kSecKeyAlgorithmRSAEncryptionPKCS1;
 733                 case kSecPaddingOAEP:
 734                     return kSecKeyAlgorithmRSAEncryptionOAEPSHA1;
 735                 default:
 736                     return NULL;
 737             }
 738         default:
 739             return NULL;
 740     }
 741 }
 742
 743 OSStatus SecKeyEncrypt(
 744                        SecKeyRef           key,                /* Public key */
 745                        SecPadding          padding,                     /* kSecPaddingNone, kSecPaddingPKCS1, kSecPaddingOAEP */
 746                        const uint8_t            *plainText,
 747                        size_t              plainTextLen,                /* length of plainText */
 748                        uint8_t             *cipherText,
 749                        size_t              *cipherTextLen) {    /* IN/OUT */
 750     SecKeyAlgorithm algorithm = SecKeyGetEncryptionAlgorithmForPadding(key, padding);
 751     if (algorithm == NULL) {
 752         return errSecParam;
 753     }
 754
 755     return SecKeyPerformLegacyOperation(key, plainText, plainTextLen, NULL, 0, cipherText, cipherTextLen,
 756                                         ^CFTypeRef(CFDataRef in1, CFDataRef in2, CFRange *range, CFErrorRef *error) {
 757                                             return SecKeyCreateEncryptedData(key, algorithm, in1, error);
 758                                         });
 759 }
 760
 761 OSStatus SecKeyDecrypt(
 762                        SecKeyRef           key,                /* Private key */
 763                        SecPadding          padding,                     /* kSecPaddingNone, kSecPaddingPKCS1, kSecPaddingOAEP */
 764                        const uint8_t       *cipherText,
 765                        size_t              cipherTextLen,               /* length of cipherText */
 766                        uint8_t             *plainText,
 767                        size_t              *plainTextLen) {     /* IN/OUT */
 768     SecKeyAlgorithm algorithm = SecKeyGetEncryptionAlgorithmForPadding(key, padding);
 769     if (algorithm == NULL) {
 770         return errSecParam;
 771     }
 772     return SecKeyPerformLegacyOperation(key, cipherText, cipherTextLen, NULL, 0, plainText, plainTextLen,
 773                                         ^CFTypeRef(CFDataRef in1, CFDataRef in2, CFRange *range, CFErrorRef *error) {
 774                                             CFDataRef decrypted = SecKeyCreateDecryptedData(key, algorithm, in1, error);
 775                                             const UInt8 *data;
 776                                             if (decrypted != NULL && algorithm == kSecKeyAlgorithmRSAEncryptionRaw &&
 777                                                 *(data = CFDataGetBytePtr(decrypted)) == 0x00) {
 778                                                 // Strip zero-padding from the beginning of the block, as the contract of this
 779                                                 // function says.
 780                                                 range->length = CFDataGetLength(decrypted);
 781                                                 while (*data == 0x00 && range->length > 0) {
 782                                                     range->location++;
 783                                                     range->length--;
 784                                                     data++;
 785                                                 }
 786                                             }
 787                                             return decrypted;
 788                                         });
 789 }
 790
 791 size_t SecKeyGetBlockSize(SecKeyRef key) {
 792     if (key->key_class->blockSize)
 793         return key->key_class->blockSize(key);
 794     return 0;
 795 }
 796
 797 /* Private API functions. */
 798
 799 CFDictionaryRef SecKeyCopyAttributeDictionary(SecKeyRef key) {
 800     return SecKeyCopyAttributes(key);
 801 }
 802
 803 SecKeyRef SecKeyCreateFromAttributeDictionary(CFDictionaryRef refAttributes) {
 804     CFErrorRef error = NULL;
 805     SecKeyRef key = SecKeyCreateWithData(CFDictionaryGetValue(refAttributes, kSecValueData), refAttributes, &error);
 806     if (key == NULL) {
 807         CFStringRef description = CFErrorCopyDescription(error);
 808         secwarning("%@", description);
 809         CFRelease(description);
 810         CFRelease(error);
 811     }
 812     return key;
 813 }
 814
 815 static SecKeyAlgorithm SecKeyGetAlgorithmForSecAsn1AlgId(SecKeyRef key, const SecAsn1AlgId *algId, bool digestData) {
 816     static const struct TableItem {
 817         const SecAsn1Oid *oid1, *oid2;
 818         const SecKeyAlgorithm *algorithms[2];
 819     } translationTableRSA[] = {
 820         { &CSSMOID_SHA1WithRSA, &CSSMOID_SHA1, {
 821             [false] = &kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA1,
 822             [true] = &kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA1,
 823         } },
 824         { &CSSMOID_SHA224WithRSA, &CSSMOID_SHA224, {
 825             [false] = &kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA224,
 826             [true] = &kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA224,
 827         } },
 828         { &CSSMOID_SHA256WithRSA, &CSSMOID_SHA256, {
 829             [false] = &kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA256,
 830             [true] = &kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA256,
 831         } },
 832         { &CSSMOID_SHA384WithRSA, &CSSMOID_SHA384, {
 833             [false] = &kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA384,
 834             [true] = &kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA384,
 835         } },
 836         { &CSSMOID_SHA512WithRSA, &CSSMOID_SHA512, {
 837             [false] = &kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA512,
 838             [true] = &kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA512,
 839         } },
 840         { &CSSMOID_MD5, NULL, {
 841             [false] = &kSecKeyAlgorithmRSASignatureDigestPKCS1v15MD5,
 842             [true] = &kSecKeyAlgorithmRSASignatureMessagePKCS1v15MD5,
 843         } },
 844         { NULL },
 845     }, translationTableECDSA[] = {
 846         { &CSSMOID_ECDSA_WithSHA1, &CSSMOID_SHA1, {
 847             [false] = &kSecKeyAlgorithmECDSASignatureDigestX962,
 848             [true] = &kSecKeyAlgorithmECDSASignatureMessageX962SHA1,
 849         } },
 850         { &CSSMOID_ECDSA_WithSHA224, &CSSMOID_SHA224, {
 851             [false] = &kSecKeyAlgorithmECDSASignatureDigestX962,
 852             [true] = &kSecKeyAlgorithmECDSASignatureMessageX962SHA224,
 853         } },
 854         { &CSSMOID_ECDSA_WithSHA256, &CSSMOID_SHA256, {
 855             [false] = &kSecKeyAlgorithmECDSASignatureDigestX962,
 856             [true] = &kSecKeyAlgorithmECDSASignatureMessageX962SHA256,
 857         } },
 858         { &CSSMOID_ECDSA_WithSHA384, &CSSMOID_SHA384, {
 859             [false] = &kSecKeyAlgorithmECDSASignatureDigestX962,
 860             [true] = &kSecKeyAlgorithmECDSASignatureMessageX962SHA384,
 861         } },
 862         { &CSSMOID_ECDSA_WithSHA512, &CSSMOID_SHA512, {
 863             [false] = &kSecKeyAlgorithmECDSASignatureDigestX962,
 864             [true] = &kSecKeyAlgorithmECDSASignatureMessageX962SHA512,
 865         } },
 866         { NULL },
 867     };
 868
 869     const struct TableItem *table;
 870     switch (SecKeyGetAlgorithmIdentifier(key)) {
 871         case kSecRSAAlgorithmID:
 872             table = translationTableRSA;
 873             break;
 874         case kSecECDSAAlgorithmID:
 875             table = translationTableECDSA;
 876             break;
 877         default:
 878             return NULL;
 879     }
 880
 881     for (; table->oid1 != NULL; table++) {
 882         if (SecAsn1OidCompare(table->oid1, &algId->algorithm) ||
 883             (table->oid2 != NULL && SecAsn1OidCompare(table->oid2, &algId->algorithm))) {
 884             return *table->algorithms[digestData];
 885         }
 886     }
 887     return NULL;
 888 }
 889
 890 OSStatus SecKeyDigestAndVerify(
 891                                SecKeyRef           key,            /* Private key */
 892                                const SecAsn1AlgId  *algId,         /* algorithm oid/params */
 893                                const uint8_t       *dataToDigest,       /* signature over this data */
 894                                size_t              dataToDigestLen,/* length of dataToDigest */
 895                                const uint8_t       *sig,                        /* signature to verify */
 896                                size_t              sigLen) {            /* length of sig */
 897
 898     SecKeyAlgorithm algorithm = SecKeyGetAlgorithmForSecAsn1AlgId(key, algId, true);
 899     if (algorithm == NULL) {
 900         return errSecUnimplemented;
 901     }
 902
 903     return SecKeyPerformLegacyOperation(key, dataToDigest, dataToDigestLen, sig, sigLen, NULL, NULL,
 904                                         ^CFTypeRef(CFDataRef in1, CFDataRef in2, CFRange *range, CFErrorRef *error) {
 905                                             return SecKeyVerifySignature(key, algorithm, in1, in2, error) ?
 906                                             kCFBooleanTrue : NULL;
 907                                         });
 908 }
 909
 910 OSStatus SecKeyDigestAndSign(
 911                              SecKeyRef           key,            /* Private key */
 912                              const SecAsn1AlgId  *algId,         /* algorithm oid/params */
 913                              const uint8_t       *dataToDigest, /* signature over this data */
 914                              size_t              dataToDigestLen,/* length of dataToDigest */
 915                              uint8_t             *sig,                  /* signature, RETURNED */
 916                              size_t              *sigLen) {             /* IN/OUT */
 917     SecKeyAlgorithm algorithm = SecKeyGetAlgorithmForSecAsn1AlgId(key, algId, true);
 918     if (algorithm == NULL) {
 919         return errSecUnimplemented;
 920     }
 921
 922     return SecKeyPerformLegacyOperation(key, dataToDigest, dataToDigestLen, NULL, 0, sig, sigLen,
 923                                         ^CFTypeRef(CFDataRef in1, CFDataRef in2, CFRange *range, CFErrorRef *error) {
 924                                             return SecKeyCreateSignature(key, algorithm, in1, error);
 925                                         });
 926 }
 927
 928 OSStatus SecKeyVerifyDigest(
 929                             SecKeyRef           key,            /* Private key */
 930                             const SecAsn1AlgId  *algId,         /* algorithm oid/params */
 931                             const uint8_t       *digestData,    /* signature over this digest */
 932                             size_t              digestDataLen,/* length of dataToDigest */
 933                             const uint8_t       *sig,                   /* signature to verify */
 934                             size_t              sigLen) {               /* length of sig */
 935     SecKeyAlgorithm algorithm = SecKeyGetAlgorithmForSecAsn1AlgId(key, algId, false);
 936     if (algorithm == NULL) {
 937         return errSecUnimplemented;
 938     }
 939
 940     return SecKeyPerformLegacyOperation(key, digestData, digestDataLen, sig, sigLen, NULL, NULL,
 941                                         ^CFTypeRef(CFDataRef in1, CFDataRef in2, CFRange *range, CFErrorRef *error) {
 942                                             return SecKeyVerifySignature(key, algorithm, in1, in2, error) ?
 943                                             kCFBooleanTrue : NULL;
 944                                         });
 945 }
 946
 947 OSStatus SecKeySignDigest(
 948                           SecKeyRef           key,            /* Private key */
 949                           const SecAsn1AlgId  *algId,         /* algorithm oid/params */
 950                           const uint8_t       *digestData,      /* signature over this digest */
 951                           size_t              digestDataLen,/* length of digestData */
 952                           uint8_t             *sig,                     /* signature, RETURNED */
 953                           size_t              *sigLen) {                /* IN/OUT */
 954     SecKeyAlgorithm algorithm = SecKeyGetAlgorithmForSecAsn1AlgId(key, algId, false);
 955     if (algorithm == NULL) {
 956         return errSecUnimplemented;
 957     }
 958
 959     return SecKeyPerformLegacyOperation(key, digestData, digestDataLen, NULL, 0, sig, sigLen,
 960                                         ^CFTypeRef(CFDataRef in1, CFDataRef in2, CFRange *range, CFErrorRef *error) {
 961                                             return SecKeyCreateSignature(key, algorithm, in1, error);
 962                                         });
 963 }
 964
 965 CFIndex SecKeyGetAlgorithmId(SecKeyRef key) {
 966         return SecKeyGetAlgorithmIdentifier(key);
 967 }
 968
 969 #if (TARGET_OS_MAC && !(TARGET_OS_EMBEDDED || TARGET_OS_IPHONE || TARGET_IPHONE_SIMULATOR))
 970 /* On OS X, SecKeyGetAlgorithmID has a different function signature (two arguments,
 971    with output in the second argument). Therefore, avoid implementing this function here
 972    if compiling for OS X.
 973  */
 974 #else
 975 CFIndex SecKeyGetAlgorithmID(SecKeyRef key) {
 976         return SecKeyGetAlgorithmIdentifier(key);
 977 }
 978 #endif
 979
 980 OSStatus SecKeyCopyPublicBytes(SecKeyRef key, CFDataRef* serializedPublic) {
 981     if (key->key_class->version > 1 && key->key_class->copyPublic)
 982         return key->key_class->copyPublic(key, serializedPublic);
 983     return errSecUnimplemented;
 984 }
 985
 986 SecKeyRef SecKeyCreateFromPublicBytes(CFAllocatorRef allocator, CFIndex algorithmID, const uint8_t *keyData, CFIndex keyDataLength)
 987 {
 988     switch (algorithmID)
 989     {
 990         case kSecRSAAlgorithmID:
 991             return SecKeyCreateRSAPublicKey(allocator,
 992                                             keyData, keyDataLength,
 993                                             kSecKeyEncodingBytes);
 994         case kSecECDSAAlgorithmID:
 995             return SecKeyCreateECPublicKey(allocator,
 996                                            keyData, keyDataLength,
 997                                            kSecKeyEncodingBytes);
 998         default:
 999             return NULL;
1000     }
1001 }
1002
1003 SecKeyRef SecKeyCreateFromPublicData(CFAllocatorRef allocator, CFIndex algorithmID, CFDataRef serialized)
1004 {
1005     return SecKeyCreateFromPublicBytes(allocator, algorithmID, CFDataGetBytePtr(serialized), CFDataGetLength(serialized));
1006 }
1007
1008 // This is a bit icky hack to avoid changing the vtable for
1009 // SecKey.
1010 size_t SecKeyGetSize(SecKeyRef key, SecKeySize whichSize)
1011 {
1012     size_t result = SecKeyGetBlockSize(key);
1013
1014     if (kSecECDSAAlgorithmID == SecKeyGetAlgorithmIdentifier(key)) {
1015         switch (whichSize) {
1016             case kSecKeyEncryptedDataSize:
1017                 result = 0;
1018                 break;
1019             case kSecKeySignatureSize:
1020                 result = (result >= 66 ? 9 : 8) + 2 * result;
1021                 break;
1022             case kSecKeyKeySizeInBits:
1023                 if (result >= 66)
1024                     return 521;
1025         }
1026     }
1027
1028     if (whichSize == kSecKeyKeySizeInBits)
1029         result *= 8;
1030
1031     return result;
1032
1033 }
1034
1035 OSStatus SecKeyFindWithPersistentRef(CFDataRef persistentRef, SecKeyRef* lookedUpData)
1036 {
1037     CFDictionaryRef query = CFDictionaryCreateForCFTypes(kCFAllocatorDefault,
1038                                                          kSecReturnRef,             kCFBooleanTrue,
1039                                                          kSecClass,                 kSecClassKey,
1040                                                          kSecValuePersistentRef,    persistentRef,
1041                                                          NULL);
1042     CFTypeRef foundRef = NULL;
1043     OSStatus status = SecItemCopyMatching(query, &foundRef);
1044
1045     if (status == errSecSuccess) {
1046         if (CFGetTypeID(foundRef) == SecKeyGetTypeID()) {
1047             *lookedUpData = (SecKeyRef) foundRef;
1048             foundRef = NULL;
1049             status = errSecSuccess;
1050         } else {
1051             status = errSecItemNotFound;
1052         }
1053     }
1054
1055     CFReleaseSafe(foundRef);
1056     CFReleaseSafe(query);
1057
1058     return status;
1059 }
1060
1061 OSStatus SecKeyCopyPersistentRef(SecKeyRef key, CFDataRef* persistentRef)
1062 {
1063     CFDictionaryRef query = CFDictionaryCreateForCFTypes(kCFAllocatorDefault,
1064                                                          kSecReturnPersistentRef,   kCFBooleanTrue,
1065                                                          kSecValueRef,              key,
1066                                                          kSecAttrSynchronizable,    kSecAttrSynchronizableAny,
1067                                                          NULL);
1068     CFTypeRef foundRef = NULL;
1069     OSStatus status = SecItemCopyMatching(query, &foundRef);
1070
1071     if (status == errSecSuccess) {
1072         if (CFGetTypeID(foundRef) == CFDataGetTypeID()) {
1073             *persistentRef = foundRef;
1074             foundRef = NULL;
1075         } else {
1076             status = errSecItemNotFound;
1077         }
1078     }
1079
1080     CFReleaseSafe(foundRef);
1081     CFReleaseSafe(query);
1082
1083     return status;
1084 }
1085
1086 /*
1087  *
1088  */
1089
1090 #define SEC_CONST_DECL(k,v) const CFStringRef k = CFSTR(v);
1091
1092 SEC_CONST_DECL(_kSecKeyWrapPGPSymAlg, "kSecKeyWrapPGPSymAlg");
1093 SEC_CONST_DECL(_kSecKeyWrapPGPFingerprint, "kSecKeyWrapPGPFingerprint");
1094 SEC_CONST_DECL(_kSecKeyWrapPGPWrapAlg, "kSecKeyWrapPGPWrapAlg");
1095 SEC_CONST_DECL(_kSecKeyWrapRFC6637Flags, "kSecKeyWrapPGPECFlags");
1096 SEC_CONST_DECL(_kSecKeyWrapRFC6637WrapDigestSHA256KekAES128, "kSecKeyWrapPGPECWrapDigestSHA256KekAES128");
1097 SEC_CONST_DECL(_kSecKeyWrapRFC6637WrapDigestSHA512KekAES256, "kSecKeyWrapPGPECWrapDigestSHA512KekAES256");
1098
1099 #undef SEC_CONST_DECL
1100
1101 CFDataRef
1102 _SecKeyCopyWrapKey(SecKeyRef key, SecKeyWrapType type, CFDataRef unwrappedKey, CFDictionaryRef parameters, CFDictionaryRef *outParam, CFErrorRef *error)
1103 {
1104     if (error)
1105         *error = NULL;
1106     if (outParam)
1107         *outParam = NULL;
1108     if (key->key_class->version > 2 && key->key_class->copyWrapKey)
1109         return key->key_class->copyWrapKey(key, type, unwrappedKey, parameters, outParam, error);
1110     SecError(errSecUnsupportedOperation, error, CFSTR("No key wrap supported for key %@"), key);
1111     return NULL;
1112 }
1113
1114 CFDataRef
1115 _SecKeyCopyUnwrapKey(SecKeyRef key, SecKeyWrapType type, CFDataRef wrappedKey, CFDictionaryRef parameters, CFDictionaryRef *outParam, CFErrorRef *error)
1116 {
1117     if (error)
1118         *error = NULL;
1119     if (outParam)
1120         *outParam = NULL;
1121     if (key->key_class->version > 2 && key->key_class->copyUnwrapKey)
1122         return key->key_class->copyUnwrapKey(key, type, wrappedKey, parameters, outParam, error);
1123
1124     SecError(errSecUnsupportedOperation, error, CFSTR("No key unwrap for key %@"), key);
1125     return NULL;
1126 }
1127
1128 static CFIndex SecKeyParamsGetCFIndex(CFTypeRef value, CFStringRef errName, CFErrorRef *error) {
1129     CFIndex result = -1;
1130     CFNumberRef localValue = NULL;
1131
1132     if (isString(value)) {
1133         CFNumberFormatterRef formatter = CFNumberFormatterCreate(kCFAllocatorDefault, CFLocaleGetSystem(), kCFNumberFormatterDecimalStyle);
1134         localValue = CFNumberFormatterCreateNumberFromString(kCFAllocatorDefault, formatter, value, NULL, kCFNumberFormatterParseIntegersOnly);
1135         CFReleaseSafe(formatter);
1136
1137         if (localValue) {
1138             CFStringRef t = CFStringCreateWithFormat(0, 0, CFSTR("%@"), localValue);
1139             if (CFEqual(t, value)) {
1140                 value = localValue;
1141             }
1142             CFReleaseSafe(t);
1143         }
1144     }
1145
1146     if (value != NULL && CFGetTypeID(value) == CFNumberGetTypeID()) {
1147         if (!CFNumberGetValue(value, kCFNumberCFIndexType, &result) || result < 0) {
1148             SecError(errSecParam, error, CFSTR("Unsupported %@: %@"), errName, value);
1149         }
1150     } else {
1151         SecError(errSecParam, error, CFSTR("Unsupported %@: %@"), errName, value);
1152     }
1153
1154     CFReleaseSafe(localValue);
1155     return result;
1156 }
1157
1158 SecKeyRef SecKeyCreateWithData(CFDataRef keyData, CFDictionaryRef parameters, CFErrorRef *error) {
1159
1160     SecKeyRef key = NULL;
1161     CFAllocatorRef allocator = NULL;
1162
1163     if (CFDictionaryGetValue(parameters, kSecAttrTokenID) != NULL) {
1164         return SecKeyCreateCTKKey(allocator, parameters, error);
1165     }
1166     else if (!keyData) {
1167         SecError(errSecParam, error, CFSTR("Failed to provide key data to SecKeyCreateWithData"));
1168         return NULL;
1169     }
1170     /* First figure out the key type (algorithm). */
1171     CFIndex algorithm, class;
1172     CFTypeRef ktype = CFDictionaryGetValue(parameters, kSecAttrKeyType);
1173     require_quiet((algorithm = SecKeyParamsGetCFIndex(ktype, CFSTR("key type"), error)) >= 0, out);
1174     CFTypeRef kclass = CFDictionaryGetValue(parameters, kSecAttrKeyClass);
1175     require_quiet((class = SecKeyParamsGetCFIndex(kclass, CFSTR("key class"), error)) >= 0, out);
1176
1177     switch (class) {
1178         case 0: // kSecAttrKeyClassPublic
1179             switch (algorithm) {
1180                 case 42: // kSecAlgorithmRSA
1181                     key = SecKeyCreateRSAPublicKey(allocator,
1182                                                    CFDataGetBytePtr(keyData), CFDataGetLength(keyData),
1183                                                    kSecKeyEncodingBytes);
1184                     if (key == NULL) {
1185                         SecError(errSecParam, error, CFSTR("RSA public key creation from data failed"));
1186                     }
1187                     break;
1188                 case 43: // kSecAlgorithmECDSA
1189                 case 73: // kSecAlgorithmEC
1190                     key = SecKeyCreateECPublicKey(allocator,
1191                                                   CFDataGetBytePtr(keyData), CFDataGetLength(keyData),
1192                                                   kSecKeyEncodingBytes);
1193                     if (key == NULL) {
1194                         SecError(errSecParam, error, CFSTR("EC public key creation from data failed"));
1195                     }
1196                     break;
1197                 default:
1198                     SecError(errSecParam, error, CFSTR("Unsupported public key type: %@"), ktype);
1199                     break;
1200             };
1201             break;
1202         case 1: // kSecAttrKeyClassPrivate
1203             switch (algorithm) {
1204                 case 42: // kSecAlgorithmRSA
1205                     key = SecKeyCreateRSAPrivateKey(allocator,
1206                                                     CFDataGetBytePtr(keyData), CFDataGetLength(keyData),
1207                                                     kSecKeyEncodingBytes);
1208                     if (key == NULL) {
1209                         SecError(errSecParam, error, CFSTR("RSA private key creation from data failed"));
1210                     }
1211                     break;
1212                 case 43: // kSecAlgorithmECDSA
1213                 case 73: // kSecAlgorithmEC
1214                     key = SecKeyCreateECPrivateKey(allocator,
1215                                                    CFDataGetBytePtr(keyData), CFDataGetLength(keyData),
1216                                                    kSecKeyEncodingBytes);
1217                     if (key == NULL) {
1218                         SecError(errSecParam, error, CFSTR("EC public key creation from data failed"));
1219                     }
1220                     break;
1221                 default:
1222                     SecError(errSecParam, error, CFSTR("Unsupported private key type: %@"), ktype);
1223                     break;
1224             };
1225             break;
1226         case 2: // kSecAttrKeyClassSymmetric
1227             SecError(errSecUnimplemented, error, CFSTR("Unsupported symmetric key type: %@"), ktype);
1228             break;
1229         default:
1230             SecError(errSecParam, error, CFSTR("Unsupported key class: %@"), kclass);
1231             break;
1232     }
1233
1234 out:
1235     return key;
1236 }
1237
1238 // Similar to CFErrorPropagate, but does not consult input value of *error, it can contain any garbage and if overwritten, previous value is never released.
1239 static inline bool SecKeyErrorPropagate(bool succeeded, CFErrorRef possibleError CF_CONSUMED, CFErrorRef *error) {
1240     if (succeeded) {
1241         return true;
1242     } else {
1243         if (error) {
1244             *error = possibleError;
1245         } else {
1246             CFRelease(possibleError);
1247         }
1248         return false;
1249     }
1250 }
1251
1252 CFDataRef SecKeyCopyExternalRepresentation(SecKeyRef key, CFErrorRef *error) {
1253     if (!key->key_class->copyExternalRepresentation) {
1254         if (error != NULL) {
1255             *error = NULL;
1256         }
1257         SecError(errSecUnimplemented, error, CFSTR("export not implemented for key %@"), key);
1258         return NULL;
1259     }
1260
1261     CFErrorRef localError = NULL;
1262     CFDataRef result = key->key_class->copyExternalRepresentation(key, &localError);
1263     SecKeyErrorPropagate(result != NULL, localError, error);
1264     return result;
1265 }
1266
1267 CFDictionaryRef SecKeyCopyAttributes(SecKeyRef key) {
1268     if (key->key_class->copyDictionary) {
1269         return key->key_class->copyDictionary(key);
1270     } else {
1271         // Create dictionary with basic values derived from other known information of the key.
1272         CFMutableDictionaryRef dict = CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault);
1273         CFIndex blockSize = SecKeyGetBlockSize(key) * 8;
1274         if (blockSize > 0) {
1275             CFNumberRef blockSizeRef = CFNumberCreate(kCFAllocatorDefault, kCFNumberCFIndexType, &blockSize);
1276             CFDictionarySetValue(dict, kSecAttrKeySizeInBits, blockSizeRef);
1277             CFRelease(blockSizeRef);
1278         }
1279
1280         switch (SecKeyGetAlgorithmIdentifier(key)) {
1281             case kSecRSAAlgorithmID:
1282                 CFDictionarySetValue(dict, kSecAttrKeyType, kSecAttrKeyTypeRSA);
1283                 break;
1284             case kSecECDSAAlgorithmID:
1285                 CFDictionarySetValue(dict, kSecAttrKeyType, kSecAttrKeyTypeECSECPrimeRandom);
1286                 break;
1287         }
1288
1289         if (key->key_class->rawSign != NULL || key->key_class->decrypt != NULL) {
1290             CFDictionarySetValue(dict, kSecAttrKeyClass, kSecAttrKeyClassPrivate);
1291         } else if (key->key_class->rawVerify != NULL || key->key_class->encrypt != NULL) {
1292             CFDictionarySetValue(dict, kSecAttrKeyClass, kSecAttrKeyClassPublic);
1293         }
1294
1295         return dict;
1296     }
1297 }
1298
1299 SecKeyRef SecKeyCopyPublicKey(SecKeyRef key) {
1300     SecKeyRef result = NULL;
1301     if (key->key_class->version >= 4 && key->key_class->copyPublicKey) {
1302         result = key->key_class->copyPublicKey(key);
1303         if (result != NULL) {
1304             return result;
1305         }
1306     }
1307
1308     CFDataRef serializedPublic = NULL;
1309
1310     require_noerr_quiet(SecKeyCopyPublicBytes(key, &serializedPublic), fail);
1311     require_quiet(serializedPublic, fail);
1312
1313     result = SecKeyCreateFromPublicData(kCFAllocatorDefault, SecKeyGetAlgorithmIdentifier(key), serializedPublic);
1314
1315 fail:
1316     CFReleaseSafe(serializedPublic);
1317     return result;
1318 }
1319
1320 SecKeyRef SecKeyCreateRandomKey(CFDictionaryRef parameters, CFErrorRef *error) {
1321     SecKeyRef privKey = NULL, pubKey = NULL;
1322     OSStatus status = SecKeyGeneratePair(parameters, &pubKey, &privKey);
1323     if (status != errSecSuccess) {
1324         if (error != NULL) {
1325             *error = NULL;
1326         }
1327         SecError(status, error, CFSTR("Key generation failed, error %d"), (int)status);
1328     }
1329     CFReleaseSafe(pubKey);
1330     return privKey;
1331 }
1332
1333 SecKeyRef SecKeyCreateDuplicate(SecKeyRef key) {
1334     if (key->key_class->version >= 4 && key->key_class->createDuplicate) {
1335         return key->key_class->createDuplicate(key);
1336     } else {
1337         return (SecKeyRef)CFRetain(key);
1338     }
1339 }
1340
1341 Boolean SecKeySetParameter(SecKeyRef key, CFStringRef name, CFPropertyListRef value, CFErrorRef *error) {
1342     if (key->key_class->version >= 4 && key->key_class->setParameter) {
1343         CFErrorRef localError = NULL;
1344         Boolean result = key->key_class->setParameter(key, name, value, &localError);
1345         SecKeyErrorPropagate(result, localError, error);
1346         return result;
1347     } else {
1348         if (error != NULL) {
1349             *error = NULL;
1350         }
1351         return SecError(errSecUnimplemented, error, CFSTR("setParameter not implemented for %@"), key);
1352     }
1353 }
1354
1355 #pragma mark Generic algorithm adaptor lookup and invocation
1356
1357 static CFTypeRef SecKeyCopyBackendOperationResult(SecKeyOperationContext *context, SecKeyAlgorithm algorithm,
1358                                                   CFTypeRef in1, CFTypeRef in2, CFErrorRef *error) {
1359     CFTypeRef result = kCFNull;
1360     assert(CFArrayGetCount(context->algorithm) > 0);
1361     if (context->key->key_class->version >= 4 && context->key->key_class->copyOperationResult != NULL) {
1362         return context->key->key_class->copyOperationResult(context->key, context->operation, algorithm,
1363                                                             context->algorithm, context->mode, in1, in2, error);
1364     }
1365
1366     // Mapping from algorithms to legacy SecPadding values.
1367     static const struct {
1368         const SecKeyAlgorithm *algorithm;
1369         CFIndex keyAlg;
1370         SecPadding padding;
1371     } paddingMap[] = {
1372         { &kSecKeyAlgorithmRSASignatureRaw, kSecRSAAlgorithmID, kSecPaddingNone },
1373         { &kSecKeyAlgorithmRSASignatureDigestPKCS1v15Raw, kSecRSAAlgorithmID, kSecPaddingPKCS1 },
1374         { &kSecKeyAlgorithmECDSASignatureRFC4754, kSecECDSAAlgorithmID, kSecPaddingSigRaw },
1375         { &kSecKeyAlgorithmECDSASignatureDigestX962, kSecECDSAAlgorithmID, kSecPaddingPKCS1 },
1376         { &kSecKeyAlgorithmRSAEncryptionRaw, kSecRSAAlgorithmID, kSecPaddingNone },
1377         { &kSecKeyAlgorithmRSAEncryptionPKCS1, kSecRSAAlgorithmID, kSecPaddingPKCS1 },
1378         { &kSecKeyAlgorithmRSAEncryptionOAEPSHA1, kSecRSAAlgorithmID, kSecPaddingOAEP },
1379     };
1380     SecPadding padding = (SecPadding)-1;
1381     CFIndex keyAlg = SecKeyGetAlgorithmIdentifier(context->key);
1382     for (size_t i = 0; i < array_size(paddingMap); ++i) {
1383         if (keyAlg == paddingMap[i].keyAlg && CFEqual(algorithm, *paddingMap[i].algorithm)) {
1384             padding = paddingMap[i].padding;
1385             break;
1386         }
1387     }
1388     require_quiet(padding != (SecPadding)-1, out);
1389
1390     // Check legacy virtual table entries.
1391     size_t size = 0;
1392     OSStatus status = errSecSuccess;
1393     switch (context->operation) {
1394         case kSecKeyOperationTypeSign:
1395             if (context->key->key_class->rawSign != NULL) {
1396                 result = kCFBooleanTrue;
1397                 if (context->mode == kSecKeyOperationModePerform) {
1398                     size = SecKeyGetSize(context->key, kSecKeySignatureSize);
1399                     result = CFDataCreateMutableWithScratch(NULL, size);
1400                     status = context->key->key_class->rawSign(context->key, padding,
1401                                                               CFDataGetBytePtr(in1), CFDataGetLength(in1),
1402                                                               CFDataGetMutableBytePtr((CFMutableDataRef)result), &size);
1403                 }
1404             }
1405             break;
1406         case kSecKeyOperationTypeVerify:
1407             if (context->key->key_class->rawVerify != NULL) {
1408                 result = kCFBooleanTrue;
1409                 if (context->mode == kSecKeyOperationModePerform) {
1410                     status = context->key->key_class->rawVerify(context->key, padding,
1411                                                                 CFDataGetBytePtr(in1), CFDataGetLength(in1),
1412                                                                 CFDataGetBytePtr(in2), CFDataGetLength(in2));
1413                 }
1414             }
1415             break;
1416         case kSecKeyOperationTypeEncrypt:
1417             if (context->key->key_class->encrypt != NULL) {
1418                 result = kCFBooleanTrue;
1419                 if (context->mode == kSecKeyOperationModePerform) {
1420                     size = SecKeyGetSize(context->key, kSecKeyEncryptedDataSize);
1421                     result = CFDataCreateMutableWithScratch(NULL, size);
1422                     status = context->key->key_class->encrypt(context->key, padding,
1423                                                               CFDataGetBytePtr(in1), CFDataGetLength(in1),
1424                                                               CFDataGetMutableBytePtr((CFMutableDataRef)result), &size);
1425                 }
1426             }
1427             break;
1428         case kSecKeyOperationTypeDecrypt:
1429             if (context->key->key_class->decrypt != NULL) {
1430                 result = kCFBooleanTrue;
1431                 if (context->mode == kSecKeyOperationModePerform) {
1432                     size = SecKeyGetSize(context->key, kSecKeyEncryptedDataSize);
1433                     result = CFDataCreateMutableWithScratch(NULL, size);
1434                     status = context->key->key_class->decrypt(context->key, padding,
1435                                                               CFDataGetBytePtr(in1), CFDataGetLength(in1),
1436                                                               CFDataGetMutableBytePtr((CFMutableDataRef)result), &size);
1437                 }
1438             }
1439             break;
1440         default:
1441             goto out;
1442     }
1443
1444     if (status == errSecSuccess) {
1445         if (CFGetTypeID(result) == CFDataGetTypeID()) {
1446             CFDataSetLength((CFMutableDataRef)result, size);
1447         }
1448     } else {
1449         SecError(status, error, CFSTR("legacy SecKey backend operation:%d(%d) failed"), (int)context->operation, (int)padding);
1450         CFReleaseNull(result);
1451     }
1452
1453 out:
1454     return result;
1455 }
1456
1457 CFTypeRef SecKeyRunAlgorithmAndCopyResult(SecKeyOperationContext *context, CFTypeRef in1, CFTypeRef in2, CFErrorRef *error) {
1458
1459     // Check algorithm array for cycles; if any value of it is duplicated inside, report 'algorithm not found' error.
1460     CFIndex algorithmCount = CFArrayGetCount(context->algorithm);
1461     for (CFIndex index = 0; index < algorithmCount - 1; index++) {
1462         SecKeyAlgorithm indexAlgorithm = CFArrayGetValueAtIndex(context->algorithm, index);
1463         for (CFIndex tested = index + 1; tested < algorithmCount; tested++) {
1464             require_quiet(!CFEqual(indexAlgorithm, CFArrayGetValueAtIndex(context->algorithm, tested)), fail);
1465         }
1466     }
1467
1468     SecKeyAlgorithm algorithm = CFArrayGetValueAtIndex(context->algorithm, algorithmCount - 1);
1469     CFTypeRef output = SecKeyCopyBackendOperationResult(context, algorithm, in1, in2, error);
1470     if (output != kCFNull) {
1471         // Backend handled the operation, return result.
1472         return output;
1473     }
1474
1475     // To silence static analyzer.
1476     CFReleaseSafe(output);
1477
1478     // Get adaptor which is able to handle requested algorithm.
1479     SecKeyAlgorithmAdaptor adaptor = SecKeyGetAlgorithmAdaptor(context->operation, algorithm);
1480     require_quiet(adaptor != NULL, fail);
1481
1482     // Invoke the adaptor and return result.
1483     CFTypeRef result = adaptor(context, in1, in2, error);
1484     require_quiet(result != kCFNull, fail);
1485     return result;
1486
1487 fail:
1488     if (context->mode == kSecKeyOperationModePerform) {
1489         SecError(errSecParam, error, CFSTR("%@: algorithm not supported by the key %@"),
1490                  CFArrayGetValueAtIndex(context->algorithm, 0), context->key);
1491         return NULL;
1492     } else {
1493         return kCFNull;
1494     }
1495 }
1496
1497 #pragma mark Algorithm-related SecKey API entry points
1498
1499 static CFMutableArrayRef SecKeyCreateAlgorithmArray(SecKeyAlgorithm algorithm) {
1500     CFMutableArrayRef result = CFArrayCreateMutableForCFTypes(kCFAllocatorDefault);
1501     CFArrayAppendValue(result, algorithm);
1502     return result;
1503 }
1504
1505 CFDataRef SecKeyCreateSignature(SecKeyRef key, SecKeyAlgorithm algorithm, CFDataRef dataToSign, CFErrorRef *error) {
1506     CFErrorRef localError = NULL;
1507     SecKeyOperationContext context = { key, kSecKeyOperationTypeSign, SecKeyCreateAlgorithmArray(algorithm) };
1508     CFDataRef result = SecKeyRunAlgorithmAndCopyResult(&context, dataToSign, NULL, &localError);
1509     SecKeyOperationContextDestroy(&context);
1510     SecKeyErrorPropagate(result != NULL, localError, error);
1511     return result;
1512 }
1513
1514 Boolean SecKeyVerifySignature(SecKeyRef key, SecKeyAlgorithm algorithm, CFDataRef signedData, CFDataRef signature,
1515                               CFErrorRef *error) {
1516     CFErrorRef localError = NULL;
1517     SecKeyOperationContext context = { key, kSecKeyOperationTypeVerify, SecKeyCreateAlgorithmArray(algorithm) };
1518     CFTypeRef res = SecKeyRunAlgorithmAndCopyResult(&context, signedData, signature, &localError);
1519     Boolean result = CFEqualSafe(res, kCFBooleanTrue);
1520     CFReleaseSafe(res);
1521     SecKeyOperationContextDestroy(&context);
1522     SecKeyErrorPropagate(result, localError, error);
1523     return result;
1524 }
1525
1526 CFDataRef SecKeyCreateEncryptedData(SecKeyRef key, SecKeyAlgorithm algorithm, CFDataRef plainText, CFErrorRef *error) {
1527     CFErrorRef localError = NULL;
1528     SecKeyOperationContext context = { key, kSecKeyOperationTypeEncrypt, SecKeyCreateAlgorithmArray(algorithm) };
1529     CFDataRef result = SecKeyRunAlgorithmAndCopyResult(&context, plainText, NULL, &localError);
1530     SecKeyOperationContextDestroy(&context);
1531     SecKeyErrorPropagate(result, localError, error);
1532     return result;
1533 }
1534
1535 CFDataRef SecKeyCreateDecryptedData(SecKeyRef key, SecKeyAlgorithm algorithm, CFDataRef cipherText, CFErrorRef *error) {
1536     SecKeyOperationContext context = { key, kSecKeyOperationTypeDecrypt, SecKeyCreateAlgorithmArray(algorithm) };
1537     CFDataRef result = SecKeyRunAlgorithmAndCopyResult(&context, cipherText, NULL, error);
1538     SecKeyOperationContextDestroy(&context);
1539     return result;
1540 }
1541
1542 CFDataRef SecKeyCopyKeyExchangeResult(SecKeyRef key, SecKeyAlgorithm algorithm, SecKeyRef publicKey,
1543                                       CFDictionaryRef parameters, CFErrorRef *error) {
1544     CFErrorRef localError = NULL;
1545     CFDataRef publicKeyData = NULL, result = NULL;
1546     SecKeyOperationContext context = { key, kSecKeyOperationTypeKeyExchange, SecKeyCreateAlgorithmArray(algorithm) };
1547     require_quiet(publicKeyData = SecKeyCopyExternalRepresentation(publicKey, error), out);
1548     result = SecKeyRunAlgorithmAndCopyResult(&context, publicKeyData, parameters, &localError);
1549     SecKeyErrorPropagate(result != NULL, localError, error);
1550
1551 out:
1552     CFReleaseSafe(publicKeyData);
1553     SecKeyOperationContextDestroy(&context);
1554     return result;
1555 }
1556
1557 Boolean SecKeyIsAlgorithmSupported(SecKeyRef key, SecKeyOperationType operation, SecKeyAlgorithm algorithm) {
1558     SecKeyOperationContext context = { key, operation, SecKeyCreateAlgorithmArray(algorithm), kSecKeyOperationModeCheckIfSupported };
1559     CFErrorRef error = NULL;
1560     CFTypeRef res = SecKeyRunAlgorithmAndCopyResult(&context, NULL, NULL, &error);
1561     Boolean result = CFEqualSafe(res, kCFBooleanTrue);
1562     CFReleaseSafe(res);
1563     CFReleaseSafe(error);
1564     SecKeyOperationContextDestroy(&context);
1565     return result;
1566 }