代码签名

代码签名是一种安全技术，用于证明应用程序是由您创建的。您应该对应用程序进行签名，使其不会触发任何操作系统安全警告。

Windows 和 macOS 都会阻止用户运行未签名的应用程序。可以分发未进行代码签名的应用程序，但是为了运行它们，用户需要经过多个高级的手动步骤。

如果您正在构建一个打算打包和分发的 Electron 应用程序，则应该对其进行代码签名。Electron 生态系统工具使代码签名应用程序变得简单，本文档将说明如何在 Windows 和 macOS 上签名应用程序。

签名和公证 macOS 构建版本

准备 macOS 应用程序以供发布需要两个步骤：首先，应用程序需要进行代码签名。然后，需要将应用程序上传到 Apple 进行一个称为公证的过程，自动化系统将在此过程中进一步验证您的应用程序是否会做出任何危害其用户的行为。

要开始此过程，请确保您满足签名和公证应用程序的要求

1. 注册 Apple Developer Program（需要缴纳年费）
2. 下载并安装 Xcode - 这需要一台运行 macOS 的计算机
3. 生成、下载并安装签名证书

Electron 的生态系统偏爱配置和自由，因此有多种方法可以对您的应用程序进行签名和公证。

使用 Electron Forge

如果您正在使用 Electron 最喜欢的构建工具，则对您的应用程序进行签名和公证需要在您的配置中添加一些内容。Forge 是官方 Electron 工具的集合，在幕后使用 @electron/packager、@electron/osx-sign 和 @electron/notarize。

有关如何配置应用程序的详细说明，请参阅 Electron Forge 文档中的签名 macOS 应用程序指南。

使用 Electron Packager

如果您没有使用像 Forge 这样的集成构建管道，您可能正在使用 @electron/packager，其中包括 @electron/osx-sign 和 @electron/notarize。

如果您正在使用 Packager 的 API，则可以传递配置，该配置既可以签名也可以公证您的应用程序。如果以下示例不能满足您的需求，请参阅 @electron/osx-sign 和 @electron/notarize，以获取许多可能的配置选项。

const packager = require('@electron/packager')

packager({
  dir: '/path/to/my/app',
  osxSign: {},
  osxNotarize: {
    appleId: '[email protected]',
    appleIdPassword: 'my-apple-id-password'
  }
})

签名 Mac App Store 应用程序

请参阅Mac App Store 指南。

签名 Windows 构建版本

在对应用程序进行代码签名之前，您需要获取代码签名证书。与 Apple 不同，Microsoft 允许开发人员在公开市场上购买这些证书。它们通常由也提供 HTTPS 证书的同一家公司出售。价格各不相同，因此货比三家可能值得您花时间。受欢迎的经销商包括

• Certum EV 代码签名证书
• DigiCert EV 代码签名证书
• Entrust EV 代码签名证书
• GlobalSign EV 代码签名证书
• IdenTrust EV 代码签名证书
• Sectigo（以前的 Comodo）EV 代码签名证书
• SSL.com EV 代码签名证书

重要的是要指出，自 2023 年 6 月起，Microsoft 要求软件必须使用“扩展验证”证书（也称为“EV 代码签名证书”）进行签名。过去，开发人员可以使用更简单、更便宜的证书（称为“authenticode 代码签名证书”或“基于软件的 OV 证书”）对软件进行签名。这些更简单的证书不再提供任何好处：Windows 会将您的应用程序视为完全未签名，并显示等效的警告对话框。

新的 EV 证书必须存储在符合 FIPS 140 Level 2、Common Criteria EAL 4+ 或同等标准的硬件存储模块上。换句话说，证书不能简单地下载到 CI 基础设施中。实际上，这些存储模块看起来像花哨的 USB 拇指驱动器。

许多证书提供商现在提供“基于云的签名” - 整个签名硬件都在其数据中心中，您可以使用它来远程签名代码。这种方法在 Electron 维护人员中很受欢迎，因为它使在 CI（例如 GitHub Actions、CircleCI 等）中签名应用程序相对容易。

