chore: macOS notarizing #1365

lidel · 2020-02-27T18:19:26Z

Motivation

This PR aims to fix macOS Catalina issues described in #1211

Details

This adds scripts that run electron-notarize as additional manual or build steps on darwin runtime, loosely following https://kilianvalkhof.com/2019/electron/notarizing-your-electron-application/

`pkgs/macos/notarize-build.js` (not used for now)

This runs as part of darwin build as it was suggested on https://www.electron.build/code-signing.

Skipped if process.env.APPLEID or process.env.APPLEIDPASS are not set at the build time. As there was no safe way to do it on TravisCI, we don't use it at CI atm.

`pkgs/macos/notarize-cli.js` (should do for now)

A standalone CLI tool that performs notarization of existing macOS artifact.
It enables us to notarize macOS artifact as a semi-automatic step during release dance:

Download .dmg from https://github.com/ipfs-shipyard/ipfs-desktop/releases/vA.B.C
Run node pkgs/macos/notarize-cli.js ./path/to/IPFS-Desktop-A.B.C.dmg

pkgs/macos/notarize.js

olizilla · 2020-02-28T12:20:17Z

Relevant context for the macOS binary signing that we set up previously #66 (comment)

lidel · 2020-03-09T19:08:07Z

@autonome
I've discussed this with @olizilla and threat model is tricky.
Doing CI-based notarization will require us to move away from TravisCI.

We have no bandwidth nor full time maintainer atm. Let's go with semi-automatic notarization during release dance.

Created a script for post-build online notarization (without stapling) – should be enough for now:

$ node pkgs/macos/notarize-cli.js ./path/to/IPFS-Desktop-A.B.C.dmg

(People download .dmg, so are online anyway)

autonome · 2020-03-09T19:18:21Z

README.md

