Sat, 20 Apr 2024 18:02:35 +0200
Regenerated source code documentation.
9325 | 1 | <!DOCTYPE html> |
2 | <html><head> | |
3 | <title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.tarfileUnsafeMembers</title> | |
4 | <meta charset="UTF-8"> | |
5 | <link rel="stylesheet" href="styles.css"> | |
6 | </head> | |
7 | <body> | |
8 | <a NAME="top" ID="top"></a> | |
9 | <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.tarfileUnsafeMembers</h1> | |
10 | <p> | |
11 | Module implementing checks for insecure use of 'tarfile.extracall()'. | |
12 | </p> | |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10259
diff
changeset
|
13 | |
9325 | 14 | <h3>Global Attributes</h3> |
15 | <table> | |
16 | <tr><td>None</td></tr> | |
17 | </table> | |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10259
diff
changeset
|
18 | |
9325 | 19 | <h3>Classes</h3> |
20 | <table> | |
21 | <tr><td>None</td></tr> | |
22 | </table> | |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10259
diff
changeset
|
23 | |
9325 | 24 | <h3>Functions</h3> |
25 | <table> | |
26 | <tr> | |
27 | <td><a href="#_getMembersValue">_getMembersValue</a></td> | |
28 | <td>Function to extract the value of the 'members' argument.</td> | |
29 | </tr> | |
30 | <tr> | |
10648
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
31 | <td><a href="#_isFilterData">_isFilterData</a></td> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
32 | <td>Function to check for the filter argument to be 'data'.</td> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
33 | </tr> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
34 | <tr> |
9325 | 35 | <td><a href="#checkTarfileUnsafeMembers">checkTarfileUnsafeMembers</a></td> |
10259
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
36 | <td>Function to check for insecure use of 'tarfile.extracall()'.</td> |
9325 | 37 | </tr> |
38 | <tr> | |
39 | <td><a href="#getChecks">getChecks</a></td> | |
40 | <td>Public method to get a dictionary with checks handled by this module.</td> | |
41 | </tr> | |
42 | </table> | |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10259
diff
changeset
|
43 | |
9325 | 44 | <hr /> |
45 | <hr /> | |
46 | <a NAME="_getMembersValue" ID="_getMembersValue"></a> | |
47 | <h2>_getMembersValue</h2> | |
48 | <b>_getMembersValue</b>(<i>context</i>) | |
49 | <p> | |
50 | Function to extract the value of the 'members' argument. | |
51 | </p> | |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10259
diff
changeset
|
52 | |
9325 | 53 | <dl> |
54 | ||
55 | <dt><i>context</i> (SecurityContext)</dt> | |
56 | <dd> | |
57 | security context object | |
58 | </dd> | |
59 | </dl> | |
60 | <dl> | |
61 | <dt>Return:</dt> | |
62 | <dd> | |
63 | dictionary containing the argument value | |
64 | </dd> | |
65 | </dl> | |
66 | <dl> | |
67 | <dt>Return Type:</dt> | |
68 | <dd> | |
69 | dict | |
70 | </dd> | |
71 | </dl> | |
72 | <div align="right"><a href="#top">Up</a></div> | |
73 | <hr /> | |
74 | <hr /> | |
10648
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
75 | <a NAME="_isFilterData" ID="_isFilterData"></a> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
76 | <h2>_isFilterData</h2> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
77 | <b>_isFilterData</b>(<i>context</i>) |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
78 | <p> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
79 | Function to check for the filter argument to be 'data'. |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
80 | </p> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
81 | |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
82 | <dl> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
83 | |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
84 | <dt><i>context</i> (SecurityContext)</dt> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
85 | <dd> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
86 | security context object |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
87 | </dd> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
88 | </dl> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
89 | <dl> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
90 | <dt>Return:</dt> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
91 | <dd> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
92 | flag indicating the 'data' filter |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
93 | </dd> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
94 | </dl> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
95 | <dl> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
96 | <dt>Return Type:</dt> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
97 | <dd> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
98 | bool |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
99 | </dd> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
100 | </dl> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
101 | <div align="right"><a href="#top">Up</a></div> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
102 | <hr /> |
57b0f5657250
Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10479
diff
changeset
|
103 | <hr /> |
9325 | 104 | <a NAME="checkTarfileUnsafeMembers" ID="checkTarfileUnsafeMembers"></a> |
105 | <h2>checkTarfileUnsafeMembers</h2> | |
10684
58c7f23ae1cb
Regenerated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10648
diff
changeset
|
106 | <b>checkTarfileUnsafeMembers</b>(<i>reportError, context, _config</i>) |
10259
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
107 | <p> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
108 | Function to check for insecure use of 'tarfile.extracall()'. |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
109 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10259
diff
changeset
|
110 | |
10259
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
111 | <dl> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
112 | |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
113 | <dt><i>reportError</i> (func)</dt> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
114 | <dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
115 | function to be used to report errors |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
116 | </dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
117 | <dt><i>context</i> (SecurityContext)</dt> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
118 | <dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
119 | security context object |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
120 | </dd> |
10684
58c7f23ae1cb
Regenerated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10648
diff
changeset
|
121 | <dt><i>_config</i> (dict)</dt> |
10259
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
122 | <dd> |
10684
58c7f23ae1cb
Regenerated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10648
diff
changeset
|
123 | dictionary with configuration data (unused) |
10259
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
124 | </dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
125 | </dl> |
9325 | 126 | <div align="right"><a href="#top">Up</a></div> |
127 | <hr /> | |
128 | <hr /> | |
129 | <a NAME="getChecks" ID="getChecks"></a> | |
130 | <h2>getChecks</h2> | |
131 | <b>getChecks</b>(<i></i>) | |
132 | <p> | |
133 | Public method to get a dictionary with checks handled by this module. | |
134 | </p> | |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10259
diff
changeset
|
135 | |
9325 | 136 | <dl> |
137 | <dt>Return:</dt> | |
138 | <dd> | |
139 | dictionary containing checker lists containing checker function and | |
140 | list of codes | |
141 | </dd> | |
142 | </dl> | |
143 | <dl> | |
144 | <dt>Return Type:</dt> | |
145 | <dd> | |
146 | dict | |
147 | </dd> | |
148 | </dl> | |
149 | <div align="right"><a href="#top">Up</a></div> | |
150 | <hr /> | |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10259
diff
changeset
|
151 | </body></html> |