Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker.html
- branch
- eric7
- changeset 11150
- 73d80859079c
- parent 10479
- 856476537696
equal
deleted
inserted
replaced
| 11149:fc45672fae42 | 11150:73d80859079c |
|---|---|
| 36 <p> | 36 <p> |
| 37 Class implementing a checker for security issues. | 37 Class implementing a checker for security issues. |
| 38 </p> | 38 </p> |
| 39 | 39 |
| 40 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 41 None | 41 CodeStyleTopicChecker |
| 42 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 43 <table> | 43 <table> |
| 44 <tr><td>Category</td></tr> | |
| 44 <tr><td>Codes</td></tr> | 45 <tr><td>Codes</td></tr> |
| 45 </table> | 46 </table> |
| 46 | 47 |
| 47 <h3>Class Methods</h3> | 48 <h3>Class Methods</h3> |
| 48 <table> | 49 <table> |
| 54 <tr> | 55 <tr> |
| 55 <td><a href="#SecurityChecker.__init__">SecurityChecker</a></td> | 56 <td><a href="#SecurityChecker.__init__">SecurityChecker</a></td> |
| 56 <td>Constructor</td> | 57 <td>Constructor</td> |
| 57 </tr> | 58 </tr> |
| 58 <tr> | 59 <tr> |
| 59 <td><a href="#SecurityChecker.__ignoreCode">__ignoreCode</a></td> | 60 <td><a href="#SecurityChecker.addError">addError</a></td> |
| 60 <td>Private method to check if the message code should be ignored.</td> | 61 <td>Public method to record an issue.</td> |
| 61 </tr> | 62 </tr> |
| 62 <tr> | 63 <tr> |
| 63 <td><a href="#SecurityChecker.getConfig">getConfig</a></td> | 64 <td><a href="#SecurityChecker.getConfig">getConfig</a></td> |
| 64 <td>Public method to get the configuration dictionary.</td> | 65 <td>Public method to get the configuration dictionary.</td> |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#SecurityChecker.reportError">reportError</a></td> | |
| 68 <td>Public method to record an issue.</td> | |
| 69 </tr> | 66 </tr> |
| 70 <tr> | 67 <tr> |
| 71 <td><a href="#SecurityChecker.run">run</a></td> | 68 <td><a href="#SecurityChecker.run">run</a></td> |
| 72 <td>Public method to check the given source against security related conditions.</td> | 69 <td>Public method to check the given source against security related conditions.</td> |
| 73 </tr> | 70 </tr> |
| 119 <dt><i>args</i> (dict)</dt> | 116 <dt><i>args</i> (dict)</dt> |
| 120 <dd> | 117 <dd> |
| 121 dictionary of arguments for the security checks | 118 dictionary of arguments for the security checks |
| 122 </dd> | 119 </dd> |
| 123 </dl> | 120 </dl> |
| 124 <a NAME="SecurityChecker.__ignoreCode" ID="SecurityChecker.__ignoreCode"></a> | 121 <a NAME="SecurityChecker.addError" ID="SecurityChecker.addError"></a> |
| 125 <h4>SecurityChecker.__ignoreCode</h4> | 122 <h4>SecurityChecker.addError</h4> |
| 126 <b>__ignoreCode</b>(<i>code</i>) | 123 <b>addError</b>(<i>lineNumber, offset, msgCode, severity, confidence, *args</i>) |
| 127 <p> | 124 <p> |
| 128 Private method to check if the message code should be ignored. | 125 Public method to record an issue. |
| 129 </p> | 126 </p> |
| 130 | 127 |
| 131 <dl> | 128 <dl> |
| 132 | 129 |
| 133 <dt><i>code</i> (str)</dt> | 130 <dt><i>lineNumber</i> (int)</dt> |
| 134 <dd> | 131 <dd> |
| 135 message code to check for | 132 line number of the issue |
| 136 </dd> | 133 </dd> |
| 137 </dl> | 134 <dt><i>offset</i> (int)</dt> |
| 138 <dl> | |
| 139 <dt>Return:</dt> | |
| 140 <dd> | 135 <dd> |
| 141 flag indicating to ignore the given code | 136 position within line of the issue |
| 142 </dd> | 137 </dd> |
| 143 </dl> | 138 <dt><i>msgCode</i> (str)</dt> |
| 144 <dl> | |
| 145 <dt>Return Type:</dt> | |
| 146 <dd> | 139 <dd> |
| 147 bool | 140 message code |
| 141 </dd> | |
| 142 <dt><i>severity</i> (str)</dt> | |
| 143 <dd> | |
| 144 severity code (H = high, M = medium, L = low, | |
| 145 U = undefined) | |
| 146 </dd> | |
| 147 <dt><i>confidence</i> (str)</dt> | |
| 148 <dd> | |
| 149 confidence code (H = high, M = medium, L = low, | |
| 150 U = undefined) | |
| 151 </dd> | |
| 152 <dt><i>args</i> (list)</dt> | |
| 153 <dd> | |
| 154 arguments for the message | |
| 148 </dd> | 155 </dd> |
| 149 </dl> | 156 </dl> |
| 150 <a NAME="SecurityChecker.getConfig" ID="SecurityChecker.getConfig"></a> | 157 <a NAME="SecurityChecker.getConfig" ID="SecurityChecker.getConfig"></a> |
| 151 <h4>SecurityChecker.getConfig</h4> | 158 <h4>SecurityChecker.getConfig</h4> |
| 152 <b>getConfig</b>(<i></i>) | 159 <b>getConfig</b>(<i></i>) |
| 164 <dt>Return Type:</dt> | 171 <dt>Return Type:</dt> |
| 165 <dd> | 172 <dd> |
| 166 dict | 173 dict |
| 167 </dd> | 174 </dd> |
| 168 </dl> | 175 </dl> |
| 169 <a NAME="SecurityChecker.reportError" ID="SecurityChecker.reportError"></a> | |
| 170 <h4>SecurityChecker.reportError</h4> | |
| 171 <b>reportError</b>(<i>lineNumber, offset, code, severity, confidence, *args</i>) | |
| 172 <p> | |
| 173 Public method to record an issue. | |
| 174 </p> | |
| 175 | |
| 176 <dl> | |
| 177 | |
| 178 <dt><i>lineNumber</i> (int)</dt> | |
| 179 <dd> | |
| 180 line number of the issue | |
| 181 </dd> | |
| 182 <dt><i>offset</i> (int)</dt> | |
| 183 <dd> | |
| 184 position within line of the issue | |
| 185 </dd> | |
| 186 <dt><i>code</i> (str)</dt> | |
| 187 <dd> | |
| 188 message code | |
| 189 </dd> | |
| 190 <dt><i>severity</i> (str)</dt> | |
| 191 <dd> | |
| 192 severity code (H = high, M = medium, L = low, | |
| 193 U = undefined) | |
| 194 </dd> | |
| 195 <dt><i>confidence</i> (str)</dt> | |
| 196 <dd> | |
| 197 confidence code (H = high, M = medium, L = low, | |
| 198 U = undefined) | |
| 199 </dd> | |
| 200 <dt><i>args</i> (list)</dt> | |
| 201 <dd> | |
| 202 arguments for the message | |
| 203 </dd> | |
| 204 </dl> | |
| 205 <a NAME="SecurityChecker.run" ID="SecurityChecker.run"></a> | 176 <a NAME="SecurityChecker.run" ID="SecurityChecker.run"></a> |
| 206 <h4>SecurityChecker.run</h4> | 177 <h4>SecurityChecker.run</h4> |
| 207 <b>run</b>(<i></i>) | 178 <b>run</b>(<i></i>) |
| 208 <p> | 179 <p> |
| 209 Public method to check the given source against security related | 180 Public method to check the given source against security related |
