Tyr Project

Tyr Project

Presentation

Tyr is a collection of tools for vulnerabilities threats exploring.

Why Tyr's name ?

Tyr is a viking god that survey the security of other viking gods. The idea of this surveyor for other give me the idea to call this project: Tyr.

What is Tyr ?

Tyr is a collection of solutions to help the end-user to explore vulnerabilities data and associated threats. To reach these objectives, Tyr offers various list of keywords with specialized usage to explore the following data:

NVD data, like CVE enrich by NVD, cve vendors comments, CPE and CpeMatch,
Mitre data like CWE, CAPEC, Att&ck,
Cisa kev.

What Tyr does ?

Tyr offers the possibility to explore and compare these data. They can be used into your own scripts shell. The following platforms are supported:

macOS,
Windows,
Debian like,
Rocky like.

For Debian and Rocky like OS, it's possible to explore the list of fixed CVE for each installed package.

These tools are accessible from command line with their integrated help for Windows plateforms, or man for Linux and macOS platforms.

All data are collected into the .tyr directory stored into your home directory. All collected sources files from NVD, Mitre and Cisa are saved into your .tyr/downloads directory.

All local databases are stored into the .tyr/db directory. After downloading and data importing you can work on all these data in offline mode.

NOTE: all collected data are stored into some sqlite databases.

What's need to use Tyr

For everybody

For every type of user, it's not necessary to install some other features than rust toolchain itself.

For installation, your have the choice below depending on your OS:

OS	Command	Comment
not windows	`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs sh`	Not valid on windows platform
debian like	`sudo apt install rustup`	-
rocky like	`sudo dnf install rustup`	-
macOS/Linux	`brew install rustup`	Homebrew package manager
windows	`scoop install rustup`	For Windows users you'll must install the MSVC Runtime you'll find on your Microsoft website if it's not installed yet.

After installation, runs:

rustup default stable

and

rust update

For developer

You'll need to install the git command first.

Afterward, create a working directory for the Tyr project and clone it:

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

Go to tyr directory and run the following commands:

cargo build --release

Copy the baldur executable to your $HOME/.cargo/bin:

For non Windows users: cp target/release/baldur $HOME/.cargo/bin
For Windows users: copy target\release\baldur.exe %USERPROFILE%\.cargo\bin

Runs the deployment command with your cargo: cargo run --release

NOTE: this command it's an own deployment command for the tyr project that is running by default.

It's recommended to quit your shell environment and to open a new one, since some PATH configuration had been updated by the deployment command.

All available commands are storing into your .tyr/bin directory into your local home directory.

If you want a help about a command, try:

<command> help for Windows users or man <command> for other users.

For system manager

Install the rust toolchain and clone the Tyr project repository as explain for developer users.

Go the tyr directory and run the following commands to generate the debian installation package.

cargo clean

cargo deb --profile release

The installation package was generated as for example: target/debian/baldur_0.0.1-1_arm64.deb.

The following commands generate a rpm installation package:

cargo clean

cargo build --release

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

The installation package was generated as for example: target/generate-rpm/baldur-0.0.1-1.aarch64.rpm

For windows/macOS installation, follows the same procedure as a developer. There is no specific installation processes for these OS for the present.

NOTE: after package installation, the end-user that wants the tyr keywords features will do:

a git clone to clone the tyr project,
from the tyr directory will run the command: deploy.

For end user

Without Linux package installed

After a process installation explain as above, open a command line interface and run the following commands:

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

Go to tyr directory and run: deploy.

The .tyr directory is created into your $HOME.

With Linux package installed

From your user session, open a command line console and run: deploy.

The .tyr directory is created into your $HOME.

Common process after installation

Open a new command line interface, and runs the following commands:

To download all data sources: download
To import all downloaded files: data.import

You're ready. To show all existing contexts, run: contexts To show the list of keywords for a context run: keywords for the default context, or keyword <context> for a specific context.

The future of Tyr

Lot of features are waiting to be implemented or are in progress like:

sbom files generation and storing into your local database,
cross analysis with vulnerabilities and threats,
tools to generate cyber-reports,
a web application for sharing all collected data from different sources and OS,
adds new installation facilities,
integrate other vulnerabilities database and create new facilities to explore them.

Authors and acknowledgement

Help will be appreciated. All tools will be developed with rust technologies.

If you want to bring your contribution, I'm encouraging you to read these documents first: documents list

License

This project is under MIT license.

Project status

This project is under development and all contributions are welcome.

These tools are provided without any guaranties.

Tyr

인기