Skip to content

Commit b546efb

Browse files
author
izar tarandach
committed
better have some documentation as well...
1 parent 6da8601 commit b546efb

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,9 @@ make
6060
All available arguments:
6161

6262
```text
63-
usage: tm.py [-h] [--sqldump SQLDUMP] [--debug] [--dfd] [--report REPORT]
64-
[--exclude EXCLUDE] [--seq] [--list] [--describe DESCRIBE]
65-
[--list-elements] [--json JSON] [--levels LEVELS [LEVELS ...]]
66-
[--stale_days STALE_DAYS]
63+
usage: tm.py [-h] [--sqldump SQLDUMP] [--debug] [--dfd] [--report REPORT] [--exclude EXCLUDE] [--seq] [--list] [--colormap]
64+
[--describe DESCRIBE] [--list-elements] [--json JSON] [--levels LEVELS [LEVELS ...]] [--stale_days STALE_DAYS]
65+
[--threat-files THREAT_FILES [THREAT_FILES ...]]
6766
6867
optional arguments:
6968
-h, --help show this help message and exit
@@ -87,10 +86,18 @@ optional arguments:
8786
checks if the delta between the TM script and the code
8887
described by it is bigger than the specified value in
8988
days
89+
--threat-files THREAT_FILES [THREAT_FILES ...]
90+
Files containing libraries of threats.
9091
```
9192

9293
The *stale_days* argument tries to determine how far apart in days the model script (which you are writing) is from the code that implements the system being modeled. Ideally, they should be pretty close in most cases of an actively developed system. You can run this periodically to measure the pulse of your project and the 'freshness' of your threat model.
9394

95+
The *THREAT_FILES* argument can list proprietary threat files. The keyword 'default' stands for the pytm library when it is wanted together with the proprietary files:
96+
97+
* nothing in the command line: uses the default library
98+
* --threat-files foo.json : uses the threats in foo.json only
99+
* --threat-files foo.json default : uses the threats in foo.json and the default ones
100+
94101
Currently available elements are: TM, Element, Server, ExternalEntity, Datastore, Actor, Process, SetOfProcesses, Dataflow, Boundary and Lambda.
95102

96103
The available properties of an element can be listed by using `--describe` followed by the name of an element:

0 commit comments

Comments
 (0)