除去(Removal)とは、PreEmptive Protection™ DashO™ がアプリケーションに不要なコードやメタデータを削除する機能です。次の 3 つの機能を備えています。
- 使用されていないクラスとメンバーの除去
- コンパイラが生成する属性の除去
- 特定のクラスの明示的な除去
除去によりアプリケーションのサイズが縮小され、保護にも役立ちます。デバッグ属性やコンパイラ生成の属性の中には、攻撃者にアプリケーションに関するさらなる洞察を与えてしまうものがあります。
この記事では、除去の仕組みについて説明します。除去を構成するには、除去の構成を参照してください。ログ呼び出しなど、特定のメソッドへの呼び出しを除去するには、メソッド呼び出しの除去を参照してください。
使用されていないクラスとメンバーの除去
DashO はエントリ ポイントをたどって、コードが使用しているクラスとメンバーを特定します。到達しなかったクラス、メソッド、フィールドはすべて未使用として扱い、除去します。
クラスおよびメンバー(メソッドとフィールド)に対して、それぞれ個別に除去を設定します。
| オプション | 除去対象 | 通常の用途 |
| Remove | 未使用のすべてのクラスまたはメンバー。 | アプリケーション |
| Remove if not public |
public または protected でない、未使用のクラスまたはメンバーのみ。
|
パブリック API を持つライブラリ。ライブラリのエントリ ポイントも同じ目的を果たします。 |
| Do not remove | なし。 | — |
対象除外
使用されていないように見えても、DashO に保持させたいクラスやメンバーを除去対象から除外します。除去対象から項目を除外を参照してください。
リフレクション
コードがリフレクションを介してのみクラスやメンバーにアクセスする場合、DashO はそれが使用されているかを必ずしも判別できるとは限りません。次のオプションがあります。
- クラスおよびメンバーをエントリ ポイントとして追加するか、除去対象から除外します。一般的に、こちらの方がより信頼性の高い選択肢です。
- [Input]>[Options]ページで、[Determine Reflected Classes]を選択します。DashO は、名前変更および除去の分析中に、クラスへの単純なリフレクションベースのアクセスを見つけようとします。
属性の除去
DashO は、デバッグ情報や選択されたその他の属性を除去します。この情報の一部は、ライブラリに対してコンパイルを行う場合や、リフレクションを使用するアプリケーションで必要になります。アプリケーションが実行時に必要としない情報のみを除去します。
デバッグ情報
| フレンドリ名(GUI で使用) | 属性名(プロジェクト ファイルで使用) | 説明 |
| Source File | SourceFile |
クラスのソース コードが含まれているファイルの名前。 |
| Source Directory | SourceDir |
ソース ファイルが格納されているディレクトリ。一般的ではありません。 |
| Source Debug Extension | SourceDebugExtension |
拡張された、ツール固有のデバッグ情報。 |
| Line Number Table | LineNumberTable |
バイトコード命令を元のソース ファイルの行番号に対応付けます。 |
| Local Variables | LocalVariableTable |
メソッドの実行時におけるローカル変数の名前と型。 |
| Local Variable Types | LocalVariableTypeTable |
ジェネリック型を持つローカル変数の型パラメーター。 |
デバッガーはこの情報の大部分を使用します。意味のある行番号を含んだスタック トレースを取得するには、Line Number Table と Source File を保持します。
追加の属性
Java コンパイラは、クラスとそのメンバーに関するメタデータも属性に格納します。アプリケーションに不要なものを除去することで、クラス ファイルのサイズを縮小できるほか、これらの情報の一部は攻撃者にソフトウェアに関する洞察を与えるため、保護の強化にもつながる可能性があります。
| フレンドリ名(GUI で使用) | 属性名(プロジェクト ファイルで使用) | 説明 |
| Exceptions | Exceptions |
メソッドがスローする可能性のある、チェックされた例外。 |
| Signature | Signature |
型パラメーターを受け取るか、パラメーター化された型を使用するクラス、メソッド、またはフィールドの署名。 |
| Deprecated | Deprecated |
クラス、インターフェイス、メソッド、またはフィールドが置き換えられたもの(廃止)としてマークします。有効な場合、DashO は JVM の Deprecated 属性と java.lang.Deprecated アノテーションの両方を除去します。詳細については、非推奨メタデータを参照してください。
|
| Synthetic | Synthetic |
ソース コードに現れないクラス メンバーをマークします。 |
| Enclosing Method | EnclosingMethod |
匿名クラスを囲むメソッド。 |
| Inner Classes | InnerClasses |
内部クラスと外部クラスの関係。 |
| Visible Annotations | RuntimeVisibleAnnotations |
クラス、メソッド、またはフィールドに付けられた、リフレクションを通じて見えるアノテーション(@Deprecated、@FunctionalInterface、@SafeVarargs など)。
|
| Invisible Annotations | RuntimeInvisibleAnnotations |
クラス、メソッド、またはフィールドに付けられた、リフレクションを通じて見えないアノテーション。 |
| Visible Parameter Annotations | RuntimeVisibleParameterAnnotations |
メソッド パラメーターに付けられた、リフレクションを通じて見えるアノテーション。 |
| Invisible Parameter Annotations | RuntimeInvisibleParameterAnnotations |
メソッド パラメーターに付けられた、リフレクションを通じて見えないアノテーション。 |
| Annotation Default | AnnotationDefault |
アノテーション要素の既定値。 |
| Method Parameters | MethodParameters |
メソッドのパラメーターの名前。 |
| Unknown Attributes | Unknown |
その他すべての属性の種類。 |
非推奨メタデータ
Java は、JVM の Deprecated 属性と java.lang.Deprecated アノテーションという 2 つの形式で非推奨を記録します。Deprecated の除去を有効にすると、DashO は既定でその両方を除去します。
DashO は java.lang.Deprecated アノテーションのみを除去します。その他の実行時に可視および不可視のアノテーションは変更されません。
プロジェクトで引き続きアノテーションが必要な場合は、プロジェクト ファイルの <attributes> 要素にある preserveDeprecatedAnnotation オプションを使用して互換モードを有効にします。
preserveDeprecatedAnnotation |
JVM Deprecated 属性
|
java.lang.Deprecated アノテーション
|
false(既定)
|
除去 | 除去 |
true |
除去 | 保持 |
JVM Deprecated 属性を除去して java.lang.Deprecated アノテーションを保持するには、preserveDeprecatedAnnotation を true に設定します。
<attributes
types="Deprecated"
preserveDeprecatedAnnotation="true"/>クラスの除去
単体テストやサンプルなど、出力に入れたくないクラスが入力に含まれている場合は、それらが完全に除去されるように DashO を構成してください。DashO は、これらのクラスを除去対象から除外している場合であっても除去します。詳細については、特定のクラスの除去を参照してください。
例とユースケース
除去の構成の選択
| シナリオ | アプローチ |
| アプリケーションを保護します。 | 使用されていないクラスとメンバーを Remove に設定します。 |
| パブリック API を持つライブラリを保護します。 | Remove if not public を使用するか、またはエントリ ポイントを定義します。 |
| 本番環境から判読可能なスタック トレースを取得する必要があります。 | Line Number Table および Source File を保持します。 |
| 入力に単体テストやサンプルが含まれています。 | それらのクラスを明示的に除去します。 |
| コードは、リフレクションを介してクラスを読み込みます。 | クラスをエントリ ポイントとして追加するか、除去の対象から除外します。 |
制限事項とトラブルシューティング
| 制限または問題 | 詳細 |
| 除去を利用できません。 | お使いのプロジェクトは Android モードを使用しているため、除去は R8 が処理します。R8 を有効にしてください。 |
| リフレクションを介してアクセスされるコードが、実行時に見つかりません。 | DashO はリフレクションを常に検出できるわけではなく、メソッドやフィールドへのリフレクションベースのアクセスを検出することはありません。項目をエントリ ポイントとして追加するか、除去の対象から除外します。 |
| 特定のクラスを除去した後、アプリケーションが実行時に失敗します。 | 別の入力クラスが、除去されたクラスを参照しています。クラスの除去を中止するか、その参照を除去します。 |
| 除外されたクラスも除去されます。 | それは、特定のクラスを除去する規則にも一致しています。それらの規則は対象除外規則より優先されます。 |
java.lang.Deprecated アノテーションを読み取るコードが動作しなくなります。
|
Deprecated の除去を行うと、アノテーションも除去されます。preserveDeprecatedAnnotation="true" を設定してください。詳細については、非推奨メタデータを参照してください。
|
| スタック トレースに行番号がありません。 | Line Number Table または Source File が削除されています。両方を保持してください。 |
| 型アノテーションが見つかりません。 | DashO はそれらを常に除去します。これを無効にすることはできません。 |
関連記事