pytm: un framework Pythonic per il threat modeling

Introduzione

Il threat modeling tradizionale troppo spesso arriva tardi alla festa, o a volte non arriva affatto. Inoltre, creare flussi di dati e report manuali può richiedere moltissimo tempo. L'obiettivo di pytm è spostare il threat modeling verso sinistra, rendendo il threat modeling più automatizzato e incentrato sullo sviluppatore.

Funzionalità

In base al tuo input e alla definizione del progetto architetturale, pytm può generare automaticamente i seguenti elementi:

Diagramma del Flusso di Dati (DFD)
Diagramma di Sequenza
Minacce rilevanti per il tuo sistema

Requisiti

Linux/MacOS
Python 3.11+
Pacchetto Graphviz
Java (OpenJDK 10 o 11)
plantuml.jar

Per Iniziare

Il file tm.py è un modello di esempio. Puoi eseguirlo per generare il report e i file immagine dei diagrammi a cui fa riferimento:``` mkdir -p tm ./tm.py --report docs/basic_template.md | pandoc -f markdown -t html > tm/report.html ./tm.py --dfd | dot -Tpng -o tm/dfd.png ./tm.py --seq | java -Djava.awt.headless=true -jar $PLANTUML_PATH -tpng -pipe > tm/seq.png

There's also an example `Makefile` that wraps all these into targets that can be easily shared for multiple models. If you have [GNU make](https://www.gnu.org/software/make/) installed (available by default on Linux distros but not on OSX), simply run:```
make MODEL=the_name_of_your_model_minus_.py

Dovresti avere plantuml.jar nella stessa directory del tuo modello, oppure impostare PLANTUML_PATH.

Per evitare di installare tutte le dipendenze, come pandoc o Java, lo script può essere eseguito all'interno di un container:```

do this only once

export USE_DOCKER=true make image

call this after every change in your model

make

### Getting Started - Variante Devbox

Per semplificare l'utilizzo di `pytm`, le dipendenze host possono essere completamente isolate usando [`Devbox`](https://github.com/jetify-com/devbox). Questa è di solito un'alternativa più leggera e più comoda rispetto all'approccio container OCI.

