एक उदाहरण `Makefile` भी है जो इन सभी को टारगेट में लपेटता है जिन्हें कई मॉडलों के लिए आसानी से साझा किया जा सकता है। यदि आपके पास [GNU make](https://www.gnu.org/software/make/) स्थापित है (डिफ़ॉल्ट रूप से Linux distros पर उपलब्ध है लेकिन OSX पर नहीं), तो बस चलाएँ:```
make MODEL=the_name_of_your_model_minus_.py

### आरंभ करना - Devbox प्रकार

`pytm` के उपयोग को सरल बनाने के लिए होस्ट निर्भरताओं को पूरी तरह से पृथक किया जा सकता है
[`Devbox`](https://github.com/jetify-com/devbox) का उपयोग करके। यह आमतौर पर एक
कम ओवरहेड और OCI कंटेनर दृष्टिकोण की तुलना में अधिक सुविधाजनक विकल्प है।

- Linux/MacOS पर Devbox इंस्टॉल करें: `curl -fsSL https://get.jetify.com/devbox | bash`
- Devbox को [Windows/WSL](https://www.jetify.com/docs/devbox/installing-devbox/index#installing-wsl2) पर इंस्टॉल करें
- devbox को नवीनतम संस्करण में अपडेट करें: `devbox version update`
- अपना GitHub एक्सेस टोकन `~/.config/nix/nix.conf` फ़ाइल में सेट करें: `access-tokens = github.com=YOUR_TOKEN_HERE`
- एक नया, पृथक शेल वातावरण बनाएं जिसमें प्रोजेक्ट की `devbox.json` फ़ाइल में निर्दिष्ट सभी उपकरण और पैकेज शामिल हों: `devbox shell`
- जब आप अपने टर्मिनल में केवल `python` टाइप करते हैं तो उपयोग होने वाले Python executable का पूर्ण पथ प्रदर्शित करने के लिए which python कमांड का उपयोग करें। आउटपुट निम्न पथ होना चाहिए:  `.devbox/nix/profile/default/bin/python`
- निम्न कमांड चलाकर परीक्षण करें, जो `sample.png` नामक PNG फ़ाइल के रूप में DFD उत्पन्न करना चाहिए:  `./tm.py --dfd | dot -Tpng -o sample.png`
- Devbox शेल वातावरण से बाहर निकलें: `exit`


## उपयोग

सभी उपलब्ध तर्क:```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

The *colormap* argument, used together with *dfd*, outputs a color-coded DFD where the elements are painted red, yellow or green depending on their risk level (as identified by running the rules).

## उपयोग - Devbox वेरिएंट

- `devbox shell`
- `pytm` का उपयोग हमेशा की तरह
- `exit`

## थ्रेट मॉडल बनाना

निम्नलिखित एक नमूना `tm.py` फ़ाइल है जो एक सरल एप्लिकेशन का वर्णन करती है जहाँ एक उपयोगकर्ता एप्लिकेशन में लॉगिन करता है और ऐप पर टिप्पणियाँ पोस्ट करता है। ऐप सर्वर उन टिप्पणियों को डेटाबेस में संग्रहीत करता है। एक AWS Lambda है जो समय-समय पर डेटाबेस को साफ करता है।```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, "(λ)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()

यह डायग्राम उत्पन्न करता है:

dfd.png

किसी एलिमेंट में `".levels = [1,2]"` एट्रिब्यूट जोड़ने से वह (और उससे जुड़े Dataflows, यदि दोनों flow endings एक ही DFD level में हों) कमांड आर्गुमेंट `"--levels 1 2"` के आधार पर render (या नहीं render) होगा।

निम्नलिखित कमांड एक Sequence डायग्राम उत्पन्न करता है।```bash

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

रिपोर्ट टेम्पलेट में उपयोग किया जाने वाला टेम्पलेटिंग प्रारूप बहुत सरल है:```text

# Threat Model Sample
***

## System Description

{tm.description}

## Dataflow Diagram

![Level 0 DFD](https://raw.githubusercontent.com/owasp/pytm/master/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}}"
}

लूप के अंदर के सभी आइटम्स को एस्केप किया जाना चाहिए, ब्रेसेस को दोगुना करके, इसलिए `{item.name}` बन जाता है `{{item.name}}`।
ऊपर दिया गया उदाहरण दो नेस्टेड लूप का उपयोग करता है, इसलिए आंतरिक लूप के आइटम्स को दो बार एस्केप करना होता है, यही कारण है कि वे चार ब्रेसेस का उपयोग कर रहे हैं।

### ओवरराइड्स

आप फाइंडिंग्स (मॉडल एसेट्स और/या डेटाफ्लो से मेल खाने वाले थ्रेट्स) की विशेषताओं को ओवरराइड कर सकते हैं, उदाहरण के लिए कस्टम CVSS स्कोर और/या रिस्पॉन्स टेक्स्ट सेट करने के लिए:```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",
    )
]

`target` फ़ील्ड उन मॉडल तत्वों के वर्गों की सूची देती है जिनसे इस खतरे (threat) का मिलान किया जाना है। ये एसेट हो सकते हैं, जैसे: Actor, Datastore, Server, Process, SetOfProcesses, ExternalEntity, Lambda, LLM, Agent या Element, जो आधार वर्ग है और किसी से भी मेल खाता है। यह एक Dataflow भी हो सकता है जो दो एसेट्स को जोड़ता है।

अन्य सभी फ़ील्ड (`condition` को छोड़कर) प्रदर्शन के लिए उपलब्ध हैं और टेम्पलेट में अंतिम [report](#report) में निष्कर्षों (findings) को सूचीबद्ध करने के लिए उपयोग की जा सकती हैं।

> **WARNING**
>
> `threats.json` फ़ाइल में ऐसी स्ट्रिंग्स हैं जो `eval()` से गुजरती हैं। सुनिश्चित करें कि फ़ाइल के पास सही अनुमतियाँ हैं, अन्यथा किसी हमलावर के स्ट्रिंग्स बदल देने पर आप उनकी ओर से कोड चला सकते हैं।

तर्क `condition` में रहता है, जहाँ `target` के सदस्यों का तार्किक मूल्यांकन किया जा सकता है। true लौटने का अर्थ है कि नियम एक निष्कर्ष उत्पन्न करता है, अन्यथा यह निष्कर्ष नहीं है। Condition `target` की विशेषताओं और/या 'target.control' की नियंत्रण विशेषताओं की तुलना कर सकता है और इनमें से किसी एक विधि को भी कॉल कर सकता है:

* `target.oneOf(class, ...)` जहाँ `class` एक या अधिक हो सकते हैं: Actor, Datastore, Server, Process, SetOfProcesses, ExternalEntity, Lambda, LLM, Agent या Dataflow,
* `target.crosses(Boundary)`,
* `target.enters(Boundary)`,
* `target.exits(Boundary)`,
* `target.inside(Boundary)`.

यदि `target` एक Dataflow है, तो याद रखें कि आप अन्य विशेषताओं के साथ `target.source` और/या `target.sink` भी एक्सेस कर सकते हैं।

एसेट्स पर शर्तें `target.input` और `target.output` विशेषताओं का निरीक्षण करके सभी आने वाले और जाने वाले Dataflows का विश्लेषण कर सकती हैं। उदाहरण के लिए, किसी खतरे का मिलान केवल इनकमिंग ट्रैफ़िक वाले सर्वरों से करने के लिए, `any(target.inputs)` का उपयोग करें। एक अधिक उन्नत उदाहरण, SQL डेटास्टोर्स से जुड़ने वाले तत्वों का मिलान करना होगा: `any(f.sink.oneOf(Datastore) and f.sink.type == DatastoreType.SQL for f in target.outputs)`।

## JSON से आयात करना

थोड़े से Python कोड के साथ, JSON से एक खतरा मॉडल (threat model) आयात करना संभव है (`tests/input.json` में मौजूद उदाहरण में विशेष प्रारूप पर ध्यान दें)। निम्नलिखित उदाहरण tests में पाया गया `input.json` उदाहरण आयात करता है। निम्नलिखित कोड को `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()

## स्लाइड्स बनाना!

एक बार जब थ्रेट मॉडल पूर्ण और तैयार हो जाता है, तो भयावह प्रस्तुति चरण आता है - और अब pytm वहाँ भी आपकी मदद कर सकता है, एक टेम्पलेट के साथ जो आपके थ्रेट मॉडल को स्लाइड्स में व्यक्त करता है, (RevealMD)[https://github.com/webpro/reveal-md] की शक्ति का उपयोग करते हुए! बस docs/revealjs.md टेम्पलेट का उपयोग करें और आपको कुछ सुंदर, पूरी तरह से कॉन्फ़िगर करने योग्य स्लाइड्स मिलेंगी, जिन्हें आप अपने ब्राउज़र से प्रस्तुत और साझा कर सकते हैं।



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



## वर्तमान में समर्थित खतरे```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