PolySwarm

This page is available in English.

このページは English でもご利用いただけます。

Linux 開発環境

システム要件

  • x86-64 CPU
  • 8GB の RAM

この説明は、Xubuntu 18.04 amd64 に基づいて作成、テストされています。

Docker のインストール

簡単に実行できるように、できる限り多くのものを Docker 化しています。

Docker-CE (ベース) と Docker Compose をインストールする必要があります。 最新の Docker セットアップがない場合は、ここで Docker をインストールしてください

インストール後、以下を実行してインストール環境が機能していることを確認します。

$ docker ps

以下のように出力される必要があります。

CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS               NAMES

次に、docker-compose をインストールします

インストール後、以下を実行してインストール環境が機能していることを確認します。

$ docker-compose -v

少なくとも docker-compose version 1.21.1, build 5a3f1a3 が出力される必要があります。

Docker のインストール後、以下のようにユーザーを docker グループに追加して、sudo なしで docker コマンドを簡単に実行できるようにすることをお勧めします。

$ sudo usermod -aG docker ${USER}

変更を有効にするには、再起動する必要があります。

Git のインストール

いくつかのソース・コード・リポジトリーを利用する必要があります。Git を使用するのが最も簡単でしょう。 ご使用の開発環境用の Git をインストールしてください。

Python と PIP のインストール

PolySwarm での開発では、Python 3.5.4 以上が必要です。 ご使用の開発プラットフォーム用の PythonPIP をインストールしてください。

(オプション) 仮想環境 (virtualenv) のセットアップ

当該マシンを他の目的で使用する予定の場合は、システム全体の Python パッケージがクリーンな状態に保たれるように、以下のように PolySwarm virtualenv を作成することをお勧めします。

pip install virtualenv
cd ~
virtualenv polyswarmvenv -p <PYTHON 3.5.4 以上のパス>
source polyswarmvenv/bin/activate

polyswarm-client ライブラリーのインストール

情報: virtualenv (上記を参照) を使用する場合は、polyswarm-client をインストールする前に virtualenv をアクティブ化してください。

polyswarm-client ライブラリーのコンパイルとインストールはシンプルです。

まず、Python 3 のヘッダー/ビルド要件をインストールします。

Ubuntu では、以下のようにします。

$ sudo apt install python3-dev

次に、以下のようにします。

pip install polyswarm-client

インストールの確認

これで有効な開発環境が用意できているはずです。

確認するために、以下のように polyswarmclient をインポートします。

$ python
...
>>> import polyswarmclient
>>>

問題なく polyswarmclient をインポートできる必要があります。

次に、EICAR テスト・ファイルを検出できる独自の PolySwarm マイクロエンジンの作成について説明します。

「Hello World」マイクロエンジンの作成 →