- Installa Devbox su Linux/MacOS: `curl -fsSL https://get.jetify.com/devbox | bash`
- Installa Devbox su [Windows/WSL](https://www.jetify.com/docs/devbox/installing-devbox/index#installing-wsl2)
- Aggiorna all'ultima versione di devbox: `devbox version update`
- Imposta il tuo token di accesso GitHub nel file `~/.config/nix/nix.conf`: `access-tokens = github.com=YOUR_TOKEN_HERE`
- Crea un nuovo ambiente shell isolato che includa tutti gli strumenti e i pacchetti specificati nel file `devbox.json` del progetto: `devbox shell`
- Visualizza il percorso completo dell'eseguibile di Python che verrà utilizzato quando digiti semplicemente `python` nel tuo terminale usando il comando which python. L'output dovrebbe essere il seguente percorso: `.devbox/nix/profile/default/bin/python`
- Verifica eseguendo il seguente comando, che dovrebbe generare un DFD come file PNG chiamato `sample.png`:  `./tm.py --dfd | dot -Tpng -o sample.png`
- Esci dall'ambiente shell Devbox: `exit`


## Utilizzo

Tutti gli argomenti disponibili:```text
usage: tm.py [-h] [--debug] [--dfd] [--report REPORT] [--exclude EXCLUDE]
             [--seq] [--list] [--colormap] [--describe DESCRIBE]
             [--list-elements] [--json JSON] [--levels LEVELS [LEVELS ...]]
             [--stale_days STALE_DAYS]

options:
  -h, --help            show this help message and exit
  --debug               print debug messages
  --dfd                 output DFD
  --report REPORT       output report using the named template file (sample
                        template file is under docs/template.md)
  --exclude EXCLUDE     specify threat IDs to be ignored
  --seq                 output sequential diagram
  --list                list all available threats
  --colormap            color the risk in the diagram
  --describe DESCRIBE   describe the properties available for a given element
  --list-elements       list all elements which can be part of a threat model
  --json JSON           output a JSON file
  --levels LEVELS [LEVELS ...]
                        Select levels to be drawn in the threat model (int
                        separated by comma).
  --stale_days STALE_DAYS
                        checks if the delta between the TM script and the code
                        described by it is bigger than the specified value in
                        days

L'argomento stale_days tenta di determinare di quanti giorni è distante lo script del modello (che stai scrivendo) dal codice che implementa il sistema modellato. Idealmente, nella maggior parte dei casi di un sistema sviluppato attivamente, dovrebbero essere abbastanza vicini. Puoi eseguirlo periodicamente per misurare il polso del tuo progetto e la 'freschezza' del tuo modello di minaccia.

Gli elementi attualmente disponibili sono: TM, Element, Server, ExternalEntity, Datastore, Actor, Process, SetOfProcesses, Dataflow, Boundary, Lambda, LLM e Agent.

Le proprietà disponibili di un elemento possono essere elencate utilizzando --describe seguito dal nome di un elemento:```text $ ./tm.py --describe Server Server class attributes: OS Operating system default: '' assumptions Assumptions about the element. These optionally allow to exclude threats with the given SIDs default factory: list controls Security controls for this element default factory: Controls data pytm.Data object(s) in incoming data flows default factory: DataSet description Description of the element default: '' findings Threats that apply to this element default factory: list handlesResources Does this asset handle resources? default: False inBoundary Trust boundary this element exists in default: None inScope Is the element in scope of the threat model default: True inputs incoming Dataflows default factory: list is_drawn default: False levels List of levels (0, 1, 2, ...) to be drawn in the model default factory: maxClassification Maximum data classification this element can handle default: <Classification.UNKNOWN: 0> minTLSVersion Minimum TLS version required default: <TLSVersion.NONE: 0> name Name of the element required onAWS Is this asset on AWS? default: False outputs outgoing Dataflows default factory: list overrides Overrides to findings, allowing to set a custom response, CVSS score or override other attributes default factory: list port Default TCP port for incoming data flows default: -1 protocol Default network protocol for incoming data flows default: '' severity Severity level of threats affecting this element default: 0 sourceFiles Location of the source code that describes this element relative to the directory of the model script default factory: list usesCache Does this server use cache? default: False usesEnvironmentVariables Does this asset use environment variables? default: False usesSessionTokens Does this server use session tokens? default: False usesVPN Does this server use VPN? default: False usesXMLParser Does this server use XML parser? default: False uuid default factory:

The *colormap* argument, usato insieme a *dfd*, produce un DFD codificato a colori in cui gli elementi sono colorati di rosso, giallo o verde a seconda del loro livello di rischio (come identificato eseguendo le regole).


## Uso - Variante Devbox

- `devbox shell`
- utilizzo di `pytm` come al solito
- `exit`

## Creazione di un modello di minaccia

Il seguente è un file `tm.py` di esempio che descrive una semplice applicazione in cui un Utente accede all'applicazione
e pubblica commenti sull'app. Il server dell'app memorizza quei commenti nel database. C'è una AWS Lambda
che pulisce periodicamente il database.```python

#!/usr/bin/env python3

from pytm import TM, Server, Datastore, Dataflow, Boundary, Actor, Lambda, LLM, Data, Classification, DatastoreType


tm = TM("my test tm")
tm.description = "another test tm"
tm.isOrdered = True

User_Web = Boundary("User/Web")
Web_DB = Boundary("Web/DB")

user = Actor("User")
user.inBoundary = User_Web

web = Server("Web Server")
web.OS = "CloudOS"
web.controls.isHardened = True
web.sourceFiles = ["server/web.cc"]

db = Datastore("SQL Database (*)")
db.OS = "CentOS"
db.controls.isHardened = False
db.inBoundary = Web_DB
db.type = DatastoreType.SQL
db.inScope = False
db.sourceFiles = ["model/schema.sql"]

comments = Data(
    name="Comments", 
    description="Comments in HTML or Markdown",  
    classification=Classification.PUBLIC,  
    isPII=False,
    isCredentials=False,  
    # credentialsLife=Lifetime.LONG,  
    isStored=True, 
    isSourceEncryptedAtRest=False, 
    isDestEncryptedAtRest=True 
)

results = Data(
    name="results", 
    description="Results of insert op",  
    classification=Classification.SENSITIVE,  
    isPII=False, 
    isCredentials=False,  
    # credentialsLife=Lifetime.LONG,  
    isStored=True, 
    isSourceEncryptedAtRest=False, 
    isDestEncryptedAtRest=True 
)

my_lambda = Lambda("cleanDBevery6hours")
my_lambda.controls.hasAccessControl = True
my_lambda.inBoundary = Web_DB

llm_api = LLM("AI Writing Assistant")
llm_api.isThirdParty = True
llm_api.processesPersonalData = True
llm_api.hasContentFiltering = False
llm_api.hasSystemPrompt = True
llm_api.processesUntrustedInput = True

my_lambda_to_db = Dataflow(my_lambda, db, "(&lambda;)Periodically cleans DB")
my_lambda_to_db.protocol = "SQL"
my_lambda_to_db.dstPort = 3306

user_to_web = Dataflow(user, web, "User enters comments (*)")
user_to_web.protocol = "HTTP"
user_to_web.dstPort = 80
user_to_web.data = comments

web_to_user = Dataflow(web, user, "Comments saved (*)")
web_to_user.protocol = "HTTP"

web_to_db = Dataflow(web, db, "Insert query with comments")
web_to_db.protocol = "MySQL"
web_to_db.dstPort = 3306

db_to_web = Dataflow(db, web, "Comments contents")
db_to_web.protocol = "MySQL"
db_to_web.data = results

web_to_llm = Dataflow(web, llm_api, "Chat completion request")
web_to_llm.protocol = "HTTPS"
web_to_llm.dstPort = 443

tm.process()

Hai anche la possibilità di usare pytmGPT per creare i tuoi modelli da testo libero!

Generazione dei diagrammi

I diagrammi vengono generati come Dot e PlantUML.

Quando l'argomento --dfd viene passato al file tm.py sopra citato, genera l'output su stdout, che viene passato a dot di Graphviz per generare il Data Flow Diagram:```bash

tm.py --dfd | dot -Tpng -o sample.png

Genera questo diagramma:

dfd.png

L'aggiunta di attributi ".levels = [1,2]" a un elemento determina se renderizzare o meno l'elemento (e i relativi Dataflows, se entrambe le estremità del flusso si trovano nello stesso livello DFD), in base all'argomento del comando "--levels 1 2".

Il seguente comando genera un diagramma di sequenza.```bash

tm.py --seq | java -Djava.awt.headless=true -jar plantuml.jar -tpng -pipe > seq.png

Genera questo diagramma:

seq.png

Creazione di un report

I diagrammi e i risultati possono essere inclusi nel modello per creare un report finale:```bash

tm.py --report docs/basic_template.md | pandoc -f markdown -t html > report.html

Il formato di templating utilizzato nel modello di report è molto semplice:```text

# Threat Model Sample
***

## System Description

{tm.description}

## Dataflow Diagram

![Level 0 DFD](https://raw.githubusercontent.com/owasp/pytm/HEAD/dfd.png)

## Dataflows

Name|From|To |Data|Protocol|Port
----|----|---|----|--------|----
{dataflows:repeat:{{item.name}}|{{item.source.name}}|{{item.sink.name}}|{{item.data}}|{{item.protocol}}|{{item.dstPort}}
}

## Findings

{findings:repeat:* {{item.description}} on element "{{item.target}}"
}

Per raggruppare i risultati per elementi, utilizza un ciclo annidato più avanzato:```text

Findings

{elements🔁{{item.findings:if:

{{item.findings🔁 Threat: {{{{item.id}}}} - {{{{item.description}}}}

Severity: {{{{item.severity}}}}

Mitigations: {{{{item.mitigations}}}}

References: {{{{item.references}}}}

}}}}}

Tutti gli elementi all'interno di un loop devono essere escapati, raddoppiando le parentesi graffe, quindi `{item.name}` diventa `{{item.name}}`.
L'esempio sopra utilizza due loop annidati, quindi gli elementi nel loop interno devono essere escapati due volte, ed è per questo che usano quattro parentesi graffe.

### Override

Puoi sovrascrivere gli attributi dei finding (minacce che corrispondono agli asset e/o ai dataflow del modello), ad esempio per impostare un punteggio CVSS personalizzato e/o un testo di risposta:```python
user_to_web = Dataflow(user, web, "User enters comments (*)", protocol="HTTP", dstPort="80")
user_to_web.overrides = [
    Finding(
        # Overflow Buffers
        threat_id="INP02",
        cvss="9.3",
        response="""**To Mitigate**: run a memory sanitizer to validate the binary""",
        severity="Very High",
    )
]

Se stai aggiungendo un Finding, assicurati di aggiungere una severità: "Very High", "High", "Medium", "Low", "Very Low".

Database delle minacce

Per il professionista della sicurezza, puoi fornire il tuo file di minacce impostando TM.threatsFile. Dovrebbe contenere voci come:```json { "SID":"INP01", "target": ["Lambda","Process"], "description": "Buffer Overflow via Environment Variables", "details": "This attack pattern involves causing a buffer overflow through manipulation of environment variables. Once the attacker finds that they can modify an environment variable, they may try to overflow associated buffers. This attack leverages implicit trust often placed in environment variables.", "Likelihood Of Attack": "High", "severity": "High", "condition": "target.usesEnvironmentVariables is True and target.controls.sanitizesInput is False and target.controls.checksInputBounds is False", "prerequisites": "The application uses environment variables.An environment variable exposed to the user is vulnerable to a buffer overflow.The vulnerable environment variable uses untrusted data.Tainted data used in the environment variables is not properly validated. For instance boundary checking is not done before copying the input data to a buffer.", "mitigations": "Do not expose environment variable to the user.Do not use untrusted data in your environment variables. Use a language or compiler that performs automatic bounds checking. There are tools such as Sharefuzz [R.10.3] which is an environment variable fuzzer for Unix that support loading a shared library. You can use Sharefuzz to determine if you are exposing an environment variable vulnerable to buffer overflow.", "example": "Attack Example: Buffer Overflow in $HOME A buffer overflow in sccw allows local users to gain root access via the $HOME environmental variable. Attack Example: Buffer Overflow in TERM A buffer overflow in the rlogin program involves its consumption of the TERM environmental variable.", "references": "https://capec.mitre.org/data/definitions/10.html, CVE-1999-0906, CVE-1999-0046, http://cwe.mitre.org/data/definitions/120.html, http://cwe.mitre.org/data/definitions/119.html, http://cwe.mitre.org/data/definitions/680.html" }

The `target` field elenca le classi di elementi del modello a cui far corrispondere questa minaccia.
Questi possono essere asset, come: Actor, Datastore, Server, Process, SetOfProcesses, ExternalEntity,
Lambda, LLM, Agent o Element, che è la classe base e corrisponde a qualsiasi. Può anche essere un Dataflow che collega due asset.

Tutti gli altri campi (tranne `condition`) sono disponibili per la visualizzazione e possono essere usati nel template
per elencare i riscontri nel [report](#report) finale.

> **AVVERTENZA**
>
> Il file `threats.json` contiene stringhe che passano attraverso `eval()`. Assicurati che il file abbia i permessi corretti
> o rischi che un attaccante modifichi le stringhe e ti induca a eseguire codice per suo conto.

La logica risiede nella `condition`, in cui i membri di `target` possono essere valutati logicamente.
Restituire true significa che la regola genera un riscontro, altrimenti non è un riscontro.
La condizione può confrontare attributi di `target` e/o attributi di controllo di 'target.control' e può anche chiamare uno di questi metodi:

* `target.oneOf(class, ...)` dove `class` è una o più tra: Actor, Datastore, Server, Process, SetOfProcesses, ExternalEntity, Lambda, LLM, Agent o Dataflow,
* `target.crosses(Boundary)`,
* `target.enters(Boundary)`,
* `target.exits(Boundary)`,
* `target.inside(Boundary)`.

Se `target` è un Dataflow, ricorda che puoi accedere a `target.source` e/o `target.sink` insieme ad altri attributi.

Le condizioni sugli asset possono analizzare tutti i Dataflow in ingresso e in uscita ispezionando
gli attributi `target.input` e `target.output`. Ad esempio, per far corrispondere una minaccia solo a
server con traffico in ingresso, usa `any(target.inputs)`. Un esempio più avanzato,
che corrisponde a elementi che si collegano a datastore SQL, sarebbe `any(f.sink.oneOf(Datastore) and f.sink.type == DatastoreType.SQL for f in target.outputs)`.

## Importazione da JSON

Con un po' di codice Python è possibile importare un modello di minacce da JSON (nota il formato speciale nell'esempio che si trova in `tests/input.json`). L'esempio seguente importa l'esempio `input.json` presente nei test. Salva il seguente codice come `tm2.py`.```python

#!/usr/bin/env python3
# Example tm2.py contents
# Run: python tm2.py --dfd | dot -Tpng -o sample_json.png

from pytm import (
    TM,
    Actor,
    Boundary,
    Classification,
    Data,
    Dataflow,
    Datastore,
    Lambda,
    Server,
    DatastoreType,
    Assumption,
    load,
)

json_file_string = './tests/input.json'
with open(json_file_string) as input_json:
    TM.reset()
    tm = load(input_json)
    tm.process()

Possiamo chiamare tm2.py nello stesso modo di prima, qui con --dfd, e poi reindirizzare l'output a Graphviz (dot):```bash

python tm2.py --dfd | dot -Tpng -o sample_json.png

## Creare slide!

Una volta che un modello di minacce è completato e pronto, arriva la temuta fase di presentazione - e ora pytm può aiutarti anche in questo, con un template che esprime il tuo modello di minacce in slide, usando la potenza di (RevealMD)[https://github.com/webpro/reveal-md]! Basta usare il template docs/revealjs.md e otterrai delle belle slide, completamente configurabili, che puoi presentare e condividere dal tuo browser.



https://github.com/izar/pytm/assets/368769/30218241-c7cc-4085-91e9-bbec2843f838



## Minacce attualmente supportate```text
INP01 - Buffer Overflow via Environment Variables
INP02 - Overflow Buffers
INP03 - Server Side Include (SSI) Injection
CR01 - Session Sidejacking
INP04 - HTTP Request Splitting
CR02 - Cross Site Tracing
INP05 - Command Line Execution through SQL Injection
INP06 - SQL Injection through SOAP Parameter Tampering
SC01 - JSON Hijacking (aka JavaScript Hijacking)
LB01 - API Manipulation
AA01 - Authentication Abuse/ByPass
DS01 - Excavation
DE01 - Interception
DE02 - Double Encoding
API01 - Exploit Test APIs
AC01 - Privilege Abuse
INP07 - Buffer Manipulation
AC02 - Shared Data Manipulation
DO01 - Flooding
HA01 - Path Traversal
AC03 - Subverting Environment Variable Values
DO02 - Excessive Allocation
DS02 - Try All Common Switches
INP08 - Format String Injection
INP09 - LDAP Injection
INP10 - Parameter Injection
INP11 - Relative Path Traversal
INP12 - Client-side Injection-induced Buffer Overflow
AC04 - XML Schema Poisoning
DO03 - XML Ping of the Death
AC05 - Content Spoofing
INP13 - Command Delimiters
INP14 - Input Data Manipulation
DE03 - Sniffing Attacks
CR03 - Dictionary-based Password Attack
API02 - Exploit Script-Based APIs
HA02 - White Box Reverse Engineering
DS03 - Footprinting
AC06 - Using Malicious Files
HA03 - Web Application Fingerprinting
SC02 - XSS Targeting Non-Script Elements
AC07 - Exploiting Incorrectly Configured Access Control Security Levels
INP15 - IMAP/SMTP Command Injection
HA04 - Reverse Engineering
SC03 - Embedding Scripts within Scripts
INP16 - PHP Remote File Inclusion
AA02 - Principal Spoof
CR04 - Session Credential Falsification through Forging
DO04 - XML Entity Expansion
DS04 - XSS Targeting Error Pages
SC04 - XSS Using Alternate Syntax
CR05 - Encryption Brute Forcing
AC08 - Manipulate Registry Information
DS05 - Lifting Sensitive Data Embedded in Cache
SC05 - Removing Important Client Functionality
INP17 - XSS Using MIME Type Mismatch
AA03 - Exploitation of Trusted Credentials
AC09 - Functionality Misuse
INP18 - Fuzzing and observing application log data/errors for application mapping
CR06 - Communication Channel Manipulation
AC10 - Exploiting Incorrectly Configured SSL
CR07 - XML Routing Detour Attacks
AA04 - Exploiting Trust in Client
CR08 - Client-Server Protocol Manipulation
INP19 - XML External Entities Blowup
INP20 - iFrame Overlay
AC11 - Session Credential Falsification through Manipulation
INP21 - DTD Injection
INP22 - XML Attribute Blowup
INP23 - File Content Injection
DO05 - XML Nested Payloads
AC12 - Privilege Escalation
AC13 - Hijacking a privileged process
AC14 - Catching exception throw/signal from privileged block
INP24 - Filter Failure through Buffer Overflow
INP25 - Resource Injection
INP26 - Code Injection
INP27 - XSS Targeting HTML Attributes
INP28 - XSS Targeting URI Placeholders
INP29 - XSS Using Doubled Characters
INP30 - XSS Using Invalid Characters
INP31 - Command Injection
INP32 - XML Injection
INP33 - Remote Code Inclusion
INP34 - SOAP Array Overflow
INP35 - Leverage Alternate Encoding
DE04 - Audit Log Manipulation
AC15 - Schema Poisoning
INP36 - HTTP Response Smuggling
INP37 - HTTP Request Smuggling
INP38 - DOM-Based XSS
AC16 - Session Credential Falsification through Prediction
INP39 - Reflected XSS
INP40 - Stored XSS
AC17 - Session Hijacking - ServerSide
AC18 - Session Hijacking - ClientSide
INP41 - Argument Injection
AC19 - Reusing Session IDs (aka Session Replay) - ServerSide
AC20 - Reusing Session IDs (aka Session Replay) - ClientSide
AC21 - Cross Site Request Forgery
DS06 - Data Leak
DR01 - Unprotected Sensitive Data
AC22 - Credentials Aging (deprecated)
AC23 - Credentials Disclosure
AC24 - Use of hardcoded credentials
LLM01 - Direct Prompt Injection
LLM02 - Indirect Prompt Injection via Retrieved Content
LLM03 - Sensitive Data Leakage to Third-Party Provider
LLM04 - Training Data Poisoning
LLM05 - Excessive Agency via Unauthorized Tool Use
LLM06 - Arbitrary Code Execution via LLM Agent
LLM07 - Jailbreaking and Safety Bypass
LLM08 - Sensitive Information Disclosure Through Output
LLM09 - Untrusted Tool Launch Configuration

pytm

Più Popolari