rusakovichma / tictaac

Easy-to-use Threat modeling-as-a-Code (TaaC) solution following DevSecOps principles. Simple CI/CD integration as well as console usage. Sugar-Free and Secure: no any external dependencies except for chart plotting are used

Threat modeling-as-a-Code in a Tick (TicTaaC) Lightweight and easy-to-use Threat modeling solution following DevSecOps principles

Preface

"One day the customer asked to perform threat modeling for our product. Of course, we have heard about it a lot from different teams, I have even read several articles and looked through a book to get familiar with this process, but they were too abstract as for me and didn't give me a certainty at all. Then we have faced several enterprise - level products which theoretically would help us, but we didn't want to deploy the whole security program because of it, we just wanted to get the prioritized threats list for our product to put it in our security backlog. Nothing else"

Anonymous Developer

Idea

The idea behind this product is clear - I want to create something simple that would help to solve this difficult problem. Ideally, with one click or a command and with a possibility to integrate it into a pipeline and do it continuously if needed. Inspired by dependency-check architecture and simplicity plus taking in mind that developers just love mapping everything in code, I've created "TicTaaC", which means "Threat modeling-as-a-Code in a Tick"

Usage

All the tool is needed is a data flow code file described in the yml-like format specially designed for this.
The examples of these files with verbose comments describing every aspect may be found here.

Command Line

More detailed instructions can be found on the github wiki. The latest CLI can be downloaded from github in the releases section.
On *nix:

$ ./bin/tic-taac.sh -h
$ ./bin/tic-taac.sh --out . --threatModel [path to threat model file(s) or folder to scan]

On Windows:

> .\bin\tic-taac.bat -h
> .\bin\tic-taac.bat --out . --threatModel [path to threat model file(s) or folder to scan]

Docker

See TicTaaC Docker Hub repository.

Quickstart on Windows:

> docker run --volume /D/threat-model:/threat-model --volume /D/report:/report rusakovichma/tic-taac:latest --threatModel /threat-model/ --out /report

*nix script:

#!/bin/sh

TT_VERSION="latest"
THREAT_MODEL_DIR=$HOME/threat-model

# Make sure we are using the latest version
docker pull rusakovichma/tic-taac:$TT_VERSION

docker run --rm \
    -e user=$USER \
    -u $(id -u ${USER}):$(id -g ${USER}) \
    --volume $THREAT_MODEL_DIR:/threat-model:z \
    --volume $(pwd)/report:/report:z \
    rusakovichma/tic-taac:$TT_VERSION \
    --threatModel /threat-model \
    --outFormat html \
    --out /report
    # Set mitigation strategy for the corresponding threats
    # see https://github.com/rusakovichma/TicTaaC/blob/master/expl/mitigations.yml 
    # --mitigations /threat-model/mitigations.yml 
    # or set the folder where scan the mitigations files: --mitigations /mitigations

Jenkins pipeline

For TicTaaC usage at Jenkins pipeline, see Jenkinsfile example.

Data Flows Examples

• Simple Threat Model
• Intermediate Model
• Advanced Model

Generated report example

Features

• Automatic Data Flow generation in a report
• Ideal for Security Teams - it has flexible Threats Library logic customization in a separate file with special expression language support
• Suitable for CICD pipeline integration
• Setting Quality Gate that can block the product release in case if unmitigated threats are presented
• No required additional dependencies
• Special lightweight and easy-to-understand format for data flows description
• Automatic Threats Attack Vector & Risk Score calculation based on the data flow context
• Threats classification by OWASP Top 10 and Microsoft STRIDE
• Setting Threats mitigation strategy in one place
• Reporting in html or json format

License

Copyright (c) Mikhail Rusakovich

Licensed under the Apache License version 2.0

tictaac's Issues

CSV format report support

Add reporting in csv format

supply-chain-attack rule improvement

Add to supply-chain-attack sanitizing and validation requirement

Multiple threat modeling files support

Add multiple threat modeling files support

Data Flow diagram generation in report

Autogenerate Data Flow diagram image in report

Functional threat modeling (abuse cases)

Add Functional threat modeling (abuse cases) possibility

Functional threat modeling (abuse cases)

Add Functional threat modeling (abuse cases) possibility

source

Hi,

Do you have any guide for the install from source? or any prerequisite list?

I got this when I wanna execute like that:
./tic-taac.sh -h
Error: Could not find or load main class com.github.rusakovichma.tictaac.Launcher
Caused by: java.lang.ClassNotFoundException: com.github.rusakovichma.tictaac.Launcher

Thanks

Lack of documentation

I would appreciate a bit more documentation about elements types meaning (e.g. difference between consumed-assets and processed-assets) and use cases.
Same here with elements types and other values differences(Values: interactor, proxy-server, web-server, database, external-service, internal-service, process).
What of these would be frontend: proxy-server or external-service?