OSX/sec/Security/SecFramework.c

   1 /*
   2  * Copyright (c) 2006-2017 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  * SecFramework.c - generic non API class specific functions
  26  */
  27
  28 #ifdef STANDALONE
  29 /* Allows us to build genanchors against the BaseSDK. */
  30 #undef __ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__
  31 #undef __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__
  32 #endif
  33
  34 #include "SecFramework.h"
  35 #include <dispatch/dispatch.h>
  36 #include <CoreFoundation/CFBundle.h>
  37 #include <CoreFoundation/CFURLAccess.h>
  38 #include <Security/SecRandom.h>
  39 #include <CommonCrypto/CommonRandomSPI.h>
  40 #include <fcntl.h>
  41 #include <sys/types.h>
  42 #include <unistd.h>
  43 #include <utilities/debugging.h>
  44 #include <utilities/SecCFWrappers.h>
  45 #include <Security/SecBase.h>
  46 #include <inttypes.h>
  47
  48 #if !(TARGET_IPHONE_SIMULATOR && defined(IPHONE_SIMULATOR_HOST_MIN_VERSION_REQUIRED) && IPHONE_SIMULATOR_HOST_MIN_VERSION_REQUIRED < 1090)
  49 #include <sys/guarded.h>
  50 #define USE_GUARDED_OPEN 1
  51 #else
  52 #define USE_GUARDED_OPEN 0
  53 #endif
  54
  55
  56 /* Security.framework's bundle id. */
  57 #if TARGET_OS_IPHONE
  58 static CFStringRef kSecFrameworkBundleID = CFSTR("com.apple.Security");
  59 #else
  60 static CFStringRef kSecFrameworkBundleID = CFSTR("com.apple.security");
  61 #endif
  62
  63 CFGiblisGetSingleton(CFBundleRef, SecFrameworkGetBundle, bundle,  ^{
  64     *bundle = CFRetainSafe(CFBundleGetBundleWithIdentifier(kSecFrameworkBundleID));
  65 })
  66
  67 CFStringRef SecFrameworkCopyLocalizedString(CFStringRef key,
  68     CFStringRef tableName) {
  69     CFBundleRef bundle = SecFrameworkGetBundle();
  70     if (bundle)
  71         return CFBundleCopyLocalizedString(bundle, key, key, tableName);
  72
  73     return CFRetainSafe(key);
  74 }
  75
  76 CFURLRef SecFrameworkCopyResourceURL(CFStringRef resourceName,
  77         CFStringRef resourceType, CFStringRef subDirName) {
  78     CFURLRef url = NULL;
  79     CFBundleRef bundle = SecFrameworkGetBundle();
  80     if (bundle) {
  81         url = CFBundleCopyResourceURL(bundle, resourceName,
  82                         resourceType, subDirName);
  83                 if (!url) {
  84             secwarning("resource: %@.%@ in %@ not found", resourceName,
  85                 resourceType, subDirName);
  86                 }
  87     }
  88
  89         return url;
  90 }
  91
  92 CFDataRef SecFrameworkCopyResourceContents(CFStringRef resourceName,
  93         CFStringRef resourceType, CFStringRef subDirName) {
  94     CFURLRef url = SecFrameworkCopyResourceURL(resourceName, resourceType,
  95         subDirName);
  96         CFDataRef data = NULL;
  97     if (url) {
  98         SInt32 error;
  99         if (!CFURLCreateDataAndPropertiesFromResource(kCFAllocatorDefault,
 100             url, &data, NULL, NULL, &error)) {
 101             secwarning("read: %ld", (long) error);
 102         }
 103         CFRelease(url);
 104     }
 105
 106         return data;
 107 }
 108
 109 static CFStringRef copyErrorMessageFromBundle(OSStatus status, CFStringRef tableName);
 110
 111 // caller MUST release the string, since it is gotten with "CFCopyLocalizedStringFromTableInBundle"
 112 // intended use of reserved param is to pass in CFStringRef with name of the Table for lookup
 113 // Will look by default in "SecErrorMessages.strings" in the resources of Security.framework.
 114
 115
 116 CFStringRef
 117 SecCopyErrorMessageString(OSStatus status, void *reserved)
 118 {
 119     CFStringRef result = copyErrorMessageFromBundle(status, CFSTR("SecErrorMessages"));
 120     if (!result)
 121         result = copyErrorMessageFromBundle(status, CFSTR("SecDebugErrorMessages"));
 122
 123     if (!result)
 124     {
 125         // no error message found, so format a faked-up error message from the status
 126         result = CFStringCreateWithFormat(NULL, NULL, CFSTR("OSStatus %d"), (int)status);
 127     }
 128
 129     return result;
 130 }
 131
 132 CFStringRef
 133 copyErrorMessageFromBundle(OSStatus status,CFStringRef tableName)
 134 {
 135
 136     CFStringRef errorString = nil;
 137     CFStringRef keyString = nil;
 138     CFBundleRef secBundle = NULL;
 139
 140     // Make a bundle instance using the URLRef.
 141     secBundle = CFBundleGetBundleWithIdentifier(kSecFrameworkBundleID);
 142     if (!secBundle)
 143         goto exit;
 144
 145     // Convert status to Int32 string representation, e.g. "-25924"
 146     keyString = CFStringCreateWithFormat (kCFAllocatorDefault, NULL, CFSTR("%d"), (int)status);
 147     if (!keyString)
 148         goto exit;
 149
 150     errorString = CFCopyLocalizedStringFromTableInBundle(keyString, tableName, secBundle, NULL);
 151     if (CFStringCompare(errorString, keyString, 0) == kCFCompareEqualTo)    // no real error message
 152     {
 153         if (errorString)
 154             CFRelease(errorString);
 155         errorString = nil;
 156     }
 157 exit:
 158     if (keyString)
 159         CFRelease(keyString);
 160
 161     return errorString;
 162 }
 163
 164
 165 const SecRandomRef kSecRandomDefault = NULL;
 166
 167 int SecRandomCopyBytes(SecRandomRef rnd, size_t count, void *bytes) {
 168     if (rnd != kSecRandomDefault)
 169         return errSecParam;
 170     return CCRandomCopyBytes(kCCRandomDefault, bytes, count);
 171 }