From 451505f5b5ffb7ee39d407678ef53292426a3998 Mon Sep 17 00:00:00 2001 From: s0ph0s Date: Wed, 28 Feb 2024 21:22:46 -0500 Subject: [PATCH] Add crypto.tls.wrap docs --- tool/net/definitions.lua | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tool/net/definitions.lua b/tool/net/definitions.lua index bbe4476af..52be9b91c 100644 --- a/tool/net/definitions.lua +++ b/tool/net/definitions.lua @@ -7967,6 +7967,14 @@ function unix.Errno:doc() end --- differs from the System Five error code. function unix.Errno:__tostring() end +--- Wraps a plain TCP client socket connection with TLS encryption. +--- +--- Initiates the connection handshake immediately. +---@param fd integer +---@param hostname string for validating that the hostname on the certificate matches what is expected +---@return crypto.tls.Connection +---@nodiscard +function crypto.tls.wrap(fd, hostname) -- CONSTANTS ---@type integer for debug logging level. See `Log`.