lib/SecRequirement.cpp

   1 /*
   2  * Copyright (c) 2006 Apple Computer, 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 // SecRequirement - API frame for SecRequirement objects
  26 //
  27 #include "cs.h"
  28 #include "Requirements.h"
  29 #include "reqparser.h"
  30 #include "reqmaker.h"
  31 #include "reqdumper.h"
  32 #include <Security/SecCertificate.h>
  33 #include <security_utilities/cfutilities.h>
  34
  35 using namespace CodeSigning;
  36
  37
  38 //
  39 // CF-standard type code function
  40 //
  41 CFTypeID SecRequirementGetTypeID(void)
  42 {
  43         BEGIN_CSAPI
  44         return gCFObjects().Requirement.typeID;
  45     END_CSAPI1(_kCFRuntimeNotATypeID)
  46 }
  47
  48
  49 //
  50 // Create a Requirement from data
  51 //
  52 OSStatus SecRequirementCreateWithData(CFDataRef data, SecCSFlags flags,
  53         SecRequirementRef *requirementRef)
  54 {
  55         BEGIN_CSAPI
  56
  57         checkFlags(flags);
  58         CodeSigning::Required(requirementRef) = (new SecRequirement(CFDataGetBytePtr(data), CFDataGetLength(data)))->handle();
  59
  60         END_CSAPI
  61 }
  62
  63
  64 //
  65 // Create a Requirement from data in a file
  66 //
  67 OSStatus SecRequirementCreateWithResource(CFURLRef resource, SecCSFlags flags,
  68         SecRequirementRef *requirementRef)
  69 {
  70         BEGIN_CSAPI
  71
  72         checkFlags(flags);
  73         CFRef<CFDataRef> data = cfLoadFile(resource);
  74         CodeSigning::Required(requirementRef) =
  75                 (new SecRequirement(CFDataGetBytePtr(data), CFDataGetLength(data)))->handle();
  76
  77         END_CSAPI
  78 }
  79
  80
  81 //
  82 // Create a Requirement from source text (compiling it)
  83 //
  84 OSStatus SecRequirementCreateWithString(CFStringRef text, SecCSFlags flags,
  85         SecRequirementRef *requirementRef)
  86 {
  87         return SecRequirementCreateWithStringAndErrors(text, flags, NULL, requirementRef);
  88 }
  89
  90 OSStatus SecRequirementCreateWithStringAndErrors(CFStringRef text, SecCSFlags flags,
  91         CFErrorRef *errors, SecRequirementRef *requirementRef)
  92 {
  93         BEGIN_CSAPI
  94
  95         checkFlags(flags);
  96         CodeSigning::Required(requirementRef) = (new SecRequirement(parseRequirement(cfString(text)), true))->handle();
  97
  98         END_CSAPI_ERRORS
  99 }
 100
 101
 102 //
 103 // Create a Requirement group.
 104 // This is the canonical point where "application group" is defined.
 105 //
 106 OSStatus SecRequirementCreateGroup(CFStringRef groupName, SecCertificateRef anchorRef,
 107         SecCSFlags flags, SecRequirementRef *requirementRef)
 108 {
 109         BEGIN_CSAPI
 110
 111         checkFlags(flags);
 112         Requirement::Maker maker;
 113         maker.put(opAnd);               // both of...
 114         maker.infoKey("Application-Group", cfString(groupName));
 115         if (anchorRef) {
 116                 CSSM_DATA certData;
 117                 MacOSError::check(SecCertificateGetData(anchorRef, &certData));
 118                 maker.anchor(0, certData.Data, certData.Length);
 119         } else {
 120                 maker.anchor();                 // canonical Apple anchor
 121         }
 122         CodeSigning::Required(requirementRef) = (new SecRequirement(maker.make(), true))->handle();
 123
 124         END_CSAPI
 125 }
 126
 127
 128 //
 129 // Extract the stable binary from from a SecRequirementRef
 130 //
 131 OSStatus SecRequirementCopyData(SecRequirementRef requirementRef, SecCSFlags flags,
 132         CFDataRef *data)
 133 {
 134         BEGIN_CSAPI
 135
 136         const Requirement *req = SecRequirement::required(requirementRef)->requirement();
 137         checkFlags(flags);
 138         CodeSigning::Required(data);
 139         *data = makeCFData(*req);
 140
 141         END_CSAPI
 142 }
 143
 144
 145 //
 146 // Generate source form for a SecRequirement (decompile/disassemble)
 147 //
 148 OSStatus SecRequirementCopyString(SecRequirementRef requirementRef, SecCSFlags flags,
 149         CFStringRef *text)
 150 {
 151         BEGIN_CSAPI
 152
 153         const Requirement *req = SecRequirement::required(requirementRef)->requirement();
 154         checkFlags(flags);
 155         CodeSigning::Required(text);
 156         *text = makeCFString(Dumper::dump(req));
 157
 158         END_CSAPI
 159 }
 160
 161
 162 //
 163 CFStringRef kSecRequirementKeyInfoPlist = CFSTR("requirement:eval:info");
 164 CFStringRef kSecRequirementKeyEntitlements = CFSTR("requirement:eval:entitlements");
 165
 166 OSStatus SecRequirementEvaluate(SecRequirementRef requirementRef,
 167         CFArrayRef certificateChain, CFDictionaryRef context,
 168         SecCSFlags flags)
 169 {
 170         BEGIN_CSAPI
 171
 172         const Requirement *req = SecRequirement::required(requirementRef)->requirement();
 173         checkFlags(flags);
 174         CodeSigning::Required(certificateChain);
 175
 176         Requirement::Context ctx(certificateChain,              // mandatory
 177                 context ? CFDictionaryRef(CFDictionaryGetValue(context, kSecRequirementKeyInfoPlist)) : NULL,
 178                 context ? CFDictionaryRef(CFDictionaryGetValue(context, kSecRequirementKeyEntitlements)) : NULL,
 179                 NULL    // can't specify a CodeDirectory here
 180         );
 181         req->validate(ctx);
 182
 183         END_CSAPI
 184 }
 185
 186
 187 //
 188 // Assemble a requirement set (as a CFData) from a dictionary of requirement objects.
 189 // An empty set is allowed.
 190 //
 191 OSStatus SecRequirementsCreateFromRequirements(CFDictionaryRef requirements, SecCSFlags flags,
 192         CFDataRef *requirementSet)
 193 {
 194         BEGIN_CSAPI
 195
 196         checkFlags(flags);
 197         if (requirements == NULL)
 198                 return errSecCSObjectRequired;
 199         CFIndex count = CFDictionaryGetCount(requirements);
 200         CFNumberRef keys[count];
 201         SecRequirementRef reqs[count];
 202         CFDictionaryGetKeysAndValues(requirements, (const void **)keys, (const void **)reqs);
 203         Requirements::Maker maker;
 204         for (CFIndex n = 0; n < count; n++) {
 205                 const Requirement *req = SecRequirement::required(reqs[n])->requirement();
 206                 maker.add(cfNumber<Requirements::Type>(keys[n]), req->clone());
 207         }
 208         Requirements *reqset = maker.make();                                    // malloc'ed
 209         CodeSigning::Required(requirementSet) = makeCFDataMalloc(*reqset);      // takes ownership of reqs
 210
 211         END_CSAPI
 212 }
 213
 214
 215 //
 216 // Break a requirement set (given as a CFData) into its constituent requirements
 217 // and return it as a CFDictionary.
 218 //
 219 OSStatus SecRequirementsCopyRequirements(CFDataRef requirementSet, SecCSFlags flags,
 220         CFDictionaryRef *requirements)
 221 {
 222         BEGIN_CSAPI
 223
 224         checkFlags(flags);
 225         if (requirementSet == NULL)
 226                 return errSecCSObjectRequired;
 227         const Requirements *reqs = (const Requirements *)CFDataGetBytePtr(requirementSet);
 228         CFRef<CFMutableDictionaryRef> dict = makeCFMutableDictionary();
 229         unsigned count = reqs->count();
 230         for (unsigned n = 0; n < count; n++) {
 231                 CFRef<SecRequirementRef> req = (new SecRequirement(reqs->blob<Requirement>(n)))->handle();
 232                 CFDictionaryAddValue(dict, CFTempNumber(reqs->type(n)), req);
 233         }
 234         CodeSigning::Required(requirements) = dict.yield();
 235
 236         END_CSAPI
 237 }
 238
 239
 240 //
 241 // Generically parse a string as some kind of requirement-related source form.
 242 // If properly recognized, return the result as a CF object:
 243 //      SecRequirementRef for a single requirement
 244 //      CFDataRef for a requirement set
 245 //
 246 OSStatus SecRequirementsCreateWithString(CFStringRef text, SecCSFlags flags,
 247         CFTypeRef *result, CFErrorRef *errors)
 248 {
 249         BEGIN_CSAPI
 250
 251         checkFlags(flags, kSecCSParseRequirement | kSecCSParseRequirementSet);
 252         if (text == NULL || result == NULL)
 253                 return errSecCSObjectRequired;
 254         std::string s = cfString(text);
 255         switch (flags & (kSecCSParseRequirement | kSecCSParseRequirementSet)) {
 256         case kSecCSParseRequirement:            // single only
 257                 *result = (new SecRequirement(parseRequirement(s), true))->handle();
 258                 break;
 259         case kSecCSParseRequirementSet:         // single only
 260                 {
 261                         const Requirements *reqs = parseRequirements(s);
 262                         *result = makeCFDataMalloc(*reqs);
 263                         break;
 264                 }
 265         case 0:
 266         case kSecCSParseRequirement | kSecCSParseRequirementSet:
 267                 {
 268                         const BlobCore *any = parseGeneric(s);
 269                         if (any->is<Requirement>())
 270                                 *result = (new SecRequirement(Requirement::specific(any), true))->handle();
 271                         else
 272                                 *result = makeCFDataMalloc(*any);
 273                         break;
 274                 }
 275         }
 276
 277         END_CSAPI_ERRORS
 278 }
 279
 280
 281 //
 282 // Convert a SecRequirementRef or a CFDataRef containing a requirement set to text.
 283 // Requirement sets will be formatted as multiple lines (one per requirement). They can be empty.
 284 // A single requirement will return a single line that is NOT newline-terminated.
 285 //
 286 OSStatus SecRequirementsCopyString(CFTypeRef input, SecCSFlags flags, CFStringRef *text)
 287 {
 288         BEGIN_CSAPI
 289
 290         checkFlags(flags);
 291         if (input == NULL)
 292                 return errSecCSObjectRequired;
 293         if (CFGetTypeID(input) == SecRequirementGetTypeID()) {
 294                 return SecRequirementCopyString(SecRequirementRef(input), flags, text);
 295         } else if (CFGetTypeID(input) == CFDataGetTypeID()) {
 296                 const Requirements *reqs = (const Requirements *)CFDataGetBytePtr(CFDataRef(input));
 297                 if (!reqs->validateBlob(CFDataGetLength(CFDataRef(input))))
 298                         return errSecCSReqInvalid;
 299                 CodeSigning::Required(text) = makeCFString(Dumper::dump(reqs, false));
 300         } else
 301                 return errSecCSInvalidObjectRef;
 302
 303         END_CSAPI
 304 }