]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc: add documentation for Lua function 'TlsGetVersion'
authorMats Klepsland <mats.klepsland@gmail.com>
Tue, 28 Aug 2018 20:54:07 +0000 (22:54 +0200)
committerMats Klepsland <mats.klepsland@gmail.com>
Sun, 16 Sep 2018 19:13:10 +0000 (21:13 +0200)
doc/userguide/lua/lua-functions.rst

index 0d829ab722a3be66799f33dff31633ad8dbf1d48..957fbb0567d426988fbc3d40023802c16fe86119 100644 (file)
@@ -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
 ~~~~~~~~~~~~~~