Merge pull request #5171 from RasmusWL/restructure-queries

Python: Restructure query file layout
2025-12-20 10:46:30 +01:00 · 2021-02-17 12:09:32 +01:00
parent ec79094957 cf9ad0cdc5
commit 8caafb3710
225 changed files with 42 additions and 40 deletions
--- a/python/ql/src/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.py
+++ b/python/ql/src/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.py
--- a/python/ql/src/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.qhelp
+++ b/python/ql/src/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.qhelp
--- a/python/ql/src/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.ql
+++ b/python/ql/src/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.ql
--- a/python/ql/src/Security/BadPractice/FlaskRunWithDebug/FlaskDebug.py
+++ b/python/ql/src/Security/BadPractice/FlaskRunWithDebug/FlaskDebug.py
--- a/python/ql/src/Security/BadPractice/FlaskRunWithDebug/FlaskDebug.qhelp
+++ b/python/ql/src/Security/BadPractice/FlaskRunWithDebug/FlaskDebug.qhelp
--- a/python/ql/src/Security/BadPractice/FlaskRunWithDebug/FlaskDebug.ql
+++ b/python/ql/src/Security/BadPractice/FlaskRunWithDebug/FlaskDebug.ql
--- a/python/ql/src/Security/BadPractice/HTTPSRequestWithoutCertValidation/HTTPSRequestWithoutCertValidation.qhelp
+++ b/python/ql/src/Security/BadPractice/HTTPSRequestWithoutCertValidation/HTTPSRequestWithoutCertValidation.qhelp
--- a/python/ql/src/Security/BadPractice/HTTPSRequestWithoutCertValidation/HTTPSRequestWithoutCertValidation.ql
+++ b/python/ql/src/Security/BadPractice/HTTPSRequestWithoutCertValidation/HTTPSRequestWithoutCertValidation.ql
--- a/python/ql/src/Security/BadPractice/HTTPSRequestWithoutCertValidation/examples/make_request.py
+++ b/python/ql/src/Security/BadPractice/HTTPSRequestWithoutCertValidation/examples/make_request.py
--- a/python/ql/src/Security/BadPractice/HardcodedCredentials/HardcodedCredentials.py
+++ b/python/ql/src/Security/BadPractice/HardcodedCredentials/HardcodedCredentials.py
--- a/python/ql/src/Security/BadPractice/HardcodedCredentials/HardcodedCredentials.qhelp
+++ b/python/ql/src/Security/BadPractice/HardcodedCredentials/HardcodedCredentials.qhelp
--- a/python/ql/src/Security/BadPractice/HardcodedCredentials/HardcodedCredentials.ql
+++ b/python/ql/src/Security/BadPractice/HardcodedCredentials/HardcodedCredentials.ql
--- a/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/IncompleteHostnameRegExp.qhelp
+++ b/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/IncompleteHostnameRegExp.qhelp
--- a/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/IncompleteHostnameRegExp.ql
+++ b/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/IncompleteHostnameRegExp.ql
--- a/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/IncompleteUrlSubstringSanitization.qhelp
+++ b/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/IncompleteUrlSubstringSanitization.qhelp
--- a/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/IncompleteUrlSubstringSanitization.ql
+++ b/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/IncompleteUrlSubstringSanitization.ql
--- a/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/examples/IncompleteHostnameRegExp.py
+++ b/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/examples/IncompleteHostnameRegExp.py
--- a/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/examples/IncompleteUrlSubstringSanitization.py
+++ b/python/ql/src/Security/BadPractice/IncompleteUrlSanitizer/examples/IncompleteUrlSubstringSanitization.py
--- a/python/ql/src/Security/BadPractice/InsecureTemporaryFile/InsecureTemporaryFile.py
+++ b/python/ql/src/Security/BadPractice/InsecureTemporaryFile/InsecureTemporaryFile.py
--- a/python/ql/src/Security/BadPractice/InsecureTemporaryFile/InsecureTemporaryFile.qhelp
+++ b/python/ql/src/Security/BadPractice/InsecureTemporaryFile/InsecureTemporaryFile.qhelp
--- a/python/ql/src/Security/BadPractice/InsecureTemporaryFile/InsecureTemporaryFile.ql
+++ b/python/ql/src/Security/BadPractice/InsecureTemporaryFile/InsecureTemporaryFile.ql
--- a/python/ql/src/Security/BadPractice/InsecureTemporaryFile/SecureTemporaryFile.py
+++ b/python/ql/src/Security/BadPractice/InsecureTemporaryFile/SecureTemporaryFile.py
--- a/python/ql/src/Security/BadPractice/Jinja2RenderWithoutEscape/Jinja2WithoutEscaping.qhelp
+++ b/python/ql/src/Security/BadPractice/Jinja2RenderWithoutEscape/Jinja2WithoutEscaping.qhelp
--- a/python/ql/src/Security/BadPractice/Jinja2RenderWithoutEscape/Jinja2WithoutEscaping.ql
+++ b/python/ql/src/Security/BadPractice/Jinja2RenderWithoutEscape/Jinja2WithoutEscaping.ql
--- a/python/ql/src/Security/BadPractice/Jinja2RenderWithoutEscape/examples/jinja2.py
+++ b/python/ql/src/Security/BadPractice/Jinja2RenderWithoutEscape/examples/jinja2.py
--- a/python/ql/src/Security/BadPractice/SSHMissingHostKeyValidation/SSHMissingHostKeyValidation.qhelp
+++ b/python/ql/src/Security/BadPractice/SSHMissingHostKeyValidation/SSHMissingHostKeyValidation.qhelp
--- a/python/ql/src/Security/BadPractice/SSHMissingHostKeyValidation/SSHMissingHostKeyValidation.ql
+++ b/python/ql/src/Security/BadPractice/SSHMissingHostKeyValidation/SSHMissingHostKeyValidation.ql
--- a/python/ql/src/Security/BadPractice/SSHMissingHostKeyValidation/examples/paramiko_host_key.py
+++ b/python/ql/src/Security/BadPractice/SSHMissingHostKeyValidation/examples/paramiko_host_key.py
--- a/python/ql/src/Security/BadPractice/WeakFilePermissions/WeakFilePermissions.qhelp
+++ b/python/ql/src/Security/BadPractice/WeakFilePermissions/WeakFilePermissions.qhelp
--- a/python/ql/src/Security/BadPractice/WeakFilePermissions/WeakFilePermissions.ql
+++ b/python/ql/src/Security/BadPractice/WeakFilePermissions/WeakFilePermissions.ql
--- a/python/ql/src/Security/Crypto/TLS/InsecureDefaultProtocol.qhelp
+++ b/python/ql/src/Security/Crypto/TLS/InsecureDefaultProtocol.qhelp
--- a/python/ql/src/Security/Crypto/TLS/InsecureDefaultProtocol.ql
+++ b/python/ql/src/Security/Crypto/TLS/InsecureDefaultProtocol.ql
--- a/python/ql/src/Security/Crypto/TLS/InsecureProtocol.qhelp
+++ b/python/ql/src/Security/Crypto/TLS/InsecureProtocol.qhelp
--- a/python/ql/src/Security/Crypto/TLS/InsecureProtocol.ql
+++ b/python/ql/src/Security/Crypto/TLS/InsecureProtocol.ql
--- a/python/ql/src/Security/Crypto/TLS/examples/insecure_default_protocol.py
+++ b/python/ql/src/Security/Crypto/TLS/examples/insecure_default_protocol.py
--- a/python/ql/src/Security/Crypto/TLS/examples/insecure_protocol.py
+++ b/python/ql/src/Security/Crypto/TLS/examples/insecure_protocol.py
--- a/python/ql/src/Security/Crypto/WeakCryptoAlgorithm/WeakCryptoAlgorithm.qhelp
+++ b/python/ql/src/Security/Crypto/WeakCryptoAlgorithm/WeakCryptoAlgorithm.qhelp
@@ -36,7 +36,7 @@
               example uses AES, which is a stronger modern algorithm.
          </p>

