OSX/libsecurity_codesigning/lib/SecCode.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 SecCode
  26         SecCode represents separately indentified running code in the system.
  27         In addition to UNIX processes, this can also include (with suitable support)
  28         scripts, applets, widgets, etc.
  29 */
  30 #ifndef _H_SECCODE
  31 #define _H_SECCODE
  32
  33 #include <Security/CSCommon.h>
  34 #include <CoreFoundation/CFBase.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 CF_ASSUME_NONNULL_BEGIN
  41
  42 /*!
  43         @function SecCodeGetTypeID
  44         Returns the type identifier of all SecCode instances.
  45 */
  46 CFTypeID SecCodeGetTypeID(void);
  47
  48
  49 /*!
  50         @function SecCodeCopySelf
  51         Obtains a SecCode object for the code making the call.
  52         The calling code is determined in a way that is subject to modification over
  53         time, but obeys the following rules. If it is a UNIX process, its process id (pid)
  54         is always used. If it is an active code host that has a dedicated guest, such a guest
  55         is always preferred. If it is a host that has called SecHostSelectGuest, such selection
  56         is considered until revoked.
  57
  58         @param flags Optional flags. Pass kSecCSDefaultFlags for standard behavior.
  59         @param self Upon successful return, contains a SecCodeRef representing the caller.
  60
  61         @result Upon success, errSecSuccess. Upon error, an OSStatus value documented in
  62         CSCommon.h or certain other Security framework headers.
  63  */
  64 OSStatus SecCodeCopySelf(SecCSFlags flags, SecCodeRef * __nonnull CF_RETURNS_RETAINED self);
  65
  66
  67 /*!
  68         @function SecCodeCopyStaticCode
  69         Given a SecCode object, locate its origin in the file system and return
  70         a SecStaticCode object representing it.
  71
  72         The link established by this call is generally reliable but is NOT guaranteed
  73         to be secure.
  74
  75         Many API functions taking SecStaticCodeRef arguments will also directly
  76         accept a SecCodeRef and apply this translation implicitly, operating on
  77         its result or returning its error code if any. Each of these functions
  78         calls out that behavior in its documentation.
  79
  80         If the code was obtained from a universal (aka "fat") program file,
  81         the resulting SecStaticCodeRef will refer only to the architecture actually
  82         being used. This means that multiple running codes started from the same file
  83         may conceivably result in different static code references if they ended up
  84         using different execution architectures. (This is unusual but possible.)
  85
  86         @param code A valid SecCode object reference representing code running
  87         on the system.
  88
  89         @param flags Optional flags. Pass kSecCSDefaultFlags for standard behavior.
  90         @constant kSecCSUseAllArchitectures
  91         If code refers to a single architecture of a universal binary, return a SecStaticCodeRef
  92         that refers to the entire universal code with all its architectures. By default, the
  93         returned static reference identifies only the actual architecture of the running program.
  94
  95         @param staticCode On successful return, a SecStaticCode object reference representing
  96         the file system origin of the given SecCode. On error, unchanged.
  97         @result Upon success, errSecSuccess. Upon error, an OSStatus value documented in
  98         CSCommon.h or certain other Security framework headers.
  99 */
 100 CF_ENUM(uint32_t) {
 101         kSecCSUseAllArchitectures = 1 << 0,
 102 };
 103
 104 OSStatus SecCodeCopyStaticCode(SecCodeRef code, SecCSFlags flags, SecStaticCodeRef * __nonnull CF_RETURNS_RETAINED staticCode);
 105
 106
 107 /*!
 108         @function SecCodeCopyHost
 109         Given a SecCode object, identify the (different) SecCode object that acts
 110         as its host. A SecCode's host acts as a supervisor and controller,
 111         and is the ultimate authority on the its dynamic validity and status.
 112         The host relationship is securely established (absent reported errors).
 113
 114         @param code A valid SecCode object reference representing code running
 115         on the system.
 116         @param flags Optional flags. Pass kSecCSDefaultFlags for standard behavior.
 117         @param host On successful return, a SecCode object reference identifying
 118         the code's host.
 119         @result Upon success, errSecSuccess. Upon error, an OSStatus value documented in
 120         CSCommon.h or certain other Security framework headers.
 121 */
 122 OSStatus SecCodeCopyHost(SecCodeRef guest, SecCSFlags flags, SecCodeRef * __nonnull CF_RETURNS_RETAINED host);
 123
 124 /*!
 125         @function SecCodeCopyGuestWithAttributes
 126         This is the omnibus API function for obtaining dynamic code references.
 127         In general, it asks a particular code acting as a code host to locate
 128         and return a guest with given attributes. Different hosts support
 129         different combinations of attributes and values for guest selection.
 130
 131         Asking the NULL host invokes system default     procedures for obtaining
 132         any running code in the system with the attributes given. The returned
 133         code may be anywhere in the system.
 134
 135         The methods a host uses to identify, separate, and control its guests
 136         are specific to each type of host. This call provides a generic abstraction layer
 137         that allows uniform interrogation of all hosts. A SecCode that does not
 138         act as a host will always return errSecCSNoSuchCode. A SecCode that does
 139         support hosting may return itself to signify that the attribute refers to
 140         itself rather than one of its hosts.
 141
 142         @param host A valid SecCode object reference representing code running
 143         on the system that acts as a Code Signing host. As a special case, passing
 144         NULL indicates that the Code Signing root of trust should be used as a starting
 145         point. Currently, that is the system kernel.
 146         @param attributes A CFDictionary containing zero or more attribute selector
 147         values. Each selector has a CFString key and associated CFTypeRef value.
 148         The key name identifies the attribute being specified; the associated value,
 149         whose type depends on the the key name, selects a particular value or other
 150         constraint on that attribute. Each host only supports particular combinations
 151         of keys and values,     and errors will be returned if any unsupported set is requested.
 152         As a special case, NULL is taken to mean an empty attribute set.
 153         Note that some hosts that support hosting chains (guests being hosts)
 154         may return sub-guests in this call. In other words, do not assume that
 155         a SecCodeRef returned by this call is a direct guest of the queried host
 156         (though it will be a proximate guest, i.e. a guest's guest some way down).
 157         Asking the NULL host for NULL attributes returns a code reference for the system root
 158         of trust (at present, the running Darwin kernel).
 159         @param flags Optional flags. Pass kSecCSDefaultFlags for standard behavior.
 160         @param guest On successful return, a SecCode object reference identifying
 161         the particular guest of the host that owns the attribute value(s) specified.
 162         This argument will not be changed if the call fails (does not return errSecSuccess).
 163         @result Upon success, errSecSuccess. Upon error, an OSStatus value documented in
 164         CSCommon.h or certain other Security framework headers. In particular:
 165         @error errSecCSUnsupportedGuestAttributes The host does not support the attribute
 166         type given by attributeType.
 167         @error errSecCSInvalidAttributeValues The type of value given for a guest
 168         attribute is not supported by the host.
 169         @error errSecCSNoSuchCode The host has no guest with the attribute value given
 170         by attributeValue, even though the value is of a supported type. This may also
 171         be returned if the host code does not currently act as a Code Signing host.
 172         @error errSecCSNotAHost The specified host cannot, in fact, act as a code
 173         host. (It is missing the kSecCodeSignatureHost option flag in its code
 174         signature.)
 175         @error errSecCSMultipleGuests The attributes specified do not uniquely identify
 176         a guest (the specification is ambiguous).
 177 */
 178 extern const CFStringRef kSecGuestAttributeCanonical;
 179 extern const CFStringRef kSecGuestAttributeHash;
 180 extern const CFStringRef kSecGuestAttributeMachPort;
 181 extern const CFStringRef kSecGuestAttributePid;
 182 extern const CFStringRef kSecGuestAttributeDynamicCode;
 183 extern const CFStringRef kSecGuestAttributeDynamicCodeInfoPlist;
 184 extern const CFStringRef kSecGuestAttributeArchitecture;
 185 extern const CFStringRef kSecGuestAttributeSubarchitecture;
 186
 187 OSStatus SecCodeCopyGuestWithAttributes(SecCodeRef __nullable host,
 188         CFDictionaryRef __nullable attributes,  SecCSFlags flags, SecCodeRef * __nonnull CF_RETURNS_RETAINED guest);
 189
 190
 191 /*!
 192         @function SecCodeCheckValidity
 193         Performs dynamic validation of the given SecCode object. The call obtains and
 194         verifies the signature on the code object. It checks the validity of only those
 195         sealed components required to establish identity. It checks the SecCode's
 196         dynamic validity status as reported by its host. It ensures that the SecCode's
 197         host is in turn valid. Finally, it validates the code against a SecRequirement
 198         if one is given. The call succeeds if all these conditions are satisfactory.
 199         It fails otherwise.
 200
 201         This call is secure against attempts to modify the file system source of the
 202         SecCode.
 203
 204         @param code The code object to be validated.
 205         @param flags Optional flags. Pass kSecCSDefaultFlags for standard behavior.
 206         @param requirement An optional code requirement specifying additional conditions
 207         the code object must satisfy to be considered valid. If NULL, no additional
 208         requirements are imposed.
 209         @param errors An optional pointer to a CFErrorRef variable. If the call fails
 210         (and something other than errSecSuccess is returned), and this argument is non-NULL,
 211         a CFErrorRef is stored there further describing the nature and circumstances
 212         of the failure. The caller must CFRelease() this error object when done with it.
 213         @result If validation passes, errSecSuccess. If validation fails, an OSStatus value
 214         documented in CSCommon.h or certain other Security framework headers.
 215 */
 216 OSStatus SecCodeCheckValidity(SecCodeRef code, SecCSFlags flags,
 217         SecRequirementRef __nullable requirement);
 218
 219 OSStatus SecCodeCheckValidityWithErrors(SecCodeRef code, SecCSFlags flags,
 220         SecRequirementRef __nullable requirement, CFErrorRef *errors);
 221
 222
 223 /*!
 224         @function SecCodeCopyPath
 225         For a given Code or StaticCode object, returns a URL to a location on disk where the
 226         code object can be found. For single files, the URL points to that file.
 227         For bundles, it points to the directory containing the entire bundle.
 228
 229         This returns the same URL as the kSecCodeInfoMainExecutable key returned
 230         by SecCodeCopySigningInformation.
 231
 232         @param code The Code or StaticCode object to be located. For a Code
 233                 argument, its StaticCode is processed as per SecCodeCopyStaticCode.
 234         @param flags Optional flags. Pass kSecCSDefaultFlags for standard behavior.
 235         @param path On successful return, contains a CFURL identifying the location
 236         on disk of the staticCode object.
 237         @result On success, errSecSuccess. On error, an OSStatus value
 238         documented in CSCommon.h or certain other Security framework headers.
 239 */
 240 OSStatus SecCodeCopyPath(SecStaticCodeRef staticCode, SecCSFlags flags,
 241         CFURLRef * __nonnull CF_RETURNS_RETAINED path);
 242
 243
 244 /*!
 245         @function SecCodeCopyDesignatedRequirement
 246         For a given Code or StaticCode object, determines its Designated Code Requirement.
 247         The Designated Requirement is the SecRequirement that the code believes
 248         should be used to properly identify it in the future.
 249
 250         If the SecCode contains an explicit Designated Requirement, a copy of that
 251         is returned. If it does not, a SecRequirement is implicitly constructed from
 252         its signing authority and its embedded unique identifier. No Designated
 253         Requirement can be obtained from code that is unsigned. Code that is modified
 254         after signature, improperly signed, or has become invalid, may or may not yield
 255         a Designated Requirement. This call does not validate the SecStaticCode argument.
 256
 257         @param code The Code or StaticCode object to be interrogated. For a Code
 258                 argument, its StaticCode is processed as per SecCodeCopyStaticCode.
 259         @param flags Optional flags. Pass kSecCSDefaultFlags for standard behavior.
 260         @param requirement On successful return, contains a copy of a SecRequirement
 261         object representing the code's Designated Requirement. On error, unchanged.
 262         @result On success, errSecSuccess. On error, an OSStatus value
 263                 documented in CSCommon.h or certain other Security framework headers.
 264 */
 265 OSStatus SecCodeCopyDesignatedRequirement(SecStaticCodeRef code, SecCSFlags flags,
 266         SecRequirementRef * __nonnull CF_RETURNS_RETAINED requirement);
 267
 268
 269 /*
 270         @function SecCodeCopySigningInformation
 271         For a given Code or StaticCode object, extract various pieces of information
 272         from its code signature and return them in the form of a CFDictionary. The amount
 273         and detail level of the data is controlled by the flags passed to the call.
 274
 275         If the code exists but is not signed at all, this call will succeed and return
 276         a dictionary that does NOT contain the kSecCodeInfoIdentifier key. This is the
 277         recommended way to check quickly whether a code is signed.
 278
 279         If the signing data for the code is corrupt or invalid, this call may fail or it
 280         may return partial data. To ensure that only valid data is returned (and errors
 281         are raised for invalid data), you must successfully call one of the CheckValidity
 282         functions on the code before calling CopySigningInformation.
 283
 284         @param code The Code or StaticCode object to be interrogated. For a Code
 285                 argument, its StaticCode is processed as per SecCodeCopyStaticCode.
 286                 Note that dynamic information (kSecCSDynamicInformation) cannot be obtained
 287                 for a StaticCode argument.
 288         @param flags Optional flags. Use any or all of the kSecCS*Information flags
 289                 to select what information to return. A generic set of entries is returned
 290                 regardless; you may specify kSecCSDefaultFlags for just those.
 291         @param information A CFDictionary containing information about the code is stored
 292                 here on successful completion. The contents of the dictionary depend on
 293                 the flags passed. Regardless of flags, the kSecCodeInfoIdentifier key is
 294                 always present if the code is signed, and always absent if the code is
 295                 unsigned.
 296                 Note that some of the objects returned are (retained) "live" API objects
 297                 used by the code signing infrastructure. Making changes to these objects
 298                 is unsupported and may cause subsequent code signing operations on the
 299                 affected code to behave in undefined ways.
 300         @result On success, errSecSuccess. On error, an OSStatus value
 301                 documented in CSCommon.h or certain other Security framework headers.
 302
 303         Flags:
 304
 305         @constant kSecCSSigningInformation Return cryptographic signing information,
 306                 including the certificate chain and CMS data (if any). For ad-hoc signed
 307                 code, there are no certificates and the CMS data is empty.
 308         @constant kSecCSRequirementInformation Return information about internal code
 309                 requirements embedded in the code. This includes the Designated Requirement.
 310         @constant kSecCSInternalInformation Return internal code signing information.
 311                 This information is for use by Apple, and is subject to change without notice.
 312                 It will not be further documented here.
 313         @constant kSecCSDynamicInformation Return dynamic validity information about
 314                 the Code. The subject code must be a SecCodeRef (not a SecStaticCodeRef).
 315         @constant kSecCSContentInformation Return more information about the file system
 316                 contents making up the signed code on disk. It is not generally advisable to
 317                 make use of this information, but some utilities (such as software-update
 318                 tools) may find it useful.
 319
 320         Dictionary keys:
 321
 322         @constant kSecCodeInfoCertificates A CFArray of SecCertificates identifying the
 323                 certificate chain of the signing certificate as seen by the system. Absent
 324                 for ad-hoc signed code. May be partial or absent in error cases.
 325         @constant kSecCodeInfoChangedFiles A CFArray of CFURLs identifying all files in
 326                 the code that may have been modified by the process of signing it. (In other
 327                 words, files not in this list will not have been touched by the signing operation.)
 328         @constant kSecCodeInfoCMS A CFData containing the CMS cryptographic object that
 329                 secures the code signature. Empty for ad-hoc signed code.
 330         @constant kSecCodeInfoDesignatedRequirement A SecRequirement describing the
 331                 actual Designated Requirement of the code.
 332         @constant kSecCodeInfoEntitlements A CFData containing the embedded entitlement
 333                 blob of the code, if any.
 334         @constant kSecCodeInfoEntitlementsDict A CFDictionary containing the embedded entitlements
 335                 of the code if it has entitlements and they are in standard dictionary form.
 336                 Absent if the code has no entitlements, or they are in a different format (in which
 337                 case, see kSecCodeInfoEntitlements).
 338         @constant kSecCodeInfoFlags A CFNumber with the static (on-disk) state of the object.
 339                 Contants are defined by the type SecCodeSignatureFlags.
 340         @constant kSecCodeInfoFormat A CFString characterizing the type and format of
 341                 the code. Suitable for display to a (knowledeable) user.
 342         @constant kSecCodeInfoDigestAlgorithm A CFNumber indicating the kind of cryptographic
 343                 hash function used within the signature to seal its pieces together.
 344         @constant kSecCodeInfoPlatformIdentifier If this code was signed as part of an operating
 345                 system release, this value identifies that release.
 346         @constant kSecCodeInfoIdentifier A CFString with the actual signing identifier
 347                 sealed into the signature. Absent for unsigned code.
 348         @constant kSecCodeInfoImplicitDesignatedRequirement A SecRequirement describing
 349                 the designated requirement that the system did generate, or would have generated,
 350                 for the code. If the Designated Requirement was implicitly generated, this is
 351                 the same object as kSecCodeInfoDesignatedRequirement; this can be used to test
 352                 for an explicit Designated Requirement.
 353         @constant kSecCodeInfoMainExecutable A CFURL identifying the main executable file
 354                 of the code. For single files, that is the file itself. For bundles, it is the
 355                 main executable as identified by its Info.plist.
 356         @constant kSecCodeInfoPList A retained CFDictionary referring to the secured Info.plist
 357                 as seen by code signing. Absent if no Info.plist is known to the code signing
 358                 subsystem. Note that this is not the same dictionary as the one CFBundle would
 359                 give you (CFBundle is free to add entries to the on-disk plist).
 360         @constant kSecCodeInfoRequirements A CFString describing the internal requirements
 361                 of the code in canonical syntax.
 362         @constant kSecCodeInfoRequirementsData A CFData containing the internal requirements
 363                 of the code as a binary blob.
 364         @constant kSecCodeInfoSource A CFString describing the source of the code signature
 365                 used for the code object. The values are meant to be shown in informational
 366                 displays; do not rely on the precise value returned.
 367         @constant kSecCodeInfoStatus A CFNumber containing the dynamic status word of the
 368                 (running) code. This is a snapshot at the time the API is executed and may be
 369                 out of date by the time you examine it. Do note however that most of the bits
 370                 are sticky and thus some values are permanently reliable. Be careful.
 371         @constant kSecCodeInfoTime A CFDate describing the signing date (securely) embedded
 372                 in the code signature. Note that a signer is able to omit this date or pre-date
 373                 it. Nobody certifies that this was really the date the code was signed; however,
 374                 you do know that this is the date the signer wanted you to see.
 375                 Ad-hoc signatures have no CMS and thus never have secured signing dates.
 376         @constant kSecCodeInfoTimestamp A CFDate describing the signing date as (securely)
 377                 certified by a timestamp authority service. This time cannot be falsified by the
 378                 signer; you trust the timestamp authority's word on this.
 379                 Ad-hoc signatures have no CMS and thus never have secured signing dates.
 380         @constant kSecCodeInfoTrust The (retained) SecTrust object the system uses to
 381                 evaluate the validity of the code's signature. You may use the SecTrust API
 382                 to extract detailed information, particularly for reasons why certificate
 383                 validation may have failed. This object may continue to be used for further
 384                 evaluations of this code; if you make any changes to it, behavior is undefined.
 385         @constant kSecCodeInfoUnique A CFData binary identifier that uniquely identifies
 386                 the static code in question. It can be used to recognize this particular code
 387                 (and none other) now or in the future. Compare to kSecCodeInfoIdentifier, which
 388                 remains stable across (developer-approved) updates.
 389                 The algorithm used may change from time to time. However, for any existing signature,
 390                 the value is stable.
 391  */
 392 CF_ENUM(uint32_t) {
 393         kSecCSInternalInformation = 1 << 0,
 394         kSecCSSigningInformation = 1 << 1,
 395         kSecCSRequirementInformation = 1 << 2,
 396         kSecCSDynamicInformation = 1 << 3,
 397         kSecCSContentInformation = 1 << 4
 398 };
 399                                                                                                         /* flag required to get this value */
 400 extern const CFStringRef kSecCodeInfoCertificates;      /* Signing */
 401 extern const CFStringRef kSecCodeInfoChangedFiles;      /* Content */
 402 extern const CFStringRef kSecCodeInfoCMS;                       /* Signing */
 403 extern const CFStringRef kSecCodeInfoDesignatedRequirement; /* Requirement */
 404 extern const CFStringRef kSecCodeInfoEntitlements;      /* Requirement */
 405 extern const CFStringRef kSecCodeInfoEntitlementsDict; /* Requirement */
 406 extern const CFStringRef kSecCodeInfoFlags;             /* generic */
 407 extern const CFStringRef kSecCodeInfoFormat;            /* generic */
 408 extern const CFStringRef kSecCodeInfoDigestAlgorithm; /* generic */
 409 extern const CFStringRef kSecCodeInfoPlatformIdentifier; /* generic */
 410 extern const CFStringRef kSecCodeInfoIdentifier;        /* generic */
 411 extern const CFStringRef kSecCodeInfoImplicitDesignatedRequirement; /* Requirement */
 412 extern const CFStringRef kSecCodeInfoMainExecutable; /* generic */
 413 extern const CFStringRef kSecCodeInfoPList;                     /* generic */
 414 extern const CFStringRef kSecCodeInfoRequirements;      /* Requirement */
 415 extern const CFStringRef kSecCodeInfoRequirementData; /* Requirement */
 416 extern const CFStringRef kSecCodeInfoSource;            /* generic */
 417 extern const CFStringRef kSecCodeInfoStatus;            /* Dynamic */
 418 extern const CFStringRef kSecCodeInfoTeamIdentifier; /* Signing */
 419 extern const CFStringRef kSecCodeInfoTime;                      /* Signing */
 420 extern const CFStringRef kSecCodeInfoTimestamp;         /* Signing */
 421 extern const CFStringRef kSecCodeInfoTrust;                     /* Signing */
 422 extern const CFStringRef kSecCodeInfoUnique;            /* generic */
 423
 424 OSStatus SecCodeCopySigningInformation(SecStaticCodeRef code, SecCSFlags flags,
 425         CFDictionaryRef * __nonnull CF_RETURNS_RETAINED information);
 426
 427
 428 /*
 429         @function SecCodeMapMemory
 430         For a given Code or StaticCode object, ask the kernel to accept the signing information
 431         currently attached to it in the caller and use it to validate memory page-ins against it,
 432         updating dynamic validity state accordingly. This change affects all processes that have
 433         the main executable of this code mapped.
 434
 435         @param code A Code or StaticCode object representing the signed code whose main executable
 436                 should be subject to page-in validation.
 437         @param flags Optional flags. Pass kSecCSDefaultFlags for standard behavior.
 438  */
 439 OSStatus SecCodeMapMemory(SecStaticCodeRef code, SecCSFlags flags);
 440
 441 CF_ASSUME_NONNULL_END
 442
 443 #ifdef __cplusplus
 444 }
 445 #endif
 446
 447 #endif //_H_SECCODE