在撰写本文时，Electron 自己的应用程序使用 DigiCert KeyLocker，但是任何提供用于签名文件的命令行工具的提供商都与 Electron 的工具兼容。

Electron 生态系统中的所有工具都使用 @electron/windows-sign，并且通常通过 windowsSign 属性公开配置选项。您可以直接使用它来签名文件 - 或者在 Electron Forge、@electron/packager、electron-winstaller 和 electron-wix-msi 中使用相同的 windowsSign 配置。

使用 Electron Forge

Electron Forge 是签名您的应用程序以及 Squirrel.Windows 和 WiX MSI 安装程序的推荐方法。有关如何配置应用程序的详细说明，请参阅 Electron Forge 代码签名教程。

使用 Electron Packager

如果您没有使用像 Forge 这样的集成构建管道，您可能正在使用 @electron/packager，其中包括 @electron/windows-sign。

如果您正在使用 Packager 的 API，则可以传递配置来签名您的应用程序。如果以下示例不能满足您的需求，请参阅 @electron/windows-sign 以获取许多可能的配置选项。

const packager = require('@electron/packager')

packager({
  dir: '/path/to/my/app',
  windowsSign: {
    signWithParams: '--my=custom --parameters',
    // If signtool.exe does not work for you, customize!
    signToolPath: 'C:\\Path\\To\\my-custom-tool.exe'
  }
})

使用 electron-winstaller (Squirrel.Windows)

electron-winstaller 是一个可以为您的 Electron 应用程序生成 Squirrel.Windows 安装程序的软件包。这是 Electron Forge 的 Squirrel.Windows Maker 在幕后使用的工具。就像 @electron/packager 一样，它在幕后使用 @electron/windows-sign，并支持相同的 windowsSign 选项。

const electronInstaller = require('electron-winstaller')
// NB: Use this syntax within an async function, Node does not have support for
//     top-level await as of Node 12.
try {
  await electronInstaller.createWindowsInstaller({
    appDirectory: '/tmp/build/my-app-64',
    outputDirectory: '/tmp/build/installer64',
    authors: 'My App Inc.',
    exe: 'myapp.exe',
    windowsSign: {
      signWithParams: '--my=custom --parameters',
      // If signtool.exe does not work for you, customize!
      signToolPath: 'C:\\Path\\To\\my-custom-tool.exe'
    }
  })
  console.log('It worked!')
} catch (e) {
  console.log(`No dice: ${e.message}`)
}

有关完整的配置选项，请查看 electron-winstaller 存储库！

使用 electron-wix-msi (WiX MSI)

electron-wix-msi 是一个可以为你的 Electron 应用程序生成 MSI 安装程序的软件包。它是 Electron Forge 的 MSI Maker 在底层使用的工具。就像 @electron/packager 一样，它在底层使用 @electron/windows-sign 并支持相同的 windowsSign 选项。

import { MSICreator } from 'electron-wix-msi'

// Step 1: Instantiate the MSICreator
const msiCreator = new MSICreator({
  appDirectory: '/path/to/built/app',
  description: 'My amazing Kitten simulator',
  exe: 'kittens',
  name: 'Kittens',
  manufacturer: 'Kitten Technologies',
  version: '1.1.2',
  outputDirectory: '/path/to/output/folder',
  windowsSign: {
    signWithParams: '--my=custom --parameters',
    // If signtool.exe does not work for you, customize!
    signToolPath: 'C:\\Path\\To\\my-custom-tool.exe'
  }
})

// Step 2: Create a .wxs template file
const supportBinaries = await msiCreator.create()

// 🆕 Step 2a: optionally sign support binaries if you
// sign you binaries as part of of your packaging script
for (const binary of supportBinaries) {
  // Binaries are the new stub executable and optionally
  // the Squirrel auto updater.
  await signFile(binary)
}

// Step 3: Compile the template to a .msi file
await msiCreator.compile()

有关完整的配置选项，请查看 electron-wix-msi 仓库！

使用 Electron Builder

Electron Builder 自带用于签名你的应用程序的自定义解决方案。你可以在这里找到它的文档。

签名 Windows 应用商店应用程序

请参阅 Windows 应用商店指南。