OSX/libsecurity_codesigning/lib/CSCommon.h

   1 /*
   2  * Copyright (c) 2006-2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*!
  25         @header CSCommon
  26         CSCommon is the common header of all Code Signing API headers.
  27         It defines types, constants, and error codes.
  28 */
  29 #ifndef _H_CSCOMMON
  30 #define _H_CSCOMMON
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #include <stdint.h>
  37 #include <CoreFoundation/CoreFoundation.h>
  38
  39 CF_ASSUME_NONNULL_BEGIN
  40
  41 /*
  42         Code Signing specific OSStatus codes.
  43         [Assigned range 0xFFFE_FAxx].
  44 */
  45 CF_ENUM(OSStatus) {
  46         errSecCSUnimplemented =                         -67072, /* unimplemented code signing feature */
  47         errSecCSInvalidObjectRef =                      -67071, /* invalid API object reference */
  48         errSecCSInvalidFlags =                          -67070, /* invalid or inappropriate API flag(s) specified */
  49         errSecCSObjectRequired =                        -67069, /* a required pointer argument was NULL */
  50         errSecCSStaticCodeNotFound =            -67068, /* cannot find code object on disk */
  51         errSecCSUnsupportedGuestAttributes = -67067, /* cannot locate guests using this attribute set */
  52         errSecCSInvalidAttributeValues =        -67066, /* given attribute values are invalid */
  53         errSecCSNoSuchCode =                            -67065, /* host has no guest with the requested attributes */
  54         errSecCSMultipleGuests =                        -67064, /* ambiguous guest specification (host has multiple guests with these attribute values) */
  55         errSecCSGuestInvalid =                          -67063, /* code identity has been invalidated */
  56         errSecCSUnsigned =                                      -67062, /* code object is not signed at all */
  57         errSecCSSignatureFailed =                       -67061, /* invalid signature (code or signature have been modified) */
  58         errSecCSSignatureNotVerifiable =        -67060, /* the code cannot be read by the verifier (file system permissions etc.) */
  59         errSecCSSignatureUnsupported =          -67059, /* unsupported type or version of signature */
  60         errSecCSBadDictionaryFormat =           -67058, /* a required plist file or resource is malformed */
  61         errSecCSResourcesNotSealed =            -67057, /* resources are present but not sealed by signature */
  62         errSecCSResourcesNotFound =                     -67056, /* code has no resources but signature indicates they must be present */
  63         errSecCSResourcesInvalid =                      -67055, /* the sealed resource directory is invalid */
  64         errSecCSBadResource =                           -67054, /* a sealed resource is missing or invalid */
  65         errSecCSResourceRulesInvalid =          -67053, /* invalid resource specification rule(s) */
  66         errSecCSReqInvalid =                            -67052, /* invalid or corrupted code requirement(s) */
  67         errSecCSReqUnsupported =                        -67051, /* unsupported type or version of code requirement(s) */
  68         errSecCSReqFailed =                                     -67050, /* code failed to satisfy specified code requirement(s) */
  69         errSecCSBadObjectFormat =                       -67049, /* object file format unrecognized, invalid, or unsuitable */
  70         errSecCSInternalError =                         -67048, /* internal error in Code Signing subsystem */
  71         errSecCSHostReject =                            -67047, /* code rejected its host */
  72         errSecCSNotAHost =                                      -67046, /* attempt to specify guest of code that is not a host */
  73         errSecCSSignatureInvalid =                      -67045, /* invalid or unsupported format for signature */
  74         errSecCSHostProtocolRelativePath =      -67044, /* host protocol violation - absolute guest path required */
  75         errSecCSHostProtocolContradiction =     -67043, /* host protocol violation - contradictory hosting modes */
  76         errSecCSHostProtocolDedicationError = -67042, /* host protocol violation - operation not allowed with/for a dedicated guest */
  77         errSecCSHostProtocolNotProxy =          -67041, /* host protocol violation - proxy hosting not engaged */
  78         errSecCSHostProtocolStateError =        -67040, /* host protocol violation - invalid guest state change request */
  79         errSecCSHostProtocolUnrelated =         -67039, /* host protocol violation - the given guest is not a guest of the given host */
  80                                                                          /* -67038 obsolete (no longer issued) */
  81         errSecCSNotSupported =                          -67037, /* operation inapplicable or not supported for this type of code */
  82         errSecCSCMSTooLarge =                           -67036, /* signature too large to embed (size limitation of on-disk representation) */
  83         errSecCSHostProtocolInvalidHash =       -67035, /* host protocol violation - invalid guest hash */
  84         errSecCSStaticCodeChanged =                     -67034, /* the code on disk does not match what is running */
  85         errSecCSDBDenied =                                      -67033, /* permission to use a database denied */
  86         errSecCSDBAccess =                                      -67032, /* cannot access a database */
  87         errSecCSSigDBDenied = errSecCSDBDenied,
  88         errSecCSSigDBAccess = errSecCSDBAccess,
  89         errSecCSHostProtocolInvalidAttribute = -67031, /* host returned invalid or inconsistent guest attributes */
  90         errSecCSInfoPlistFailed =                       -67030, /* invalid Info.plist (plist or signature have been modified) */
  91         errSecCSNoMainExecutable =                      -67029, /* the code has no main executable file */
  92         errSecCSBadBundleFormat =                       -67028, /* bundle format unrecognized, invalid, or unsuitable */
  93         errSecCSNoMatches =                                     -67027, /* no matches for search or update operation */
  94         errSecCSFileHardQuarantined =           -67026, /* File created by an AppSandbox, exec/open not allowed */
  95         errSecCSOutdated =                                      -67025, /* presented data is out of date */
  96         errSecCSDbCorrupt =                                     -67024, /* a system database or file is corrupt */
  97         errSecCSResourceDirectoryFailed =       -67023, /* invalid resource directory (directory or signature have been modified) */
  98         errSecCSUnsignedNestedCode =            -67022, /* nested code is unsigned */
  99         errSecCSBadNestedCode =                         -67021, /* nested code is modified or invalid */
 100         errSecCSBadCallbackValue =                      -67020, /* monitor callback returned invalid value */
 101         errSecCSHelperFailed =                          -67019, /* the codesign_allocate helper tool cannot be found or used */
 102         errSecCSVetoed =                                        -67018,
 103         errSecCSBadLVArch =                                     -67017, /* library validation flag cannot be used with an i386 binary */
 104         errSecCSResourceNotSupported =          -67016, /* unsupported resource found (something not a directory, file or symlink) */
 105         errSecCSRegularFile =                           -67015, /* the main executable or Info.plist must be a regular file (no symlinks, etc.) */
 106         errSecCSUnsealedAppRoot =                       -67014, /* unsealed contents present in the bundle root */
 107         errSecCSWeakResourceRules =                     -67013, /* resource envelope is obsolete (custom omit rules) */
 108         errSecCSDSStoreSymlink =                        -67012, /* .DS_Store files cannot be a symlink */
 109         errSecCSAmbiguousBundleFormat =         -67011, /* bundle format is ambiguous (could be app or framework) */
 110         errSecCSBadMainExecutable =                     -67010, /* main executable failed strict validation */
 111         errSecCSBadFrameworkVersion =           -67009, /* embedded framework contains modified or invalid version */
 112         errSecCSUnsealedFrameworkRoot =         -67008, /* unsealed contents present in the root directory of an embedded framework */
 113         errSecCSWeakResourceEnvelope =          -67007, /* resource envelope is obsolete (version 1 signature) */
 114         errSecCSCancelled =                                     -67006, /* operation was terminated by explicit cancellation */
 115         errSecCSInvalidPlatform =                       -67005, /* invalid platform identifier or platform mismatch */
 116         errSecCSTooBig =                                        -67004, /* code is too big for current signing format */
 117         errSecCSInvalidSymlink =                        -67003, /* invalid destination for symbolic link in bundle */
 118         errSecCSNotAppLike =                            -67002, /* the code is valid but does not seem to be an app */
 119         errSecCSBadDiskImageFormat =            -67001, /* disk image format unrecognized, invalid, or unsuitable */
 120         errSecCSUnsupportedDigestAlgorithm = -67000, /* signature digest algorithm(s) specified are not supported */
 121 };
 122
 123 /*
 124  * Code Signing specific CFError "user info" keys.
 125  * In calls that can return CFErrorRef indications, if a CFErrorRef is actually
 126  * returned, its "user info" dictionary may contain some of the following keys
 127  * to more closely describe the circumstances of the failure.
 128  * Do not rely on the presence of any particular key to categorize a problem;
 129  * always use the primary OSStatus return for that. The data contained under
 130  * these keys is always supplemental and optional.
 131  */
 132 extern const CFStringRef kSecCFErrorArchitecture;       /* CFStringRef: name of architecture causing the problem */
 133 extern const CFStringRef kSecCFErrorPattern;            /* CFStringRef: invalid resource selection pattern encountered */
 134 extern const CFStringRef kSecCFErrorResourceSeal;       /* CFTypeRef: invalid component in resource seal (CodeResources) */
 135 extern const CFStringRef kSecCFErrorResourceAdded;      /* CFURLRef: unsealed resource found */
 136 extern const CFStringRef kSecCFErrorResourceAltered; /* CFURLRef: modified resource found */
 137 extern const CFStringRef kSecCFErrorResourceMissing; /* CFURLRef: sealed (non-optional) resource missing */
 138 extern const CFStringRef kSecCFErrorInfoPlist;          /* CFTypeRef: Info.plist dictionary or component thereof found invalid */
 139 extern const CFStringRef kSecCFErrorGuestAttributes; /* CFTypeRef: Guest attribute set of element not accepted */
 140 extern const CFStringRef kSecCFErrorRequirementSyntax; /* CFStringRef: compilation error for Requirement source */
 141 extern const CFStringRef kSecCFErrorPath;                       /* CFURLRef: subcomponent containing the error */
 142
 143 /*!
 144         @typedef SecCodeRef
 145         This is the type of a reference to running code.
 146
 147         In many (but not all) calls, this can be passed to a SecStaticCodeRef
 148         argument, which performs an implicit SecCodeCopyStaticCode call and
 149         operates on the result.
 150 */
 151 typedef struct CF_BRIDGED_TYPE(id) __SecCode *SecCodeRef;       /* running code */
 152
 153 /*!
 154         @typedef SecStaticCodeRef
 155         This is the type of a reference to static code on disk.
 156 */
 157 typedef struct CF_BRIDGED_TYPE(id) __SecCode const *SecStaticCodeRef;   /* code on disk */
 158
 159 /*!
 160         @typedef SecRequirementRef
 161         This is the type of a reference to a code requirement.
 162 */
 163 typedef struct CF_BRIDGED_TYPE(id) __SecRequirement *SecRequirementRef; /* code requirement */
 164
 165
 166 /*!
 167         @typedef SecGuestRef
 168         An abstract handle to identify a particular Guest in the context of its Host.
 169
 170         Guest handles are assigned by the host at will, with kSecNoGuest (zero) being
 171         reserved as the null value. They can be reused for new children if desired.
 172 */
 173 typedef u_int32_t SecGuestRef;
 174
 175 CF_ENUM(SecGuestRef) {
 176         kSecNoGuest = 0,                /* not a valid SecGuestRef */
 177 };
 178
 179
 180 /*!
 181         @typedef SecCSFlags
 182         This is the type of flags arguments to Code Signing API calls.
 183         It provides a bit mask of request and option flags. All of the bits in these
 184         masks are reserved to Apple; if you set any bits not defined in these headers,
 185         the behavior is generally undefined.
 186
 187         This list describes the flags that are shared among several Code Signing API calls.
 188         Flags that only apply to one call are defined and documented with that call.
 189         Global flags are assigned from high order down (31 -> 0); call-specific flags
 190         are assigned from the bottom up (0 -> 31).
 191
 192         @constant kSecCSDefaultFlags
 193         When passed to a flags argument throughout, indicates that default behavior
 194         is desired. Do not mix with other flags values.
 195         @constant kSecCSConsiderExpiration
 196         When passed to a call that performs code validation, requests that code signatures
 197         made by expired certificates be rejected. By default, expiration of participating
 198         certificates is not automatic grounds for rejection.
 199 */
 200 typedef CF_OPTIONS(uint32_t, SecCSFlags) {
 201     kSecCSDefaultFlags = 0,                                     /* no particular flags (default behavior) */
 202
 203     kSecCSConsiderExpiration = 1 << 31,         /* consider expired certificates invalid */
 204     kSecCSEnforceRevocationChecks = 1 << 30,    /* force revocation checks regardless of preference settings */
 205     kSecCSNoNetworkAccess = 1 << 29,            /* do not use the network, cancels "kSecCSEnforceRevocationChecks"  */
 206         kSecCSReportProgress = 1 << 28,                 /* make progress report call-backs when configured */
 207     kSecCSCheckTrustedAnchors = 1 << 27, /* build certificate chain to system trust anchors, not to any self-signed certificate */
 208 };
 209
 210
 211 /*!
 212         @typedef SecCodeSignatureFlags
 213         This is the type of option flags that can be embedded in a code signature
 214         during signing, and that govern the use of the signature thereafter.
 215         Some of these flags can be set through the codesign(1) command's --options
 216         argument; some are set implicitly based on signing circumstances; and all
 217         can be set with the kSecCodeSignerFlags item of a signing information dictionary.
 218
 219         @constant kSecCodeSignatureHost
 220         Indicates that the code may act as a host that controls and supervises guest
 221         code. If this flag is not set in a code signature, the code is never considered
 222         eligible to be a host, and any attempt to act like one will be ignored or rejected.
 223         @constant kSecCodeSignatureAdhoc
 224         The code has been sealed without a signing identity. No identity may be retrieved
 225         from it, and any code requirement placing restrictions on the signing identity
 226         will fail. This flag is set by the code signing API and cannot be set explicitly.
 227         @constant kSecCodeSignatureForceHard
 228         Implicitly set the "hard" status bit for the code when it starts running.
 229         This bit indicates that the code prefers to be denied access to a resource
 230         if gaining such access would cause its invalidation. Since the hard bit is
 231         sticky, setting this option bit guarantees that the code will always have
 232         it set.
 233         @constant kSecCodeSignatureForceKill
 234         Implicitly set the "kill" status bit for the code when it starts running.
 235         This bit indicates that the code wishes to be terminated with prejudice if
 236         it is ever invalidated. Since the kill bit is sticky, setting this option bit
 237         guarantees that the code will always be dynamically valid, since it will die
 238         immediately     if it becomes invalid.
 239         @constant kSecCodeSignatureForceExpiration
 240         Forces the kSecCSConsiderExpiration flag on all validations of the code.
 241  */
 242 typedef CF_OPTIONS(uint32_t, SecCodeSignatureFlags) {
 243         kSecCodeSignatureHost = 0x0001,                 /* may host guest code */
 244         kSecCodeSignatureAdhoc = 0x0002,                /* must be used without signer */
 245         kSecCodeSignatureForceHard = 0x0100,    /* always set HARD mode on launch */
 246         kSecCodeSignatureForceKill = 0x0200,    /* always set KILL mode on launch */
 247         kSecCodeSignatureForceExpiration = 0x0400, /* force certificate expiration checks */
 248         kSecCodeSignatureRestrict = 0x0800, /* restrict dyld loading */
 249         kSecCodeSignatureEnforcement = 0x1000, /* enforce code signing */
 250         kSecCodeSignatureLibraryValidation = 0x2000, /* library validation required */
 251 };
 252
 253
 254 /*!
 255         @typedef SecCodeStatus
 256         The code signing system attaches a set of status flags to each running code.
 257         These flags are maintained by the code's host, and can be read by anyone.
 258         A code may change its own flags, a host may change its guests' flags,
 259         and root may change anyone's flags.     However, these flags are sticky in that
 260         each can change in only one direction (and never back, for the lifetime of the code).
 261         Not even root can violate this restriction.
 262
 263         There are other flags in SecCodeStatus that are not publicly documented.
 264         Do not rely on them, and do not ever attempt to explicitly set them.
 265
 266         @constant kSecCodeStatusValid
 267         Indicates that the code is dynamically valid, i.e. it started correctly
 268         and has not been invalidated since then. The valid bit can only be cleared.
 269
 270         Warning: This bit is not your one-stop shortcut to determining the validity     of code.
 271         It represents the dynamic component of the full validity function; if this
 272         bit is unset, the code is definitely invalid, but the converse is not always true.
 273         In fact, code hosts may represent the outcome of some delayed static validation work in this bit,
 274         and thus it strictly represents a blend of (all of) dynamic and (some of) static validity,
 275         depending on the implementation of the particular host managing the code. You can (only)
 276         rely that (1) dynamic invalidation will clear this bit; and (2) the combination
 277         of static validation and dynamic validity (as performed by the SecCodeCheckValidity* APIs)
 278         will give a correct answer.
 279
 280         @constant kSecCodeStatusHard
 281         Indicates that the code prefers to be denied access to resources if gaining access
 282         would invalidate it. This bit can only be set.
 283         It is undefined whether code that is marked hard and is already invalid will still
 284         be denied access to a resource that would invalidate it if it were still valid. That is,
 285         the code may or may not get access to such a resource while being invalid, and that choice
 286         may appear random.
 287
 288         @constant kSecCodeStatusKill
 289         Indicates that the code wants to be killed (terminated) if it ever loses its validity.
 290         This bit can only be set. Code that has the kill flag set will never be dynamically invalid
 291         (and live). Note however that a change in static validity does not necessarily trigger instant
 292         death.
 293 */
 294 typedef CF_OPTIONS(uint32_t, SecCodeStatus) {
 295         kSecCodeStatusValid =   0x0001,
 296         kSecCodeStatusHard =    0x0100,
 297         kSecCodeStatusKill =    0x0200,
 298 };
 299
 300
 301 /*!
 302         @typedef SecRequirementType
 303         An enumeration indicating different types of internal requirements for code.
 304  */
 305 typedef CF_ENUM(uint32_t, SecRequirementType) {
 306         kSecHostRequirementType =                       1,      /* what hosts may run us */
 307         kSecGuestRequirementType =                      2,      /* what guests we may run */
 308         kSecDesignatedRequirementType =         3,      /* designated requirement */
 309         kSecLibraryRequirementType =            4,      /* what libraries we may link against */
 310         kSecPluginRequirementType =                     5,      /* what plug-ins we may load */
 311         kSecInvalidRequirementType,                             /* invalid type of Requirement (must be last) */
 312         kSecRequirementTypeCount = kSecInvalidRequirementType /* number of valid requirement types */
 313 };
 314
 315
 316 /*!
 317  Types of cryptographic digests (hashes) used to hold code signatures
 318  together.
 319
 320  Each combination of type, length, and other parameters is a separate
 321  hash type; we don't understand "families" here.
 322
 323  These type codes govern the digest links that connect a CodeDirectory
 324  to its subordinate data structures (code pages, resources, etc.)
 325  They do not directly control other uses of hashes (such as those used
 326  within X.509 certificates and CMS blobs).
 327  */
 328 typedef CF_ENUM(uint32_t, SecCSDigestAlgorithm) {
 329         kSecCodeSignatureNoHash                                                 =  0,   /* null value */
 330         kSecCodeSignatureHashSHA1                                               =  1,   /* SHA-1 */
 331         kSecCodeSignatureHashSHA256                                             =  2,   /* SHA-256 */
 332         kSecCodeSignatureHashSHA256Truncated                    =  3,   /* SHA-256 truncated to first 20 bytes */
 333         kSecCodeSignatureHashSHA384                                             =  4,   /* SHA-384 */
 334 };
 335
 336 CF_ASSUME_NONNULL_END
 337
 338 #ifdef __cplusplus
 339 }
 340 #endif
 341
 342 #endif //_H_CSCOMMON