src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword</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.awsHardcodedPassword</h1>
<p>
Module implementing checks for potentially hardcoded AWS passwords.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>AWS_ACCESS_KEY_ID_MAX_ENTROPY</td></tr>
<tr><td>AWS_ACCESS_KEY_ID_REGEX</td></tr>
<tr><td>AWS_ACCESS_KEY_ID_SYMBOLS</td></tr>
<tr><td>AWS_SECRET_ACCESS_KEY_MAX_ENTROPY</td></tr>
<tr><td>AWS_SECRET_ACCESS_KEY_REGEX</td></tr>
<tr><td>AWS_SECRET_ACCESS_KEY_SYMBOLS</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Functions</h3>
<table>
<tr>
<td><a href="#checkHardcodedAwsKey">checkHardcodedAwsKey</a></td>
<td>Function to check for potentially hardcoded AWS passwords.</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="#shannonEntropy">shannonEntropy</a></td>
<td>Function to caclculate the Shannon entropy of some given data.</td>
</tr>
</table>

<hr />
<hr />
<a NAME="checkHardcodedAwsKey" ID="checkHardcodedAwsKey"></a>
<h2>checkHardcodedAwsKey</h2>
<b>checkHardcodedAwsKey</b>(<i>reportError, context, config</i>)
<p>
    Function to check for potentially hardcoded AWS passwords.
</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="shannonEntropy" ID="shannonEntropy"></a>
<h2>shannonEntropy</h2>
<b>shannonEntropy</b>(<i>data, symbols</i>)
<p>
    Function to caclculate the Shannon entropy of some given data.
</p>
<p>
    Source:
    http://blog.dkbza.org/2007/05/scanning-data-for-entropy-anomalies.html
</p>

<dl>

<dt><i>data</i> (str)</dt>
<dd>
data to calculate the entropy for
</dd>
<dt><i>symbols</i> (str)</dt>
<dd>
allowed symbols
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
Shannon entropy of the given data
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
float
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>