DashO Gradle プラグイン(Android 用)を Gradle ビルドに追加し、Android プラグインの後に適用してから、dasho クロージャを使用して、DashO が Android アプリケーションまたは Android ライブラリを保護する方法を構成します。
必要条件
- Gradle でビルドされる Android アプリケーションまたはライブラリ プロジェクト。
- DashO がインストールされている。
- DashO、Gradle、Android Gradle プラグイン、Kotlin、および Java の互換性のあるバージョン。DashO Gradle プラグイン(Android 用)バージョン間の互換性を参照してください。
プラグインの追加
ルートの build.gradle ファイル内の buildscript に、PreEmptive Maven リポジトリと DashO プラグインのアーティファクトを追加します。
buildscript {
repositories {
maven { url 'https://maven.preemptive.com' }
}
dependencies {
classpath 'com.android.tools.build:gradle:4.1.1'
classpath 'com.preemptive.dasho:dasho-android:1.4.+'
}
}モジュールレベルのビルド ファイルで com.android.application または com.android.library の後に DashO プラグインを適用します。
apply plugin: 'com.android.application'
apply plugin: 'com.preemptive.dasho.android'plugins ブロックを使用してプラグインを適用することもできます。
plugins {
id 'com.android.application'
id 'com.preemptive.dasho.android'
}Android ライブラリの場合は、com.android.application を com.android.library に置き換えます。
プラグインの構成
com.preemptive.dasho.android を適用した後、モジュールレベルのビルド ファイルに dasho クロージャを追加します。プロパティはすべて省略可能(任意)です。
dasho {
debug false
doxFilename "project.dox"
enabledBuildVariants "release"
excludeFromProtection null
home "/Applications/PreEmptive Protection DashO 12.5.0 x.y/Contents/Java"
javaOptions "-Xmx128m", "-Xms96m"
libraryAssetDirs "../lib/src/main/assets"
libraryResourceDirs "../lib/src/main/res"
searchVersion "11"
verbose false
}以下のプロパティを使用して統合を調整します。
| 名前 | 説明 | 既定値 |
debug |
--debug および --printStackTraces オプションを指定して DashO を実行し、DashO の呼び出しに使用されたコマンドを出力します。
|
false |
doxFilename |
プロジェクト ディレクトリ内の DashO 構成ファイルを指定します。このパス内の円記号(\)はエスケープする(\\)か、スラッシュ(/)に置き換える必要があります。
|
プラグインはバリアント固有のファイルを検索し、次に project.dox を検索します。
|
enabledBuildVariants |
DashO が保護するビルド バリアントを指定します。この値は、バリアント名と照合される、大文字と小文字を区別しない正規表現です。空の文字列はすべてのバリアントに一致します。 |
release(すべての release バリアントと一致します)
|
excludeFromProtection |
DashO が保護対象の入力ではなく依存関係として扱う必要のある入力を、大文字と小文字を区別しない正規表現として指定します。 | 入力は除外されません。 |
protectProjectFilesOnly |
true の場合、プロジェクト ディレクトリの外部にある JAR ファイルとクラスを DashO の保護対象から除外します。
|
false |
home |
DashOPro.jar が含まれているディレクトリである、DashO ホームを指定します。このプロパティを searchVersion と一緒に設定しないでください。
|
設定なし |
javaOptions |
プラグインが DashO を実行する際に追加の JVM オプションを渡します。 | 追加オプションなし |
libraryAssetDirs |
リソースの暗号化の対象として選択する参照ライブラリの Asset ディレクトリを 1 つ以上指定します。 | ライブラリの Asset は暗号化されません。 |
libraryResourceDirs |
参照ライブラリのリソース ディレクトリを 1 つ以上指定します。raw サブディレクトリにあるリソースのみが暗号化されます。
|
ライブラリの Raw リソースは暗号化されません。 |
searchVersion |
既定のインストール場所から、{major}[.{minor}] に一致する DashO バージョンを検索します。このプロパティを home と一緒に設定しないでください。
|
設定なし |
verbose |
--verbose および --printStackTraces オプションを指定して DashO を実行し、DashO の呼び出しに使用されたコマンドを出力します。
|
false |
runtimeJars |
保護処理中に、Android アーカイブ(AAR)に必要なランタイム JAR の依存関係のクラスが利用できない場合に、依存関係を読み込みます。 | false |
includeAutoGeneratedModules |
protectProjectFilesOnly が false である場合、Dagger/Hilt、Room、データ バインディングなどの生成されたクラスをプロジェクト ファイルとして、DashO の処理に含めます。
|
false |
プラグインは Gradle 用に構成された Java バージョンを使用します。これは、Gradle プロパティの org.gradle.java.home を使用して構成できます。
デバッグ バリアントを保護する場合は、そのビルドに対して Android Studio の Apply Changes を使用しないでください。DashO の保護タスクが実行されるように、完全なビルドを実行します。
DashO プロジェクト ファイルの構成
プラグインには DashO プロジェクト ファイルが必要です。プロジェクトに合った手順を選択してください。
| プロジェクト | 対処方法 |
| まだ DashO プロジェクト ファイルがない | DashO プロジェクト ファイルの生成 |
project.dox などの DashO プロジェクト ファイルが既にある
|
ビルドの実行と検証に進みます。プラグインは、プラグインがプロジェクト ファイルを検出する方法の説明に従ってファイルを検索します。 |
DashO プロジェクト ファイルの生成
- プロジェクト ルートから次を実行します。
./gradlew clean assembleRelease -DGENERATE_DASHO_CONFIG-DGENERATE_DASHO_CONFIGプロパティを指定すると、プラグインは既定の Android モード プロジェクト ファイルであるproject.doxを生成します。 - 保護ビルドを実行する前に、生成されたプロジェクト ファイルを確認して構成します。
プラグインがプロジェクト ファイルを検出する方法
doxFileName を設定した場合、プラグインはそのファイルを使用します。そうでない場合は、アプリケーション レベルの build.gradle ファイルが格納されているディレクトリを検索し、現在のバリアントに最も一致する特定のファイルを使用します。これにより、個々のバリアント、ビルド タイプ、またはフレーバーごとに異なる DashO 設定を保持できます。
たとえば、freePhoneDebug バリアントの場合、プラグインは次の順序で検索します。
android {
buildTypes {
debug { }
release { }
}
flavorDimensions 'monetization', 'deviceType'
productFlavors {
free { dimension 'monetization' }
paid { dimension 'monetization' }
phone { dimension 'deviceType' }
tablet { dimension 'deviceType' }
}
}ビルド バリアント freePhoneDebug の場合、DashO Gradle プラグイン(Android 用)は、アプリケーション レベルの build.gradle と同じディレクトリにあるプロジェクト ファイルを検索し、以下のリストの中で最初に見つかったプロジェクトファイルを使用します。
freePhoneDebug.doxfreePhone.doxfree.doxphone.doxdebug.doxproject.dox
この命名動作により、個々のバリアント、ビルド タイプ、またはフレーバーごとに異なる DashO 設定を保持できます。
保護対象から入力を除外
入力を依存関係として DashO で利用可能にする必要があるが、入力として保護すべきでない場合は、excludeFromProtection を使用します。この値は、大文字と小文字を区別しないで入力ファイル名と照合される正規表現です。
たとえば、次のように記述します。
dasho {
excludeFromProtection "androidx"
}この例では、ファイル名に androidx を含む入力を依存関係として扱います。
正規表現を定義する際には、次の動作を考慮してください。
- 正規表現は、完全な Maven 座標ではなく、ファイル名と照合されます。
- ファイル名の一部が一致すれば十分です。
- 空の正規表現や、すべての入力と一致する
.*のような正規表現は使用しないでください。すべての入力が対象から除外されると、ビルドは失敗します。 - 一部のプラグインは、DashO が処理する前に依存関係ファイルの名前を変更します。ファイル名が内容を表さないものになってしまう場合は、ファイル名を変更するプラグインよりも前に
com.preemptive.dasho.androidを適用してください。
たとえば、次のように記述します。
plugins {
id 'com.android.application'
id 'com.preemptive.dasho.android'
id 'com.google.firebase.firebase-perf'
}プラグインの順序を変更できない場合は、protectProjectFilesOnly を true に設定して、プロジェクト ディレクトリ外にあるサードパーティ製ライブラリを除外します。
アプリケーションにライブラリ プロジェクトが含まれている場合、そのライブラリを単独の保護された成果物としても配布するのでない限り、ライブラリを個別に保護しないでください。ライブラリとアプリケーションの両方を保護しようとすると、DashO が同じコードを複数回処理してしまう可能性があります。
ライブラリのリソース暗号化の構成
プラグインは、Android Gradle の構成からアプリケーションの資産とリソースの場所を自動的に取得します。アプリケーションとライブラリの両方をビルドし、ライブラリの Asset または Raw リソースを DashO で暗号化したい場合は、libraryAssetDirs および libraryResourceDirs を構成します。
dasho {
libraryAssetDirs "../lib/src/main/assets"
libraryResourceDirs "../lib/src/main/res"
}ライブラリのリソース ディレクトリにある raw サブディレクトリ内のファイルのみが、リソースの暗号化の対象となります。
Android ライブラリの依存関係の構成
DashO が AAR の処理中に外部クラスが見つからないと報告する場合は、runtimeJars を有効にして、プラグインがライブラリに必要なランタイム JAR の依存関係を読み込めるようにします。
dasho {
runtimeJars = true
}protectProjectFilesOnly が有効になっており、生成されたクラスも保護する必要がある場合は、includeAutoGeneratedModules を有効にします。
dasho {
protectProjectFilesOnly true
includeAutoGeneratedModules true
}プラグインの実行と検証
enabledBuildVariants に一致するバリアントの Gradle ビルド タスクを実行します。プラグインは、そのビルドに自身の保護タスクを追加します。
リリース バリアントのビルド
プロジェクト ルートから次を実行します。
./gradlew clean assembleReleaseプラグインは、doxFilename で指定されたプロジェクト ファイル、または既定の検索規則によって見つかったファイルを使用します。
デバッグ バリアントのビルド
既定では、プラグインはリリース バリアントのみを保護します。デバッグ ビルドを保護するには、次のようにします。
-
enabledBuildVariantsをデバッグ バリアントと一致するように設定します。enabledBuildVariantsは大文字と小文字を区別しない正規表現であるため、1 つの値で両方のビルド タイプに一致させることができます。dasho { enabledBuildVariants "release|debug" }すべてのバリアントを保護するには、空の文字列を使用します。
- プロジェクト ルートから次を実行します。
./gradlew clean assembleDebug
ビルドの検証
- インストールされている DashO Android プラグインのバージョンを表示します。
./gradlew dashOPluginVersion - ビルド出力で DashO のバージョンが識別されており、DashO のエラーが発生せずに完了していることを確認します。
サポートされているビルド プロパティ
本プラグインでは、以下の Gradle プロジェクト プロパティ、Java システム プロパティ、および環境変数がサポートされています。
| プロパティ | 用途 |
DASHO_HOME |
DashO ホームを指定します。 |
DASHO_LICENSE |
DashO で使用されるライセンス文字列を指定します。Android プラグイン 1.3.0 以降でサポートされます。 |
DISABLE_DASHO |
有効にすると、DashO によりクラス処理が行われなくなります。値は不要です。false 以外の値は true として扱われます。
|
GENERATE_DASHO_CONFIG |
既定の Android モード プロジェクト ファイルを生成します。値は不要です。false 以外の値は true として扱われます。
|
SHOW_DASHO_CMD |
DashO を起動する際に使用されるコマンド ライン引数を表示します。値は不要です。false 以外の値は true として扱われます。
|
プロパティは、Gradle コマンド ラインで -P{name}[={value}] または -D{name}[={value}] を使用して渡すことができます。
gradlew build -PDASHO_HOME=<dashoホームのパス>
gradlew build -DDASHO_HOME=<dashoホームのパス>また、gradle.properties で Gradle プロジェクト プロパティを定義することもできます。環境変数を通じて Gradle プロジェクト プロパティを指定するには、プロパティ名の先頭に ORG_GRADLE_PROJECT_ を付けます。
たとえば、次のように記述します。
ORG_GRADLE_PROJECT_DASHO_LICENSE={key[:email]}ライセンスの構成
ビルド時に Gradle プロジェクト プロパティ、Java システム プロパティ、または環境変数を通じて DashO ライセンス文字列を提供する必要がある場合は、DASHO_LICENSE を使用します。
たとえば、次のように記述します。
gradlew build -PDASHO_LICENSE={key[:email]}保護されていないライセンス文字列をソース管理に格納することは避けてください。