src/eric7/Documentation/Source/eric7.EricNetwork.EricSslErrorHandler.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10423
299802979277
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.EricNetwork.EricSslErrorHandler</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.EricNetwork.EricSslErrorHandler</h1>
10
11 <p>
12 Module implementing a SSL error handler.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#EricSslErrorHandler">EricSslErrorHandler</a></td>
25 <td>Class implementing a handler for SSL errors.</td>
26 </tr>
27 <tr>
28 <td><a href="#EricSslErrorState">EricSslErrorState</a></td>
29 <td>Class defining the SSL error handling states.</td>
30 </tr>
31 </table>
32 <h3>Functions</h3>
33
34 <table>
35 <tr><td>None</td></tr>
36 </table>
37 <hr />
38 <hr />
39 <a NAME="EricSslErrorHandler" ID="EricSslErrorHandler"></a>
40 <h2>EricSslErrorHandler</h2>
41
42 <p>
43 Class implementing a handler for SSL errors.
44 </p>
45 <p>
46 It also initializes the default SSL configuration with certificates
47 permanently accepted by the user already.
48 </p>
49 <h3>Derived from</h3>
50 QObject
51 <h3>Class Attributes</h3>
52
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62
63 <table>
64
65 <tr>
66 <td><a href="#EricSslErrorHandler.__init__">EricSslErrorHandler</a></td>
67 <td>Constructor</td>
68 </tr>
69 <tr>
70 <td><a href="#EricSslErrorHandler.__certToString">__certToString</a></td>
71 <td>Private method to convert a certificate to a formatted string.</td>
72 </tr>
73 <tr>
74 <td><a href="#EricSslErrorHandler.__getSystemCaCertificates">__getSystemCaCertificates</a></td>
75 <td>Private method to get the list of system certificates.</td>
76 </tr>
77 <tr>
78 <td><a href="#EricSslErrorHandler.sslErrors">sslErrors</a></td>
79 <td>Public method to handle SSL errors.</td>
80 </tr>
81 <tr>
82 <td><a href="#EricSslErrorHandler.sslErrorsReply">sslErrorsReply</a></td>
83 <td>Public slot to handle SSL errors for a network reply.</td>
84 </tr>
85 <tr>
86 <td><a href="#EricSslErrorHandler.sslErrorsReplySlot">sslErrorsReplySlot</a></td>
87 <td>Public slot to handle SSL errors for a network reply.</td>
88 </tr>
89 </table>
90 <h3>Static Methods</h3>
91
92 <table>
93 <tr><td>None</td></tr>
94 </table>
95
96 <a NAME="EricSslErrorHandler.__init__" ID="EricSslErrorHandler.__init__"></a>
97 <h4>EricSslErrorHandler (Constructor)</h4>
98 <b>EricSslErrorHandler</b>(<i>parent=None</i>)
99
100 <p>
101 Constructor
102 </p>
103 <dl>
104
105 <dt><i>parent</i></dt>
106 <dd>
107 reference to the parent object (QObject)
108 </dd>
109 </dl>
110 <a NAME="EricSslErrorHandler.__certToString" ID="EricSslErrorHandler.__certToString"></a>
111 <h4>EricSslErrorHandler.__certToString</h4>
112 <b>__certToString</b>(<i>cert</i>)
113
114 <p>
115 Private method to convert a certificate to a formatted string.
116 </p>
117 <dl>
118
119 <dt><i>cert</i></dt>
120 <dd>
121 certificate to convert (QSslCertificate)
122 </dd>
123 </dl>
124 <dl>
125 <dt>Return:</dt>
126 <dd>
127 formatted string (string)
128 </dd>
129 </dl>
130 <a NAME="EricSslErrorHandler.__getSystemCaCertificates" ID="EricSslErrorHandler.__getSystemCaCertificates"></a>
131 <h4>EricSslErrorHandler.__getSystemCaCertificates</h4>
132 <b>__getSystemCaCertificates</b>(<i></i>)
133
134 <p>
135 Private method to get the list of system certificates.
136 </p>
137 <dl>
138 <dt>Return:</dt>
139 <dd>
140 list of system certificates (list of QSslCertificate)
141 </dd>
142 </dl>
143 <a NAME="EricSslErrorHandler.sslErrors" ID="EricSslErrorHandler.sslErrors"></a>
144 <h4>EricSslErrorHandler.sslErrors</h4>
145 <b>sslErrors</b>(<i>errors, server, port=-1</i>)
146
147 <p>
148 Public method to handle SSL errors.
149 </p>
150 <dl>
151
152 <dt><i>errors</i> (list of QSslError)</dt>
153 <dd>
154 list of SSL errors
155 </dd>
156 <dt><i>server</i> (str)</dt>
157 <dd>
158 name of the server
159 </dd>
160 <dt><i>port</i> (int)</dt>
161 <dd>
162 value of the port
163 </dd>
164 </dl>
165 <dl>
166 <dt>Return:</dt>
167 <dd>
168 tuple indicating to ignore the SSL errors and indicating a
169 change of the default SSL configuration
170 </dd>
171 </dl>
172 <dl>
173 <dt>Return Type:</dt>
174 <dd>
175 tuple of (EricSslErrorState, bool)
176 </dd>
177 </dl>
178 <a NAME="EricSslErrorHandler.sslErrorsReply" ID="EricSslErrorHandler.sslErrorsReply"></a>
179 <h4>EricSslErrorHandler.sslErrorsReply</h4>
180 <b>sslErrorsReply</b>(<i>reply, errors</i>)
181
182 <p>
183 Public slot to handle SSL errors for a network reply.
184 </p>
185 <dl>
186
187 <dt><i>reply</i></dt>
188 <dd>
189 reference to the reply object (QNetworkReply)
190 </dd>
191 <dt><i>errors</i></dt>
192 <dd>
193 list of SSL errors (list of QSslError)
194 </dd>
195 </dl>
196 <dl>
197 <dt>Return:</dt>
198 <dd>
199 tuple indicating to ignore the SSL errors (one of NotIgnored,
200 SystemIgnored or UserIgnored) and indicating a change of the
201 default SSL configuration (boolean)
202 </dd>
203 </dl>
204 <a NAME="EricSslErrorHandler.sslErrorsReplySlot" ID="EricSslErrorHandler.sslErrorsReplySlot"></a>
205 <h4>EricSslErrorHandler.sslErrorsReplySlot</h4>
206 <b>sslErrorsReplySlot</b>(<i>reply, errors</i>)
207
208 <p>
209 Public slot to handle SSL errors for a network reply.
210 </p>
211 <dl>
212
213 <dt><i>reply</i></dt>
214 <dd>
215 reference to the reply object (QNetworkReply)
216 </dd>
217 <dt><i>errors</i></dt>
218 <dd>
219 list of SSL errors (list of QSslError)
220 </dd>
221 </dl>
222 <div align="right"><a href="#top">Up</a></div>
223 <hr />
224 <hr />
225 <a NAME="EricSslErrorState" ID="EricSslErrorState"></a>
226 <h2>EricSslErrorState</h2>
227
228 <p>
229 Class defining the SSL error handling states.
230 </p>
231 <h3>Derived from</h3>
232 enum.Enum
233 <h3>Class Attributes</h3>
234
235 <table>
236 <tr><td>NOT_IGNORED</td></tr><tr><td>SYSTEM_IGNORED</td></tr><tr><td>USER_IGNORED</td></tr>
237 </table>
238 <h3>Class Methods</h3>
239
240 <table>
241 <tr><td>None</td></tr>
242 </table>
243 <h3>Methods</h3>
244
245 <table>
246 <tr><td>None</td></tr>
247 </table>
248 <h3>Static Methods</h3>
249
250 <table>
251 <tr><td>None</td></tr>
252 </table>
253
254 <div align="right"><a href="#top">Up</a></div>
255 <hr />
256 </body></html>

eric ide

mercurial