Redocument deprecated encryption modules.

1 files changed, 28 insertions, 5 deletions

diff --git a/data/anope.example.conf b/data/anope.example.conf
index c48e74e6a..7e2536663 100644
--- a/data/anope.example.conf
+++ b/data/anope.example.conf
@@ -1308,16 +1308,39 @@ module
 }
 
 /*
- * [DEPRECATED] enc_md5, enc_none, enc_old, enc_posix, enc_sha1, enc_sha256
+ * [EXTRA] enc_posix
  *
- * These modules are deprecated can *ONLY* be used as a verify-only encryption
- * module to retain compatibility with old Anope databases. They will be removed
- * in a future release.
+ * Provides verify-only support for passwords encrypted using the POSIX crypt()
+ * function. Load this if you are migratign from another services packages such
+ * as Atheme. See https://en.wikipedia.org/wiki/Crypt_(C) for more information.
+ *
+ * You must load another encryption method before this to re-encrypt passwords
+ * with when a user logs in.
+ */
+#module { name = "enc_posix" }
+
+/*
+ * [DEPRECATED] enc_md5, enc_none, enc_old, enc_sha1, enc_sha256
+ *
+ * Provides verify-only support for passwords encrypted using encryption methods
+ * from older versions of Anope. These methods are no longer considered secure
+ * and will be removed in a future version of Anope. Only load them if you are
+ * upgrading from a previous version of Anope that used them.
+ *
+ * enc_md5:    Verifies passwords encrypted with the MD5 algorithm
+ * enc_none:   Verifies passwords that are not encrypted
+ * enc_sha1:   Verifies passwords encrypted with the SHA1 algorithm
+ * enc_old:    Verifies passwords encrypted with the broken MD5 algorithm used
+ *             before 1.7.17.
+ * enc_sha256: Verifies passwords encrypted with the SHA256 algorithm using a
+ *             custom initialisation vector as a salt.
+ *
+ * You must load another encryption method before this to re-encrypt passwords
+ * with when a user logs in.
  */
 #module { name = "enc_md5" }
 #module { name = "enc_none" }
 #module { name = "enc_old" }
-#module { name = "enc_posix" }
 #module { name = "enc_sha1" }
 #module { name = "enc_sha256" }