Add doc notes about MD5 configuration requirements

cppalliance · Oct 29, 2024 · 51eaa78 · 51eaa78
1 parent 051d33c
commit 51eaa78
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/doc/crypt/config.adoc b/doc/crypt/config.adoc
@@ -10,9 +10,7 @@ https://www.boost.org/LICENSE_1_0.txt
 
 == User Configurable Macros
 
-The following configuration macros are available:
-
-- None at this time
+- `BOOST_CRYPT_ENABLE_MD5`: Without this define `#include <boost/crypt/hash/md5.hpp>` will issue a `#error` because it is in-secure.
 
 == Automatic Configuration Macros
 

diff --git a/doc/crypt/md5.adoc b/doc/crypt/md5.adoc
@@ -9,6 +9,8 @@ https://www.boost.org/LICENSE_1_0.txt
 
 = MD5
 
+WARNING: MD5 is not secure so it must be explicitly enabled as an acknowledgment of the risk of using it.
+
 This library supports MD5 as described in https://www.ietf.org/rfc/rfc1321.txt[RFC 1321].
 There is a wide range of acceptable inputs for the base md5 function: