[apple/libsecurity_codesigning.git] / lib / SecStaticCode.cpp

/*
 * Copyright (c) 2006-2007 Apple Inc. All Rights Reserved.
 * 
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

//
// SecStaticCode - API frame for SecStaticCode objects
//
#include "cs.h"
#include "StaticCode.h"
#include <security_utilities/cfmunge.h>
#include <fcntl.h>
#include <dirent.h>

using namespace CodeSigning;


//
// CF-standard type code function
//
CFTypeID SecStaticCodeGetTypeID(void)
{
	BEGIN_CSAPI
	return gCFObjects().StaticCode.typeID;
    END_CSAPI1(_kCFRuntimeNotATypeID)
}


//
// Create an StaticCode directly from disk path.
//
OSStatus SecStaticCodeCreateWithPath(CFURLRef path, SecCSFlags flags, SecStaticCodeRef *staticCodeRef)
{
	BEGIN_CSAPI
	
	checkFlags(flags);
	CodeSigning::Required(staticCodeRef) = (new SecStaticCode(DiskRep::bestGuess(cfString(path).c_str())))->handle();

	END_CSAPI
}

const CFStringRef kSecCodeAttributeArchitecture =	CFSTR("architecture");
const CFStringRef kSecCodeAttributeSubarchitecture =CFSTR("subarchitecture");
const CFStringRef kSecCodeAttributeBundleVersion =	CFSTR("bundleversion");

OSStatus SecStaticCodeCreateWithPathAndAttributes(CFURLRef path, SecCSFlags flags, CFDictionaryRef attributes,
	SecStaticCodeRef *staticCodeRef)
{
	BEGIN_CSAPI
	
	checkFlags(flags);
	DiskRep::Context ctx;
	std::string version; // holds memory placed into ctx
	if (attributes) {
		std::string archName;
		int archNumber, subarchNumber;
		if (cfscan(attributes, "{%O=%s}", kSecCodeAttributeArchitecture, &archName)) {
			ctx.arch = Architecture(archName.c_str());
		} else if (cfscan(attributes, "{%O=%d,%O=%d}",
				kSecCodeAttributeArchitecture, &archNumber, kSecCodeAttributeSubarchitecture, &subarchNumber))
			ctx.arch = Architecture(archNumber, subarchNumber);
		else if (cfscan(attributes, "{%O=%d}", kSecCodeAttributeArchitecture, &archNumber))
			ctx.arch = Architecture(archNumber);
		if (cfscan(attributes, "{%O=%s}", kSecCodeAttributeBundleVersion, &version))
			ctx.version = version.c_str();
	}
	
	CodeSigning::Required(staticCodeRef) = (new SecStaticCode(DiskRep::bestGuess(cfString(path).c_str(), &ctx)))->handle();

	END_CSAPI
}


//
// Check static validity of a StaticCode
//
static void validate(SecStaticCode *code, const SecRequirement *req, SecCSFlags flags);
static void validateNested(string location, const SecRequirement *req, SecCSFlags flags, string exclude = "/");

static void validate(SecStaticCode *code, const SecRequirement *req, SecCSFlags flags)
{
	try {
		code->validateNonResourceComponents();	// also validates the CodeDirectory
		if (!(flags & kSecCSDoNotValidateExecutable))
			code->validateExecutable();
		if (!(flags & kSecCSDoNotValidateResources))
			code->validateResources();
		if (req)
			code->validateRequirement(req->requirement(), errSecCSReqFailed);
		if (flags & kSecCSCheckNestedCode)
			if (CFURLRef baseUrl = code->resourceBase()) {
				// CFBundle has no orderly enumerator of these things, so this is somewhat ad-hoc.
				// (It should be augmented by information in ResourceDirectory.)
				string base = cfString(baseUrl) + "/";
				validateNested(base + "Frameworks", req, flags);
				validateNested(base + "SharedFrameworks", req, flags);
				validateNested(base + "PlugIns", req, flags);
				validateNested(base + "Plug-ins", req, flags);
				validateNested(base + "XPCServices", req, flags);
				validateNested(base + "MacOS", req, flags, code->mainExecutablePath());	// helpers
			}
	} catch (CSError &err) {
		if (Universal *fat = code->diskRep()->mainExecutableImage())	// Mach-O
			if (MachO *mach = fat->architecture()) {
				err.augment(kSecCFErrorArchitecture, CFTempString(mach->architecture().displayName()));
				delete mach;
			}
		throw;
	} catch (const MacOSError &err) {
		// add architecture information if we can get it
		if (Universal *fat = code->diskRep()->mainExecutableImage())
			if (MachO *mach = fat->architecture()) {
				CFTempString arch(mach->architecture().displayName());
				delete mach;
				CSError::throwMe(err.error, kSecCFErrorArchitecture, arch);
			}
		// else just pass it on
		throw;
	}
}

static void validateNested(string location, const SecRequirement *req, SecCSFlags flags, string exclude)
{
	DIR *dir = opendir(location.c_str());
	if (dir == 0) {
		if (errno == ENOENT)	// nothing there (okay)
			return;
		UnixError::throwMe();
	}
	while (struct dirent *dp = readdir(dir)) {
		switch (dp->d_type) {
		case DT_REG:
		case DT_LNK:
		case DT_DIR:
			break;
		default:
			continue;
		}
		if (dp->d_name[0] == '.')
			continue;
		string path = location + "/" + dp->d_name;
		if (path == exclude)	// main executable; skip
			continue;
		try {
			SecPointer<SecStaticCode> code = new SecStaticCode(DiskRep::bestGuess(path));
			validate(code, req, flags);
		} catch (CSError &err) {
			err.augment(kSecCFErrorPath, CFTempURL(path));
			throw;
		}
	}
	closedir(dir);
}


OSStatus SecStaticCodeCheckValidity(SecStaticCodeRef staticCodeRef, SecCSFlags flags,
	SecRequirementRef requirementRef)
{
	return SecStaticCodeCheckValidityWithErrors(staticCodeRef, flags, requirementRef, NULL);
}

OSStatus SecStaticCodeCheckValidityWithErrors(SecStaticCodeRef staticCodeRef, SecCSFlags flags,
	SecRequirementRef requirementRef, CFErrorRef *errors)
{
	BEGIN_CSAPI
	
	checkFlags(flags,
		  kSecCSCheckAllArchitectures
		| kSecCSDoNotValidateExecutable
		| kSecCSDoNotValidateResources
		| kSecCSConsiderExpiration
		| kSecCSEnforceRevocationChecks
		| kSecCSCheckNestedCode);

	SecPointer<SecStaticCode> code = SecStaticCode::requiredStatic(staticCodeRef);
	const SecRequirement *req = SecRequirement::optional(requirementRef);
	DTRACK(CODESIGN_EVAL_STATIC, code, (char*)code->mainExecutablePath().c_str());
	if (flags & kSecCSCheckAllArchitectures) {
		SecStaticCode::AllArchitectures archs(code);
		while (SecPointer<SecStaticCode> scode = archs())
			validate(scode, req, flags);
	} else
		validate(code, req, flags);

	END_CSAPI_ERRORS
}


//
// ====================================================================================
//
// The following API functions are called SecCode* but accept both SecCodeRef and
// SecStaticCodeRef arguments, operating on the implied SecStaticCodeRef as appropriate.
// Hence they're here, rather than in SecCode.cpp.
//


//
// Retrieve location information for an StaticCode.
//
OSStatus SecCodeCopyPath(SecStaticCodeRef staticCodeRef, SecCSFlags flags, CFURLRef *path)
{
	BEGIN_CSAPI
	
	checkFlags(flags);
	SecPointer<SecStaticCode> staticCode = SecStaticCode::requiredStatic(staticCodeRef);
	CodeSigning::Required(path) = staticCode->canonicalPath();

	END_CSAPI
}


//
// Fetch or make up a designated requirement
//
OSStatus SecCodeCopyDesignatedRequirement(SecStaticCodeRef staticCodeRef, SecCSFlags flags,
	SecRequirementRef *requirementRef)
{
	BEGIN_CSAPI
	
	checkFlags(flags);
	const Requirement *req =
		SecStaticCode::requiredStatic(staticCodeRef)->designatedRequirement();
	CodeSigning::Required(requirementRef) = (new SecRequirement(req))->handle();

	END_CSAPI
}


//
// Fetch a particular internal requirement, if present
//
OSStatus SecCodeCopyInternalRequirement(SecStaticCodeRef staticCodeRef, SecRequirementType type,
	SecCSFlags flags, SecRequirementRef *requirementRef)
{
	BEGIN_CSAPI
	
	checkFlags(flags);
	const Requirement *req =
		SecStaticCode::requiredStatic(staticCodeRef)->internalRequirement(type);
	CodeSigning::Required(requirementRef) = req ? (new SecRequirement(req))->handle() : NULL;

	END_CSAPI
}


//
// Record for future use a detached code signature.
//
OSStatus SecCodeSetDetachedSignature(SecStaticCodeRef codeRef, CFDataRef signature,
	SecCSFlags flags)
{
	BEGIN_CSAPI
	
	checkFlags(flags);
	SecPointer<SecStaticCode> code = SecStaticCode::requiredStatic(codeRef);

	if (signature)
		CFRetain(signature);	// own a reference...
	code->detachedSignature(signature); // ... and pass it to the code
	code->resetValidity();

	END_CSAPI
}


//
// Attach a code signature to a kernel memory mapping for page-in validation.
//
OSStatus SecCodeMapMemory(SecStaticCodeRef codeRef, SecCSFlags flags)
{
	BEGIN_CSAPI
	
	checkFlags(flags);
	SecPointer<SecStaticCode> code = SecStaticCode::requiredStatic(codeRef);
	if (const CodeDirectory *cd = code->codeDirectory(false)) {
		fsignatures args = { code->diskRep()->signingBase(), (void *)cd, cd->length() };
		UnixError::check(::fcntl(code->diskRep()->fd(), F_ADDSIGS, &args));
	} else
		MacOSError::throwMe(errSecCSUnsigned);

	END_CSAPI
}
Commit	Line	Data
7d31e928 A	1	/*
	2	* Copyright (c) 2006-2007 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	// SecStaticCode - API frame for SecStaticCode objects
	26	//
	27	#include "cs.h"
	28	#include "StaticCode.h"
f60086fc	29	#include <security_utilities/cfmunge.h>
7d31e928	30	#include <fcntl.h>
f60086fc	31	#include <dirent.h>
7d31e928 A	32
	33	using namespace CodeSigning;
	34
	35
	36	//
	37	// CF-standard type code function
	38	//
	39	CFTypeID SecStaticCodeGetTypeID(void)
	40	{
	41	BEGIN_CSAPI
	42	return gCFObjects().StaticCode.typeID;
	43	END_CSAPI1(_kCFRuntimeNotATypeID)
	44	}
	45
	46
	47	//
	48	// Create an StaticCode directly from disk path.
	49	//
	50	OSStatus SecStaticCodeCreateWithPath(CFURLRef path, SecCSFlags flags, SecStaticCodeRef *staticCodeRef)
	51	{
	52	BEGIN_CSAPI
	53
	54	checkFlags(flags);
f60086fc A	55	CodeSigning::Required(staticCodeRef) = (new SecStaticCode(DiskRep::bestGuess(cfString(path).c_str())))->handle();
	56
	57	END_CSAPI
	58	}
	59
	60	const CFStringRef kSecCodeAttributeArchitecture = CFSTR("architecture");
	61	const CFStringRef kSecCodeAttributeSubarchitecture =CFSTR("subarchitecture");
	62	const CFStringRef kSecCodeAttributeBundleVersion = CFSTR("bundleversion");
	63
	64	OSStatus SecStaticCodeCreateWithPathAndAttributes(CFURLRef path, SecCSFlags flags, CFDictionaryRef attributes,
	65	SecStaticCodeRef *staticCodeRef)
	66	{
	67	BEGIN_CSAPI
	68
	69	checkFlags(flags);
	70	DiskRep::Context ctx;
	71	std::string version; // holds memory placed into ctx
	72	if (attributes) {
	73	std::string archName;
	74	int archNumber, subarchNumber;
	75	if (cfscan(attributes, "{%O=%s}", kSecCodeAttributeArchitecture, &archName)) {
	76	ctx.arch = Architecture(archName.c_str());
	77	} else if (cfscan(attributes, "{%O=%d,%O=%d}",
	78	kSecCodeAttributeArchitecture, &archNumber, kSecCodeAttributeSubarchitecture, &subarchNumber))
	79	ctx.arch = Architecture(archNumber, subarchNumber);
	80	else if (cfscan(attributes, "{%O=%d}", kSecCodeAttributeArchitecture, &archNumber))
	81	ctx.arch = Architecture(archNumber);
	82	if (cfscan(attributes, "{%O=%s}", kSecCodeAttributeBundleVersion, &version))
	83	ctx.version = version.c_str();
	84	}
	85
	86	CodeSigning::Required(staticCodeRef) = (new SecStaticCode(DiskRep::bestGuess(cfString(path).c_str(), &ctx)))->handle();
7d31e928 A	87
	88	END_CSAPI
	89	}
	90
	91
	92	//
	93	// Check static validity of a StaticCode
	94	//
f60086fc A	95	static void validate(SecStaticCode code, const SecRequirement req, SecCSFlags flags);
	96	static void validateNested(string location, const SecRequirement *req, SecCSFlags flags, string exclude = "/");
	97
	98	static void validate(SecStaticCode code, const SecRequirement req, SecCSFlags flags)
	99	{
	100	try {
935e6928	101	code->validateNonResourceComponents(); // also validates the CodeDirectory
f60086fc A	102	if (!(flags & kSecCSDoNotValidateExecutable))
	103	code->validateExecutable();
	104	if (!(flags & kSecCSDoNotValidateResources))
	105	code->validateResources();
	106	if (req)
	107	code->validateRequirement(req->requirement(), errSecCSReqFailed);
	108	if (flags & kSecCSCheckNestedCode)
	109	if (CFURLRef baseUrl = code->resourceBase()) {
	110	// CFBundle has no orderly enumerator of these things, so this is somewhat ad-hoc.
	111	// (It should be augmented by information in ResourceDirectory.)
	112	string base = cfString(baseUrl) + "/";
	113	validateNested(base + "Frameworks", req, flags);
	114	validateNested(base + "SharedFrameworks", req, flags);
	115	validateNested(base + "PlugIns", req, flags);
	116	validateNested(base + "Plug-ins", req, flags);
	117	validateNested(base + "XPCServices", req, flags);
	118	validateNested(base + "MacOS", req, flags, code->mainExecutablePath()); // helpers
	119	}
	120	} catch (CSError &err) {
	121	if (Universal *fat = code->diskRep()->mainExecutableImage()) // Mach-O
	122	if (MachO *mach = fat->architecture()) {
	123	err.augment(kSecCFErrorArchitecture, CFTempString(mach->architecture().displayName()));
	124	delete mach;
	125	}
	126	throw;
	127	} catch (const MacOSError &err) {
	128	// add architecture information if we can get it
	129	if (Universal *fat = code->diskRep()->mainExecutableImage())
	130	if (MachO *mach = fat->architecture()) {
	131	CFTempString arch(mach->architecture().displayName());
	132	delete mach;
	133	CSError::throwMe(err.error, kSecCFErrorArchitecture, arch);
	134	}
	135	// else just pass it on
	136	throw;
	137	}
	138	}
	139
	140	static void validateNested(string location, const SecRequirement *req, SecCSFlags flags, string exclude)
	141	{
	142	DIR *dir = opendir(location.c_str());
	143	if (dir == 0) {
	144	if (errno == ENOENT) // nothing there (okay)
	145	return;
	146	UnixError::throwMe();
	147	}
	148	while (struct dirent *dp = readdir(dir)) {
	149	switch (dp->d_type) {
	150	case DT_REG:
	151	case DT_LNK:
	152	case DT_DIR:
	153	break;
	154	default:
	155	continue;
	156	}
	157	if (dp->d_name[0] == '.')
	158	continue;
	159	string path = location + "/" + dp->d_name;
	160	if (path == exclude) // main executable; skip
	161	continue;
	162	try {
	163	SecPointer<SecStaticCode> code = new SecStaticCode(DiskRep::bestGuess(path));
	164	validate(code, req, flags);
	165	} catch (CSError &err) {
166	err.augment(kSecCFErrorPath, CFTempURL(path));
167	throw;
168	}
169	}
170	closedir(dir);
171	}
172
173
7d31e928 A	174	OSStatus SecStaticCodeCheckValidity(SecStaticCodeRef staticCodeRef, SecCSFlags flags,
	175	SecRequirementRef requirementRef)
	176	{
	177	return SecStaticCodeCheckValidityWithErrors(staticCodeRef, flags, requirementRef, NULL);
	178	}
	179
	180	OSStatus SecStaticCodeCheckValidityWithErrors(SecStaticCodeRef staticCodeRef, SecCSFlags flags,
	181	SecRequirementRef requirementRef, CFErrorRef *errors)
	182	{
	183	BEGIN_CSAPI
	184
	185	checkFlags(flags,
	186	kSecCSCheckAllArchitectures
	187	\| kSecCSDoNotValidateExecutable
	188	\| kSecCSDoNotValidateResources
f60086fc	189	\| kSecCSConsiderExpiration
935e6928	190	\| kSecCSEnforceRevocationChecks
f60086fc	191	\| kSecCSCheckNestedCode);
7d31e928 A	192
7d31e928 A	193	SecPointer<SecStaticCode> code = SecStaticCode::requiredStatic(staticCodeRef);
f60086fc	194	const SecRequirement *req = SecRequirement::optional(requirementRef);
d1c1ab47	195	DTRACK(CODESIGN_EVAL_STATIC, code, (char*)code->mainExecutablePath().c_str());
f60086fc A	196	if (flags & kSecCSCheckAllArchitectures) {
	197	SecStaticCode::AllArchitectures archs(code);
	198	while (SecPointer<SecStaticCode> scode = archs())
	199	validate(scode, req, flags);
	200	} else
	201	validate(code, req, flags);
7d31e928 A	202
	203	END_CSAPI_ERRORS
	204	}
	205
	206
	207	//
	208	// ====================================================================================
	209	//
	210	// The following API functions are called SecCode* but accept both SecCodeRef and
	211	// SecStaticCodeRef arguments, operating on the implied SecStaticCodeRef as appropriate.
	212	// Hence they're here, rather than in SecCode.cpp.
	213	//
	214
	215
	216	//
	217	// Retrieve location information for an StaticCode.
	218	//
	219	OSStatus SecCodeCopyPath(SecStaticCodeRef staticCodeRef, SecCSFlags flags, CFURLRef *path)
	220	{
	221	BEGIN_CSAPI
	222
	223	checkFlags(flags);
	224	SecPointer<SecStaticCode> staticCode = SecStaticCode::requiredStatic(staticCodeRef);
f60086fc	225	CodeSigning::Required(path) = staticCode->canonicalPath();
7d31e928 A	226
	227	END_CSAPI
	228	}
	229
	230
	231	//
	232	// Fetch or make up a designated requirement
	233	//
	234	OSStatus SecCodeCopyDesignatedRequirement(SecStaticCodeRef staticCodeRef, SecCSFlags flags,
	235	SecRequirementRef *requirementRef)
	236	{
	237	BEGIN_CSAPI
	238
	239	checkFlags(flags);
	240	const Requirement *req =
	241	SecStaticCode::requiredStatic(staticCodeRef)->designatedRequirement();
f60086fc	242	CodeSigning::Required(requirementRef) = (new SecRequirement(req))->handle();
d1c1ab47 A	243
	244	END_CSAPI
	245	}
	246
	247
	248	//
	249	// Fetch a particular internal requirement, if present
	250	//
	251	OSStatus SecCodeCopyInternalRequirement(SecStaticCodeRef staticCodeRef, SecRequirementType type,
	252	SecCSFlags flags, SecRequirementRef *requirementRef)
	253	{
	254	BEGIN_CSAPI
	255
	256	checkFlags(flags);
	257	const Requirement *req =
	258	SecStaticCode::requiredStatic(staticCodeRef)->internalRequirement(type);
f60086fc	259	CodeSigning::Required(requirementRef) = req ? (new SecRequirement(req))->handle() : NULL;
7d31e928 A	260
	261	END_CSAPI
	262	}
	263
	264
	265	//
	266	// Record for future use a detached code signature.
	267	//
	268	OSStatus SecCodeSetDetachedSignature(SecStaticCodeRef codeRef, CFDataRef signature,
	269	SecCSFlags flags)
	270	{
	271	BEGIN_CSAPI
	272
	273	checkFlags(flags);
	274	SecPointer<SecStaticCode> code = SecStaticCode::requiredStatic(codeRef);
	275
d1c1ab47 A	276	if (signature)
	277	CFRetain(signature); // own a reference...
	278	code->detachedSignature(signature); // ... and pass it to the code
7d31e928 A	279	code->resetValidity();
	280
	281	END_CSAPI
	282	}
	283
	284
	285	//
	286	// Attach a code signature to a kernel memory mapping for page-in validation.
	287	//
	288	OSStatus SecCodeMapMemory(SecStaticCodeRef codeRef, SecCSFlags flags)
	289	{
	290	BEGIN_CSAPI
	291
	292	checkFlags(flags);
	293	SecPointer<SecStaticCode> code = SecStaticCode::requiredStatic(codeRef);
	294	if (const CodeDirectory *cd = code->codeDirectory(false)) {
	295	fsignatures args = { code->diskRep()->signingBase(), (void *)cd, cd->length() };
	296	UnixError::check(::fcntl(code->diskRep()->fd(), F_ADDSIGS, &args));
	297	} else
	298	MacOSError::throwMe(errSecCSUnsigned);
	299
	300	END_CSAPI
	301	}