Skip to content

Commit 70257a7

Browse files
authored
Update README.rst
1 parent 92fa3b7 commit 70257a7

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,17 @@ Soon you will find a `README.rst`_ in every directory in the ``pyt/`` folder, `s
6363
How to Use
6464
============
6565

66-
1. Choose a web framework: `The -a option determines which functions will have their arguments tainted`_, by default it is Flask.
66+
1. Choose a web framework
6767

68-
2. (optional) Customize source and sink information: Use the ``-t`` option to specify sources and sinks, by default `this file is used`_.
68+
`The -a option determines which functions will have their arguments tainted`_, by default it is Flask.
6969

70-
3. (optional) Customize which library functions propagate taint: For functions that are imported from libraries, e.g. ``url_for`` or ``os.path.join``, use the ``-m`` option to specify whether or not they return tainted values given tainted inputs, by `default this file is used`_.
70+
2. (optional) Customize source and sink information
71+
72+
Use the ``-t`` option to specify sources and sinks, by default `this file is used`_.
73+
74+
3. (optional) Customize which library functions propagate taint
75+
76+
For functions from builtins or libraries, e.g. ``url_for`` or ``os.path.join``, use the ``-m`` option to specify whether or not they return tainted values given tainted inputs, by `default this file is used`_.
7177

7278
.. _The -a option determines which functions will have their arguments tainted: https://github.com/python-security/pyt/tree/master/pyt/web_frameworks#web-frameworks
7379
.. _this file is used: https://github.com/python-security/pyt/blob/master/pyt/vulnerability_definitions/all_trigger_words.pyt

0 commit comments

Comments
 (0)