OSX/libsecurity_codesigning/lib/signer.h

   1 /*
   2  * Copyright (c) 2006-2012,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 // signer - Signing operation supervisor and controller
  26 //
  27 #ifndef _H_SIGNER
  28 #define _H_SIGNER
  29
  30 #include "CodeSigner.h"
  31 #include "cdbuilder.h"
  32 #include "signerutils.h"
  33 #include "StaticCode.h"
  34 #include <security_utilities/utilities.h>
  35
  36 namespace Security {
  37 namespace CodeSigning {
  38
  39
  40 //
  41 // The signer driver class.
  42 // This is a workflow object, containing all the data needed for the various
  43 // signing stages to cooperate. It is not meant to be API visible; that is
  44 // SecCodeSigner's job.
  45 //
  46 class SecCodeSigner::Signer : public DiskRep::SigningContext {
  47 public:
  48         Signer(SecCodeSigner &s, SecStaticCode *c) : state(s), code(c), requirements(NULL)
  49         { strict = signingFlags() & kSecCSSignStrictPreflight; }
  50         ~Signer() { ::free((Requirements *)requirements); }
  51
  52         void sign(SecCSFlags flags);
  53         void remove(SecCSFlags flags);
  54         void edit(SecCSFlags flags);
  55
  56         SecCodeSigner &state;
  57         SecStaticCode * const code;
  58
  59         const CodeDirectory::HashAlgorithms& digestAlgorithms() const { return hashAlgorithms; }
  60         void setDigestAlgorithms(CodeDirectory::HashAlgorithms types) { hashAlgorithms = types; }
  61
  62         std::string path() const { return cfStringRelease(rep->copyCanonicalPath()); }
  63         SecIdentityRef signingIdentity() const { return state.mSigner; }
  64         std::string signingIdentifier() const { return identifier; }
  65
  66 protected:
  67         void prepare(SecCSFlags flags);                         // set up signing parameters
  68         void signMachO(Universal *fat, const Requirement::Context &context); // sign a Mach-O binary
  69         void signArchitectureAgnostic(const Requirement::Context &context); // sign anything else
  70
  71         void prepareForEdit(SecCSFlags flags);          // set up signature editing
  72         void editMachO(Universal *fat);                         // edit a Mach-O binary
  73         void editArchitectureAgnostic();                        // edit anything else
  74
  75         // HashAlgorithm -> PreEncrypt hashes
  76         typedef std::map<CodeDirectory::HashAlgorithm, CFCopyRef<CFDataRef> >
  77                 PreEncryptHashMap;
  78         // Architecture -> PreEncryptHashMap
  79         typedef std::map<Architecture, PreEncryptHashMap >
  80                 PreEncryptHashMaps;
  81         // HashAlgorithm -> Hardened Runtime Version
  82         typedef std::map<CodeDirectory::HashAlgorithm, uint32_t>
  83                 RuntimeVersionMap;
  84         // Architecture -> RuntimeVersionMap
  85         typedef std::map<Architecture, RuntimeVersionMap>
  86                 RuntimeVersionMaps;
  87         // Architecture -> RawComponentMap
  88         typedef EditableDiskRep::RawComponentMap RawComponentMap;
  89         typedef std::map<Architecture, std::unique_ptr<RawComponentMap>>
  90                 RawComponentMaps;
  91
  92         void populate(DiskRep::Writer &writer);         // global
  93         void populate(CodeDirectory::Builder &builder, DiskRep::Writer &writer,
  94                                   InternalRequirements &ireqs,
  95                                   size_t offset, size_t length,
  96                                   bool mainBinary, size_t execSegBase, size_t execSegLimit,
  97                                   unsigned alternateDigestCount,
  98                                   const PreEncryptHashMap& preEncryptHashMap,
  99                                   uint32_t runtimeVersion, bool generateEntitlementDER);        // per-architecture
 100         CFDataRef signCodeDirectory(const CodeDirectory *cd,
 101                                                                 CFDictionaryRef hashDict, CFArrayRef hashList);
 102
 103         uint32_t cdTextFlags(std::string text);         // convert text CodeDirectory flags
 104         std::string uniqueName() const;                         // derive unique string from rep
 105
 106 protected:
 107
 108         std::string sdkPath(const std::string &path) const;
 109         bool isAdhoc() const;
 110         SecCSFlags signingFlags() const;
 111
 112 private:
 113         static EditableDiskRep *editMainExecutableRep(DiskRep *rep);
 114
 115         void addPreEncryptHashes(PreEncryptHashMap &map, SecStaticCode const *code);
 116         void addRuntimeVersions(RuntimeVersionMap &map, SecStaticCode const *code);
 117
 118         void considerTeamID(const PreSigningContext& context);
 119         std::vector<Endian<uint32_t> > topSlots(CodeDirectory::Builder &builder) const;
 120
 121         static bool booleanEntitlement(CFDictionaryRef entDict, CFStringRef key);
 122         static void cookEntitlements(CFDataRef entitlements, bool generateDER,
 123                                                                  uint64_t *execSegFlags, CFDataRef *entitlementsDER);
 124
 125 protected:
 126         void buildResources(std::string root, std::string relBase, CFDictionaryRef rules);
 127         CFMutableDictionaryRef signNested(const std::string &path, const std::string &relpath);
 128         CFDataRef hashFile(const char *path, CodeDirectory::HashAlgorithm type);
 129         CFDictionaryRef hashFile(const char *path, CodeDirectory::HashAlgorithms types);
 130
 131 private:
 132         RefPointer<DiskRep> rep;                // DiskRep of Code being signed
 133         CFRef<CFDictionaryRef> resourceDirectory;       // resource directory
 134         CFRef<CFDataRef> resourceDictData; // XML form of resourceDirectory
 135         CodeDirectory::HashAlgorithms hashAlgorithms; // hash algorithm(s) to use
 136         std::string identifier;                 // signing identifier
 137         std::string teamID;             // team identifier
 138         CFRef<CFDataRef> entitlements;  // entitlements
 139         Architecture preEncryptMainArch; // pre-encrypt main architecture
 140         PreEncryptHashMaps preEncryptHashMaps;  // pre-encrypt hashes to keep
 141         Architecture runtimeVersionMainArch; // runtime version main architecture
 142         RuntimeVersionMaps runtimeVersionMap; // runtime versions to keep
 143         uint32_t cdFlags;                               // CodeDirectory flags
 144         const Requirements *requirements; // internal requirements ready-to-use
 145         size_t pagesize;                                // size of main executable pages
 146         CFAbsoluteTime signingTime;             // signing time for CMS signature (0 => now)
 147         bool emitSigningTime;                   // emit signing time as a signed CMS attribute
 148         bool strict;                                    // strict validation
 149
 150         // Signature Editing
 151         Architecture editMainArch;              // main architecture for editing
 152         RawComponentMaps editComponents; // components for signature
 153
 154 private:
 155         Mutex resourceLock;
 156 };
 157
 158
 159 } // end namespace CodeSigning
 160 } // end namespace Security
 161
 162 #endif // !_H_CODESIGNER