Skip to content

Commit

Permalink
Make small fixes in docs (#899)
Browse files Browse the repository at this point in the history
* add missing `code-block` RST directives and/or surrounding blank lines
* fix issue ID in `b508_snmp_weak_cryptography.rst` filename
* fix outdated example filename in docstring of `injection_sql.py`
  • Loading branch information
mportesdev committed May 15, 2022
1 parent 0e3f6e7 commit 7104b33
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 2 deletions.
2 changes: 2 additions & 0 deletions bandit/plugins/hashlib_insecure_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
:Example:
.. code-block:: none
>> Issue: [B324:hashlib] Use of weak MD4, MD5, or SHA1 hash for
security. Consider usedforsecurity=False
Severity: High Confidence: High
Expand Down
2 changes: 1 addition & 1 deletion bandit/plugins/injection_sql.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
construction.
Severity: Medium Confidence: Low
CWE: CWE-89 (https://cwe.mitre.org/data/definitions/89.html)
Location: ./examples/sql_statements_without_sql_alchemy.py:4
Location: ./examples/sql_statements.py:4
3 query = "DELETE FROM foo WHERE id = '%s'" % identifier
4 query = "UPDATE foo SET value = 'b' WHERE id = '%s'" % identifier
5
Expand Down
3 changes: 3 additions & 0 deletions bandit/plugins/logging_config_insecure_listen.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
across the socket with signature verification or encryption/decryption.
:Example:
.. code-block:: none
>> Issue: [B612:logging_config_listen] Use of insecure
logging.config.listen detected.
Severity: Medium Confidence: High
Expand Down
3 changes: 2 additions & 1 deletion doc/source/blacklists/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ A utility method bandit.blacklists.utils.build_conf_dict is provided to aid
building these dictionaries.

:Example:
.. code-block:: none

.. code-block:: none
>> Issue: [B317:blacklist] Using xml.sax.parse to parse untrusted XML data
is known to be vulnerable to XML attacks. Replace xml.sax.parse with its
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ issue.


**Config Options:**

.. code-block:: yaml
password_config_option_not_marked_secret:
function_names:
- oslo.config.cfg.StrOpt
Expand Down

0 comments on commit 7104b33

Please sign in to comment.