-          <sample src="examples/broken_crypto.py" />
+          <sample src="examples/weak_crypto_algorithm.py" />

          <p>
               WARNING: Although the second example above is more robust,
--- a/python/ql/src/Security/Crypto/WeakCryptoAlgorithm/WeakCryptoAlgorithm.ql
+++ b/python/ql/src/Security/Crypto/WeakCryptoAlgorithm/WeakCryptoAlgorithm.ql
--- a/python/ql/src/Security/Crypto/WeakCryptoAlgorithm/examples/weak_crypto_algorithm.py
+++ b/python/ql/src/Security/Crypto/WeakCryptoAlgorithm/examples/weak_crypto_algorithm.py
--- a/python/ql/src/Security/Crypto/WeakCryptoKey/WeakCryptoKey.qhelp
+++ b/python/ql/src/Security/Crypto/WeakCryptoKey/WeakCryptoKey.qhelp
--- a/python/ql/src/Security/Crypto/WeakCryptoKey/WeakCryptoKey.ql
+++ b/python/ql/src/Security/Crypto/WeakCryptoKey/WeakCryptoKey.ql
--- a/python/ql/src/Security/Exposure/SensitiveDataExposure/CleartextLogging.qhelp
+++ b/python/ql/src/Security/Exposure/SensitiveDataExposure/CleartextLogging.qhelp
--- a/python/ql/src/Security/Exposure/SensitiveDataExposure/CleartextLogging.ql
+++ b/python/ql/src/Security/Exposure/SensitiveDataExposure/CleartextLogging.ql
--- a/python/ql/src/Security/Exposure/SensitiveDataExposure/CleartextStorage.qhelp
+++ b/python/ql/src/Security/Exposure/SensitiveDataExposure/CleartextStorage.qhelp
--- a/python/ql/src/Security/Exposure/SensitiveDataExposure/CleartextStorage.ql
+++ b/python/ql/src/Security/Exposure/SensitiveDataExposure/CleartextStorage.ql
--- a/python/ql/src/Security/Exposure/SensitiveDataExposure/examples/password_in_cookie.py
+++ b/python/ql/src/Security/Exposure/SensitiveDataExposure/examples/password_in_cookie.py
--- a/python/ql/src/Security/Exposure/StackTraceExposure/StackTraceExposure.py
+++ b/python/ql/src/Security/Exposure/StackTraceExposure/StackTraceExposure.py
--- a/python/ql/src/Security/Exposure/StackTraceExposure/StackTraceExposure.qhelp
+++ b/python/ql/src/Security/Exposure/StackTraceExposure/StackTraceExposure.qhelp
--- a/python/ql/src/Security/Exposure/StackTraceExposure/StackTraceExposure.ql
+++ b/python/ql/src/Security/Exposure/StackTraceExposure/StackTraceExposure.ql
--- a/python/ql/src/Security/CWE-020-ExternalAPIs/ExternalAPISinkExample.py
+++ b/python/ql/src/Security/CWE-020-ExternalAPIs/ExternalAPISinkExample.py
--- a/python/ql/src/Security/CWE-020-ExternalAPIs/ExternalAPITaintStepExample.py
+++ b/python/ql/src/Security/CWE-020-ExternalAPIs/ExternalAPITaintStepExample.py
--- a/python/ql/src/Security/CWE-020-ExternalAPIs/ExternalAPIs.qll
+++ b/python/ql/src/Security/CWE-020-ExternalAPIs/ExternalAPIs.qll
@@ -41,6 +41,7 @@ private import semmle.python.objects.ObjectInternal
 * A callable that is considered a "safe" external API from a security perspective.
 */
 class SafeExternalAPI extends Unit {
+  /** Gets a callable that is considered a "safe" external API from a security perspective. */
  abstract DataFlowPrivate::DataFlowCallable getSafeCallable();
 }

