doc/README_osx.md

   1 Deterministic OS X Dmg Notes.
   2
   3 Working OS X DMGs are created in Linux by combining a recent clang,
   4 the Apple binutils (ld, ar, etc) and DMG authoring tools.
   5
   6 Apple uses clang extensively for development and has upstreamed the necessary
   7 functionality so that a vanilla clang can take advantage. It supports the use
   8 of -F, -target, -mmacosx-version-min, and --sysroot, which are all necessary
   9 when building for OS X.
  10
  11 Apple's version of binutils (called cctools) contains lots of functionality
  12 missing in the FSF's binutils. In addition to extra linker options for
  13 frameworks and sysroots, several other tools are needed as well such as
  14 install_name_tool, lipo, and nmedit. These do not build under linux, so they
  15 have been patched to do so. The work here was used as a starting point:
  16 [mingwandroid/toolchain4](https://github.com/mingwandroid/toolchain4).
  17
  18 In order to build a working toolchain, the following source packages are needed
  19 from Apple: cctools, dyld, and ld64.
  20
  21 These tools inject timestamps by default, which produce non-deterministic
  22 binaries. The ZERO_AR_DATE environment variable is used to disable that.
  23
  24 This version of cctools has been patched to use the current version of clang's
  25 headers and its libLTO.so rather than those from llvmgcc, as it was
  26 originally done in toolchain4.
  27
  28 To complicate things further, all builds must target an Apple SDK. These SDKs
  29 are free to download, but not redistributable.
  30 To obtain it, register for a developer account, then download the [Xcode 7.3.1 dmg](https://developer.apple.com/devcenter/download.action?path=/Developer_Tools/Xcode_7.3.1/Xcode_7.3.1.dmg).
  31
  32 This file is several gigabytes in size, but only a single directory inside is
  33 needed:
  34 ```
  35 Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.11.sdk
  36 ```
  37
  38 Unfortunately, the usual linux tools (7zip, hpmount, loopback mount) are incapable of opening this file.
  39 To create a tarball suitable for Gitian input, there are two options:
  40
  41 Using Mac OS X, you can mount the dmg, and then create it with:
  42 ```
  43   $ hdiutil attach Xcode_7.3.1.dmg
  44   $ tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.11.sdk.tar.gz MacOSX10.11.sdk
  45 ```
  46
  47 Alternatively, you can use 7zip and SleuthKit to extract the files one by one.
  48 The script contrib/macdeploy/extract-osx-sdk.sh automates this. First ensure
  49 the dmg file is in the current directory, and then run the script. You may wish
  50 to delete the intermediate 5.hfs file and MacOSX10.11.sdk (the directory) when
  51 you've confirmed the extraction succeeded.
  52
  53 ```bash
  54 apt-get install p7zip-full sleuthkit
  55 contrib/macdeploy/extract-osx-sdk.sh
  56 rm -rf 5.hfs MacOSX10.11.sdk
  57 ```
  58
  59 The Gitian descriptors build 2 sets of files: Linux tools, then Apple binaries
  60 which are created using these tools. The build process has been designed to
  61 avoid including the SDK's files in Gitian's outputs. All interim tarballs are
  62 fully deterministic and may be freely redistributed.
  63
  64 genisoimage is used to create the initial DMG. It is not deterministic as-is,
  65 so it has been patched. A system genisoimage will work fine, but it will not
  66 be deterministic because the file-order will change between invocations.
  67 The patch can be seen here:  [theuni/osx-cross-depends](https://raw.githubusercontent.com/theuni/osx-cross-depends/master/patches/cdrtools/genisoimage.diff).
  68 No effort was made to fix this cleanly, so it likely leaks memory badly. But
  69 it's only used for a single invocation, so that's no real concern.
  70
  71 genisoimage cannot compress DMGs, so afterwards, the 'dmg' tool from the
  72 libdmg-hfsplus project is used to compress it. There are several bugs in this
  73 tool and its maintainer has seemingly abandoned the project. It has been forked
  74 and is available (with fixes) here: [theuni/libdmg-hfsplus](https://github.com/theuni/libdmg-hfsplus).
  75
  76 The 'dmg' tool has the ability to create DMGs from scratch as well, but this
  77 functionality is broken. Only the compression feature is currently used.
  78 Ideally, the creation could be fixed and genisoimage would no longer be necessary.
  79
  80 Background images and other features can be added to DMG files by inserting a
  81 .DS_Store before creation. This is generated by the script
  82 contrib/macdeploy/custom_dsstore.py.
  83
  84 As of OS X Mavericks (10.9), using an Apple-blessed key to sign binaries is a
  85 requirement in order to satisfy the new Gatekeeper requirements. Because this
  86 private key cannot be shared, we'll have to be a bit creative in order for the
  87 build process to remain somewhat deterministic. Here's how it works:
  88
  89 - Builders use Gitian to create an unsigned release. This outputs an unsigned
  90   dmg which users may choose to bless and run. It also outputs an unsigned app
  91   structure in the form of a tarball, which also contains all of the tools
  92   that have been previously (deterministically) built in order to create a
  93   final dmg.
  94 - The Apple keyholder uses this unsigned app to create a detached signature,
  95   using the script that is also included there. Detached signatures are available from this [repository](https://github.com/bitcoin-core/bitcoin-detached-sigs).
  96 - Builders feed the unsigned app + detached signature back into Gitian. It
  97   uses the pre-built tools to recombine the pieces into a deterministic dmg.