Skip to content

Commit b6129cf

Browse files
authored
Separated the important options from the rest
This readme is shitty, I need to improve it
1 parent 3126aae commit b6129cf

File tree

1 file changed

+29
-5
lines changed

1 file changed

+29
-5
lines changed

README.rst

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,35 +72,59 @@ Usage
7272
required arguments:
7373
targets source file(s) or directory(s) to be tested
7474
75-
optional arguments:
75+
important optional arguments:
7676
-a ADAPTOR, --adaptor ADAPTOR
7777
Choose a web framework adaptor: Flask(Default),
7878
Django, Every or Pylons
79+
80+
-t TRIGGER_WORD_FILE, --trigger-word-file TRIGGER_WORD_FILE
81+
Input file with a list of sources and sinks
82+
83+
-m BLACKBOX_MAPPING_FILE, --blackbox-mapping-file BLACKBOX_MAPPING_FILE
84+
Input blackbox mapping file
85+
86+
optional arguments:
7987
-pr PROJECT_ROOT, --project-root PROJECT_ROOT
8088
Add project root, only important when the entry file
8189
is not at the root of the project.
8290
-b BASELINE_JSON_FILE, --baseline BASELINE_JSON_FILE
8391
Path of a baseline report to compare against (only
8492
JSON-formatted files are accepted)
8593
-j, --json Prints JSON instead of report.
86-
-m BLACKBOX_MAPPING_FILE, --blackbox-mapping-file BLACKBOX_MAPPING_FILE
87-
Input blackbox mapping file.
88-
-t TRIGGER_WORD_FILE, --trigger-word-file TRIGGER_WORD_FILE
89-
Input file with a list of sources and sinks
9094
-o OUTPUT_FILE, --output OUTPUT_FILE
9195
write report to filename
9296
--ignore-nosec do not skip lines with # nosec comments
9397
-r, --recursive find and process files in subdirectories
9498
-x EXCLUDED_PATHS, --exclude EXCLUDED_PATHS
9599
Separate files with commas
96100
101+
97102
print arguments:
98103
-trim, --trim-reassigned-in
99104
Trims the reassigned list to just the vulnerability
100105
chain.
101106
-i, --interactive Will ask you about each blackbox function call in
102107
vulnerability chains.
103108
109+
Choosing a Web Framework
110+
========================
111+
112+
`The -a option chooses what functions will have their arguments tainted`_
113+
114+
.. _The -a option chooses what functions will have their arguments tainted: https://github.com/python-security/pyt/tree/master/pyt/web_frameworks#web-frameworks
115+
116+
Configuring Source and Sink Information
117+
=======================================
118+
119+
Use the ``-t`` option to specify sources and sinks, by default `this file is used`_.
120+
121+
.. _this file is used: https://github.com/python-security/pyt/blob/master/pyt/vulnerability_definitions/all_trigger_words.pyt
122+
123+
For functions that are imported from libraries, use the ``-m`` option to specify whether or not they
124+
return tainted values given tainted inputs, by `default this file is used`_.
125+
126+
.. _default this file is used: https://github.com/python-security/pyt/blob/master/pyt/vulnerability_definitions/blackbox_mapping.json)
127+
104128
Usage from Source
105129
=================
106130

0 commit comments

Comments
 (0)