Tyr Project

Tyr Project

プレゼンテーション

Tyr は、脆弱性の脅威を調査するためのツールのコレクションです。

なぜ Tyr という名前なのか？

Tyr は、他のヴァイキングの神々の安全を監視するヴァイキングの神です。この他者のための監視者というアイデアが、このプロジェクトを Tyr と名付けるきっかけとなりました。

Tyr とは何か？

Tyr は、エンドユーザーが脆弱性データと関連する脅威を調査するためのソリューションのコレクションです。これらの目的を達成するために、Tyr は以下のデータを調査するための専門的な用途を持つ様々なキーワードリストを提供します：

NVD データ（NVD によって拡充された CVE、CVE ベンダーのコメント、CPE や CpeMatch など）、
Mitre データ（CWE、CAPEC、Att&ck など）、
Cisa kev。

Tyr は何をするのか？

Tyr は、これらのデータを調査および比較する機能を提供します。これらは独自のシェルスクリプト内で使用できます。以下のプラットフォームをサポートしています：

macOS、
Windows、
Debian 系、
Rocky 系。

Debian および Rocky 系 OS では、インストールされた各パッケージに対して修正済み CVE のリストを調査することが可能です。

これらのツールは、Windows プラットフォームでは統合ヘルプ付きのコマンドラインから、Linux および macOS プラットフォームでは man からアクセスできます。

すべてのデータは、ホームディレクトリに保存された .tyr ディレクトリに収集されます。NVD、Mitre、Cisa から収集されたすべてのソースファイルは、.tyr/downloads ディレクトリに保存されます。

すべてのローカルデータベースは .tyr/db ディレクトリに保存されます。ダウンロードとデータのインポート後は、オフラインモードですべてのデータを操作できます。

NOTE: 収集されたすべてのデータは、いくつかの sqlite データベースに保存されます。

Tyr を使うために必要なもの

すべてのユーザー向け

すべてのタイプのユーザーにとって、rust ツールチェーン自体以外の機能をインストールする必要はありません。

インストールには、お使いの OS に応じて以下のいずれかを選択できます：

OS	コマンド	コメント
not windows	`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs sh`	Windows プラットフォームでは無効
debian like	`sudo apt install rustup`	-
rocky like	`sudo dnf install rustup`	-
macOS/Linux	`brew install rustup`	Homebrew パッケージマネージャー
windows	`scoop install rustup`	Windows ユーザーの場合、まだインストールされていなければ、Microsoft のウェブサイトにある MSVC Runtime をインストールする必要があります。

インストール後、以下を実行します：

rustup default stable

および

rust update

開発者向け

まず git コマンドをインストールする必要があります。

その後、Tyr プロジェクト用の作業ディレクトリを作成し、クローンします:

git clone https://gitlab.com/cyberactivity/tyr.git

tyr ディレクトリに移動し、以下のコマンドを実行します:

cargo build --release

baldur 実行ファイルを $HOME/.cargo/bin にコピーします:

Windows 以外のユーザーの場合: cp target/release/baldur $HOME/.cargo/bin
Windows ユーザーの場合: copy target\release\baldur.exe %USERPROFILE%\.cargo\bin

cargo を使ってデプロイコマンドを実行します: cargo run --release

NOTE: このコマンドは tyr プロジェクト独自のデプロイコマンドであり、デフォルトで実行されます。

デプロイコマンドによって PATH 設定の一部が更新されているため、シェル環境を終了し、新しいシェルを開くことを推奨します。

利用可能なすべてのコマンドは、ローカルホームディレクトリ内の .tyr/bin ディレクトリに保存されます。

コマンドのヘルプを表示したい場合は、以下を試してください:

Windows ユーザーの場合は <command> help、その他のユーザーの場合は man <command>。

システム管理者向け

開発者ユーザー向けの説明に従って、Rust ツールチェーンをインストールし、Tyr プロジェクトリポジトリをクローンします。

tyr ディレクトリに移動し、以下のコマンドを実行して Debian インストールパッケージを生成します。

cargo clean

cargo deb --profile release

インストールパッケージは、例えば target/debian/baldur_0.0.1-1_arm64.deb のように生成されます。

以下のコマンドは rpm インストールパッケージを生成します:

cargo clean

cargo build --release

cargo generate-rpm -p src/baldur --profile release

インストールパッケージは、例えば target/generate-rpm/baldur-0.0.1-1.aarch64.rpm のように生成されます。

Windows/macOS へのインストールについては、開発者と同じ手順に従ってください。現時点では、これらの OS 向けの専用インストールプロセスはありません。

NOTE: パッケージインストール後、tyr のキーワード機能を利用したいエンドユーザーは以下を実行します:

git clone で tyr プロジェクトをクローンする、
tyr ディレクトリからコマンド deploy を実行する。

エンドユーザー向け

Linux パッケージをインストールしていない場合

上記で説明したプロセスのインストール後、コマンドラインインターフェースを開き、以下のコマンドを実行します:

git clone https://gitlab.com/cyberactivity/tyr.git

tyr ディレクトリに移動し、deploy を実行します。

.tyr ディレクトリが $HOME 内に作成されます。

Linux パッケージをインストール済みの場合

ユーザーセッションからコマンドラインコンソールを開き、deploy を実行します。

.tyr ディレクトリが $HOME 内に作成されます。

インストール後の共通プロセス

新しいコマンドラインインターフェースを開き、以下のコマンドを実行します:

すべてのデータソースをダウンロードするには: download
ダウンロードしたすべてのファイルをインポートするには: data.import

これで準備完了です。既存のすべてのコンテキストを表示するには、contexts を実行します。コンテキストのキーワード一覧を表示するには、デフォルトコンテキストの場合は keywords、特定のコンテキストの場合は keyword <context> を実行します。

Tyr の今後

多くの機能が実装待ちまたは進行中です。例えば:

sbom ファイルの生成とローカルデータベースへの保存、
脆弱性および脅威とのクロス分析、
サイバーレポートを生成するツール、
さまざまなソースや OS から収集したすべてのデータを共有するための Web アプリケーション、
OSINT ソースの統合、
新しいインストール機能の追加、
他の脆弱性データベースの統合と、それらを探索するための新しい機能の作成、
コンテキストおよびキーワードの解析の改善、
検証テストの改善、
JSON 出力の追加、
さまざまな OS をサポートするインストーラー (Windows、macOS など)

著者と謝辞

協力を歓迎します。すべてのツールは Rust 技術を用いて開発されます。

コントリビュート方法

貢献したい場合は、まず以下のドキュメントを読むことをお勧めします: ドキュメント一覧。

貢献したい場合は、まずリポジトリをクローンしてください。

ライセンス

このプロジェクトは MIT ライセンスの下にあります。

プロジェクトの状況

このプロジェクトは開発中であり、すべての貢献を歓迎します。

これらのツールはいかなる保証もなく提供されます。

Tyr

人気