Dockerized Android

Dockerized Android は、Docker 内で Android エミュレータを実行し、ブラウザを通じて制御できるコンテナベースのフレームワークです。このプロジェクトは、モバイルセキュリティコンポーネントを Cyber Range に統合するための出発点を提供するために開発されましたが、あらゆる目的に使用できます。ただし、開発およびテスト目的では、docker-android プロジェクトを推奨します。

はじめに

上記の簡単な説明にあるように、このプロジェクトは Cyber Range にモバイルセキュリティコンポーネントを導入するための出発点を提供するために作成されました。そのため、すでに開発されている機能および今後追加される予定の機能は、現実的なシミュレーション（セキュリティトレーニングなど）のセットアップを容易にするのに役立ちます。この README はかなり長いので、「実行方法」の部分に飛ばしてしまっても構いません。

機能

現在利用可能な機能は以下の通りです。

Docker 内で Android エミュレータを実行
Web ブラウザを介してデバイスを制御
アプリケーションのインストール
ポートフォワーディングの有効化
デバイスの再起動
SMS のエミュレート
Web ブラウザから端末を使用
物理デバイスも接続可能
起動時の動作をカスタマイズ（設定セクションを参照）
複数のインスタンスを簡単に管理

初期設定	インスタンスマネージャ設定	手動設定
initial-setup	instance-manager-setup	manual-setup

ツールボックスの機能	インスタンス切り替え
toolbox	instance-switch

アーキテクチャ

このプロジェクトは、以下の 3 つの主要なコンポーネントで構成されています。

Dockerized Android Core（コア）
Dockerized Android UI
Dockerized Android Instance Manager（インスタンスマネージャ）（オプション）次の図は、2 つの必須コンポーネントの実際のアーキテクチャの概要を示しています。

コアコンポーネント

コアコンポーネントは、Docker コンテナ内で Android コンポーネント（エミュレートまたは実デバイス）を実行するために必要なすべてのプロセスを実行し、さらにいくつかの機能を外部に公開するコンポーネントです。一連の機能を提供するために複数のプロセスを管理する必要があるため、間違いなく最も複雑な部分です。上の図では、長時間実行プロセス、起動プロセス、ユーティリティスクリプトの明確な区別が示されています。さらに、この図は 6 つの長時間実行プロセスがあることを示していますが、これはコアコンポーネントの一般的な概要を提供するために追加されたわずかな不正確さであり、実際にはコアコンポーネントには 2 つの異なるフレーバーがあります。

エミュレータ用コア
実デバイス用コア

主なアーキテクチャ上の違いは、長時間実行プロセスに関するものです。エミュレータ用コアは長時間実行の emulator プロセスを実行し、実デバイス用コアは物理デバイスの表示と制御のために長時間実行の scrcpy プロセスを実行します。他の部分はかなり類似しており、コアコンポーネントのタイプに基づいて異なる動作を実現するためのロジックが一部異なるのみです。

UI コンポーネント

UI コンポーネントは、バックエンドが公開するすべての機能を簡単に使用できるようにし、さらにデバイスの表示と制御機能も追加します。ユーザーは手動でコアコンポーネントのアドレスと対応するポート（バックエンドが公開するポートと websockify が公開するポート）を入力する必要があります。この手動セットアップにより、デフォルトのポート（バックエンドは 4242、websockify は 6080）を変更できます。

インスタンスマネージャコンポーネント

インスタンスマネージャコンポーネントの役割は、単一の REST API を通じて実行中のすべてのコアに関する情報（アドレスとポート）を提供することです。これは、docker-compose に存在するすべてのコアに関する情報を含むシンプルな JSON 設定ファイルを作成することで行われ、手作業で 1 つずつ追加する面倒な作業を回避します。JSON 設定ファイルの構造は以下のとおりです。

{
    "instances": [
        {
            "name": [デバイスを識別する任意の文字列],
            "address": [コンポーネントのアドレス],
            "core_port": [バックエンドのポート],
            "vnc_port": [VNC のポート]
        }
    ]
}

Docker イメージ一覧

secsi/dockerized-android-core-bare はシステムイメージをダウンロードせず、すべての SDK フォルダがあるホストマシン上のフォルダをマウントできます。

実行方法

プラットフォームの実行方法の完全な例については、examples ディレクトリにある docker-compose を参照してください。このディレクトリには 3 つの異なる設定が含まれています。

docker-compose-core: 実デバイス用のコアを備えた設定。
docker-compose-emulator: エミュレータ用のコアを備えた設定。
docker-compose-instance-manager: 2 つの異なるコアと オプション のインスタンスマネージャコンポーネントを備えた設定。

動作を理解したら、必要に応じて変更できます。

前提条件

マシンに Docker および Docker Compose がインストールされている必要があります。

OS 互換性

このプラットフォームはホスト OS によって動作が異なります。以下に現在の互換性をまとめた表を示します。

	Linux	Windows	OS X
エミュレータ用コア	完全互換	未サポート（近日対応予定）	未サポート
実デバイス用コア	完全互換	完全互換	回避策あり

Windows および OS X では、ネストされた仮想化を備えた Linux VM を使用する必要があります。

Linux マシンがネストされた仮想化をサポートしているかどうかを確認するには、次のコマンドを実行します。

sudo apt install cpu-checker
kvm-ok

OS X の実デバイス向け回避策

OS X で実デバイス用コアを使用するには、以下の方法があります。

ホストの adb を使用する
ワイヤレス接続を使用する

ワイヤレス接続については、Google が簡単なチュートリアルを提供しています。コンテナ内からホストの adb に接続するには、手動でコンテナ内に入り、以下を実行します。

adb -H host.docker.internal devices

実行

フレームワークの使用を開始するためのコマンドは次のとおりです。

まず、examples フォルダから設定を選択します。例:

cp ./examples/docker-compose-core.yml docker-compose.yml

docker-compose で実行します。

docker-compose up

より簡単に、次のコマンドを使用することもできます。

docker-compose -f ./examples/docker-compose-core.yml up

あとはブラウザで http://127.0.0.1:8080 にアクセスし、現在の設定を行います。

インスタンスマネージャ を使用しない場合は、Manual Setup（手動設定）をクリックし、以下の情報を入力します。

インスタンスの任意の名前。
docker-compose で宣言されたコアコンポーネントの IP アドレス。
コアのポート番号（デフォルトは 4242）。
VNC のポート番号（デフォルトは 6080）。

インスタンスマネージャ を使用する場合は、"Instance Manager" をクリックし、IP アドレス とその ポート番号（例: 193.21.1.100:7373）を入力するだけです。

以上です。ブラウザ内でフレームワークを使用できます。

ビルド

utils フォルダ内のスクリプトを使用して、イメージを自分でビルドすることもできます。

設定

ENV 変数を使用してセットアップをカスタマイズするためのいくつかの機能を設定できます。以下の表にその一覧を示します。

REAL_DEVICE_SERIAL 変数は、複数の物理デバイスが接続されている場合に必須です。設定されていないと何も動作しません。最後に、各コンポーネントが公開するポートの一覧を示します。

ライセンス

Dockerized Android は、MIT ライセンスの下でリリースされたオープンソースのフリーソフトウェアです。