docs/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/luci.xml.html">luci.xml</a>
 131         </li>
 132
 133         <li>
 134                 <a href="../modules/nixio.html">nixio</a>
 135         </li>
 136
 137         <li>
 138                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 139         </li>
 140
 141         <li>
 142                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 143         </li>
 144
 145         <li>
 146                 <a href="../modules/nixio.File.html">nixio.File</a>
 147         </li>
 148
 149         <li>
 150                 <a href="../modules/nixio.README.html">nixio.README</a>
 151         </li>
 152
 153         <li>
 154                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 155         </li>
 156
 157         <li><strong>nixio.TLSContext</strong></li>
 158
 159         <li>
 160                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 161         </li>
 162
 163         <li>
 164                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 165         </li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 177         </li>
 178
 179         <li>
 180                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 181         </li>
 182
 183 </ul>
 184
 185
 186
 187 <!-- File list -->
 188
 189
 190
 191
 192
 193
 194
 195 </div><!-- id="navigation" -->
 196
 197 <div id="content">
 198
 199 <h1>Object Instance <code>nixio.TLSContext</code></h1>
 200
 201 <p>
 202  Transport Layer Security Context Object.</p>
 203
 204
 205
 206
 207
 208
 209
 210 <h2>Functions</h2>
 211 <table class="function_list">
 212
 213         <tr>
 214         <td class="name" nowrap><a href="#TLSContext.create">TLSContext:create</a>&nbsp;(socket)</td>
 215         <td class="summary">
 216  Create a TLS Socket from a socket descriptor.</td>
 217         </tr>
 218
 219         <tr>
 220         <td class="name" nowrap><a href="#TLSContext.set_cert">TLSContext:set_cert</a>&nbsp;(path)</td>
 221         <td class="summary">
 222  Assign a PEM certificate to this context.</td>
 223         </tr>
 224
 225         <tr>
 226         <td class="name" nowrap><a href="#TLSContext.set_ciphers">TLSContext:set_ciphers</a>&nbsp;(cipherlist)</td>
 227         <td class="summary">
 228  Set the available ciphers for this context.</td>
 229         </tr>
 230
 231         <tr>
 232         <td class="name" nowrap><a href="#TLSContext.set_key">TLSContext:set_key</a>&nbsp;(path)</td>
 233         <td class="summary">
 234  Assign a PEM private key to this context.</td>
 235         </tr>
 236
 237         <tr>
 238         <td class="name" nowrap><a href="#TLSContext.set_verify">TLSContext:set_verify</a>&nbsp;(flag1, ...)</td>
 239         <td class="summary">
 240  Set the verification flags of this context.</td>
 241         </tr>
 242
 243         <tr>
 244         <td class="name" nowrap><a href="#TLSContext.set_verify_depth">TLSContext:set_verify_depth</a>&nbsp;(depth)</td>
 245         <td class="summary">
 246  Set the verification depth of this context.</td>
 247         </tr>
 248
 249 </table>
 250
 251
 252
 253
 254
 255
 256 <br/>
 257 <br/>
 258
 259
 260 <h2><a name="functions"></a>Functions</h2>
 261 <dl class="function">
 262
 263
 264
 265 <dt><a name="TLSContext.create"></a><strong>TLSContext:create</strong>&nbsp;(socket)</dt>
 266 <dd>
 267
 268  Create a TLS Socket from a socket descriptor.
 269
 270
 271 <h3>Parameters</h3>
 272 <ul>
 273
 274         <li>
 275           socket: Socket Object
 276         </li>
 277
 278 </ul>
 279
 280
 281
 282
 283
 284
 285 <h3>Return value:</h3>
 286 TLSSocket Object
 287
 288
 289
 290 </dd>
 291
 292
 293
 294
 295 <dt><a name="TLSContext.set_cert"></a><strong>TLSContext:set_cert</strong>&nbsp;(path)</dt>
 296 <dd>
 297
 298  Assign a PEM certificate to this context.
 299
 300
 301 <h3>Parameters</h3>
 302 <ul>
 303
 304         <li>
 305           path: Certificate File path
 306         </li>
 307
 308 </ul>
 309
 310
 311
 312
 313 <h3>Usage:</h3>
 314 This function calls SSL_CTX_use_certificate_chain_file().
 315
 316
 317
 318 <h3>Return value:</h3>
 319 true
 320
 321
 322
 323 </dd>
 324
 325
 326
 327
 328 <dt><a name="TLSContext.set_ciphers"></a><strong>TLSContext:set_ciphers</strong>&nbsp;(cipherlist)</dt>
 329 <dd>
 330
 331  Set the available ciphers for this context.
 332
 333
 334 <h3>Parameters</h3>
 335 <ul>
 336
 337         <li>
 338           cipherlist: String containing a list of ciphers
 339         </li>
 340
 341 </ul>
 342
 343
 344
 345
 346 <h3>Usage:</h3>
 347 This function calls SSL_CTX_set_cipher_list().
 348
 349
 350
 351 <h3>Return value:</h3>
 352 true
 353
 354
 355
 356 </dd>
 357
 358
 359
 360
 361 <dt><a name="TLSContext.set_key"></a><strong>TLSContext:set_key</strong>&nbsp;(path)</dt>
 362 <dd>
 363
 364  Assign a PEM private key to this context.
 365
 366
 367 <h3>Parameters</h3>
 368 <ul>
 369
 370         <li>
 371           path: Private Key File path
 372         </li>
 373
 374 </ul>
 375
 376
 377
 378
 379 <h3>Usage:</h3>
 380 This function calls SSL_CTX_use_PrivateKey_file().
 381
 382
 383
 384 <h3>Return value:</h3>
 385 true
 386
 387
 388
 389 </dd>
 390
 391
 392
 393
 394 <dt><a name="TLSContext.set_verify"></a><strong>TLSContext:set_verify</strong>&nbsp;(flag1, ...)</dt>
 395 <dd>
 396
 397  Set the verification flags of this context.
 398
 399
 400 <h3>Parameters</h3>
 401 <ul>
 402
 403         <li>
 404           flag1: First Flag     ["none", "peer", "verify_fail_if_no_peer_cert",
 405  "client_once"]
 406         </li>
 407
 408         <li>
 409           ...: More Flags       [-"-]
 410         </li>
 411
 412 </ul>
 413
 414
 415
 416
 417 <h3>Usage:</h3>
 418 This function calls SSL_CTX_set_verify().
 419
 420
 421
 422 <h3>Return value:</h3>
 423 true
 424
 425
 426
 427 </dd>
 428
 429
 430
 431
 432 <dt><a name="TLSContext.set_verify_depth"></a><strong>TLSContext:set_verify_depth</strong>&nbsp;(depth)</dt>
 433 <dd>
 434
 435  Set the verification depth of this context.
 436
 437
 438 <h3>Parameters</h3>
 439 <ul>
 440
 441         <li>
 442           depth: Depth
 443         </li>
 444
 445 </ul>
 446
 447
 448
 449
 450 <h3>Usage:</h3>
 451 This function calls SSL_CTX_set_verify_depth().
 452
 453
 454
 455 <h3>Return value:</h3>
 456 true
 457
 458
 459
 460 </dd>
 461
 462
 463 </dl>
 464
 465
 466
 467
 468
 469 </div> <!-- id="content" -->
 470
 471 </div> <!-- id="main" -->
 472
 473 <div id="about">
 474         <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>
 475 </div> <!-- id="about" -->
 476
 477 </div> <!-- id="container" -->
 478 </body>
 479 </html>