Merge pull request #1818 from dibdot/lxc_fix
[project/luci.git] / documentation / api / modules / nixio.TLSContext.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html>
4 <head>
5     <title>Reference</title>
6     <link rel="stylesheet" href="../luadoc.css" type="text/css" />
7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
8 </head>
9
10 <body>
11 <div id="container">
12
13 <div id="product">
14         <div id="product_logo"></div>
15         <div id="product_name"><big><b></b></big></div>
16         <div id="product_description"></div>
17 </div> <!-- id="product" -->
18
19 <div id="main">
20
21 <div id="navigation">
22
23
24 <h1>LuaDoc</h1>
25 <ul>
26         
27         <li><a href="../index.html">Index</a></li>
28         
29 </ul>
30
31
32 <!-- Module list -->
33
34 <h1>Modules</h1>
35 <ul>
36
37         <li>
38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
39         </li>
40
41         <li>
42                 <a href="../modules/luci.http.html">luci.http</a>
43         </li>
44
45         <li>
46                 <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
47         </li>
48
49         <li>
50                 <a href="../modules/luci.http.date.html">luci.http.date</a>
51         </li>
52
53         <li>
54                 <a href="../modules/luci.http.mime.html">luci.http.mime</a>
55         </li>
56
57         <li>
58                 <a href="../modules/luci.i18n.html">luci.i18n</a>
59         </li>
60
61         <li>
62                 <a href="../modules/luci.ip.html">luci.ip</a>
63         </li>
64
65         <li>
66                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
67         </li>
68
69         <li>
70                 <a href="../modules/luci.json.html">luci.json</a>
71         </li>
72
73         <li>
74                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
75         </li>
76
77         <li>
78                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
79         </li>
80
81         <li>
82                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
83         </li>
84
85         <li>
86                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
87         </li>
88
89         <li>
90                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
91         </li>
92
93         <li>
94                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
95         </li>
96
97         <li>
98                 <a href="../modules/luci.sys.html">luci.sys</a>
99         </li>
100
101         <li>
102                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
103         </li>
104
105         <li>
106                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
107         </li>
108
109         <li>
110                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
111         </li>
112
113         <li>
114                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
115         </li>
116
117         <li>
118                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
119         </li>
120
121         <li>
122                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
123         </li>
124
125         <li>
126                 <a href="../modules/luci.util.html">luci.util</a>
127         </li>
128
129         <li>
130                 <a href="../modules/nixio.html">nixio</a>
131         </li>
132
133         <li>
134                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
135         </li>
136
137         <li>
138                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
139         </li>
140
141         <li>
142                 <a href="../modules/nixio.File.html">nixio.File</a>
143         </li>
144
145         <li>
146                 <a href="../modules/nixio.README.html">nixio.README</a>
147         </li>
148
149         <li>
150                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
151         </li>
152
153         <li><strong>nixio.TLSContext</strong></li>
154         
155         <li>
156                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
157         </li>
158
159         <li>
160                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
161         </li>
162
163         <li>
164                 <a href="../modules/nixio.bin.html">nixio.bin</a>
165         </li>
166
167         <li>
168                 <a href="../modules/nixio.bit.html">nixio.bit</a>
169         </li>
170
171         <li>
172                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
173         </li>
174
175         <li>
176                 <a href="../modules/nixio.fs.html">nixio.fs</a>
177         </li>
178
179 </ul>
180
181
182
183 <!-- File list -->
184
185
186
187
188
189
190
191 </div><!-- id="navigation" -->
192
193 <div id="content">
194
195 <h1>Object Instance <code>nixio.TLSContext</code></h1>
196
197 <p>
198  Transport Layer Security Context Object.</p>
199
200
201
202
203
204
205
206 <h2>Functions</h2>
207 <table class="function_list">
208
209         <tr>
210         <td class="name" nowrap><a href="#TLSContext.create">TLSContext:create</a>&nbsp;(socket)</td>
211         <td class="summary">
212  Create a TLS Socket from a socket descriptor.</td>
213         </tr>
214
215         <tr>
216         <td class="name" nowrap><a href="#TLSContext.set_cert">TLSContext:set_cert</a>&nbsp;(path)</td>
217         <td class="summary">
218  Assign a PEM certificate to this context.</td>
219         </tr>
220
221         <tr>
222         <td class="name" nowrap><a href="#TLSContext.set_ciphers">TLSContext:set_ciphers</a>&nbsp;(cipherlist)</td>
223         <td class="summary">
224  Set the available ciphers for this context.</td>
225         </tr>
226
227         <tr>
228         <td class="name" nowrap><a href="#TLSContext.set_key">TLSContext:set_key</a>&nbsp;(path)</td>
229         <td class="summary">
230  Assign a PEM private key to this context.</td>
231         </tr>
232
233         <tr>
234         <td class="name" nowrap><a href="#TLSContext.set_verify">TLSContext:set_verify</a>&nbsp;(flag1, ...)</td>
235         <td class="summary">
236  Set the verification flags of this context.</td>
237         </tr>
238
239         <tr>
240         <td class="name" nowrap><a href="#TLSContext.set_verify_depth">TLSContext:set_verify_depth</a>&nbsp;(depth)</td>
241         <td class="summary">
242  Set the verification depth of this context.</td>
243         </tr>
244
245 </table>
246
247
248
249
250
251
252 <br/>
253 <br/>
254
255
256 <h2><a name="functions"></a>Functions</h2>
257 <dl class="function">
258
259
260
261 <dt><a name="TLSContext.create"></a><strong>TLSContext:create</strong>&nbsp;(socket)</dt>
262 <dd>
263
264  Create a TLS Socket from a socket descriptor.
265
266
267 <h3>Parameters</h3>
268 <ul>
269         
270         <li>
271           socket: Socket Object
272         </li>
273         
274 </ul>
275
276
277
278
279
280
281 <h3>Return value:</h3>
282 TLSSocket Object
283
284
285
286 </dd>
287
288
289
290
291 <dt><a name="TLSContext.set_cert"></a><strong>TLSContext:set_cert</strong>&nbsp;(path)</dt>
292 <dd>
293
294  Assign a PEM certificate to this context.
295
296
297 <h3>Parameters</h3>
298 <ul>
299         
300         <li>
301           path: Certificate File path
302         </li>
303         
304 </ul>
305
306
307
308
309 <h3>Usage:</h3>
310 This function calls SSL_CTX_use_certificate_chain_file().
311
312
313
314 <h3>Return value:</h3>
315 true
316
317
318
319 </dd>
320
321
322
323
324 <dt><a name="TLSContext.set_ciphers"></a><strong>TLSContext:set_ciphers</strong>&nbsp;(cipherlist)</dt>
325 <dd>
326
327  Set the available ciphers for this context.
328
329
330 <h3>Parameters</h3>
331 <ul>
332         
333         <li>
334           cipherlist: String containing a list of ciphers
335         </li>
336         
337 </ul>
338
339
340
341
342 <h3>Usage:</h3>
343 This function calls SSL_CTX_set_cipher_list().
344
345
346
347 <h3>Return value:</h3>
348 true
349
350
351
352 </dd>
353
354
355
356
357 <dt><a name="TLSContext.set_key"></a><strong>TLSContext:set_key</strong>&nbsp;(path)</dt>
358 <dd>
359
360  Assign a PEM private key to this context.
361
362
363 <h3>Parameters</h3>
364 <ul>
365         
366         <li>
367           path: Private Key File path
368         </li>
369         
370 </ul>
371
372
373
374
375 <h3>Usage:</h3>
376 This function calls SSL_CTX_use_PrivateKey_file().
377
378
379
380 <h3>Return value:</h3>
381 true
382
383
384
385 </dd>
386
387
388
389
390 <dt><a name="TLSContext.set_verify"></a><strong>TLSContext:set_verify</strong>&nbsp;(flag1, ...)</dt>
391 <dd>
392
393  Set the verification flags of this context.
394
395
396 <h3>Parameters</h3>
397 <ul>
398         
399         <li>
400           flag1: First Flag     ["none", "peer", "verify_fail_if_no_peer_cert",  
401  "client_once"]
402         </li>
403         
404         <li>
405           ...: More Flags       [-"-]
406         </li>
407         
408 </ul>
409
410
411
412
413 <h3>Usage:</h3>
414 This function calls SSL_CTX_set_verify().
415
416
417
418 <h3>Return value:</h3>
419 true
420
421
422
423 </dd>
424
425
426
427
428 <dt><a name="TLSContext.set_verify_depth"></a><strong>TLSContext:set_verify_depth</strong>&nbsp;(depth)</dt>
429 <dd>
430
431  Set the verification depth of this context.
432
433
434 <h3>Parameters</h3>
435 <ul>
436         
437         <li>
438           depth: Depth
439         </li>
440         
441 </ul>
442
443
444
445
446 <h3>Usage:</h3>
447 This function calls SSL_CTX_set_verify_depth().
448
449
450
451 <h3>Return value:</h3>
452 true
453
454
455
456 </dd>
457
458
459 </dl>
460
461
462
463
464
465 </div> <!-- id="content" -->
466
467 </div> <!-- id="main" -->
468
469 <div id="about">
470         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
471 </div> <!-- id="about" -->
472
473 </div> <!-- id="container" -->
474 </body>
475 </html>