2022-12-21 15:15:22 +00:00
|
|
|
# MacOS Deployment
|
|
|
|
|
|
|
|
|
|
## SDK Extraction
|
|
|
|
|
|
|
|
|
|
### Step 1: Obtaining `Xcode.app`
|
|
|
|
|
|
|
|
|
|
A free Apple Developer Account is required to proceed.
|
|
|
|
|
|
|
|
|
|
Our current macOS SDK
|
|
|
|
|
(`Xcode-12.2-12B45b-extracted-SDK-with-libcxx-headers.tar.gz`)
|
|
|
|
|
can be extracted from
|
|
|
|
|
[Xcode_12.2.xip](https://download.developer.apple.com/Developer_Tools/Xcode_12.2/Xcode_12.2.xip).
|
|
|
|
|
|
|
|
|
|
Alternatively, after logging in to your account go to 'Downloads', then 'More'
|
|
|
|
|
and search for [`Xcode 12.2`](https://developer.apple.com/download/all/?q=Xcode%2012.2).
|
|
|
|
|
|
|
|
|
|
An Apple ID and cookies enabled for the hostname are needed to download this.
|
|
|
|
|
|
2023-03-16 01:21:12 +00:00
|
|
|
The `sha256sum` of the downloaded XIP archive should be `28d352f8c14a43d9b8a082ac6338dc173cb153f964c6e8fb6ba389e5be528bd0`.
|
2022-12-21 15:15:22 +00:00
|
|
|
|
|
|
|
|
After Xcode version 7.x, Apple started shipping the `Xcode.app` in a `.xip`
|
|
|
|
|
archive. This makes the SDK less-trivial to extract on non-macOS machines. One
|
|
|
|
|
approach (tested on Debian Buster) is outlined below:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Install/clone tools needed for extracting Xcode.app
|
|
|
|
|
apt install cpio
|
|
|
|
|
git clone https://github.com/bitcoin-core/apple-sdk-tools.git
|
|
|
|
|
|
|
|
|
|
# Unpack Xcode_12.2.xip and place the resulting Xcode.app in your current
|
|
|
|
|
# working directory
|
|
|
|
|
python3 apple-sdk-tools/extract_xcode.py -f Xcode_12.2.xip | cpio -d -i
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
On macOS the process is more straightforward:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
xip -x Xcode_12.2.xip
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Step 2: Generating `Xcode-12.2-12B45b-extracted-SDK-with-libcxx-headers.tar.gz` from `Xcode.app`
|
|
|
|
|
|
|
|
|
|
To generate `Xcode-12.2-12B45b-extracted-SDK-with-libcxx-headers.tar.gz`, run
|
|
|
|
|
the script [`gen-sdk`](./gen-sdk) with the path to `Xcode.app` (extracted in the
|
|
|
|
|
previous stage) as the first argument.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Generate a Xcode-12.2-12B45b-extracted-SDK-with-libcxx-headers.tar.gz from
|
|
|
|
|
# the supplied Xcode.app
|
|
|
|
|
./contrib/macdeploy/gen-sdk '/path/to/Xcode.app'
|
|
|
|
|
```
|
|
|
|
|
|
2023-03-16 01:21:12 +00:00
|
|
|
The `sha256sum` of the generated TAR.GZ archive should be `332477876917786b26dd7c3fc1665d2c5cdca81c72755e6a9754f308de77d33b`.
|
2022-12-21 15:15:22 +00:00
|
|
|
|
2023-03-01 15:54:30 +00:00
|
|
|
## Deterministic macOS App Notes
|
2022-12-21 15:15:22 +00:00
|
|
|
|
2023-03-01 15:54:30 +00:00
|
|
|
macOS Applications are created in Linux by combining a recent `clang` and the Apple
|
|
|
|
|
`binutils` (`ld`, `ar`, etc).
|
2022-12-21 15:15:22 +00:00
|
|
|
|
|
|
|
|
Apple uses `clang` extensively for development and has upstreamed the necessary
|
|
|
|
|
functionality so that a vanilla clang can take advantage. It supports the use of `-F`,
|
|
|
|
|
`-target`, `-mmacosx-version-min`, and `-isysroot`, which are all necessary when
|
|
|
|
|
building for macOS.
|
|
|
|
|
|
|
|
|
|
Apple's version of `binutils` (called `cctools`) contains lots of functionality missing in the
|
|
|
|
|
FSF's `binutils`. In addition to extra linker options for frameworks and sysroots, several
|
|
|
|
|
other tools are needed as well such as `install_name_tool`, `lipo`, and `nmedit`. These
|
|
|
|
|
do not build under Linux, so they have been patched to do so. The work here was used as
|
|
|
|
|
a starting point: [mingwandroid/toolchain4](https://github.com/mingwandroid/toolchain4).
|
|
|
|
|
|
|
|
|
|
In order to build a working toolchain, the following source packages are needed from
|
|
|
|
|
Apple: `cctools`, `dyld`, and `ld64`.
|
|
|
|
|
|
|
|
|
|
These tools inject timestamps by default, which produce non-deterministic binaries. The
|
|
|
|
|
`ZERO_AR_DATE` environment variable is used to disable that.
|
|
|
|
|
|
|
|
|
|
This version of `cctools` has been patched to use the current version of `clang`'s headers
|
|
|
|
|
and its `libLTO.so` rather than those from `llvmgcc`, as it was originally done in `toolchain4`.
|
|
|
|
|
|
|
|
|
|
To complicate things further, all builds must target an Apple SDK. These SDKs are free to
|
|
|
|
|
download, but not redistributable. See the SDK Extraction notes above for how to obtain it.
|
|
|
|
|
|
|
|
|
|
The Guix process builds 2 sets of files: Linux tools, then Apple binaries which are
|
|
|
|
|
created using these tools. The build process has been designed to avoid including the
|
|
|
|
|
SDK's files in Guix's outputs. All interim tarballs are fully deterministic and may be freely
|
|
|
|
|
redistributed.
|
|
|
|
|
|
|
|
|
|
As of OS X 10.9 Mavericks, using an Apple-blessed key to sign binaries is a requirement in
|
|
|
|
|
order to satisfy the new Gatekeeper requirements. Because this private key cannot be
|
|
|
|
|
shared, we'll have to be a bit creative in order for the build process to remain somewhat
|
|
|
|
|
deterministic. Here's how it works:
|
|
|
|
|
|
2023-03-01 15:54:30 +00:00
|
|
|
- Builders use Guix to create an unsigned release. This outputs an unsigned ZIP which
|
2022-12-21 15:15:22 +00:00
|
|
|
users may choose to bless and run. It also outputs an unsigned app structure in the form
|
|
|
|
|
of a tarball, which also contains all of the tools that have been previously (deterministically)
|
|
|
|
|
built in order to create a final DMG.
|
|
|
|
|
- The Apple keyholder uses this unsigned app to create a detached signature, using the
|
|
|
|
|
script that is also included there. Detached signatures are available from this [repository](https://github.com/bitcoin-core/bitcoin-detached-sigs).
|
|
|
|
|
- Builders feed the unsigned app + detached signature back into Guix. It uses the
|
2023-03-01 15:54:30 +00:00
|
|
|
pre-built tools to recombine the pieces into a deterministic ZIP.
|
