diff mbox series

[BlueZ] README: Add Mesh required Kernel Configuration section

Message ID 20200311221518.25060-1-brian.gix@intel.com
State New
Headers show
Series [BlueZ] README: Add Mesh required Kernel Configuration section | expand

Commit Message

Brian Gix March 11, 2020, 10:15 p.m. UTC 
Not all distributions include all required mesh crypto support.  This
adds a section with known kernel required options.
---
 README | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
diff mbox series

Patch

diff --git a/README b/README
index c7032d02b..ad0a307f4 100644
--- a/README
+++ b/README
@@ -61,6 +61,31 @@  When neither --enable-mesh nor --enable-btpclient is specified, then this
 part is irrelevant and Embedded Linux library is not required.
 
 
+Kernel Build Options (for Mesh)
+===============================
+
+The Mesh daemon uses kernel provided crypto utilities to perform required
+security securities of Bluetooth Mesh. Many standard distributions currently
+enable all required crypto features, but a few notable distributions do
+not.
+
+If Mesh Cryptography is not working, the following configuration options
+may need to be enabled, and the kernel rebuilt.
+
+1. A minimum of kernel version 4.9 or later is required
+
+2. The kernel must at a minimum have the following .config options turned on:
+	CONFIG_CRYPTO_USER
+	CONFIG_CRYPTO_USER_API
+	CONFIG_CRYPTO_USER_API_AEAD
+	CONFIG_CRYPTO_USER_API_HASH
+
+	CONFIG_CRYPTO_AES
+	CONFIG_CRYPTO_CCM
+	CONFIG_CRYPTO_AEAD
+	CONFIG_CRYPTO_CMAC
+
+
 Configuration and options
 =========================