OSX/libsecurity_codesigning/lib/bundlediskrep.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 // bundlediskrep - bundle directory disk representation
  26 //
  27 #ifndef _H_BUNDLEDISKREP
  28 #define _H_BUNDLEDISKREP
  29
  30 #include "diskrep.h"
  31 #include "machorep.h"
  32
  33 #include <sys/cdefs.h>
  34
  35 #if TARGET_OS_OSX
  36 __BEGIN_DECLS
  37 #include <AppleFSCompression/AppleFSCompression.h>
  38 __END_DECLS
  39 #endif
  40
  41 namespace Security {
  42 namespace CodeSigning {
  43
  44
  45 #define BUNDLEDISKREP_DIRECTORY         "_CodeSignature"
  46 #define CODERESOURCES_LINK                      "CodeResources"
  47 #define STORE_RECEIPT_DIRECTORY         "_MASReceipt"
  48
  49
  50 //
  51 // A BundleDiskRep represents a standard Mac OS X bundle on disk.
  52 // The bundle is expected to have an Info.plist, and a "main executable file"
  53 // of some sort (as indicated therein).
  54 // The BundleDiskRep stores the necessary components in the main executable
  55 // if it is in Mach-O format, or in files in a _CodeSignature directory if not.
  56 // This DiskRep supports resource sealing.
  57 //
  58 class BundleDiskRep : public DiskRep, public EditableDiskRep {
  59 public:
  60         BundleDiskRep(const char *path, const Context *ctx = NULL);
  61         BundleDiskRep(CFBundleRef ref, const Context *ctx = NULL);
  62         ~BundleDiskRep();
  63
  64         CFDataRef component(CodeDirectory::SpecialSlot slot);
  65         RawComponentMap createRawComponents();
  66         CFDataRef identification();
  67         DiskRep *mainExecRep() const { return mExecRep.get(); };
  68         std::string mainExecutablePath();
  69         CFURLRef copyCanonicalPath();
  70         std::string resourcesRootPath();
  71         std::string resourcesRelativePath();
  72         void adjustResources(ResourceBuilder &builder);
  73         Universal *mainExecutableImage();
  74         void prepareForSigning(SigningContext &context);
  75         size_t signingBase();
  76         size_t signingLimit();
  77         size_t execSegBase(const Architecture *arch);
  78         size_t execSegLimit(const Architecture *arch);
  79         std::string format();
  80         CFArrayRef modifiedFiles();
  81         UnixPlusPlus::FileDesc &fd();
  82         void flush();
  83     CFDictionaryRef diskRepInformation();
  84
  85         std::string recommendedIdentifier(const SigningContext &ctx);
  86         CFDictionaryRef defaultResourceRules(const SigningContext &ctx);
  87         const Requirements *defaultRequirements(const Architecture *arch, const SigningContext &ctx);
  88         size_t pageSize(const SigningContext &ctx);
  89
  90         void strictValidate(const CodeDirectory* cd, const ToleratedErrors& tolerated, SecCSFlags flags);
  91         void strictValidateStructure(const CodeDirectory* cd, const ToleratedErrors& tolerated, SecCSFlags flags);
  92         CFArrayRef allowedResourceOmissions();
  93
  94         void registerStapledTicket();
  95
  96         bool appleInternalForcePlatform() const {return forcePlatform;};
  97
  98         CFBundleRef bundle() const { return mBundle; }
  99
 100 public:
 101         Writer *writer();
 102         class Writer;
 103         friend class Writer;
 104
 105 protected:
 106         std::string metaPath(const char *name);
 107         void createMeta();                                              // (try to) create the meta-file directory
 108         CFDataRef metaData(const char *name);
 109         CFDataRef metaData(CodeDirectory::SpecialSlot slot);
 110
 111 private:
 112         void setup(const Context *ctx);                 // shared init
 113         void checkModifiedFile(CFMutableArrayRef files, CodeDirectory::SpecialSlot slot);
 114         CFDataRef loadRegularFile(CFURLRef url);
 115         void recordStrictError(OSStatus error);
 116         void validateMetaDirectory(const CodeDirectory* cd);
 117         void validateFrameworkRoot(std::string root);
 118         void checkPlainFile(UnixPlusPlus::FileDesc fd, const std::string& path);
 119         void checkForks(UnixPlusPlus::FileDesc fd);
 120         void checkMoved(CFURLRef oldPath, CFURLRef newPath);
 121         void componentFromExec(bool fromExec);
 122
 123 private:
 124         CFRef<CFBundleRef> mBundle;
 125         std::string mMetaPath;                                  // path to directory containing signing files
 126         bool mMetaExists;                                               // separate meta-file directory exists
 127         CFRef<CFURLRef> mMainExecutableURL;             // chosen main executable URL
 128         bool mInstallerPackage;                                 // is an installer (not executable) bundle
 129         bool mAppLike;                                                  // is some form of app
 130         string mFormat;                                                 // format description string
 131         RefPointer<DiskRep> mExecRep;                   // DiskRep for main executable file
 132         bool mComponentsFromExec;                               // components are drawn from main executable diskrep
 133         bool mComponentsFromExecValid;                  // mComponentsFromExec is valid (tri-state)
 134         std::set<CodeDirectory::SpecialSlot> mUsedComponents; // remember what components we've retrieved
 135         std::set<OSStatus> mStrictErrors;               // strict validation errors encountered
 136         bool forcePlatform;                                             // treat as anchor apple on apple internal
 137 };
 138
 139
 140 //
 141 // Writers
 142 //
 143 //
 144 class BundleDiskRep::Writer : public DiskRep::Writer {
 145         friend class BundleDiskRep;
 146 public:
 147         Writer(BundleDiskRep *r);
 148
 149         void component(CodeDirectory::SpecialSlot slot, CFDataRef data);
 150         void remove();
 151         void flush();
 152
 153 protected:
 154         DiskRep *execRep() { return rep->mExecRep; }
 155         void remove(CodeDirectory::SpecialSlot slot);
 156         void purgeMetaDirectory();
 157
 158 protected:
 159         RefPointer<BundleDiskRep> rep;
 160         RefPointer<DiskRep::Writer> execWriter;
 161         bool mMadeMetaDirectory;
 162         std::set<std::string> mWrittenFiles;
 163 };
 164
 165
 166 } // end namespace CodeSigning
 167 } // end namespace Security
 168
 169 #endif // !_H_BUNDLEDISKREP