diff options
| author | Jo-Philipp Wich <jow@openwrt.org> | 2015-09-01 16:44:03 +0200 |
|---|---|---|
| committer | Jo-Philipp Wich <jow@openwrt.org> | 2015-09-01 16:44:03 +0200 |
| commit | 00e2b03927b5c107aefef1c71ef14facd4c3cb77 (patch) | |
| tree | c6ad87ea21b6d026290537e70e054df2cbb8d682 /documentation/api/modules/nixio.TLSContext.html | |
| parent | ed1a6416964df17b3a76a7043734d0fde4a6bd41 (diff) | |
Move doc/ to documentation/api/
Signed-off-by: Jo-Philipp Wich <jow@openwrt.org>
Diffstat (limited to 'documentation/api/modules/nixio.TLSContext.html')
| -rw-r--r-- | documentation/api/modules/nixio.TLSContext.html | 447 |
1 files changed, 447 insertions, 0 deletions
diff --git a/documentation/api/modules/nixio.TLSContext.html b/documentation/api/modules/nixio.TLSContext.html new file mode 100644 index 0000000000..a0f630974f --- /dev/null +++ b/documentation/api/modules/nixio.TLSContext.html @@ -0,0 +1,447 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<head> + <title>Reference</title> + <link rel="stylesheet" href="../luadoc.css" type="text/css" /> + <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/--> +</head> + +<body> +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + +<div id="main"> + +<div id="navigation"> + + +<h1>LuaDoc</h1> +<ul> + + <li><a href="../index.html">Index</a></li> + +</ul> + + +<!-- Module list --> + +<h1>Modules</h1> +<ul> + + <li> + <a href="../modules/luci.dispatcher.html">luci.dispatcher</a> + </li> + + <li> + <a href="../modules/luci.http.protocol.html">luci.http.protocol</a> + </li> + + <li> + <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a> + </li> + + <li> + <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a> + </li> + + <li> + <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a> + </li> + + <li> + <a href="../modules/luci.i18n.html">luci.i18n</a> + </li> + + <li> + <a href="../modules/luci.ip.html">luci.ip</a> + </li> + + <li> + <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a> + </li> + + <li> + <a href="../modules/luci.jsonc.html">luci.jsonc</a> + </li> + + <li> + <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a> + </li> + + <li> + <a href="../modules/luci.sys.init.html">luci.sys.init</a> + </li> + + <li> + <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a> + </li> + + <li> + <a href="../modules/luci.sys.net.html">luci.sys.net</a> + </li> + + <li> + <a href="../modules/luci.sys.process.html">luci.sys.process</a> + </li> + + <li> + <a href="../modules/luci.sys.user.html">luci.sys.user</a> + </li> + + <li> + <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a> + </li> + + <li> + <a href="../modules/nixio.html">nixio</a> + </li> + + <li> + <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a> + </li> + + <li> + <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a> + </li> + + <li> + <a href="../modules/nixio.File.html">nixio.File</a> + </li> + + <li> + <a href="../modules/nixio.README.html">nixio.README</a> + </li> + + <li> + <a href="../modules/nixio.Socket.html">nixio.Socket</a> + </li> + + <li><strong>nixio.TLSContext</strong></li> + + <li> + <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a> + </li> + + <li> + <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a> + </li> + + <li> + <a href="../modules/nixio.bin.html">nixio.bin</a> + </li> + + <li> + <a href="../modules/nixio.bit.html">nixio.bit</a> + </li> + + <li> + <a href="../modules/nixio.crypto.html">nixio.crypto</a> + </li> + + <li> + <a href="../modules/nixio.fs.html">nixio.fs</a> + </li> + +</ul> + + + +<!-- File list --> + + + + + + + +</div><!-- id="navigation" --> + +<div id="content"> + +<h1>Object Instance <code>nixio.TLSContext</code></h1> + +<p> + Transport Layer Security Context Object.</p> + + + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#TLSContext.create">TLSContext:create</a> (socket)</td> + <td class="summary"> + Create a TLS Socket from a socket descriptor.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#TLSContext.set_cert">TLSContext:set_cert</a> (path)</td> + <td class="summary"> + Assign a PEM certificate to this context.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#TLSContext.set_ciphers">TLSContext:set_ciphers</a> (cipherlist)</td> + <td class="summary"> + Set the available ciphers for this context.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#TLSContext.set_key">TLSContext:set_key</a> (path)</td> + <td class="summary"> + Assign a PEM private key to this context.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#TLSContext.set_verify">TLSContext:set_verify</a> (flag1, ...)</td> + <td class="summary"> + Set the verification flags of this context.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#TLSContext.set_verify_depth">TLSContext:set_verify_depth</a> (depth)</td> + <td class="summary"> + Set the verification depth of this context.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="TLSContext.create"></a><strong>TLSContext:create</strong> (socket)</dt> +<dd> + + Create a TLS Socket from a socket descriptor. + + +<h3>Parameters</h3> +<ul> + + <li> + socket: Socket Object + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +TLSSocket Object + + + +</dd> + + + + +<dt><a name="TLSContext.set_cert"></a><strong>TLSContext:set_cert</strong> (path)</dt> +<dd> + + Assign a PEM certificate to this context. + + +<h3>Parameters</h3> +<ul> + + <li> + path: Certificate File path + </li> + +</ul> + + + + +<h3>Usage:</h3> +This function calls SSL_CTX_use_certificate_chain_file(). + + + +<h3>Return value:</h3> +true + + + +</dd> + + + + +<dt><a name="TLSContext.set_ciphers"></a><strong>TLSContext:set_ciphers</strong> (cipherlist)</dt> +<dd> + + Set the available ciphers for this context. + + +<h3>Parameters</h3> +<ul> + + <li> + cipherlist: String containing a list of ciphers + </li> + +</ul> + + + + +<h3>Usage:</h3> +This function calls SSL_CTX_set_cipher_list(). + + + +<h3>Return value:</h3> +true + + + +</dd> + + + + +<dt><a name="TLSContext.set_key"></a><strong>TLSContext:set_key</strong> (path)</dt> +<dd> + + Assign a PEM private key to this context. + + +<h3>Parameters</h3> +<ul> + + <li> + path: Private Key File path + </li> + +</ul> + + + + +<h3>Usage:</h3> +This function calls SSL_CTX_use_PrivateKey_file(). + + + +<h3>Return value:</h3> +true + + + +</dd> + + + + +<dt><a name="TLSContext.set_verify"></a><strong>TLSContext:set_verify</strong> (flag1, ...)</dt> +<dd> + + Set the verification flags of this context. + + +<h3>Parameters</h3> +<ul> + + <li> + flag1: First Flag ["none", "peer", "verify_fail_if_no_peer_cert", + "client_once"] + </li> + + <li> + ...: More Flags [-"-] + </li> + +</ul> + + + + +<h3>Usage:</h3> +This function calls SSL_CTX_set_verify(). + + + +<h3>Return value:</h3> +true + + + +</dd> + + + + +<dt><a name="TLSContext.set_verify_depth"></a><strong>TLSContext:set_verify_depth</strong> (depth)</dt> +<dd> + + Set the verification depth of this context. + + +<h3>Parameters</h3> +<ul> + + <li> + depth: Depth + </li> + +</ul> + + + + +<h3>Usage:</h3> +This function calls SSL_CTX_set_verify_depth(). + + + +<h3>Return value:</h3> +true + + + +</dd> + + +</dl> + + + + + +</div> <!-- id="content" --> + +</div> <!-- id="main" --> + +<div id="about"> + <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> +</div> <!-- id="about" --> + +</div> <!-- id="container" --> +</body> +</html> |