macappnotarizer.py - A Notarizing Service for macOS apps

Provides app notarization for macOS apps.

*.dmg files can by signed directly, *.app files are rather special folders than real files and should be packed inside a tar archive for signing.

Prerequisites

The service needs an SFTP server for exchanging data with the clients.

Additionally, for signing your macOS app you need

if you want to notarize the app an App Store Connect API key

Installation

Install dependencies

Install rcodesign as described here in the documentation: https://gregoryszorc.com/docs/apple-codesign/0.26.0/apple_codesign_getting_started.html#installing

Install a recent version of 7zz either from your distros package manager or from https://7-zip.org/download.html

Install the Service

Clone this repository on a server that shall provide the service, create a virtual environment, and install the requirements.

git clone https://invent.kde.org/sysadmin/ci-notary-service.git macappnotarizer
cd macappnotarizer
python3 -m venv .venv
. .venv/bin/activate
pip3 install -r requirements.txt

Configure the Service

Copy macappnotarizer.sample.ini to macappnotarizer.ini and replace the example values with the appropriate values for your installation.

Then copy macappnotarizer-projects.sample.yaml to macappnotarizer-projects.yaml and specify the settings for the projects you want to notarize apps for.

Run the Service

Activate the virtual environment and start macappnotarizer.py.

cd ~/macappnotarizer
. .venv/bin/activate
python3 macappnotarizer.py --id workerA --config macappnotarizer.ini

where you replace workerA with a unique alpha-numeric ID for each instance of macappnotarizer.py you start.

Use the Service to Notarize a macOS App

Clone this repository on the client, create a virtual environment, and install the requirements.

git clone https://invent.kde.org/sysadmin/ci-notary-service.git macappnotarizer
cd macappnotarizer
python3 -m venv .venv
. .venv/bin/activate
pip3 install -r requirements.txt

Copy notarizemacapp.sample.ini to notarizemacapp.ini and replace the example values with the appropriate values for your installation. In particular, the value for BasePath must match the corresponding value in the settings of the service.

Then run notarizemacapp.py to notarize the macOS app

python3 notarizemacapp --config notarizemacapp.ini <appfile>

Managing the Service with systemd

We set up the service under the user's control with a per-user systemd instance.

Copy macappnotarizer-user.sample.service to ~/.config/systemd/user/macappnotarizer-user.service and modify it as needed. The example uses the username as ID of the service worker. Make sure that the ID is unique if you run multiple service workers.

Start the service with

systemctl --user start macappnotarizer-user.service

If you want the service to be started automatically, then enable autostart with

systemctl --user enable macappnotarizer-user.service

Note: By default, the systemd user instance and thus the user-managed services are started after the first login of a user and killed after the last session of the user is closed. To start the user instance right after boot, and keep the systemd user instance running after the last session closes you have to enable lingering for the user:

loginctl enable-linger USERNAME

For more details on user-managed services see https://wiki.archlinux.org/title/Systemd/User.

3.7 KiB Raw Blame History