Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword.html
eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing checks for potentially hardcoded AWS passwords. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <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> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 <tr><td>None</td></tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 | |
| 40 <table> | |
| 41 | |
| 42 <tr> | |
| 43 <td><a href="#checkHardcodedAwsKey">checkHardcodedAwsKey</a></td> | |
| 44 <td>Function to check for potentially hardcoded AWS passwords.</td> | |
| 45 </tr> | |
| 46 <tr> | |
| 47 <td><a href="#getChecks">getChecks</a></td> | |
| 48 <td>Public method to get a dictionary with checks handled by this module.</td> | |
| 49 </tr> | |
| 50 <tr> | |
| 51 <td><a href="#shannonEntropy">shannonEntropy</a></td> | |
| 52 <td>Function to caclculate the Shannon entropy of some given data.</td> | |
| 53 </tr> | |
| 54 </table> | |
| 55 <hr /> | |
| 56 <hr /> | |
| 57 <a NAME="checkHardcodedAwsKey" ID="checkHardcodedAwsKey"></a> | |
| 58 <h2>checkHardcodedAwsKey</h2> | |
| 59 <b>checkHardcodedAwsKey</b>(<i>reportError, context, config</i>) | |
| 60 | |
| 61 <p> | |
| 62 Function to check for potentially hardcoded AWS passwords. | |
| 63 </p> | |
| 64 <dl> | |
| 65 | |
| 66 <dt><i>reportError</i> (func)</dt> | |
| 67 <dd> | |
| 68 function to be used to report errors | |
| 69 </dd> | |
| 70 <dt><i>context</i> (SecurityContext)</dt> | |
| 71 <dd> | |
| 72 security context object | |
| 73 </dd> | |
| 74 <dt><i>config</i> (dict)</dt> | |
| 75 <dd> | |
| 76 dictionary with configuration data | |
| 77 </dd> | |
| 78 </dl> | |
| 79 <div align="right"><a href="#top">Up</a></div> | |
| 80 <hr /> | |
| 81 <hr /> | |
| 82 <a NAME="getChecks" ID="getChecks"></a> | |
| 83 <h2>getChecks</h2> | |
| 84 <b>getChecks</b>(<i></i>) | |
| 85 | |
| 86 <p> | |
| 87 Public method to get a dictionary with checks handled by this module. | |
| 88 </p> | |
| 89 <dl> | |
| 90 <dt>Return:</dt> | |
| 91 <dd> | |
| 92 dictionary containing checker lists containing checker function and | |
| 93 list of codes | |
| 94 </dd> | |
| 95 </dl> | |
| 96 <dl> | |
| 97 <dt>Return Type:</dt> | |
| 98 <dd> | |
| 99 dict | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <div align="right"><a href="#top">Up</a></div> | |
| 103 <hr /> | |
| 104 <hr /> | |
| 105 <a NAME="shannonEntropy" ID="shannonEntropy"></a> | |
| 106 <h2>shannonEntropy</h2> | |
| 107 <b>shannonEntropy</b>(<i>data, symbols</i>) | |
| 108 | |
| 109 <p> | |
| 110 Function to caclculate the Shannon entropy of some given data. | |
| 111 </p> | |
| 112 <p> | |
| 113 Source: | |
| 114 http://blog.dkbza.org/2007/05/scanning-data-for-entropy-anomalies.html | |
| 115 </p> | |
| 116 <dl> | |
| 117 | |
| 118 <dt><i>data</i> (str)</dt> | |
| 119 <dd> | |
| 120 data to calculate the entropy for | |
| 121 </dd> | |
| 122 <dt><i>symbols</i> (str)</dt> | |
| 123 <dd> | |
| 124 allowed symbols | |
| 125 </dd> | |
| 126 </dl> | |
| 127 <dl> | |
| 128 <dt>Return:</dt> | |
| 129 <dd> | |
| 130 Shannon entropy of the given data | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <dl> | |
| 134 <dt>Return Type:</dt> | |
| 135 <dd> | |
| 136 float | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <div align="right"><a href="#top">Up</a></div> | |
| 140 <hr /> | |
| 141 </body></html> |
