CodePush での Code signing
Code signingは、CodePush バンドル(JavaScript アップデート)にデジタル署名を追加するセキュリティ機構です。この署名により、クライアントアプリは、アップデートが信頼できる提供元によって作成されたこと、および配信中に改ざんされていないことを検証できます。
CodePush code signingは次の3つの段階で行います。
-
RSA キーペアを生成します。
- 秘密鍵は、CodePush バンドルへの署名に使用します。
- 公開鍵は、署名を検証するためにモバイルアプリに埋め込みます。
-
CodePush アップデートをリリースする際、Bitrise CodePush CLIが秘密鍵を使ってバンドルに署名します。バンドルのハッシュを含み、この秘密鍵でデジタル署名された JWT(JSON Web Token)が作成されます。
-
モバイルアプリ(公開鍵を埋め込み済み)は、アップデートを適用する前に JWT 署名を検証します。検証に失敗した場合、アップデートは拒否されます。
アプリの署名Click to copy link
- iOS
- Android
-
アプリ SDK のバージョン 5.1.0 以降を使用してください。それより前のバージョンは code signing をサポートしていません。
-
Bitrise CodePush CLI のバージョンが 1.0.0 以降であることを確認してください。これにより code signing 機能を利用できます。
-
Open SSL を使用して、PEM 形式の RSA キーペアを生成します。
openssl genrsa -out private_key.pem 2048openssl rsa -in private_key.pem -pubout -out public_key.pem秘密鍵は安全に保管し、決して共有しないでください。公開鍵はアプリ自体に埋め込まれます。
-
公開鍵の文字列をアプリの
Info.plistに追加します。<key>CodePushPublicKey</key><string>-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArVJ2k...-----END PUBLIC KEY-----</string> -
code signing をサポートする、更新後のアプリ SDK(5.1.0 以降)で iOS アプリを再ビルドします。
-
Bitrise CodePush CLI を使用して、アップデートをバンドルし署名します。
警告出力ディレクトリの名前は、必ず
CodePushにしてください。SDK は、パッケージハッシュの検証時にディレクトリ名をパスのプレフィックスとして使用します。それ以外の名前にするとハッシュが一致せず、デバイス上でアップデートが通知なく拒否されます。bitrise :codepush bundle --platform ios --private-key-path ./private_key.pem署名済みの JWT(
.codepushreleaseファイル)はバンドルディレクトリ内に生成され、サーバーにアップロードされます。アップロードされる.zipファイルには、.codepushreleaseファイルとバンドル済みの出力ファイルの両方が含まれます。 -
バンドル済みのアップデートをプッシュします。
bitrise :codepush push ./CodePush \--deployment Staging \--app-version 1.0.0 \--private-key-path ./private_key.pemヒント必要に応じて、バンドル、署名、プッシュを 1 つのコマンドで実行することもできます。
bitrise :codepush push --bundle --platform ios \--deployment Staging \--app-version 1.0.0 \--private-key-path ./private_key.pem
-
アプリ SDK のバージョン 5.1.0 以降を使用してください。それより前のバージョンは code signing をサポートしていません。
-
Bitrise CodePush CLI のバージョンが 1.0.0 以降であることを確認してください。これにより code signing 機能を利用できます。
-
Open SSL を使用して、PEM 形式の RSA キーペアを生成します。
openssl genrsa -out private_key.pem 2048openssl rsa -in private_key.pem -pubout -out public_key.pem秘密鍵は安全に保管し、決して共有しないでください。公開鍵はアプリ自体に埋め込まれます。
-
公開鍵の文字列を
/android/app/src/main/res/values/strings.xmlに追加します。<resources><string name="CodePushPublicKey">-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArVJ2k...-----END PUBLIC KEY-----</string></resources> -
CodePush クライアントインスタンスを設定します。
コンストラクターを使用できます。
new CodePush("deployment-key", getApplicationContext(), BuildConfig.DEBUG, R.string.CodePushPublicKey);または、ビルダーを使用できます。
new CodePushBuilder("deployment-key", getApplicationContext()).setIsDebugMode(BuildConfig.DEBUG).setPublicKeyResourceDescriptor(R.string.CodePushPublicKey).build();React Native 0.61 以降の場合は、CodePush SDK リポジトリの Android セットアップガイドに従ってください。
-
code signing をサポートする、更新後のアプリ SDK(5.1.0 以降)で Android アプリを再ビルドします。
-
Bitrise CodePush CLI を使用して、アップデートをバンドルし署名します。
警告出力ディレクトリの名前は、必ず
CodePushにしてください。SDK は、パッケージハッシュの検証時にディレクトリ名をパスのプレフィックスとして使用します。それ以外の名前にするとハッシュが一致せず、デバイス上でアップデートが通知なく拒否されます。bitrise :codepush bundle --platform android --private-key-path ./private_key.pem署名済みの JWT(
.codepushreleaseファイル)はバンドルディレクトリ内に生成され、サーバーにアップロードされます。アップロードされる.zipファイルには、.codepushreleaseファイルとバンドル済みの出力ファイルの両方が含まれます。 -
バンドル済みのアップデートをプッシュします。
bitrise :codepush push ./CodePush \--deployment Staging \--app-version 1.0.0 \--private-key-path ./private_key.pemヒント必要に応じて、バンドル、署名、プッシュを 1 つのコマンドで実行することもできます。
bitrise :codepush push --bundle --platform android \--deployment Staging \--app-version 1.0.0 \--private-key-path ./private_key.pem
Code signingとデルタアップデートClick to copy link
署名付きアップデートは、バイナリ差分を含むデルタアップデートでも動作します。署名はデルタではなく、完全なアップデートパッケージを対象としています。SDKはまずデルタから完全なパッケージを再構築し、再構築したパッケージに対して署名を検証します。検証に失敗した場合、SDKはアップデートを拒否します。
詳細については、デルタアップデートを参照してください。
Code signing における Expo のサポートClick to copy link
アプリ SDK と Bitrise CodePush CLI はどちらも、Expo プロジェクトでの code signing をサポートしています。全体の流れは標準的な React Native アプリと同じです。RSA キーペアを生成し、公開鍵をアプリに埋め込み、リリース時に --private-key-path フラグを使ってバンドルに署名します。
マネージド Expo Workflow での主な違いは、公開鍵の埋め込み方法です。通常は EAS Build とカスタム config plugin が必要です。アップデートをバンドルしてプッシュする際は、通常どおり標準の bitrise :codepush コマンドを使用します。