diff options
author | Steven Barth <steven@midlink.org> | 2009-04-21 16:26:45 +0000 |
---|---|---|
committer | Steven Barth <steven@midlink.org> | 2009-04-21 16:26:45 +0000 |
commit | a2b916ab736802050b19562b7c163e3f3bb1566f (patch) | |
tree | d35b68f7bcac43f66f4cdb915ef327b76856594b /libs/nixio/docsrc/nixio.TLSContext.lua | |
parent | 085a0a9ec040fc3ea5ee537d2cee724aa775747b (diff) |
Merge nixio 0.2
Diffstat (limited to 'libs/nixio/docsrc/nixio.TLSContext.lua')
-rw-r--r-- | libs/nixio/docsrc/nixio.TLSContext.lua | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/libs/nixio/docsrc/nixio.TLSContext.lua b/libs/nixio/docsrc/nixio.TLSContext.lua new file mode 100644 index 0000000000..7cc071195a --- /dev/null +++ b/libs/nixio/docsrc/nixio.TLSContext.lua @@ -0,0 +1,46 @@ +--- Transport Layer Security Context Object. +-- @cstyle instance +module "nixio.TLSContext" + +--- Create a TLS Socket from a socket descriptor. +-- @class function +-- @name TLSContext.create +-- @param socket Socket Object +-- @return TLSSocket Object + +--- Assign a PEM certificate to this context. +-- @class function +-- @name TLSContext.set_cert +-- @usage This function calls SSL_CTX_use_certificate_chain_file(). +-- @param path Certificate File path +-- @return true + +--- Assign a PEM private key to this context. +-- @class function +-- @name TLSContext.set_key +-- @usage This function calls SSL_CTX_use_PrivateKey_file(). +-- @param path Private Key File path +-- @return true + +--- Set the available ciphers for this context. +-- @class function +-- @name TLSContext.set_ciphers +-- @usage This function calls SSL_CTX_set_cipher_list(). +-- @param cipherlist String containing a list of ciphers +-- @return true + +--- Set the verification depth of this context. +-- @class function +-- @name TLSContext.set_verify_depth +-- @usage This function calls SSL_CTX_set_verify_depth(). +-- @param depth Depth +-- @return true + +--- Set the verification flags of this context. +-- @class function +-- @name TLSContext.set_verify +-- @usage This function calls SSL_CTX_set_verify(). +-- @param flag1 First Flag ["none", "peer", "verify_fail_if_no_peer_cert", +-- "client_once"] +-- @param ... More Flags [-"-] +-- @return true
\ No newline at end of file |