Thu, 04 Jan 2024 18:02:25 +0100
Fine tuned the source code documentation template and regenerated the source code documentation.
9325 | 1 | <!DOCTYPE html> |
2 | <html><head> | |
3 | <title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.snmpSecurity</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.snmpSecurity</h1> | |
10 | <p> | |
11 | Module implementing checks for the insecure use of SNMP. | |
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="#checkInsecureVersion">checkInsecureVersion</a></td> | |
10259
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
28 | <td>Function to check for the use of insecure SNMP version like v1, v2c.</td> |
9325 | 29 | </tr> |
30 | <tr> | |
31 | <td><a href="#checkWeakCryptography">checkWeakCryptography</a></td> | |
10259
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
32 | <td>Function to check for the use of insecure SNMP cryptography (i.e.</td> |
9325 | 33 | </tr> |
34 | <tr> | |
35 | <td><a href="#getChecks">getChecks</a></td> | |
36 | <td>Public method to get a dictionary with checks handled by this module.</td> | |
37 | </tr> | |
38 | </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
|
39 | |
9325 | 40 | <hr /> |
41 | <hr /> | |
42 | <a NAME="checkInsecureVersion" ID="checkInsecureVersion"></a> | |
43 | <h2>checkInsecureVersion</h2> | |
44 | <b>checkInsecureVersion</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
|
45 | <p> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
46 | Function to check for the use of insecure SNMP version like |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
47 | v1, v2c. |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
48 | </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
|
49 | |
10259
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
50 | <dl> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
51 | |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
52 | <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
|
53 | <dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
54 | 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
|
55 | </dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
56 | <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
|
57 | <dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
58 | security context object |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
59 | </dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
60 | <dt><i>config</i> (dict)</dt> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
61 | <dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
62 | dictionary with configuration data |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
63 | </dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
64 | </dl> |
9325 | 65 | <div align="right"><a href="#top">Up</a></div> |
66 | <hr /> | |
67 | <hr /> | |
68 | <a NAME="checkWeakCryptography" ID="checkWeakCryptography"></a> | |
69 | <h2>checkWeakCryptography</h2> | |
70 | <b>checkWeakCryptography</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
|
71 | <p> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
72 | Function to check for the use of insecure SNMP cryptography |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
73 | (i.e. v3 using noAuthNoPriv). |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
74 | </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
|
75 | |
10259
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
76 | <dl> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
77 | |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
78 | <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
|
79 | <dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
80 | 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
|
81 | </dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
82 | <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
|
83 | <dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
84 | security context object |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
85 | </dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
86 | <dt><i>config</i> (dict)</dt> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
87 | <dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
88 | dictionary with configuration data |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
89 | </dd> |
b51dfacef37f
Regenerated the source documentation with the corrected module parser.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10070
diff
changeset
|
90 | </dl> |
9325 | 91 | <div align="right"><a href="#top">Up</a></div> |
92 | <hr /> | |
93 | <hr /> | |
94 | <a NAME="getChecks" ID="getChecks"></a> | |
95 | <h2>getChecks</h2> | |
96 | <b>getChecks</b>(<i></i>) | |
97 | <p> | |
98 | Public method to get a dictionary with checks handled by this module. | |
99 | </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
|
100 | |
9325 | 101 | <dl> |
102 | <dt>Return:</dt> | |
103 | <dd> | |
104 | dictionary containing checker lists containing checker function and | |
105 | list of codes | |
106 | </dd> | |
107 | </dl> | |
108 | <dl> | |
109 | <dt>Return Type:</dt> | |
110 | <dd> | |
111 | dict | |
112 | </dd> | |
113 | </dl> | |
114 | <div align="right"><a href="#top">Up</a></div> | |
115 | <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
|
116 | </body></html> |