From: Mats Klepsland <mats.klepsland@gmail.com>
Date: Tue, 28 Aug 2018 20:54:07 +0000 (+0200)
Subject: doc: add documentation for Lua function 'TlsGetVersion'
X-Git-Tag: suricata-4.1.0-rc2~85
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4d38d0844be794655de18798da5c368f952b95a3;p=thirdparty%2Fsuricata.git

doc: add documentation for Lua function 'TlsGetVersion'
---

diff --git a/doc/userguide/lua/lua-functions.rst b/doc/userguide/lua/lua-functions.rst
index 0d829ab722..957fbb0567 100644
--- a/doc/userguide/lua/lua-functions.rst
+++ b/doc/userguide/lua/lua-functions.rst
@@ -393,6 +393,22 @@ Initialize with:
       return needs
   end
 
+TlsGetVersion
+~~~~~~~~~~~~~
+
+Get the negotiated version in a TLS session as a string through TlsGetVersion.
+
+Example:
+
+::
+
+  function log (args)
+      version = TlsGetVersion()
+      if version then
+          -- do something
+      end
+  end
+
 TlsGetCertInfo
 ~~~~~~~~~~~~~~