diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.djangoSqlInjection.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.djangoSqlInjection.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,148 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.djangoSqlInjection</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.djangoSqlInjection</h1> + +<p> +Module implementing checks for potential SQL injections risks. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#checkDjangoExtraUsed">checkDjangoExtraUsed</a></td> +<td>Function to check for potential SQL injection on extra function.</td> +</tr> +<tr> +<td><a href="#checkDjangoRawSqlUsed">checkDjangoRawSqlUsed</a></td> +<td>Function to check for potential SQL injection on RawSQL function.</td> +</tr> +<tr> +<td><a href="#getChecks">getChecks</a></td> +<td>Public method to get a dictionary with checks handled by this module.</td> +</tr> +<tr> +<td><a href="#keywords2dict">keywords2dict</a></td> +<td>Function to extract keywords arguments into a dictionary.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="checkDjangoExtraUsed" ID="checkDjangoExtraUsed"></a> +<h2>checkDjangoExtraUsed</h2> +<b>checkDjangoExtraUsed</b>(<i>reportError, context, config</i>) + +<p> + Function to check for potential SQL injection on extra function. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="checkDjangoRawSqlUsed" ID="checkDjangoRawSqlUsed"></a> +<h2>checkDjangoRawSqlUsed</h2> +<b>checkDjangoRawSqlUsed</b>(<i>reportError, context, config</i>) + +<p> + Function to check for potential SQL injection on RawSQL function. +</p> +<dl> + +<dt><i>reportError</i> (func)</dt> +<dd> +function to be used to report errors +</dd> +<dt><i>context</i> (SecurityContext)</dt> +<dd> +security context object +</dd> +<dt><i>config</i> (dict)</dt> +<dd> +dictionary with configuration data +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getChecks" ID="getChecks"></a> +<h2>getChecks</h2> +<b>getChecks</b>(<i></i>) + +<p> + Public method to get a dictionary with checks handled by this module. +</p> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing checker lists containing checker function and + list of codes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="keywords2dict" ID="keywords2dict"></a> +<h2>keywords2dict</h2> +<b>keywords2dict</b>(<i>keywords</i>) + +<p> + Function to extract keywords arguments into a dictionary. +</p> +<dl> + +<dt><i>keywords</i> (list of ast.keyword)</dt> +<dd> +list of keyword nodes +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +dictionary with keyword name and value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file