@@ -119,6 +119,9 @@ Other languages are periodically pulled from [Transifex](https://www.transifex.c
 - Publish local changes and the tag to GitHub repo: `git push && git push origin vA.B.C`
 - Wait for the CI to upload the binaries to the draft release (a new one will be created if you haven't drafted one).
 - The `latest.yml, latest-mac.yml, latest-linux.yml` files on the release are used by the app to determine when an app update is available. Once a release is published, users should recieve the app update. See: https://www.electron.build/auto-update.
+- Notarize `.dmg` at Apple (context: [#1365](https://github.com/ipfs-shipyard/ipfs-desktop/issues/1211))
+    1. Download `.dmg` from `https://github.com/ipfs-shipyard/ipfs-desktop/releases/vA.B.C`
+    2. Run `node pkgs/macos/notarize-cli.js ./IPFS-Desktop-A.B.C.dmg`


What do you do w/ the notarized dmg? Commit back to repo?

Should adding and editing the .env file be here too?

what to do with notarized .dmg?

IIUC we would do nothing with notarized .dmg, just discard it for now. Goal is to inform Apple that this is a legit binary blob, so it can give thumbs up when someone's macOS asks about it in the future.

Why? We can't replace .dmg attached to GitHub Release with notarized version because checksum in latest-mac.yml would no longer match and that would break autoupdates.

But online notarization should still work: when macOS sees a new version of ipfs-desktop it will check for stapled notarization, won't find it, so it will fallback to asking Apple servers if running it is ok. Autoupdate requires internet connection anyway, so this non-stapled notarization should also work.

env

notarize-cli will inform user if env variables are missing, but I've added note about them in 99d0dfb

README.md

This adds scripts that run electron-notarize as additional manual or build steps on darvin runtime, loosly following https://kilianvalkhof.com/2019/electron/notarizing-your-electron-application/ Context: #1211 License: MIT Signed-off-by: Marcin Rataj <[email protected]>

electron-userland/electron-builder#3940 (comment) License: MIT Signed-off-by: Marcin Rataj <[email protected]>

License: MIT Signed-off-by: Marcin Rataj <[email protected]>

electron-notarize-dmg is electron-notarize but supports DMG without stapling (which is what we want for now) License: MIT Signed-off-by: Marcin Rataj <[email protected]>

olizilla · 2020-03-11T14:20:41Z

worth noting that we are depending on electron-notarize-dmg which is a user provided fork of electron-notify... it's pinned at 1.0.0, which is good as we don't trust any old updates of this fork... the github diff for the fork seem legit, but thats no guarantee of whats inside the published module electron/notarize@master...hugozap:master

lidel · 2020-03-12T01:28:28Z

@olizilla yes, I pinned it for that very reason. For what its worth I checked code from NPM in node_modules and the diff is matching github one.

(Manual cli notarization is a temporary solution until we get a full time maintainer who will have bandwidth for doing in on the CI safely)

olizilla · 2020-03-12T11:03:00Z

The underside of this iceberg required us to also

upgrade locally installed xcode to the latest version (11.3)
generate a new new app-specific password in the apple developer portal
renew our apple developer license, for $99 per year.
sign agreements for unpaid and, suprisingly, paid apps even though we only want to notarize a free app that we do not distribute through the app store.
- many thanks to https://forums.developer.apple.com/message/397892#397892

with all that in place, running

node pkgs/macos/notarize-cli.js ~/Downloads/IPFS-Desktop-0.10.4.dmg

returned without error. The overlord blessed us with an email.

olizilla · 2020-03-12T14:20:43Z

Can confirm... on macos 10.15.3, trying to run ipfs-desktop 0.10.3 results in

while trying trying to run 0.10.4 now gives us a

\o/

olizilla · 2020-03-12T14:31:04Z

For what its worth I checked code from NPM in node_modules and the diff is matching github one.

very cool @lidel. did i mention that you are the best?

lidel · 2020-03-12T17:06:12Z

@olizilla no, you are! thank you for pushing this through the finish line ❤️

lidel force-pushed the fix/macos-notarizing branch from 6a459e2 to 69d4481 Compare February 27, 2020 18:21

lidel commented Feb 27, 2020

View reviewed changes

pkgs/macos/notarize.js Outdated Show resolved Hide resolved

lidel force-pushed the fix/macos-notarizing branch from 55df677 to 1e055e5 Compare March 9, 2020 18:54

lidel changed the title ~~wip: macOS notarizing~~ chore: macOS notarizing Mar 9, 2020

lidel requested a review from autonome March 9, 2020 19:01

lidel marked this pull request as ready for review March 9, 2020 19:02

autonome suggested changes Mar 9, 2020

View reviewed changes

lidel force-pushed the fix/macos-notarizing branch from 59b8905 to 69d7c9d Compare March 9, 2020 19:42

lidel commented Mar 10, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

autonome approved these changes Mar 10, 2020

View reviewed changes

lidel added 5 commits March 11, 2020 00:14

fix: go-ipfs binary notarization on macOS

f34c9d0

electron-userland/electron-builder#3940 (comment) License: MIT Signed-off-by: Marcin Rataj <[email protected]>

chore: electron-builder 22.4.0

56e997e

License: MIT Signed-off-by: Marcin Rataj <[email protected]>

docs: clarify env variables needed for notarization

5304c0c

refactor: electron-notarize-dmg for CLI notarization

0537b48

electron-notarize-dmg is electron-notarize but supports DMG without stapling (which is what we want for now) License: MIT Signed-off-by: Marcin Rataj <[email protected]>

lidel force-pushed the fix/macos-notarizing branch from 99d0dfb to 0537b48 Compare March 10, 2020 23:31

lidel merged commit 81e74d5 into master Mar 10, 2020

lidel deleted the fix/macos-notarizing branch March 10, 2020 23:54

lidel mentioned this pull request Mar 12, 2020

'IPFS Desktop' can't be opened because Apple cannot check it for malicious software #1211

Closed

momack2 mentioned this pull request Apr 26, 2020

Release 0.11.0 #1415

Closed

22 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: macOS notarizing #1365

chore: macOS notarizing #1365

lidel commented Feb 27, 2020 •

edited

Loading

olizilla commented Feb 28, 2020

lidel commented Mar 9, 2020

autonome Mar 9, 2020

autonome Mar 9, 2020

lidel Mar 9, 2020 •

edited

Loading

olizilla commented Mar 11, 2020

lidel commented Mar 12, 2020

olizilla commented Mar 12, 2020 •

edited

Loading

olizilla commented Mar 12, 2020

olizilla commented Mar 12, 2020

lidel commented Mar 12, 2020

chore: macOS notarizing #1365

chore: macOS notarizing #1365

Conversation

lidel commented Feb 27, 2020 • edited Loading

Motivation

Details

pkgs/macos/notarize-build.js (not used for now)

pkgs/macos/notarize-cli.js (should do for now)

olizilla commented Feb 28, 2020

lidel commented Mar 9, 2020

autonome Mar 9, 2020

Choose a reason for hiding this comment

autonome Mar 9, 2020

Choose a reason for hiding this comment

lidel Mar 9, 2020 • edited Loading

Choose a reason for hiding this comment

what to do with notarized .dmg?

env

olizilla commented Mar 11, 2020

lidel commented Mar 12, 2020

olizilla commented Mar 12, 2020 • edited Loading

olizilla commented Mar 12, 2020

olizilla commented Mar 12, 2020

lidel commented Mar 12, 2020

lidel commented Feb 27, 2020 •

edited

Loading

`pkgs/macos/notarize-build.js` (not used for now)

`pkgs/macos/notarize-cli.js` (should do for now)

lidel Mar 9, 2020 •

edited

Loading

olizilla commented Mar 12, 2020 •

edited

Loading