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

branch
eric7
changeset 10479
856476537696
parent 10259
b51dfacef37f
child 10684
58c7f23ae1cb
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword</h1> 9 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword</h1>
10
11 <p> 10 <p>
12 Module implementing checks for potentially hardcoded AWS passwords. 11 Module implementing checks for potentially hardcoded AWS passwords.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 <table>
16 <tr><td>AWS_ACCESS_KEY_ID_MAX_ENTROPY</td></tr>
17 <tr><td>AWS_ACCESS_KEY_ID_REGEX</td></tr>
18 <tr><td>AWS_ACCESS_KEY_ID_SYMBOLS</td></tr>
19 <tr><td>AWS_SECRET_ACCESS_KEY_MAX_ENTROPY</td></tr>
20 <tr><td>AWS_SECRET_ACCESS_KEY_REGEX</td></tr>
21 <tr><td>AWS_SECRET_ACCESS_KEY_SYMBOLS</td></tr>
22 </table>
15 23
16 <table>
17 <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>
18 </table>
19 <h3>Classes</h3> 24 <h3>Classes</h3>
20
21 <table> 25 <table>
22 <tr><td>None</td></tr> 26 <tr><td>None</td></tr>
23 </table> 27 </table>
28
24 <h3>Functions</h3> 29 <h3>Functions</h3>
25
26 <table> 30 <table>
27
28 <tr> 31 <tr>
29 <td><a href="#checkHardcodedAwsKey">checkHardcodedAwsKey</a></td> 32 <td><a href="#checkHardcodedAwsKey">checkHardcodedAwsKey</a></td>
30 <td>Function to check for potentially hardcoded AWS passwords.</td> 33 <td>Function to check for potentially hardcoded AWS passwords.</td>
31 </tr> 34 </tr>
32 <tr> 35 <tr>
36 <tr> 39 <tr>
37 <td><a href="#shannonEntropy">shannonEntropy</a></td> 40 <td><a href="#shannonEntropy">shannonEntropy</a></td>
38 <td>Function to caclculate the Shannon entropy of some given data.</td> 41 <td>Function to caclculate the Shannon entropy of some given data.</td>
39 </tr> 42 </tr>
40 </table> 43 </table>
44
41 <hr /> 45 <hr />
42 <hr /> 46 <hr />
43 <a NAME="checkHardcodedAwsKey" ID="checkHardcodedAwsKey"></a> 47 <a NAME="checkHardcodedAwsKey" ID="checkHardcodedAwsKey"></a>
44 <h2>checkHardcodedAwsKey</h2> 48 <h2>checkHardcodedAwsKey</h2>
45 <b>checkHardcodedAwsKey</b>(<i>reportError, context, config</i>) 49 <b>checkHardcodedAwsKey</b>(<i>reportError, context, config</i>)
46
47 <p> 50 <p>
48 Function to check for potentially hardcoded AWS passwords. 51 Function to check for potentially hardcoded AWS passwords.
49 </p> 52 </p>
53
50 <dl> 54 <dl>
51 55
52 <dt><i>reportError</i> (func)</dt> 56 <dt><i>reportError</i> (func)</dt>
53 <dd> 57 <dd>
54 function to be used to report errors 58 function to be used to report errors
66 <hr /> 70 <hr />
67 <hr /> 71 <hr />
68 <a NAME="getChecks" ID="getChecks"></a> 72 <a NAME="getChecks" ID="getChecks"></a>
69 <h2>getChecks</h2> 73 <h2>getChecks</h2>
70 <b>getChecks</b>(<i></i>) 74 <b>getChecks</b>(<i></i>)
71
72 <p> 75 <p>
73 Public method to get a dictionary with checks handled by this module. 76 Public method to get a dictionary with checks handled by this module.
74 </p> 77 </p>
78
75 <dl> 79 <dl>
76 <dt>Return:</dt> 80 <dt>Return:</dt>
77 <dd> 81 <dd>
78 dictionary containing checker lists containing checker function and 82 dictionary containing checker lists containing checker function and
79 list of codes 83 list of codes
89 <hr /> 93 <hr />
90 <hr /> 94 <hr />
91 <a NAME="shannonEntropy" ID="shannonEntropy"></a> 95 <a NAME="shannonEntropy" ID="shannonEntropy"></a>
92 <h2>shannonEntropy</h2> 96 <h2>shannonEntropy</h2>
93 <b>shannonEntropy</b>(<i>data, symbols</i>) 97 <b>shannonEntropy</b>(<i>data, symbols</i>)
94
95 <p> 98 <p>
96 Function to caclculate the Shannon entropy of some given data. 99 Function to caclculate the Shannon entropy of some given data.
97 </p> 100 </p>
98 <p> 101 <p>
99 Source: 102 Source:
100 http://blog.dkbza.org/2007/05/scanning-data-for-entropy-anomalies.html 103 http://blog.dkbza.org/2007/05/scanning-data-for-entropy-anomalies.html
101 </p> 104 </p>
105
102 <dl> 106 <dl>
103 107
104 <dt><i>data</i> (str)</dt> 108 <dt><i>data</i> (str)</dt>
105 <dd> 109 <dd>
106 data to calculate the entropy for 110 data to calculate the entropy for

eric ide

mercurial