doc/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.protocol.html">luci.http.protocol</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.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.jsonc.html">luci.jsonc</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
  87         </li>
  88
  89         <li>
  90                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
  91         </li>
  92
  93         <li>
  94                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
  95         </li>
  96
  97         <li>
  98                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
  99         </li>
 100
 101         <li>
 102                 <a href="../modules/nixio.html">nixio</a>
 103         </li>
 104
 105         <li>
 106                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 107         </li>
 108
 109         <li>
 110                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 111         </li>
 112
 113         <li>
 114                 <a href="../modules/nixio.File.html">nixio.File</a>
 115         </li>
 116
 117         <li>
 118                 <a href="../modules/nixio.README.html">nixio.README</a>
 119         </li>
 120
 121         <li>
 122                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 123         </li>
 124
 125         <li><strong>nixio.TLSContext</strong></li>
 126
 127         <li>
 128                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 149         </li>
 150
 151 </ul>
 152
 153
 154
 155 <!-- File list -->
 156
 157
 158
 159
 160
 161
 162
 163 </div><!-- id="navigation" -->
 164
 165 <div id="content">
 166
 167 <h1>Object Instance <code>nixio.TLSContext</code></h1>
 168
 169 <p>
 170  Transport Layer Security Context Object.</p>
 171
 172
 173
 174
 175
 176
 177
 178 <h2>Functions</h2>
 179 <table class="function_list">
 180
 181         <tr>
 182         <td class="name" nowrap><a href="#TLSContext.create">TLSContext:create</a>&nbsp;(socket)</td>
 183         <td class="summary">
 184  Create a TLS Socket from a socket descriptor.</td>
 185         </tr>
 186
 187         <tr>
 188         <td class="name" nowrap><a href="#TLSContext.set_cert">TLSContext:set_cert</a>&nbsp;(path)</td>
 189         <td class="summary">
 190  Assign a PEM certificate to this context.</td>
 191         </tr>
 192
 193         <tr>
 194         <td class="name" nowrap><a href="#TLSContext.set_ciphers">TLSContext:set_ciphers</a>&nbsp;(cipherlist)</td>
 195         <td class="summary">
 196  Set the available ciphers for this context.</td>
 197         </tr>
 198
 199         <tr>
 200         <td class="name" nowrap><a href="#TLSContext.set_key">TLSContext:set_key</a>&nbsp;(path)</td>
 201         <td class="summary">
 202  Assign a PEM private key to this context.</td>
 203         </tr>
 204
 205         <tr>
 206         <td class="name" nowrap><a href="#TLSContext.set_verify">TLSContext:set_verify</a>&nbsp;(flag1, ...)</td>
 207         <td class="summary">
 208  Set the verification flags of this context.</td>
 209         </tr>
 210
 211         <tr>
 212         <td class="name" nowrap><a href="#TLSContext.set_verify_depth">TLSContext:set_verify_depth</a>&nbsp;(depth)</td>
 213         <td class="summary">
 214  Set the verification depth of this context.</td>
 215         </tr>
 216
 217 </table>
 218
 219
 220
 221
 222
 223
 224 <br/>
 225 <br/>
 226
 227
 228 <h2><a name="functions"></a>Functions</h2>
 229 <dl class="function">
 230
 231
 232
 233 <dt><a name="TLSContext.create"></a><strong>TLSContext:create</strong>&nbsp;(socket)</dt>
 234 <dd>
 235
 236  Create a TLS Socket from a socket descriptor.
 237
 238
 239 <h3>Parameters</h3>
 240 <ul>
 241
 242         <li>
 243           socket: Socket Object
 244         </li>
 245
 246 </ul>
 247
 248
 249
 250
 251
 252
 253 <h3>Return value:</h3>
 254 TLSSocket Object
 255
 256
 257
 258 </dd>
 259
 260
 261
 262
 263 <dt><a name="TLSContext.set_cert"></a><strong>TLSContext:set_cert</strong>&nbsp;(path)</dt>
 264 <dd>
 265
 266  Assign a PEM certificate to this context.
 267
 268
 269 <h3>Parameters</h3>
 270 <ul>
 271
 272         <li>
 273           path: Certificate File path
 274         </li>
 275
 276 </ul>
 277
 278
 279
 280
 281 <h3>Usage:</h3>
 282 This function calls SSL_CTX_use_certificate_chain_file().
 283
 284
 285
 286 <h3>Return value:</h3>
 287 true
 288
 289
 290
 291 </dd>
 292
 293
 294
 295
 296 <dt><a name="TLSContext.set_ciphers"></a><strong>TLSContext:set_ciphers</strong>&nbsp;(cipherlist)</dt>
 297 <dd>
 298
 299  Set the available ciphers for this context.
 300
 301
 302 <h3>Parameters</h3>
 303 <ul>
 304
 305         <li>
 306           cipherlist: String containing a list of ciphers
 307         </li>
 308
 309 </ul>
 310
 311
 312
 313
 314 <h3>Usage:</h3>
 315 This function calls SSL_CTX_set_cipher_list().
 316
 317
 318
 319 <h3>Return value:</h3>
 320 true
 321
 322
 323
 324 </dd>
 325
 326
 327
 328
 329 <dt><a name="TLSContext.set_key"></a><strong>TLSContext:set_key</strong>&nbsp;(path)</dt>
 330 <dd>
 331
 332  Assign a PEM private key to this context.
 333
 334
 335 <h3>Parameters</h3>
 336 <ul>
 337
 338         <li>
 339           path: Private Key File path
 340         </li>
 341
 342 </ul>
 343
 344
 345
 346
 347 <h3>Usage:</h3>
 348 This function calls SSL_CTX_use_PrivateKey_file().
 349
 350
 351
 352 <h3>Return value:</h3>
 353 true
 354
 355
 356
 357 </dd>
 358
 359
 360
 361
 362 <dt><a name="TLSContext.set_verify"></a><strong>TLSContext:set_verify</strong>&nbsp;(flag1, ...)</dt>
 363 <dd>
 364
 365  Set the verification flags of this context.
 366
 367
 368 <h3>Parameters</h3>
 369 <ul>
 370
 371         <li>
 372           flag1: First Flag     ["none", "peer", "verify_fail_if_no_peer_cert",
 373  "client_once"]
 374         </li>
 375
 376         <li>
 377           ...: More Flags       [-"-]
 378         </li>
 379
 380 </ul>
 381
 382
 383
 384
 385 <h3>Usage:</h3>
 386 This function calls SSL_CTX_set_verify().
 387
 388
 389
 390 <h3>Return value:</h3>
 391 true
 392
 393
 394
 395 </dd>
 396
 397
 398
 399
 400 <dt><a name="TLSContext.set_verify_depth"></a><strong>TLSContext:set_verify_depth</strong>&nbsp;(depth)</dt>
 401 <dd>
 402
 403  Set the verification depth of this context.
 404
 405
 406 <h3>Parameters</h3>
 407 <ul>
 408
 409         <li>
 410           depth: Depth
 411         </li>
 412
 413 </ul>
 414
 415
 416
 417
 418 <h3>Usage:</h3>
 419 This function calls SSL_CTX_set_verify_depth().
 420
 421
 422
 423 <h3>Return value:</h3>
 424 true
 425
 426
 427
 428 </dd>
 429
 430
 431 </dl>
 432
 433
 434
 435
 436
 437 </div> <!-- id="content" -->
 438
 439 </div> <!-- id="main" -->
 440
 441 <div id="about">
 442         <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>
 443 </div> <!-- id="about" -->
 444
 445 </div> <!-- id="container" -->
 446 </body>
 447 </html>