-
-
Notifications
You must be signed in to change notification settings - Fork 18
/
GNUmakefile
780 lines (663 loc) · 31 KB
/
GNUmakefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
#
# GNU 'make' file
#
#
# Requires Python 3
# On macOS:
# $ brew install [email protected]
# - add to your .bash_profile:
# export PATH="$HOME/Library/Python/3.12/bin:$PATH"
#
SHELL = /bin/bash
# Change to your own Apple Developer ID, if you want to code-sign the resultant .app
APPLEID ?= [email protected]
TEAMID ?= ZD8TVTCXDS
# The unique App ID assigned by App Store Connect, under App Information (NOT your Apple ID!!)
APPID ?= 1608360813
#DEVID ?= Developer ID Application: Perry Kundert ($(TEAMID))
#DEVID ?= DDB5489E29389E9081E0A2FD83B6555D1B101829
#DEVID ?= 3rd Party Mac Developer Application: Perry Kundert ($(TEAMID))
#DEVID ?= A5DE932A0649AE3B6F06A8134F3E19D2E19A8196
# Developer ID Application (not for Mac App Store)
DEVID ?= EAA134BE299C43D27E33E2B8645FF4CF55DE8A92
#PKGID ?= 3rd Party Mac Developer Installer: Perry Kundert ($(TEAMID))
#PKGID ?= 1B482CEB543825C33C366A5665B935D3CEC9FD05
PKGID ?= Developer ID Installer: Perry Kundert ($(TEAMID))
BUNDLEID ?= ca.kundert.perry.SLIP39
APIISSUER ?= 5f3b4519-83ae-4e01-8d31-f7db26f68290
APIKEY ?= 5H98J7LKPC
APICREDENTIALS ?= ~/.private_keys/AuthKey_$(APIKEY).p8
#PROVISION ?= ~/Documents/Apple/Certificates/SLIP39_Mac_App_Store_Provisioning.provisionprofile
PROVISION ?= ~/Documents/Apple/Certificates/SLIP39_Mac_General_Provisioning.provisionprofile
# Various cx_Freeze targets are at paths with computed extensions, eg: build/exe.win-amd64-3.10/
CXFREEZE_VER ?= 3.10
CXFREEZE_ARCH ?= amd64
CXFREEZE_EXT ?= win-$(CXFREEZE_ARCH)-$(CXFREEZE_VER)
#SIGNTOOL ?= "/c/Program Files (x86)/Windows Kits/10/bin/10.0.19041.0/x86"
SIGNTOOL ?= "c:\Program Files (x86)\Windows Kits\10\bin\10.0.19041.0\x86\signtool.exe"
# PY[3] is the target Python interpreter; require 3.11+. Detect if it is named python3 or python.
PY3 ?= $(shell python3 --version >/dev/null 2>&1 && echo python3 || echo python )
VERSION = $(shell $(PY3) -c 'exec(open("slip39/version.py").read()); print( __version__ )')
PLATFORM ?= $(shell $(PY3) -c "import sys; print( sys.platform )" )
ifeq ($(PLATFORM),darwin)
INSTALLER := pkg
else ifeq ($(PLATFORM),win32)
INSTALLER := msi
else
INSTALLER :=
endif
# To see all pytest output, uncomment --capture=no, ...
PYTESTOPTS = --capture=no --log-cli-level=WARNING
PY3TEST = $(PY3) -m pytest $(PYTESTOPTS)
# VirtualEnv: Build them in eg. ~/src/python-slip39-1.2.3/
# o Will use the *current* git branch when creating a venv and populating it
VENV_LOCAL ?= ~/src/
GHUB_NAME = python-slip39
GHUB_REPO = [email protected]:pjkundert/$(GHUB_NAME)
GHUB_BRCH = $(shell git rev-parse --abbrev-ref HEAD )
VENV_NAME = $(GHUB_NAME)-$(VERSION)
VENV_OPTS = # --copies # Doesn't help; still references some system libs.
.PHONY: all help test doctest analyze pylint build-check build install upload clean FORCE
all: help
help:
@echo "GNUmakefile for cpppo. Targets:"
@echo " help This help"
@echo " test Run unit tests under Python3"
@echo " clean Remove build artifacts"
@echo " build Build clean dist wheel and app under Python3"
@echo " install Install in /usr/local for Python3"
@echo " upload Upload new version to pypi (package maintainer only)"
@echo " app Build the macOS SLIP-39.app"
@echo " installer Build the .dmg, .msi, as appropriate for PLATFORM"
@echo " print-PLATFORM prints the detected PLATFORM"
test:
$(PY3TEST)
analyze:
$(PY3) -m flake8 --color never -j 1 --max-line-length=250 \
--exclude slip39/tabulate \
--ignore=W503,E201,E202,E203,E127,E221,E223,E226,E231,E241,E242,E251,E265,E272,E274 \
slip39
pylint:
cd .. && pylint slip39 --disable=W,C,R
build-check:
@$(PY3) -m build --version \
|| ( \
echo -e "\n\n!!! Missing Python modules; run:"; \
echo -e "\n\n $(PY3) -m pip install --break-system-packages --user --upgrade pip setuptools wheel build\n"; \
false; \
)
signing-check:
$(SIGNTOOL)
build: clean wheel
#
# org-mode products.
#
# deps: All of the gui/.txt files needed to built, before the sdist, wheel or app
#
# emacs $< --batch -f org-ascii-export-to-ascii --kill
%.txt: %.org
emacs --batch \
--eval "(require 'org)" \
--insert "$<" \
--eval "(org-ascii-export-as-ascii nil nil nil nil '(:ascii-charset utf-8))" \
--eval "(write-file \"$@\")" \
--kill
TXT = $(patsubst %.org,%.txt,$(wildcard slip39/*/*.org))
slip39/gui/SLIP-39.txt:
toilet --font ascii12 SLIP-39 > $@
@echo " Safe & Effective (tm) Crypto Wallet Backup and Recovery" >> $@
@echo " (explanations and instructions will appear here)" >> $@
slip39/layout/COVER.txt:
toilet --width 200 https://slip39.com > $@
@echo " Safe & Effective (tm) Crypto Wallet Backup and Recovery" >> $@
@echo " (explanations and instructions will appear here)" >> $@
# Any build dependencies that are dynamically generated, and may need updating from time to time
deps: $(TXT) slip39/gui/SLIP-39.txt slip39/layout/COVER.txt
#
# Agent Keypairs, Product Licences
#
GLOBAL_OPTIONS = -vv
CREDENTIALS = $(abspath $(HOME)/.crypto-licensing )
export CRYPTO_LIC_PASSWORD
export CRYPTO_LIC_USERNAME
.PHONY: slip-39 perry-kundert
products: slip-39 \
perry-kundert \
slip-39:
perry-kundert: [email protected]
perry-kundert: CRYPTO_LIC_PASSWORD=password
perry-kundert: slip39/invoice/payments_test/perry-kundert.crypto-license
perry-kundert: GRANTS="{\"crypto-licensing-server\": {\
\"override\": { \
\"rate\": \"0.1%\", \
\"crypto\": { \
\"ETH\": \"0xe4909b66FD66DA7d86114695A1256418580C8767\", \
\"BTC\": \"bc1qygm3dlynmjxuflghr0hmq6r7wmff2jd5gtgz0q\" \
}\
}\
}}"
# Create .crypto-keypair from seed; note: if the make rule fails, intermediate files are deleted.
# We expect any password to be transmitted in CRYPTO_LIC_PASSWORD env. var.
%.crypto-keypair: %.crypto-seed
$(PY3) -m crypto_licensing $(GLOBAL_OPTIONS) \
--extra $(dir $(basename $@ )) \
--name $(notdir $(basename $@ )) \
--reverse-save \
registered \
--username $(USERNAME) \
--seed $$( cat $< )
# Create .crypto-license, signed by .crypto-keypair
%.crypto-license : %.crypto-keypair
$(PY3) -m crypto_licensing $(GLOBAL_OPTIONS) \
--extra $(dir $(basename $@ )) \
--name $(notdir $(basename $@ )) \
--reverse-save \
license \
--username $(USERNAME) --no-registering \
--client $(CLIENT) --client-pubkey $(CLIENT_PUBKEY) \
--grant $(GRANTS) \
--author $(AUTHOR) --domain $(DOMAIN) --product $(PRODUCT) $(LICENSE_OPTIONS)
#
# VirtualEnv build, install and activate
#
venv: $(VENV_LOCAL)/$(VENV_NAME)
venv-activate: $(VENV_LOCAL)/$(VENV_NAME)-activate
$(VENV_LOCAL)/$(VENV_NAME):
@git diff --quiet || ( \
echo -e "\n\n!!! Git repo branch $(GHUB_BRCH) is dirty; cannot create venv!"; false \
)
@echo; echo "*** Building $@ VirtualEnv..."
@rm -rf $@ && $(PY3) -m venv $(VENV_OPTS) $@ \
&& cd $@ && git clone $(GHUB_REPO) -b $(GHUB_BRCH) \
&& . ./bin/activate \
&& make -C $(GHUB_NAME) install-tests install
# Activate a given VirtualEnv, and go to its python-slip39 installation
# o Creates a custom venv-activate.sh script in the venv, and uses it start
# start a sub-shell in that venv, with a CWD in the contained python-slip39 installation
$(VENV_LOCAL)/$(VENV_NAME)-activate: $(VENV_LOCAL)/$(VENV_NAME)
@echo; echo "*** Activating $@ VirtualEnv"
@[ -s $</venv-activate.sh ] || ( \
echo "PS1='[\u@\h \W)]\\$$ '"; \
echo "[ ! -r ~/.git-completion.bash ] || source ~/.git-completion.bash"; \
echo "[ ! -r ~/.git-prompt.sh ] || source ~/.git-prompt.sh && PS1='[\u@\h \W\$$(__git_ps1 \" (%s)\")]\\$$ '"; \
echo "source $</bin/activate"; \
echo "cd $</$(GHUB_NAME)"; \
) > $</venv-activate.sh
@bash --init-file $</venv-activate.sh -i
wheel: deps dist/slip39-$(VERSION)-py3-none-any.whl
dist/slip39-$(VERSION)-py3-none-any.whl: build-check FORCE
$(PY3) -m build
@ls -last dist
# Install from wheel, including all optional extra dependencies (except dev)
install: dist/slip39-$(VERSION)-py3-none-any.whl FORCE
$(PY3) -m pip install --break-system-packages --user --force-reinstall $<[all]
install-tests:
$(PY3) -m pip install --upgrade --break-system-packages --user -r requirements-tests.txt
# Building / Signing / Notarizing and Uploading the macOS or win32 App
# o TODO: no signed and notarized package yet accepted for upload by macOS App Store
#
# Mac: To build the .dmg installer, run:
# make clean
# make installer # continue running every couple of minutes 'til the App is notarized
#
installer: $(INSTALLER)
dmg: deps app-dmg-valid
pkg: deps app-pkg-valid
msi: deps dist/slip39-$(VERSION)-win64.msi
exe: deps build/exe.$(CXFREEZE_EXT)/SLIP-39.exe
app: deps dist/SLIP-39.app
app-packages: app-zip-valid app-dmg-valid app-pkg-valid
app-upload: app-dmg-upload
# Generate, Sign and Package the macOS SLIP-39.app GUI for App Store or local/manual installation
# o Try all the approaches of packaging a macOS App for App Store upload
app-dmg: dist/SLIP-39-$(VERSION).dmg
app-zip: dist/SLIP-39-$(VERSION).zip
app-pkg: dist/SLIP-39-$(VERSION).pkg
app-dmg-valid: dist/SLIP-39-$(VERSION).dmg.valid
app-zip-valid: dist/SLIP-39-$(VERSION).zip.valid
app-pkg-valid: dist/SLIP-39-$(VERSION).pkg.valid
app-dmg-upload: dist/SLIP-39-$(VERSION).dmg.upload-package
app-zip-upload: dist/SLIP-39-$(VERSION).zip.upload-package
app-pkg-upload: dist/SLIP-39-$(VERSION).pkg.upload-package
#
# Build the windows .msi installer. Must build and sign the .exe first
#
build/exe.$(CXFREEZE_EXT)/SLIP-39.exe:
@echo -e "\n\n*** Building $@"
@$(PY3) setup.py build_exe > cx_Freeze.build_exe.log \
&& echo -e "\n\n*** $@ Build successfully:" \
|| ( echo -e "\n\n!!! $@ Build failed:"; tail -20 cx_Freeze.build_exe.log; false )
dist/slip39-$(VERSION)-win64.msi: build/exe.$(CXFREEZE_EXT)/SLIP-39.exe # signing-check
#@echo -e "\n\n*** Signing $<"
#$(SIGNTOOL) sign /v /t \
# http://timestamp.digicert.com \
# /n "$(DEVID)" \
# $<
@echo -e "\n\n*** Package $@"
@$(PY3) setup.py bdist_msi > $cx_Freeze.bdist_msi.log \
&& echo -e "\n\n*** $@ Build successfully:" \
|| ( echo -e "\n\n!!! $@ Build failed:"; tail -20 cx_Freeze.bdist_msi.log; false )
#
# Build the macOS App, and create and sign the .dmg file
#
# o Uses https://github.com/sindresorhus/create-dmg
# - npm install --global create-dmg
# - Renames the resultant file from "SLIP-39 1.2.3.dmg" to "SLIP-39-1.2.3.dmg"
# - It automatically finds the correct signing key (unkown)
#
dist/SLIP-39-$(VERSION).dmg: dist/SLIP-39.app
@echo -e "\n\n*** Creating and signing DMG $@..."
npx create-dmg -v --overwrite --identity "$(PKGID)" $< dist/
mv "SLIP-39 $(VERSION).dmg" "$@"
@echo "Checking signature..."; ./SLIP-39.metadata/check-signature $@
.PHONY: dist/SLIP-39-$(VERSION).dmg-verify
dist/SLIP-39-$(VERSION).dmg-verify: dist/SLIP-39-$(VERSION).dmg
@echo -e "\n\n*** Verifying signing of $<..."
#codesign --verify -v $< \
# || ( echo "!!! Unable to verify codesign: "; codesign --verify -vv $<; false )
spctl --assess --type install --context context:primary-signature -vvv $< || \
spctl --assess --type execute --context context:primary-signature -vvv $< || \
spctl --assess --type open --context context:primary-signature -vvv $< || \
spctl --assess --type install -vvv $< || \
spctl --assess --type execute -vvv $< || \
spctl --assess --type open -vvv $<
# Notarize the .dmg, unless we've already uploaded it and have a RequestUUID
dist/SLIP-39-$(VERSION).dmg.notarization: dist/SLIP-39-$(VERSION).dmg
jq -r '.["notarization-upload"]["RequestUUID"]' $@ 2>/dev/null \
|| xcrun altool --notarize-app -f $< \
--primary-bundle-id $(BUNDLEID) \
--team-id $(TEAMID) \
--apiKey $(APIKEY) --apiIssuer $(APIISSUER) \
--output-format json \
> $@
# Refresh the ...dmg.notariation-status, unless it is already "Status: success"
dist/SLIP-39-$(VERSION).dmg.notarization-status: dist/SLIP-39-$(VERSION).dmg.notarization FORCE
[ -s $@ ] && grep "Status: success" $@ \
|| xcrun altool \
--apiKey $(APIKEY) --apiIssuer $(APIISSUER) \
--notarization-info $$( jq -r '.["notarization-upload"]["RequestUUID"]' $< ) \
| tee -a $@
# Check notarization status 'til Status: success, then staple it to ...dmg, and create ...dmg.valid marker file
dist/SLIP-39-$(VERSION).dmg.valid: dist/SLIP-39-$(VERSION).dmg.notarization-status FORCE
@grep "Status: success" $< || \
( tail -10 $<; echo -e "\n\n!!! App not yet notarized; try again in a few seconds..."; false )
( [ -r $@ ] ) \
&& ( echo -e "\n\n*** Notarization complete; refreshing $@" && touch $@ ) \
|| ( \
xcrun stapler staple dist/SLIP-39-$(VERSION).dmg && \
xcrun stapler validate dist/SLIP-39-$(VERSION).dmg && \
echo -e "\n\n*** Notarization attached to $@" && \
touch $@ \
)
# macOS ...dmg App Upload: Unless the ...dmg.upload file exists and is non-empty.
# o Try either upload-package and upload-app approach
# o NOTE that --apple-id is NOT your "Apple ID", it is the unique App ID
# See: https://github.com/fastlane/fastlane/issues/14783
dist/SLIP-39-$(VERSION).dmg.upload-package: dist/SLIP-39-$(VERSION).dmg dist/SLIP-39-$(VERSION).dmg.valid FORCE
[ -s $@ ] || ( \
echo -e "\n\n*** Uploading the signed DMG file: $<..." && \
echo "*** Verifying notarization stapling..." && xcrun stapler validate $< && \
echo "*** Checking signature..." && ./SLIP-39.metadata/check-signature $< && \
echo "*** Upload starting for $<..." && \
xcrun altool --upload-package $< \
--type macos \
--bundle-id $(BUNDLEID) --bundle-version $(VERSION) --bundle-short-version-string $(VERSION) \
--apple-id $(APPID) --team $(TEAMID) \
--apiKey $(APIKEY) --apiIssuer $(APIISSUER) \
| tee -a $@ \
)
dist/SLIP-39-$(VERSION).dmg.upload-app: dist/SLIP-39-$(VERSION).dmg dist/SLIP-39-$(VERSION).dmg.valid FORCE
[ -s $@ ] || ( \
echo -e "\n\n*** Uploading the signed DMG file: $<..." && \
echo "*** Verifying notarization stapling..." && xcrun stapler validate $< && \
echo "*** Checking signature..." && ./SLIP-39.metadata/check-signature $< && \
echo "*** Upload starting for $<..." && \
xcrun altool --upload-app -f $< \
--type macos \
--primary-bundle-id $(BUNDLEID) \
--apiKey $(APIKEY) --apiIssuer $(APIISSUER) \
| tee -a $@ \
)
#
# Create the .pkg, ensuring that the App was created and signed appropriately
# o Sign this w/ the ...Developer ID?
# - Nope: "...An installer signing identity (not an application signing identity) is required for signing flat-style products."
# See: https://lessons.livecode.com/m/4071/l/876834-signing-and-uploading-apps-to-the-mac-app-store
# o Need ... --product <path-to-app-bundle-Info.plist>
# According to this article, a "Developer ID Installer:..." signing key is required:
# See: https://forums.ivanti.com/s/article/Obtaining-an-Apple-Developer-ID-Certificate-for-macOS-Provisioning?language=en_US&ui-force-components-controllers-recordGlobalValueProvider.RecordGvp.getRecord=1
# Must copy the app w/ ditto, into a target dir structure including the destination location, eg. /Applications/SLIP-39.app/...
#
dist/SLIP-39-$(VERSION).pkg: dist/SLIP-39.app
#rm -rf /tmp/SLIP-39-pkg
#ditto $< /tmp/SLIP-39-pkg/SLIP-39.app
productbuild \
--sign "$(PKGID)" \
--timestamp \
--identifier "$(BUNDLEID).pkg" \
--version $(VERSION) \
--root "$<" "/Applications/SLIP-39.app/" \
$@
# Confirm that the .pkg is signed w/ the correct certificates.
# See: https://developer.apple.com/documentation/security/notarizing_macos_software_before_distribution/resolving_common_notarization_issues
# Not these:
# spctl --assess --type install --context context:primary-signature -vvv $< || \
# spctl --assess --type execute --context context:primary-signature -vvv $< || \
# spctl --assess --type open --context context:primary-signature -vvv $< || \
# spctl --assess --type install -vvv $< || \
# spctl --assess --type execute -vvv $< || \
# spctl --assess --type open -vvv $< || true
# Wrong:
# o The developer.apple.com/documentation is wrong; it is directly in conflict with the error
# messages returned, demanding the 3rd Party Installer signing key
.PHONY: dist/SLIP-39-$(VERSION).pkg-verify
dist/SLIP-39-$(VERSION).pkg-verify: dist/SLIP-39-$(VERSION).pkg
@echo -e "\n\n*** Verifying signing of $<..."
pkgutil --check-signature $< | grep "Signed with a trusted timestamp"
#pkgutil --check-signature $< | grep "1. Developer ID Installer:"
#
# macOS Package Notarization
# See: https://oozou.com/blog/scripting-notarization-for-macos-app-distribution-38
# https://developer.apple.com/documentation/technotes/tn3147-migrating-to-the-latest-notarization-tool
# o The .pkg version doesn't work due to incorrect signing keys for the .pkg (unknown reason)
#
# Submits the version's .pkg for notariation, and waits for completion (success or failure).
# - The output contains the Submission ID, required to obtain the JSON notary log
dist/SLIP-39-$(VERSION).pkg.notarization: dist/SLIP-39-$(VERSION).pkg dist/SLIP-39-$(VERSION).pkg-verify
grep "Submission ID" $@ 2>/dev/null \
|| xcrun notarytool submit \
--issuer $(APIISSUER) \
--key-id $(APIKEY) \
--key $(APICREDENTIALS) \
--wait \
$< \
> $@
dist/SLIP-39-$(VERSION).pkg.notarization-status: dist/SLIP-39-$(VERSION).pkg.notarization FORCE
[ -s $@ ] && grep "Status: success" $@ \
|| xcrun notarytool log \
--issuer $(APIISSUER) \
--key-id $(APIKEY) \
--key $(APICREDENTIALS) \
$$( grep -A1 "Submission ID" < $< | grep "id:" | awk '{print $$2}' ) \
> $@
# Check notarization status 'til Status: success, then staple it to ...pkg, and create ...pkg.valid marker file
dist/SLIP-39-$(VERSION).pkg.valid: dist/SLIP-39-$(VERSION).pkg.notarization-status FORCE
@grep "Ready for distribution" $< || \
( tail -10 $<; echo -e "\n\n!!! App not yet notarized..."; false )
( [ -r $@ ] ) \
&& ( echo -e "\n\n*** Notarization complete; refreshing $@" && touch $@ ) \
|| ( \
xcrun stapler staple dist/SLIP-39-$(VERSION).pkg && \
xcrun stapler validate dist/SLIP-39-$(VERSION).pkg && \
echo -e "\n\n*** Notarization attached to $@" && \
touch $@ \
)
# macOS ...pkg App Upload: Unless the ...dmg.upload file exists and is non-empty.
# o Could also use Transporter
# o Try either upload-package and upload-app approach
# o NOTE that --apple-id is NOT your "Apple ID", it is the unique App ID (see above)
dist/SLIP-39-$(VERSION).pkg.upload-package: dist/SLIP-39-$(VERSION).pkg dist/SLIP-39-$(VERSION).pkg.valid FORCE
[ -s $@ ] || ( \
echo -e "\n\n*** Uploading the signed PKG file: $<..." && \
echo "*** Verifying notarization stapling..." && xcrun stapler validate $< && \
echo "*** Checking signature..." && ./SLIP-39.metadata/check-signature $< && \
echo "*** Upload starting for $<..." && \
xcrun altool --upload-package $< \
--type macos \
--bundle-id $(BUNDLEID) --bundle-version $(VERSION) --bundle-short-version-string $(VERSION) \
--apple-id $(APPID) --team $(TEAMID) \
--apiKey $(APIKEY) --apiIssuer $(APIISSUER) \
| tee -a $@ \
)
#
# Build the macOS App, and Package the macOS App as a Zip file for Notarization
#
# o Create a ZIP archive suitable for notarization.
#
dist/SLIP-39-$(VERSION).zip: dist/SLIP-39.app
@echo -e "\n\n*** Creating and signing DMG $@..."
@echo "Checking signature..." && ./SLIP-39.metadata/check-signature $<
codesign --verify $<
codesign -dv -r- $<
codesign -vv $<
rm -f $@
/usr/bin/ditto -c -k --keepParent "$<" "$@"
@ls -last dist
# Upload and notarize the .zip, unless we've already uploaded it and have a RequestUUID
dist/SLIP-39-$(VERSION).zip.notarization: dist/SLIP-39-$(VERSION).zip
jq -r '.["notarization-upload"]["RequestUUID"]' $@ 2>/dev/null \
|| xcrun altool --notarize-app -f $< \
--primary-bundle-id $(BUNDLEID) \
--team-id $(TEAMID) \
--apiKey $(APIKEY) --apiIssuer $(APIISSUER) \
--output-format json \
> $@
# Refresh the ...zip.notariation-status, unless it is already "Status: success"
dist/SLIP-39-$(VERSION).zip.notarization-status: dist/SLIP-39-$(VERSION).zip.notarization FORCE
[ -s $@ ] && grep "Status: success" $@ \
|| xcrun altool \
--apiKey $(APIKEY) --apiIssuer $(APIISSUER) \
--notarization-info $$( jq -r '.["notarization-upload"]["RequestUUID"]' $< ) \
| tee -a $@
# Check notarization status 'til Status: success, then mark the ...zip.valid
# o We can't staple anything to a zip, but the contained app will now pass Gateway
# on the client system, b/c it will check w/ Apple's servers that the app was notarized.
dist/SLIP-39-$(VERSION).zip.valid: dist/SLIP-39-$(VERSION).zip.notarization-status FORCE
@grep "Status: success" $< || \
( tail -10 $<; echo -e "\n\n!!! App not yet notarized; try again in a few seconds..."; false )
@echo -e "\n\n*** Notarization complete; refreshing $@" \
&& touch $@
# Submit App Zip w/o notarization stapled.
# o Doesn't work; same "Unsupported toolchain." error as ...-notarized.zip.upload
dist/SLIP-39-$(VERSION).zip.upload-package: dist/SLIP-39-$(VERSION).zip dist/SLIP-39-$(VERSION).zip.valid FORCE
[ -s $@ ] || xcrun altool --upload-package $< \
--type macos \
--bundle-id $(BUNDLEID) --bundle-version $(VERSION) --bundle-short-version-string $(VERSION) \
--apple-id $(APPID) \
--apiKey $(APIKEY) --apiIssuer $(APIISSUER) \
| tee -a $@
# Check notarization status 'til Status: success, then staple it to ...app, and create ...-notarized.zip
# o The .zip version works, but the notarization cannot be stapled to the zip;
# - It should usually be checked via Gatekeeper, by the recipient of the App in the .zip
# - We have to receive notification that the SLIP-39.zip.notarization-status Status: success
# - So, once we confirm notarization, just submit/publish the original .zip file
# o For other purposes (eg. just for manual installation), we can package the Notarized app
dist/SLIP-39-$(VERSION)-notarized.zip: dist/SLIP-39-$(VERSION).app dist/SLIP-39-$(VERSION).zip.valid
( [ -r $@ ] ) \
&& ( echo -e "\n\n*** Notarization compete; not re-generating $@"; true ) \
|| ( \
xcrun stapler staple $<; \
xcrun stapler validate $<; \
echo -e "\n\n*** Notarization attached to $<; creating $@"; \
/usr/bin/ditto -c -k --keepParent "$<" "$@"; \
ls -last dist; \
)
# macOS ...zip App Upload: Unless the ...zip.upload file exists and is non-zero
# o I don't think it is possible to construct, notarize and submit an App for the macOS store via Zip
# - We can't staple the notarization onto it. Must use a .pkg or .dmg...
# *** Error: Error uploading 'dist/SLIP-39-6.6.4-notarized.zip'.
# *** Error: Unsupported toolchain. Packages submitted to the App Store must be created either through Xcode, or using the productbuild[1] tool, as described in "Submitting your Mac apps to the App Store." Packages created by other tools, including PackageMaker, are not acceptable. [SIS] With error code STATE_ERROR.VALIDATION_ERROR.90270 for id 39784451-3843-428b-97ec-37c1b196ca35 Asset validation failed (-19208)
dist/SLIP-39-$(VERSION)-notarized.zip.upload: dist/SLIP-39-$(VERSION)-notarized.zip FORCE
[ -s $@ ] || xcrun altool --upload-package $< \
--type macos \
--bundle-id $(BUNDLEID) --bundle-version $(VERSION) --bundle-short-version-string $(VERSION) \
--apple-id $(APPID) \
--apiKey $(APIKEY) --apiIssuer $(APIISSUER) \
| tee -a $@
#
# The macOS gui APP
#
# Rebuild the gui App; ensure we discard any partial/prior build and gui artifacts The --onefile
# approach doesn't seem to work, as we need to sign things after packaging. We need to customize
# the SLIP-39.spec file (eg. for version), so we do not target SLIP-39.py (which would re-generate it
# without our additions)
#
# Additional .spec file configurations:
# - https://developer.apple.com/documentation/bundleresources/information_property_list/lsminimumsystemversion
#
# o The codesign --verify succeeds w/ the '3rd Party Mac Developer Application ...', but not the spctl --assess?
#
.PHONY: dist/SLIP-39.app-signed
dist/SLIP-39.app-signed: dist/SLIP-39.app \
dist/SLIP-39.app-checkids
@echo -e "\n\n*** Verifying codesigning of $<..."
codesign --verify -v $< \
|| ( echo "!!! Unable to verify codesign: "; codesign --verify -vv $<; false )
spctl --assess --type install --context context:primary-signature -vvv $< || \
spctl --assess --type execute --context context:primary-signature -vvv $< || \
spctl --assess --type open --context context:primary-signature -vvv $< || true
.PHONY: dist/SLIP-39.app-checkids
dist/SLIP-39.app-checkids: SLIP-39.spec
@echo -e "\n\n*** Checking Developer/Installer IDs for $(TEAMID) in $<..."
security find-identity -vp macappstore
security find-identity -vp macappstore | grep "$(DEVID)" \
|| ( echo "!!! Unable to find Developer ID for signing: $(DEVID)"; false )
security find-identity -vp macappstore | grep "$(PKGID)" \
|| ( echo "!!! Unable to find Installer ID for signing: $(PKGID)"; false )
# Not necessary?
# --options=runtime --timestamp
#
# For details on Signing Apps:
# See: https://developer.apple.com/library/archive/technotes/tn2318/_index.html
# For PyInstaller-specific hints:
# https://gist.github.com/txoof/0636835d3cc65245c6288b2374799c43
# https://github.com/txoof/codesign
# https://github.com/The-Nicholas-R-Barrow-Company-LLC/PyMacApp
# * In order for code signing to succeed, your code signing key(s) MUST have all of their dependent
# (issuer) keys downloaded to your Keychain, from https://www.apple.com/certificateauthority.
# - Use Keychain Access, right-click on your signing key and click Evaluate "...".
# - Find each dependent key, and look at its SHA fingerprint, and then see if you have
# that one in your System keychain, downloading all the named keys from apple 'til
# you find the one with the matching fingerprint. Grr... Repeat 'til check-signature works.
# * To be accepted by the Mac App Store, your App must be signed, and have an entitlements.plist
# containing:
# <key>com.apple.security.app-sandbox</key> <true/>
# - This causes PyInstaller created apps to crash, because they can't execute the Python interpreter
# recursively (?) https://github.com/pyinstaller/pyinstaller/issues/2198
# - Here is an up-to-date diary of the woes encountered: https://github.com/pyinstaller/pyinstaller/issues/7123
# - A summary of the solutions is here: https://github.com/nyavramov/python_app_mac_app_store
#
dist/SLIP-39.app: SLIP-39-macOS.spec \
SLIP-39.metadata/entitlements.plist \
images/SLIP-39.icns \
$(PROVISION)
@echo -e "\n\n*** Rebuilding $@, version $(VERSION)..."
rm -rf build $@*
sed -I "" -E "s/version=.*/version='$(VERSION)',/" $<
sed -I "" -E "s/'CFBundleVersion':.*/'CFBundleVersion':'$(VERSION)',/" $<
sed -I "" -E "s/codesign_identity=.*/codesign_identity='$(DEVID)',/" $<
pyinstaller --noconfirm $<
#echo "Copying Provisioning Profile..."; rsync -va $(PROVISION) $@/Contents/embedded.provisionprofile
echo "Checking signature (pyinstaller signed)..."; ./SLIP-39.metadata/check-signature $@ || true
codesign --verify --verbose $@
# codesign --deep --force \
# --all-architectures --options=runtime --timestamp \
# --sign "$(DEVID)" \
# $@
# echo "Checking signature (app code signed)..."; ./SLIP-39.metadata/check-signature $@ || true
# codesign --verify $@
codesign --deep --force --timestamp --verbose --options runtime \
--all-architectures \
--entitlements ./SLIP-39.metadata/entitlements.plist \
--sign "$(DEVID)" \
$@
echo "Checking signature (app code + entitlements signed w/ $(DEVID))..."; ./SLIP-39.metadata/check-signature $@ || true
codesign --verify --verbose $@
touch $@ # try to avoid unnecessary rebuilding
app-assess: dist/SLIP-39.app
spctl --assess --type execute --context context:primary-signature -vvv $<
#
# Only used for initial creation of SLIP-39.spec; it must be customized, so this target cannot be
# used to achieve a complete, operational SLIP-39.spec file!
#
# Roughly, change:
#
# app = BUNDLE(coll,
# name='SLIP-39.app',
# - icon=None,
# + icon='images/SLIP-39.icns',
# + version='6.4.1',
# + info_plist={
# + 'CFBundleVersion':'6.4.1',
# + 'CFBundlePackageType':'APPL',
# + 'LSApplicationCategoryType':'public.app-category.utilities',
# + 'LSMinimumSystemVersion':'10.15.0',
# + })
# +
# bundle_identifier='ca.kundert.perry.SLIP39')
SLIP-39-macOS.spec: SLIP-39.py
@echo -e "\n\n!!! Rebuilding $@; Must be manually edited..."
pyinstaller --noconfirm --windowed --onefile \
--codesign-identity "$(DEVID)" \
--osx-bundle-identifier "$(BUNDLEID)" \
--collect-data shamir_mnemonic \
--hidden-import slip39 \
--collect-data slip39 \
$<
mv SLIP-39.spec $@
@echo "!!! Regenerated $@: must be manually corrected!"
false # Make the build fail if we've regenerated the .spec
dist/SLIP-39.exe: SLIP-39-win32.spec
rm -rf build $@
pyinstaller --noconfirm $<
SLIP-39-win32.spec: SLIP-39.py
@echo -e "\n\n!!! Rebuilding $@; Must be manually edited..."
pyinstaller --noconfirm --windowed --onefile \
--collect-data shamir_mnemonic \
--hidden-import slip39 \
--collect-data slip39 \
$<
mv SLIP-39.spec $@
@echo "!!! Regenerated $@: must be manually corrected!"
false # Make the build fail if we've regenerated the .spec
#
# macOS Icons
#
# Requires a source images/SLIP-39.png at least 1024x1024
#
# See: https://stackoverflow.com/questions/12306223/how-to-manually-create-icns-files-using-iconutil
#
images/SLIP-39.icns: images/SLIP-39.iconset
iconutil --convert icns -o $@ $<
images/SLIP-39.iconset: images/SLIP-39.png
rm -rf $@
mkdir $@
sips -z 16 16 $< --out $@/icon_16x16.png
sips -z 32 32 $< --out $@/[email protected]
sips -z 32 32 $< --out $@/icon_32x32.png
sips -z 64 64 $< --out $@/[email protected]
sips -z 128 128 $< --out $@/icon_128x128.png
sips -z 256 256 $< --out $@/[email protected]
sips -z 256 256 $< --out $@/icon_256x256.png
sips -z 512 512 $< --out $@/[email protected]
sips -z 512 512 $< --out $@/icon_512x512.png
sips -z 1024 1024 $< --out $@/[email protected]
#
# Pypi pip packaging
#
# Support uploading a new version of slip39 to pypi. Must:
# o advance __version__ number in slip39/version.py
# o log in to your pypi account (ie. for package maintainer only)
#
upload-check:
@$(PY3) -m twine --version \
|| ( echo -e "\n\n*** Missing Python modules; run:\n\n $(PY3) -m pip install --upgrade twine\n" \
&& false )
upload: upload-check wheel
$(PY3) -m twine upload --repository pypi dist/slip39-$(VERSION)*
clean:
@rm -rf MANIFEST *.png build dist auto *.egg-info $(shell find . -name '__pycache__' )
# Run only tests with a prefix containing the target string, eg test-api
test-%:
$(PY3TEST) $(shell find slip39 -name '*$**_test.py')
# Run all tests with names matching the target string
unit-%:
$(PY3TEST) -k $*
#
# Target to allow the printing of 'make' variables, eg:
#
# make print-CXXFLAGS
#
print-%:
@echo $* = $($*)
@echo $*\'s origin is $(origin $*)