アプリロジック暗号化 (Encrypt プラグイン)

アプリロジック暗号化 プラグインは、アプリに組み込まれている HTML5 アセットを、暗号化 ( アプリのビルド時 )・復号化 ( アプリの実行時 ) するプラグインです。

サポート対象のプラットフォーム

• Cordova 7.1 以降

• iOS 9 以降

  • WKWebView 対応版（ 5.0.5 以降 ）は、iOS 11 以降

  • CustomScheme 対応版（ 6.1.0 以降 ）は、iOS 11 以降

• Android 4.1 以降

暗号化方式

• 暗号化方式 AES

• 鍵長 256 bit

プラグインの追加方法

1. Monaca クラウド IDE から設定 → Cordova プラグインの管理を選択します。

2. 利用可能なプラグイン 項目の Encrypt プラグインにカーソルを置き、有効ボタンをクリックします。

3. 次に、有効なプラグイン 項目へ行き、先ほど追加したプラグイン上に、カーソルを置き、設定ボタンをクリックします。

4. プラグインの設定に必要なパラメーターを入力します。入力後、OKボタンをクリックします。入力できるパラメーターは、次のとおりです。

手動での復号化

上記の 「 自動復号化 」 機能を使用する以外にも、手動でも、フォルダーの復号化を行えます。この場合、monaca.Encrypt.setDecryptHash() を実行するまで、対象のフォルダー ( 暗号化されているフォルダー ) は、読み込むことができません。つまり、index.html ファイル上で、script タグを使用しても、対象のファイルを読み込むことができません。

手動で復号化を行う場合には、次の手順に従います。

ステップ 1 : 手動での復号化を有効にする

手動での復号化を有効にする場合、上記の手順 ( 「 プラグインの追加方法 」 の 4 番目の手順 ) で解説した AUTO_DECRYPT を、0 に設定します。

ステップ 2 : ハッシュ値を取得する

monaca.Encrypt.setDecryptHash() 関数 ( フォルダーの復号化用 ) を呼ぶときには、次のハッシュ値が必要となります。ハッシュ値は、次のようにして、ビルドログ上で確認できます。

1. プロジェクトをビルドします ( iOS または Android )。

2. ビルド完了後、次のような画面が表示されます。表示された画面上で、 こちらをクリックをクリックして、ビルドログを表示させます。

3. お好きなテキストエディターを開き、ビルドログの内容をコピー&ペーストして、ハッシュ値を検索します。次の箇所が、ハッシュ値となります。

...
Hash : [4c716d***************************************************ae9f720d]
...

ステップ 3 : 復号化用の関数を実行する

ここまでの手順で、復号化用の関数を使用する準備ができました。なお、この関数は、次のように、deviceready イベント内で、実行する必要があります。

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    monaca.Encrypt.setDecryptHash(
        function() {alert('SUCESS');},
        function() {alert('FAIL');},
    "4c716d***************************************************ae9f720d"); // Hash code for decryption
}

CustomSchemeの設定 (Cordova 10以降+本プラグイン 6.1.0以降 iOS専用)

本プラグインは、iOSの場合、単体でschemeとhostnameを設定することが可能です。(In-App アップデータプラグインとは共通です。)

まず、Cordova 10のデフォルトのscheme、hostnameを指定するための設定

<preference name="scheme" value="monaca-app"/>
<preference name="hostname" value="localhost"/>

は外してください。（これを指定してしまうと、ビルドエラーになります。）

config.xmlに以下の様にschemeとhostnameを設定することができます。

<preference name="monaca:scheme" value="monacax-app"/>
<preference name="monaca:hostname" value="monacax.io"/>

この例では、schemeをmonacax-app、hostnameをmonacax.ioとしています。 schemeに使える文字は、RFC 2396 Appendix Aにあるように

 scheme        = alpha *( alpha | digit | "+" | "-" | "." )

となります。

monaca:scheme と moanca:hostname を省略 した場合、それぞれ monaca-plugin と monaca.plugin になります。

App Store への提出に際して

このプラグインでは、iOS SDK の暗号化ライブラリが採用されているため、アプリを App Store に提出し審査を受ける際、特別な設定が求められます。輸出コンプライアンス情報 において、次のとおり回答してください。

バージョン履歴

プライバシーマニフェスト

このプラグインで必要となるプライバシーマニフェストは以下のようになります。(cordova-ios 7.1.0以上)

<platform name="ios">
  <privacy-manifest>
    <key>NSPrivacyTracking</key>
    <false/>
    <key>NSPrivacyTrackingDomains</key>
    <array/>
    <key>NSPrivacyAccessedAPITypes</key>
    <array>
    <dict>
      <key>NSPrivacyAccessedAPIType</key>
      <string>NSPrivacyAccessedAPICategoryUserDefaults</string>
      <key>NSPrivacyAccessedAPITypeReasons</key>
      <array>
      <string>CA92.1</string>
      </array>
    </dict>
    </array>
    <key>NSPrivacyCollectedDataTypes</key>
    <array/>
  </privacy-manifest>
</platform>

マニフェストの記述方法について詳しくは https://ja.docs.monaca.io/release_notes/ios-privacy-manifest#puraibashmanifesutono を参照して下さい。