eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker.html

<!DOCTYPE html>
<html><head>
<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker</h1>

<p>
Module implementing the security checker.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#SecurityChecker">SecurityChecker</a></td>
<td>Class implementing a checker for security issues.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="SecurityChecker" ID="SecurityChecker"></a>
<h2>SecurityChecker</h2>

<p>
    Class implementing a checker for security issues.
</p>
<h3>Derived from</h3>
object
<h3>Class Attributes</h3>

<table>
<tr><td>Codes</td></tr>
</table>
<h3>Class Methods</h3>

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

<table>

<tr>
<td><a href="#SecurityChecker.__init__">SecurityChecker</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#SecurityChecker.__generateTree">__generateTree</a></td>
<td>Private method to generate an AST for our source.</td>
</tr>
<tr>
<td><a href="#SecurityChecker.__ignoreCode">__ignoreCode</a></td>
<td>Private method to check if the message code should be ignored.</td>
</tr>
<tr>
<td><a href="#SecurityChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td>
<td>Private method to report a syntax error.</td>
</tr>
<tr>
<td><a href="#SecurityChecker.getConfig">getConfig</a></td>
<td>Public method to get the configuration dictionary.</td>
</tr>
<tr>
<td><a href="#SecurityChecker.reportError">reportError</a></td>
<td>Public method to record an issue.</td>
</tr>
<tr>
<td><a href="#SecurityChecker.run">run</a></td>
<td>Public method to check the given source against security related conditions.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="SecurityChecker.__init__" ID="SecurityChecker.__init__"></a>
<h4>SecurityChecker (Constructor)</h4>
<b>SecurityChecker</b>(<i>source, filename, select, ignore, expected, repeat, args</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>source</i> (list of str)</dt>
<dd>
source code to be checked
</dd>
<dt><i>filename</i> (str)</dt>
<dd>
name of the source file
</dd>
<dt><i>select</i> (list of str)</dt>
<dd>
list of selected codes
</dd>
<dt><i>ignore</i> (list of str)</dt>
<dd>
list of codes to be ignored
</dd>
<dt><i>expected</i> (list of str)</dt>
<dd>
list of expected codes
</dd>
<dt><i>repeat</i> (bool)</dt>
<dd>
flag indicating to report each occurrence of a code
</dd>
<dt><i>args</i> (dict)</dt>
<dd>
dictionary of arguments for the security checks
</dd>
</dl>
<a NAME="SecurityChecker.__generateTree" ID="SecurityChecker.__generateTree"></a>
<h4>SecurityChecker.__generateTree</h4>
<b>__generateTree</b>(<i></i>)

<p>
        Private method to generate an AST for our source.
</p>
<dl>
<dt>Return:</dt>
<dd>
generated AST
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
ast.AST
</dd>
</dl>
<a NAME="SecurityChecker.__ignoreCode" ID="SecurityChecker.__ignoreCode"></a>
<h4>SecurityChecker.__ignoreCode</h4>
<b>__ignoreCode</b>(<i>code</i>)

<p>
        Private method to check if the message code should be ignored.
</p>
<dl>

<dt><i>code</i> (str)</dt>
<dd>
message code to check for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating to ignore the given code
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="SecurityChecker.__reportInvalidSyntax" ID="SecurityChecker.__reportInvalidSyntax"></a>
<h4>SecurityChecker.__reportInvalidSyntax</h4>
<b>__reportInvalidSyntax</b>(<i></i>)

<p>
        Private method to report a syntax error.
</p>
<a NAME="SecurityChecker.getConfig" ID="SecurityChecker.getConfig"></a>
<h4>SecurityChecker.getConfig</h4>
<b>getConfig</b>(<i></i>)

<p>
        Public method to get the configuration dictionary.
</p>
<dl>
<dt>Return:</dt>
<dd>
dictionary containing the configuration
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="SecurityChecker.reportError" ID="SecurityChecker.reportError"></a>
<h4>SecurityChecker.reportError</h4>
<b>reportError</b>(<i>lineNumber, offset, code, severity, confidence, *args</i>)

<p>
        Public method to record an issue.
</p>
<dl>

<dt><i>lineNumber</i> (int)</dt>
<dd>
line number of the issue
</dd>
<dt><i>offset</i> (int)</dt>
<dd>
position within line of the issue
</dd>
<dt><i>code</i> (str)</dt>
<dd>
message code
</dd>
<dt><i>severity</i> (str)</dt>
<dd>
severity code (H = high, M = medium, L = low,
            U = undefined)
</dd>
<dt><i>confidence</i> (str)</dt>
<dd>
confidence code (H = high, M = medium, L = low,
            U = undefined)
</dd>
<dt><i>args</i> (list)</dt>
<dd>
arguments for the message
</dd>
</dl>
<a NAME="SecurityChecker.run" ID="SecurityChecker.run"></a>
<h4>SecurityChecker.run</h4>
<b>run</b>(<i></i>)

<p>
        Public method to check the given source against security related
        conditions.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>