swimlane/soc-fakerSOCおよびセキュリティ自動化のための偽データ生成に使用するPythonパッケージ。
soc-faker は、セキュリティオペレーションセンター、情報セキュリティ専門家、プロダクトチームなどが使用するための偽のデータを生成するために使用されます。
soc-faker は Python 3.6 以上で動作します。soc-faker は pip を使用してインストールするか、このリポジトリを直接クローンすることができます。
このドキュメントの作成時点では、soc-faker は以下の主要カテゴリの偽データを生成する機能を持っています。各カテゴリの詳細は、以下のリンクを選択して確認できます。
pip install soc-faker --user
git clone https://github.com/swimlane/soc-faker.git
cd soc-faker
python setup.py install
以下のライブラリが必須であり、soc-faker によってインストールされます。
requests==2.23.0
pendulum==2.1.2
ipaddress==1.0.23
bs4==0.0.1
xmltodict==0.12.0
netaddr==0.7.20
fire==0.3.1
soc-faker は Python パッケージであり、インポートして使用することも、コマンドラインユーティリティを介してセキュリティツール、製品、およびセキュリティに関連する一般的なデータに関する偽データを生成するために使用することもできます。
soc-faker をソースまたは pip を使用してインストールした後、以下のようにしてインポートおよびインスタンス化できます。
from socfaker import SocFaker
sc = SocFaker()
soc-faker のインスタンスを生成したら、ニーズに応じて利用可能なさまざまなプロパティとメソッドにアクセスできます。soc-faker の動作を確認したい場合は、リポジトリの bin フォルダにある bin/test.py スクリプトを参照してください。すべての利用可能なプロパティとメソッドの例が示されています。
さらに、各プロパティとメソッドの詳細については、ドキュメントをお読みください。
soc-faker がインストールされると、自動的にコマンドラインユーティリティが作成され使用できるようになります。このユーティリティは、お好みのシェルで単に soc-faker と入力することでアクセスできます。
soc-faker のヘルプを表示するには、次のように入力します。
soc-faker
# または
soc-faker --help
ライブラリと同じように各プロパティにアクセスできます。唯一の違いは、プロパティ間の . をスペースに置き換えることです。たとえば、ランダムに生成された hashes をすばやく取得したい場合は、次のように実行します。
soc-faker file hashes
これにより、シェルに以下のような出力が返されます。
md5: aa3150ac34ee6a5911e61ab6a5052a6d
sha1: de5c15f64d979ed84bac340c334a63d94401059d
sha256: 118a9f9de8f3dd6471ef113959485ecbaf66368dea16758eab4e22da182d0e9f
問題が発生した場合は、正しいと思われる内容を入力してください。組み込みのヘルプが、soc-faker 内の各データポイントについて、利用可能なすべてのグループ、コマンドなどをガイドします。
提供されている Dockerfile を使用して、soc-faker の開発およびテスト環境をセットアップできます。
Dockerfile を使用するには、このリポジトリのディレクトリに cd して次のコマンドを実行します。
docker build --force-rm -t socfaker .
ビルドが完了したら、Docker コンテナを実行します。
docker run -p 7001:7001 -ti socfaker
これを実行すると、bin\test.py のテスト Python ファイルが呼び出されます。追加のテストや開発のためにこのファイルを変更してください。
このプロジェクト内のテストは、利用可能なすべてのプロパティとメソッドをカバーする必要があります。このプロジェクトが成長するにつれてテストはより堅牢になりますが、現時点では、それらが存在し出力を返すことをテストしています。
行動規範とプルリクエストの提出プロセスについては、CONTRIBUTING.md をお読みください。
バージョニングには SemVer を使用しています。
soc-faker の特定バージョンの機能の詳細については、CHANGELOG.md をお読みください。
このプロジェクトに参加したコントリビューターのリストもご覧ください。
このプロジェクトは MIT ライセンスの下でライセンスされています。詳細については LICENSE ファイルを参照してください。
soc-faker は Swimlane のオープンソースプロジェクトです。私たちは、アプリケーション向けに構築したプロジェクトの一部を共有することで、オープンソースコミュニティに貢献することを信じています。Swimlane は自動化されたサイバーセキュリティオペレーションおよびインシデント対応プラットフォームであり、サイバーセキュリティチームが脅威インテリジェンスを活用し、インシデント対応を迅速化し、セキュリティオペレーションを自動化することを可能にします。
SecOps Hub は、セキュリティ専門家がアイデア、ユースケース、ベストプラクティス、インシデント対応戦略を共有するための、オープンでプロダクトに依存しないオンラインコミュニティです。