--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.insecureSslTls.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,158 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.insecureSslTls</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.insecureSslTls</h1> + +<p> +Module implementing a check for use of SSL/TLS with insecure protocols. +</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="#checkInsecureSslDefaults">checkInsecureSslDefaults</a></td> +<td>Function to check for SSL use with insecure defaults specified.</td> +</tr> +<tr> +<td><a href="#checkInsecureSslProtocolVersion">checkInsecureSslProtocolVersion</a></td> +<td>Function to check for use of insecure SSL protocol version.</td> +</tr> +<tr> +<td><a href="#checkSslWithoutVersion">checkSslWithoutVersion</a></td> +<td>Function to check for SSL use with no version specified.</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="checkInsecureSslDefaults" ID="checkInsecureSslDefaults"></a> +<h2>checkInsecureSslDefaults</h2> +<b>checkInsecureSslDefaults</b>(<i>reportError, context, config</i>) + +<p> + Function to check for SSL use with insecure defaults specified. +</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="checkInsecureSslProtocolVersion" ID="checkInsecureSslProtocolVersion"></a> +<h2>checkInsecureSslProtocolVersion</h2> +<b>checkInsecureSslProtocolVersion</b>(<i>reportError, context, config</i>) + +<p> + Function to check for use of insecure SSL protocol version. +</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="checkSslWithoutVersion" ID="checkSslWithoutVersion"></a> +<h2>checkSslWithoutVersion</h2> +<b>checkSslWithoutVersion</b>(<i>reportError, context, config</i>) + +<p> + Function to check for SSL use with no version specified. +</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