search

Threagile / threagile

Agile Threat Modeling Toolkit
https://threagile.io
MIT License
603 stars 128 forks source link

Create more documentation regarding tech/protocol types, diagram color legend, and usage of schema json etc. #13

Open cschneider4711 opened 3 years ago

cschneider4711 commented 3 years ago

This issue is to track the creation of aforementioned documentation

chujiaoma commented 2 years ago

Hi, I was wondering where is the documentation regarding the protocol types? I'd also be interested to know more about how the different types of authorization for technical asset is defined and used? thanks.

dAnjou commented 2 years ago

It'd also be super useful to know which fields and values have what kind of implication on the output. Like, how does the output change if I change confidentiality from internal to restricted, or doesn't that make a difference at all?

cschneider4711 commented 11 months ago

First part of docs have been added via recent PRs (thx to @Thorsten-Sick ) and direct commits: Now several explanation switches on the CLI can be used to list these (basic still) explanations:

  -explain-model-macros
        Detailed explanation of all the model macros
  -explain-risk-rules
        Detailed explanation of all the risk rules
  -explain-types
        Detailed explanation of all the types

... each of them returning the details in the console then.