Mercurial > prosody-modules
changeset 3728:5073bbd86970
mod_warn_legacy_tls: Add a README
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 03 Nov 2019 13:14:26 +0100 |
parents | 36023eb3254e |
children | 75299ac7e258 |
files | mod_warn_legacy_tls/README.markdown |
diffstat | 1 files changed, 28 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_warn_legacy_tls/README.markdown Sun Nov 03 13:14:26 2019 +0100 @@ -0,0 +1,28 @@ +TLS 1.0 and TLS 1.1 are about to be obsolete. This module warns clients +if they are using those versions, to prepare for disabling them. + +# Configuration + +``` {.lua} +modules_enabled = { + -- other modules etc + "warn_legacy_tls"; +} + +-- This is the default, you can leave it out if you don't wish to +-- customise or translate the message sent. +-- '%s' will be replaced with the TLS version in use. +legacy_tls_warning = [[ +Your connection is encrypted using the %s protocol, which has been demonstrated to be insecure and will be disabled soon. Please upgrade your client. +]] +``` + +## Options + +`legacy_tls_warning` +: A string. The text of the message sent to clients that use outdated + TLS versions. Default as in the above example. + +`legacy_tls_versions` +: Set of TLS versions, defaults to + `{ "SSLv3", "TLSv1", "TLSv1.1" }`{.lua}, i.e. TLS \< 1.2.