コード署名

コード署名はセキュリティ技術のひとつで、アプリの作成者があなたであることを検証します。 オペレーティングシステムのセキュリティ警告がトリガされないようにするには、アプリケーションに署名する必要があります。

Windows と macOS はどちらも、ユーザが署名されていないアプリケーションを実行することを阻害します。 It is possible to distribute applications without codesigning them - but in order to run them, users need to go through multiple advanced and manual steps.

パッケージ化して配布する予定の Electron アプリケーションを作成している場合は、コード署名されている必要があります。 Electron エコシステム ツールを使用すると、アプリのコード署名が簡単になります。このドキュメントでは、Windows と macOS の両方でアプリに署名する方法について説明します。

macOS ビルドへの署名 & 公証

macOS アプリをリリースに向けて準備するには、2 つのステップが必要です。まず、アプリをコード署名する必要があります。 次に、公証 と呼ばれるプロセスのためにアプリを Apple にアップロードする必要があります。自動化されたシステムによって、アプリがユーザーを危険に晒すようなことをしていないかどうか、さらに確認します。

このプロセスを開始するには、以下に示すアプリへの署名と公証の要件を満たしていることを確認してください。

1. Apple Developer Program に登録する (年会費が必要)
2. Xcode をダウンロードしてインストールします - これは macOS を実行しているコンピュータが必要です
3. 署名証明書 を生成、ダウンロードして、インストールします

Electron のエコシステムでは構成とその自由度を重視しているため、アプリケーションの署名と公証の取得には複数の方法が用意されています。

Electron Forge を使用する

好きな Electron のビルドツールを使用している場合、アプリケーションの署名と公証を行うにあたって、設定にいくつか追加する必要があります。 forge は、内部で @electron/packager、@electron/osx-sign、@electron/notarize を利用している、Electron 公式のツールの集合体です。

アプリケーションの設定方法の詳細は、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: 'felix@felix.fun',
    appleIdPassword: 'my-apple-id-password'
  }
})

Mac App Store アプリケーションの署名

Mac App Store Guide を参照してください。

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 レベル 2、Common Criteria EAL 4+ または同等の規格に準拠したハードウェアストレージモジュールに保存する必要があります。 つまり、証明書を CI インフラに単純にダウンロードすることはできません。 実際のところ、これらのストレージモジュールは高級な USB メモリのようなものです。

現在、多くの証明書プロバイダーが「クラウドベースの署名」を提供しています。署名ハードウェア全体がデータセンターにあり、それを使用してリモートでコードに署名できます。 このアプローチは CI (GitHub Actions、CircleCI など) でのアプリケーションの署名が比較的簡単になるので、Electron のメンテナの間で一般的です。

執筆時点では、Electron の独自のアプリは DigiCert KeyLocker を使用していますが、ファイルに署名するためのコマンドライン ツールを提供する任意のプロバイダであれば Electron のツールと互換性があります。

Electron エコシステム内のすべてのツールは @electron/windows-sign を使用しており、通常は windowsSign プロパティを通じて構成オプションを公開しています。 これを使用してファイルを直接署名することも、Electron Forge、@electron/packager、electron-winstaller、および electron-wix-msi 全体で同じ windowsSign 構成を使用することもできます。

Electron Forge を使用する

アプリだけでなく Squirrel.Windows と WiX MSI のインストーラーも署名するのであれば、Electron Forge を推奨します。 アプリケーションの設定方法の詳細な手順は 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',
    // signtool.exe が動作してくれない場合は、カスタマイズしましょう!
    signToolPath: 'C:\\Path\\To\\my-custom-tool.exe'
  }
})

electron-winstaller (Squirrel.Windows) を使用する

electron-winstaller は、Electron アプリ向けに Squirrel.Windows のインストーラーを生成するパッケージです。 これは Electron Forge の Squirrel.Windows メーカー で内部的に使用されているツールです。 @electron/packager と同様に、内部では @electron/windows-sign を使用しており、同じ windowsSign のオプションをサポートしています。

const electronInstaller = require('electron-winstaller')
// 注: この構文は非同期関数内で使用してください。Node 12 の時点では Node は
//     トップレベル await をサポートしていません。
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',
      // signtool.exe が動作してくれない場合は、カスタマイズしましょう!
      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 メーカー で内部的に使用されているツールです。 @electron/packager と同様に、内部では @electron/windows-sign を使用しており、同じ windowsSign のオプションをサポートしています。

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

// ステップ 1: 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',
    // signtool.exe が動作してくれない場合は、カスタマイズしましょう!
    signToolPath: 'C:\\Path\\To\\my-custom-tool.exe'
  }
})

// ステップ 2: .wxs テンプレートファイルを作成します
const supportBinaries = await msiCreator.create()

// 🆕 ステップ 2a: パッケージスクリプトの一部でバイナリ署名する場合は、
// 任意で補助バイナリに署名します。
for (const binary of supportBinaries) {
  // バイナリは新しいスタブの実行可能ファイルと、任意の
  // Squirrel 自動アップデーターです。
  await signFile(binary)
}

// ステップ 3: テンプレートを .msi ファイルにコンパイルする
await msiCreator.compile()

全部の構成オプションについては、electron-wix-msi リポジトリをご確認ください!

Electron Builder を使用する

Electron Builder にはアプリケーションに署名するためのカスタムソリューションが付属しています。 そのドキュメントはこちら にあります。

Windows Store アプリケーションの署名

Windows ストアのガイド を参照してください。