From c0446b5c2e86ae9ffc5f4f07517ee9bab5f5b2b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Porte=C5=A1?= Date: Thu, 5 May 2022 21:34:44 +0200 Subject: [PATCH] Make small fixes in docs * 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` --- bandit/plugins/hashlib_insecure_functions.py | 2 ++ bandit/plugins/injection_sql.py | 2 +- bandit/plugins/logging_config_insecure_listen.py | 3 +++ doc/source/blacklists/index.rst | 3 ++- .../plugins/b109_password_config_option_not_marked_secret.rst | 2 ++ ...p_weak_cryptography.rst => b509_snmp_weak_cryptography.rst} | 0 6 files changed, 10 insertions(+), 2 deletions(-) rename doc/source/plugins/{b508_snmp_weak_cryptography.rst => b509_snmp_weak_cryptography.rst} (100%) diff --git a/bandit/plugins/hashlib_insecure_functions.py b/bandit/plugins/hashlib_insecure_functions.py index a60bd1e09..30627a060 100644 --- a/bandit/plugins/hashlib_insecure_functions.py +++ b/bandit/plugins/hashlib_insecure_functions.py @@ -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 diff --git a/bandit/plugins/injection_sql.py b/bandit/plugins/injection_sql.py index 7f0d8ccfc..c69750ca1 100644 --- a/bandit/plugins/injection_sql.py +++ b/bandit/plugins/injection_sql.py @@ -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 diff --git a/bandit/plugins/logging_config_insecure_listen.py b/bandit/plugins/logging_config_insecure_listen.py index f83b7ee75..96815f036 100644 --- a/bandit/plugins/logging_config_insecure_listen.py +++ b/bandit/plugins/logging_config_insecure_listen.py @@ -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 diff --git a/doc/source/blacklists/index.rst b/doc/source/blacklists/index.rst index 0f5213413..98385e773 100644 --- a/doc/source/blacklists/index.rst +++ b/doc/source/blacklists/index.rst @@ -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 diff --git a/doc/source/plugins/b109_password_config_option_not_marked_secret.rst b/doc/source/plugins/b109_password_config_option_not_marked_secret.rst index 2dcdce001..0fb5b3349 100644 --- a/doc/source/plugins/b109_password_config_option_not_marked_secret.rst +++ b/doc/source/plugins/b109_password_config_option_not_marked_secret.rst @@ -19,7 +19,9 @@ issue. **Config Options:** + .. code-block:: yaml + password_config_option_not_marked_secret: function_names: - oslo.config.cfg.StrOpt diff --git a/doc/source/plugins/b508_snmp_weak_cryptography.rst b/doc/source/plugins/b509_snmp_weak_cryptography.rst similarity index 100% rename from doc/source/plugins/b508_snmp_weak_cryptography.rst rename to doc/source/plugins/b509_snmp_weak_cryptography.rst