--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.generalHardcodedPassword.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,144 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.generalHardcodedPassword</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.generalHardcodedPassword</h1> + +<p> +Module implementing checks for potentially hardcoded passwords. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>RE_CANDIDATES</td></tr><tr><td>RE_WORDS</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#checkHardcodedPasswordAsDefault">checkHardcodedPasswordAsDefault</a></td> +<td>Function to check for use of hard-coded password argument defaults.</td> +</tr> +<tr> +<td><a href="#checkHardcodedPasswordAsFunctionArg">checkHardcodedPasswordAsFunctionArg</a></td> +<td>Function to check for use of hard-coded password function arguments.</td> +</tr> +<tr> +<td><a href="#checkHardcodedPasswordAsString">checkHardcodedPasswordAsString</a></td> +<td>Function to check for use of hardcoded password strings.</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> +</table> +<hr /> +<hr /> +<a NAME="checkHardcodedPasswordAsDefault" ID="checkHardcodedPasswordAsDefault"></a> +<h2>checkHardcodedPasswordAsDefault</h2> +<b>checkHardcodedPasswordAsDefault</b>(<i>reportError, context, config</i>) + +<p> + Function to check for use of hard-coded password argument defaults. +</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="checkHardcodedPasswordAsFunctionArg" ID="checkHardcodedPasswordAsFunctionArg"></a> +<h2>checkHardcodedPasswordAsFunctionArg</h2> +<b>checkHardcodedPasswordAsFunctionArg</b>(<i>reportError, context, config</i>) + +<p> + Function to check for use of hard-coded password function arguments. +</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="checkHardcodedPasswordAsString" ID="checkHardcodedPasswordAsString"></a> +<h2>checkHardcodedPasswordAsString</h2> +<b>checkHardcodedPasswordAsString</b>(<i>reportError, context, config</i>) + +<p> + Function to check for use of hardcoded password strings. +</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 /> +</body></html> \ No newline at end of file