/
macPackager.ts
459 lines (400 loc) · 18.2 KB
/
macPackager.ts
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
import BluebirdPromise from "bluebird-lst"
import { deepAssign, Arch, AsyncTaskManager, exec, InvalidConfigurationError, log, use, getArchSuffix } from "builder-util"
import { signAsync, SignOptions } from "electron-osx-sign"
import { mkdir, readdir } from "fs/promises"
import { Lazy } from "lazy-val"
import * as path from "path"
import { copyFile, statOrNull, unlinkIfExists } from "builder-util/out/fs"
import { orIfFileNotExist } from "builder-util/out/promise"
import { AppInfo } from "./appInfo"
import { CertType, CodeSigningInfo, createKeychain, findIdentity, Identity, isSignAllowed, removeKeychain, reportError } from "./codeSign/macCodeSign"
import { DIR_TARGET, Platform, Target } from "./core"
import { AfterPackContext, ElectronPlatformName } from "./index"
import { MacConfiguration, MasConfiguration } from "./options/macOptions"
import { Packager } from "./packager"
import { chooseNotNull, PlatformPackager } from "./platformPackager"
import { ArchiveTarget } from "./targets/ArchiveTarget"
import { PkgTarget, prepareProductBuildArgs } from "./targets/pkg"
import { createCommonTarget, NoOpTarget } from "./targets/targetFactory"
import { isMacOsHighSierra } from "./util/macosVersion"
import { getTemplatePath } from "./util/pathManager"
import * as fs from "fs/promises"
export default class MacPackager extends PlatformPackager<MacConfiguration> {
readonly codeSigningInfo = new Lazy<CodeSigningInfo>(() => {
const cscLink = this.getCscLink()
if (cscLink == null || process.platform !== "darwin") {
return Promise.resolve({ keychainFile: process.env.CSC_KEYCHAIN || null })
}
return createKeychain({
tmpDir: this.info.tempDirManager,
cscLink,
cscKeyPassword: this.getCscPassword(),
cscILink: chooseNotNull(this.platformSpecificBuildOptions.cscInstallerLink, process.env.CSC_INSTALLER_LINK),
cscIKeyPassword: chooseNotNull(this.platformSpecificBuildOptions.cscInstallerKeyPassword, process.env.CSC_INSTALLER_KEY_PASSWORD),
currentDir: this.projectDir,
}).then(result => {
const keychainFile = result.keychainFile
if (keychainFile != null) {
this.info.disposeOnBuildFinish(() => removeKeychain(keychainFile))
}
return result
})
})
private _iconPath = new Lazy(() => this.getOrConvertIcon("icns"))
constructor(info: Packager) {
super(info, Platform.MAC)
}
get defaultTarget(): Array<string> {
return this.info.framework.macOsDefaultTargets
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
protected prepareAppInfo(appInfo: AppInfo): AppInfo {
return new AppInfo(this.info, this.platformSpecificBuildOptions.bundleVersion, this.platformSpecificBuildOptions)
}
async getIconPath(): Promise<string | null> {
return this._iconPath.value
}
createTargets(targets: Array<string>, mapper: (name: string, factory: (outDir: string) => Target) => void): void {
for (const name of targets) {
switch (name) {
case DIR_TARGET:
break
case "dmg": {
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { DmgTarget } = require("dmg-builder")
mapper(name, outDir => new DmgTarget(this, outDir))
break
}
case "zip":
// https://github.com/electron-userland/electron-builder/issues/2313
mapper(name, outDir => new ArchiveTarget(name, outDir, this, true))
break
case "pkg":
mapper(name, outDir => new PkgTarget(this, outDir))
break
default:
mapper(name, outDir => (name === "mas" || name === "mas-dev" ? new NoOpTarget(name) : createCommonTarget(name, outDir, this)))
break
}
}
}
protected async doPack(
outDir: string,
appOutDir: string,
platformName: ElectronPlatformName,
arch: Arch,
platformSpecificBuildOptions: MacConfiguration,
targets: Array<Target>
): Promise<any> {
switch (arch) {
default: {
return super.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)
}
case Arch.universal: {
const x64Arch = Arch.x64
const x64AppOutDir = appOutDir + "--" + Arch[x64Arch]
await super.doPack(outDir, x64AppOutDir, platformName, x64Arch, platformSpecificBuildOptions, targets, false, true)
const arm64Arch = Arch.arm64
const arm64AppOutPath = appOutDir + "--" + Arch[arm64Arch]
await super.doPack(outDir, arm64AppOutPath, platformName, arm64Arch, platformSpecificBuildOptions, targets, false, true)
const framework = this.info.framework
log.info(
{
platform: platformName,
arch: Arch[arch],
[`${framework.name}`]: framework.version,
appOutDir: log.filePath(appOutDir),
},
`packaging`
)
const appFile = `${this.appInfo.productFilename}.app`
const { makeUniversalApp } = require("@electron/universal")
await makeUniversalApp({
x64AppPath: path.join(x64AppOutDir, appFile),
arm64AppPath: path.join(arm64AppOutPath, appFile),
outAppPath: path.join(appOutDir, appFile),
force: true,
})
await fs.rm(x64AppOutDir, { recursive: true, force: true })
await fs.rm(arm64AppOutPath, { recursive: true, force: true })
await this.doSignAfterPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)
break
}
}
}
async pack(outDir: string, arch: Arch, targets: Array<Target>, taskManager: AsyncTaskManager): Promise<any> {
let nonMasPromise: Promise<any> | null = null
const hasMas = targets.length !== 0 && targets.some(it => it.name === "mas" || it.name === "mas-dev")
const prepackaged = this.packagerOptions.prepackaged
if (!hasMas || targets.length > 1) {
const appPath = prepackaged == null ? path.join(this.computeAppOutDir(outDir, arch), `${this.appInfo.productFilename}.app`) : prepackaged
nonMasPromise = (
prepackaged
? Promise.resolve()
: this.doPack(outDir, path.dirname(appPath), this.platform.nodeName as ElectronPlatformName, arch, this.platformSpecificBuildOptions, targets)
).then(() => this.packageInDistributableFormat(appPath, arch, targets, taskManager))
}
for (const target of targets) {
const targetName = target.name
if (!(targetName === "mas" || targetName === "mas-dev")) {
continue
}
const masBuildOptions = deepAssign({}, this.platformSpecificBuildOptions, this.config.mas)
if (targetName === "mas-dev") {
deepAssign(masBuildOptions, this.config.masDev, {
type: "development",
})
}
const targetOutDir = path.join(outDir, `${targetName}${getArchSuffix(arch)}`)
if (prepackaged == null) {
await this.doPack(outDir, targetOutDir, "mas", arch, masBuildOptions, [target])
await this.sign(path.join(targetOutDir, `${this.appInfo.productFilename}.app`), targetOutDir, masBuildOptions, arch)
} else {
await this.sign(prepackaged, targetOutDir, masBuildOptions, arch)
}
}
if (nonMasPromise != null) {
await nonMasPromise
}
}
private async sign(appPath: string, outDir: string | null, masOptions: MasConfiguration | null, arch: Arch | null): Promise<void> {
if (!isSignAllowed()) {
return
}
const isMas = masOptions != null
const options = masOptions == null ? this.platformSpecificBuildOptions : masOptions
const qualifier = options.identity
if (!isMas && qualifier === null) {
if (this.forceCodeSigning) {
throw new InvalidConfigurationError("identity explicitly is set to null, but forceCodeSigning is set to true")
}
log.info({ reason: "identity explicitly is set to null" }, "skipped macOS code signing")
return
}
const keychainFile = (await this.codeSigningInfo.value).keychainFile
const explicitType = options.type
const type = explicitType || "distribution"
const isDevelopment = type === "development"
const certificateTypes = getCertificateTypes(isMas, isDevelopment)
let identity = null
for (const certificateType of certificateTypes) {
identity = await findIdentity(certificateType, qualifier, keychainFile)
if (identity != null) {
break
}
}
if (identity == null) {
if (!isMas && !isDevelopment && explicitType !== "distribution") {
identity = await findIdentity("Mac Developer", qualifier, keychainFile)
if (identity != null) {
log.warn("Mac Developer is used to sign app — it is only for development and testing, not for production")
}
}
if (identity == null) {
await reportError(isMas, certificateTypes, qualifier, keychainFile, this.forceCodeSigning)
return
}
}
if (!isMacOsHighSierra()) {
throw new InvalidConfigurationError("macOS High Sierra 10.13.6 is required to sign")
}
let filter = options.signIgnore
if (Array.isArray(filter)) {
if (filter.length == 0) {
filter = null
}
} else if (filter != null) {
filter = filter.length === 0 ? null : [filter]
}
const filterRe = filter == null ? null : filter.map(it => new RegExp(it))
let binaries = options.binaries || undefined
if (binaries) {
// Accept absolute paths for external binaries, else resolve relative paths from the artifact's app Contents path.
const userDefinedBinaries = await Promise.all(
binaries.map(async destination => {
if (await statOrNull(destination)) {
return destination
}
return path.resolve(appPath, destination)
})
)
// Insert at front to prioritize signing. We still sort by depth next
binaries = userDefinedBinaries.concat(binaries)
log.info("Signing addtional user-defined binaries: " + JSON.stringify(userDefinedBinaries, null, 1))
}
const signOptions: any = {
"identity-validation": false,
// https://github.com/electron-userland/electron-builder/issues/1699
// kext are signed by the chipset manufacturers. You need a special certificate (only available on request) from Apple to be able to sign kext.
ignore: (file: string) => {
if (filterRe != null) {
for (const regExp of filterRe) {
if (regExp.test(file)) {
return true
}
}
}
return (
file.endsWith(".kext") ||
file.startsWith("/Contents/PlugIns", appPath.length) ||
file.includes("/node_modules/puppeteer/.local-chromium") ||
file.includes("/node_modules/playwright-firefox/.local-browsers") ||
file.includes("/node_modules/playwright/.local-browsers")
)
/* Those are browser automating modules, browser (chromium, nightly) cannot be signed
https://github.com/electron-userland/electron-builder/issues/2010
https://github.com/electron-userland/electron-builder/issues/5383
*/
},
identity: identity,
type,
platform: isMas ? "mas" : "darwin",
version: this.config.electronVersion,
app: appPath,
keychain: keychainFile || undefined,
binaries,
timestamp: isMas ? masOptions?.timestamp : options.timestamp,
requirements: isMas || this.platformSpecificBuildOptions.requirements == null ? undefined : await this.getResource(this.platformSpecificBuildOptions.requirements),
// https://github.com/electron-userland/electron-osx-sign/issues/196
// will fail on 10.14.5+ because a signed but unnotarized app is also rejected.
"gatekeeper-assess": options.gatekeeperAssess === true,
// https://github.com/electron-userland/electron-builder/issues/1480
"strict-verify": options.strictVerify,
hardenedRuntime: isMas ? masOptions && masOptions.hardenedRuntime === true : options.hardenedRuntime !== false,
}
await this.adjustSignOptions(signOptions, masOptions)
log.info(
{
file: log.filePath(appPath),
identityName: identity.name,
identityHash: identity.hash,
provisioningProfile: signOptions["provisioning-profile"] || "none",
},
"signing"
)
await this.doSign(signOptions)
// https://github.com/electron-userland/electron-builder/issues/1196#issuecomment-312310209
if (masOptions != null && !isDevelopment) {
const certType = isDevelopment ? "Mac Developer" : "3rd Party Mac Developer Installer"
const masInstallerIdentity = await findIdentity(certType, masOptions.identity, keychainFile)
if (masInstallerIdentity == null) {
throw new InvalidConfigurationError(`Cannot find valid "${certType}" identity to sign MAS installer, please see https://electron.build/code-signing`)
}
// mas uploaded to AppStore, so, use "-" instead of space for name
const artifactName = this.expandArtifactNamePattern(masOptions, "pkg", arch)
const artifactPath = path.join(outDir!, artifactName)
await this.doFlat(appPath, artifactPath, masInstallerIdentity, keychainFile)
await this.dispatchArtifactCreated(artifactPath, null, Arch.x64, this.computeSafeArtifactName(artifactName, "pkg", arch, true, this.platformSpecificBuildOptions.defaultArch))
}
}
private async adjustSignOptions(signOptions: any, masOptions: MasConfiguration | null) {
const resourceList = await this.resourceList
const customSignOptions = masOptions || this.platformSpecificBuildOptions
const entitlementsSuffix = masOptions == null ? "mac" : "mas"
let entitlements = customSignOptions.entitlements
if (entitlements == null) {
const p = `entitlements.${entitlementsSuffix}.plist`
if (resourceList.includes(p)) {
entitlements = path.join(this.info.buildResourcesDir, p)
} else {
entitlements = getTemplatePath("entitlements.mac.plist")
}
}
signOptions.entitlements = entitlements
let entitlementsInherit = customSignOptions.entitlementsInherit
if (entitlementsInherit == null) {
const p = `entitlements.${entitlementsSuffix}.inherit.plist`
if (resourceList.includes(p)) {
entitlementsInherit = path.join(this.info.buildResourcesDir, p)
} else {
entitlementsInherit = getTemplatePath("entitlements.mac.plist")
}
}
signOptions["entitlements-inherit"] = entitlementsInherit
if (customSignOptions.provisioningProfile != null) {
signOptions["provisioning-profile"] = customSignOptions.provisioningProfile
}
signOptions["entitlements-loginhelper"] = customSignOptions.entitlementsLoginHelper
}
//noinspection JSMethodCanBeStatic
protected async doSign(opts: SignOptions): Promise<any> {
return signAsync(opts)
}
//noinspection JSMethodCanBeStatic
protected async doFlat(appPath: string, outFile: string, identity: Identity, keychain: string | null | undefined): Promise<any> {
// productbuild doesn't created directory for out file
await mkdir(path.dirname(outFile), { recursive: true })
const args = prepareProductBuildArgs(identity, keychain)
args.push("--component", appPath, "/Applications")
args.push(outFile)
return await exec("productbuild", args)
}
public getElectronSrcDir(dist: string) {
return path.resolve(this.projectDir, dist, this.info.framework.distMacOsAppName)
}
public getElectronDestinationDir(appOutDir: string) {
return path.join(appOutDir, this.info.framework.distMacOsAppName)
}
// todo fileAssociations
async applyCommonInfo(appPlist: any, contentsPath: string) {
const appInfo = this.appInfo
const appFilename = appInfo.productFilename
// https://github.com/electron-userland/electron-builder/issues/1278
appPlist.CFBundleExecutable = appFilename.endsWith(" Helper") ? appFilename.substring(0, appFilename.length - " Helper".length) : appFilename
const icon = await this.getIconPath()
if (icon != null) {
const oldIcon = appPlist.CFBundleIconFile
const resourcesPath = path.join(contentsPath, "Resources")
if (oldIcon != null) {
await unlinkIfExists(path.join(resourcesPath, oldIcon))
}
const iconFileName = `${appFilename}.icns`
appPlist.CFBundleIconFile = iconFileName
await copyFile(icon, path.join(resourcesPath, iconFileName))
}
appPlist.CFBundleName = appInfo.productName
appPlist.CFBundleDisplayName = appInfo.productName
const minimumSystemVersion = this.platformSpecificBuildOptions.minimumSystemVersion
if (minimumSystemVersion != null) {
appPlist.LSMinimumSystemVersion = minimumSystemVersion
}
appPlist.CFBundleIdentifier = appInfo.macBundleIdentifier
appPlist.CFBundleShortVersionString = this.platformSpecificBuildOptions.bundleShortVersion || appInfo.version
appPlist.CFBundleVersion = appInfo.buildVersion
use(this.platformSpecificBuildOptions.category || (this.config as any).category, it => (appPlist.LSApplicationCategoryType = it))
appPlist.NSHumanReadableCopyright = appInfo.copyright
if (this.platformSpecificBuildOptions.darkModeSupport) {
appPlist.NSRequiresAquaSystemAppearance = false
}
const extendInfo = this.platformSpecificBuildOptions.extendInfo
if (extendInfo != null) {
Object.assign(appPlist, extendInfo)
}
}
protected async signApp(packContext: AfterPackContext, isAsar: boolean): Promise<any> {
const appFileName = `${this.appInfo.productFilename}.app`
await BluebirdPromise.map(readdir(packContext.appOutDir), (file: string): any => {
if (file === appFileName) {
return this.sign(path.join(packContext.appOutDir, file), null, null, null)
}
return null
})
if (!isAsar) {
return
}
const outResourcesDir = path.join(packContext.appOutDir, "resources", "app.asar.unpacked")
await BluebirdPromise.map(orIfFileNotExist(readdir(outResourcesDir), []), (file: string): any => {
if (file.endsWith(".app")) {
return this.sign(path.join(outResourcesDir, file), null, null, null)
} else {
return null
}
})
}
}
function getCertificateTypes(isMas: boolean, isDevelopment: boolean): CertType[] {
if (isDevelopment) {
return isMas ? ["Mac Developer", "Apple Development"] : ["Developer ID Application"]
}
return isMas ? ["Apple Distribution"] : ["Developer ID Application"]
}