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

branch
eric7
changeset 9325
8157eb19aba5
child 10070
9f5758c0fec1
diff -r 7f7f3e47b238 -r 8157eb19aba5 src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.tarfileUnsafeMembers.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.tarfileUnsafeMembers.html	Tue Sep 13 20:00:55 2022 +0200
@@ -0,0 +1,119 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.tarfileUnsafeMembers</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.tarfileUnsafeMembers</h1>
+
+<p>
+Module implementing checks for insecure use of 'tarfile.extracall()'.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#_getMembersValue">_getMembersValue</a></td>
+<td>Function to extract the value of the 'members' argument.</td>
+</tr>
+<tr>
+<td><a href="#checkTarfileUnsafeMembers">checkTarfileUnsafeMembers</a></td>
+<td>Function to check for insecure use of 'tarfile.extracall()'.</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>
+</table>
+<hr />
+<hr />
+<a NAME="_getMembersValue" ID="_getMembersValue"></a>
+<h2>_getMembersValue</h2>
+<b>_getMembersValue</b>(<i>context</i>)
+
+<p>
+    Function to extract the value of the 'members' argument.
+</p>
+<dl>
+
+<dt><i>context</i> (SecurityContext)</dt>
+<dd>
+security context object
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the argument value
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="checkTarfileUnsafeMembers" ID="checkTarfileUnsafeMembers"></a>
+<h2>checkTarfileUnsafeMembers</h2>
+<b>checkTarfileUnsafeMembers</b>(<i>reportError, context, config</i>)
+
+<p>
+    Function to check for insecure use of 'tarfile.extracall()'.
+</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 />
+</body></html>
\ No newline at end of file

eric ide

mercurial