--- a/python/ql/src/Security/CWE-020-ExternalAPIs/ExternalAPIsUsedWithUntrustedData.qhelp
+++ b/python/ql/src/Security/CWE-020-ExternalAPIs/ExternalAPIsUsedWithUntrustedData.qhelp
--- a/python/ql/src/Security/CWE-020-ExternalAPIs/ExternalAPIsUsedWithUntrustedData.ql
+++ b/python/ql/src/Security/CWE-020-ExternalAPIs/ExternalAPIsUsedWithUntrustedData.ql
--- a/python/ql/src/Security/CWE-020-ExternalAPIs/UntrustedDataToExternalAPI.qhelp
+++ b/python/ql/src/Security/CWE-020-ExternalAPIs/UntrustedDataToExternalAPI.qhelp
--- a/python/ql/src/Security/CWE-020-ExternalAPIs/UntrustedDataToExternalAPI.ql
+++ b/python/ql/src/Security/CWE-020-ExternalAPIs/UntrustedDataToExternalAPI.ql
--- a/python/ql/src/Security/Injection/CodeInjection/CodeInjection.qhelp
+++ b/python/ql/src/Security/Injection/CodeInjection/CodeInjection.qhelp
--- a/python/ql/src/Security/Injection/CodeInjection/CodeInjection.ql
+++ b/python/ql/src/Security/Injection/CodeInjection/CodeInjection.ql
--- a/python/ql/src/Security/Injection/CodeInjection/examples/code_injection.py
+++ b/python/ql/src/Security/Injection/CodeInjection/examples/code_injection.py
--- a/python/ql/src/Security/Injection/CommandInjection/CommandInjection.qhelp
+++ b/python/ql/src/Security/Injection/CommandInjection/CommandInjection.qhelp
--- a/python/ql/src/Security/Injection/CommandInjection/CommandInjection.ql
+++ b/python/ql/src/Security/Injection/CommandInjection/CommandInjection.ql
--- a/python/ql/src/Security/Injection/CommandInjection/examples/command_injection.py
+++ b/python/ql/src/Security/Injection/CommandInjection/examples/command_injection.py
--- a/python/ql/src/Security/Injection/OpenRedirect/OpenRedirect.qhelp
+++ b/python/ql/src/Security/Injection/OpenRedirect/OpenRedirect.qhelp
--- a/python/ql/src/Security/Injection/OpenRedirect/OpenRedirect.ql
+++ b/python/ql/src/Security/Injection/OpenRedirect/OpenRedirect.ql
--- a/python/ql/src/Security/Injection/OpenRedirect/examples/redirect_bad.py
+++ b/python/ql/src/Security/Injection/OpenRedirect/examples/redirect_bad.py
--- a/python/ql/src/Security/Injection/OpenRedirect/examples/redirect_good.py
+++ b/python/ql/src/Security/Injection/OpenRedirect/examples/redirect_good.py
--- a/python/ql/src/Security/Injection/PathInjection/PathInjection.qhelp
+++ b/python/ql/src/Security/Injection/PathInjection/PathInjection.qhelp
--- a/python/ql/src/Security/Injection/PathInjection/PathInjection.ql
+++ b/python/ql/src/Security/Injection/PathInjection/PathInjection.ql
--- a/python/ql/src/Security/Injection/PathInjection/examples/tainted_path.py
+++ b/python/ql/src/Security/Injection/PathInjection/examples/tainted_path.py
--- a/python/ql/src/Security/Injection/ReflectedXss/ReflectedXss.qhelp
+++ b/python/ql/src/Security/Injection/ReflectedXss/ReflectedXss.qhelp
--- a/python/ql/src/Security/Injection/ReflectedXss/ReflectedXss.ql
+++ b/python/ql/src/Security/Injection/ReflectedXss/ReflectedXss.ql
--- a/python/ql/src/Security/Injection/ReflectedXss/examples/xss.py
+++ b/python/ql/src/Security/Injection/ReflectedXss/examples/xss.py
--- a/python/ql/src/Security/Injection/SqlInjection/SqlInjection.qhelp
+++ b/python/ql/src/Security/Injection/SqlInjection/SqlInjection.qhelp
--- a/python/ql/src/Security/Injection/SqlInjection/SqlInjection.ql
+++ b/python/ql/src/Security/Injection/SqlInjection/SqlInjection.ql
--- a/python/ql/src/Security/Injection/SqlInjection/examples/sql_injection.py
+++ b/python/ql/src/Security/Injection/SqlInjection/examples/sql_injection.py
--- a/python/ql/src/Security/Injection/TarSlip/TarSlip.qhelp
+++ b/python/ql/src/Security/Injection/TarSlip/TarSlip.qhelp
--- a/python/ql/src/Security/Injection/TarSlip/TarSlip.ql
+++ b/python/ql/src/Security/Injection/TarSlip/TarSlip.ql
--- a/python/ql/src/Security/Injection/TarSlip/examples/tarslip_bad.py
+++ b/python/ql/src/Security/Injection/TarSlip/examples/tarslip_bad.py
--- a/python/ql/src/Security/Injection/TarSlip/examples/tarslip_good.py
+++ b/python/ql/src/Security/Injection/TarSlip/examples/tarslip_good.py
--- a/python/ql/src/Security/Injection/UnsafeDeserialization/JsonGood.py
+++ b/python/ql/src/Security/Injection/UnsafeDeserialization/JsonGood.py
--- a/python/ql/src/Security/Injection/UnsafeDeserialization/UnpicklingBad.py
+++ b/python/ql/src/Security/Injection/UnsafeDeserialization/UnpicklingBad.py
--- a/python/ql/src/Security/Injection/UnsafeDeserialization/UnsafeDeserialization.qhelp
+++ b/python/ql/src/Security/Injection/UnsafeDeserialization/UnsafeDeserialization.qhelp
--- a/python/ql/src/Security/Injection/UnsafeDeserialization/UnsafeDeserialization.ql
+++ b/python/ql/src/Security/Injection/UnsafeDeserialization/UnsafeDeserialization.ql
--- a/python/ql/test/query-tests/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.expected
+++ b/python/ql/test/query-tests/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.expected
--- a/python/ql/test/query-tests/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.qlref
+++ b/python/ql/test/query-tests/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.qlref
@@ -0,0 +1 @@
+Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.ql
--- a/python/ql/test/query-tests/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces_test.py
+++ b/python/ql/test/query-tests/Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces_test.py
--- a/python/ql/test/query-tests/Security/BadPractice/BindToAllInterfaces/options
+++ b/python/ql/test/query-tests/Security/BadPractice/BindToAllInterfaces/options
--- a/python/ql/test/query-tests/Security/BadPractice/FlaskRunWithDebug/FlaskDebug.expected
+++ b/python/ql/test/query-tests/Security/BadPractice/FlaskRunWithDebug/FlaskDebug.expected
--- a/python/ql/test/query-tests/Security/BadPractice/FlaskRunWithDebug/FlaskDebug.qlref
+++ b/python/ql/test/query-tests/Security/BadPractice/FlaskRunWithDebug/FlaskDebug.qlref
@@ -0,0 +1 @@
+Security/BadPractice/FlaskRunWithDebug/FlaskDebug.ql
--- a/python/ql/test/query-tests/Security/BadPractice/FlaskRunWithDebug/options
+++ b/python/ql/test/query-tests/Security/BadPractice/FlaskRunWithDebug/options
@@ -0,0 +1 @@
+semmle-extractor-options: --max-import-depth=2 -p ../../lib
--- a/python/ql/test/query-tests/Security/BadPractice/FlaskRunWithDebug/test.py
+++ b/python/ql/test/query-tests/Security/BadPractice/FlaskRunWithDebug/test.py
--- a/python/ql/test/query-tests/Security/BadPractice/HTTPSRequestWithoutCertValidation/RequestWithoutValidation.expected
+++ b/python/ql/test/query-tests/Security/BadPractice/HTTPSRequestWithoutCertValidation/RequestWithoutValidation.expected
--- a/python/ql/test/query-tests/Security/BadPractice/HTTPSRequestWithoutCertValidation/RequestWithoutValidation.qlref
+++ b/python/ql/test/query-tests/Security/BadPractice/HTTPSRequestWithoutCertValidation/RequestWithoutValidation.qlref
@@ -0,0 +1 @@
+Security/BadPractice/HTTPSRequestWithoutCertValidation/HTTPSRequestWithoutCertValidation.ql
--- a/python/ql/test/query-tests/Security/BadPractice/HTTPSRequestWithoutCertValidation/make_request.py
+++ b/python/ql/test/query-tests/Security/BadPractice/HTTPSRequestWithoutCertValidation/make_request.py
--- a/python/ql/test/query-tests/Security/BadPractice/HTTPSRequestWithoutCertValidation/options
+++ b/python/ql/test/query-tests/Security/BadPractice/HTTPSRequestWithoutCertValidation/options
@@ -0,0 +1 @@
+semmle-extractor-options: -p ../../lib --max-import-depth=3
--- a/python/ql/test/query-tests/Security/BadPractice/HardcodedCredentials/HardcodedCredentials.expected
+++ b/python/ql/test/query-tests/Security/BadPractice/HardcodedCredentials/HardcodedCredentials.expected
--- a/python/ql/test/query-tests/Security/BadPractice/HardcodedCredentials/HardcodedCredentials.qlref
+++ b/python/ql/test/query-tests/Security/BadPractice/HardcodedCredentials/HardcodedCredentials.qlref
@@ -0,0 +1 @@
+Security/BadPractice/HardcodedCredentials/HardcodedCredentials.ql
--- a/python/ql/test/query-tests/Security/BadPractice/HardcodedCredentials/test.py
+++ b/python/ql/test/query-tests/Security/BadPractice/HardcodedCredentials/test.py
--- a/python/ql/test/query-tests/Security/BadPractice/IncompleteUrlSanitizer/IncompleteHostnameRegExp.expected
+++ b/python/ql/test/query-tests/Security/BadPractice/IncompleteUrlSanitizer/IncompleteHostnameRegExp.expected
--- a/python/ql/test/query-tests/Security/BadPractice/IncompleteUrlSanitizer/IncompleteHostnameRegExp.qlref
+++ b/python/ql/test/query-tests/Security/BadPractice/IncompleteUrlSanitizer/IncompleteHostnameRegExp.qlref
@@ -0,0 +1 @@
+Security/BadPractice/IncompleteUrlSanitizer/IncompleteHostnameRegExp.ql
--- a/Show More
+++ b/Show More
				`@@ -0,0 +1 @@`
				`Security/BadPractice/BindToAllInterfaces/BindToAllInterfaces.ql`
				`@@ -0,0 +1 @@`
				`Security/BadPractice/FlaskRunWithDebug/FlaskDebug.ql`
				`@@ -0,0 +1 @@`
				`semmle-extractor-options: --max-import-depth=2 -p ../../lib`
				`@@ -0,0 +1 @@`
				`Security/BadPractice/HTTPSRequestWithoutCertValidation/HTTPSRequestWithoutCertValidation.ql`
				`@@ -0,0 +1 @@`
				`semmle-extractor-options: -p ../../lib --max-import-depth=3`
				`@@ -0,0 +1 @@`
				`Security/BadPractice/HardcodedCredentials/HardcodedCredentials.ql`
				`@@ -0,0 +1 @@`
				`Security/BadPractice/IncompleteUrlSanitizer/IncompleteHostnameRegExp.ql`