mbedtls: Kconfig option to enable/disable debug functions
authorMichael Heimpold <mhei@heimpold.de>
Thu, 3 Jan 2019 23:00:41 +0000 (00:00 +0100)
committerHauke Mehrtens <hauke@hauke-m.de>
Sun, 27 Jan 2019 00:04:53 +0000 (01:04 +0100)
This introduces a new Kconfig option to switch on/off mbedtls' support
for debug functions.

The idea behind is to inspect TLS traffic with Wireshark for debug
purposes. At the moment, there is no native or 'nice' support for
this, but at
https://github.com/Lekensteyn/mbedtls/commit/68aea15833e1ac9290b8f52a4223fb4585fb3986
an example implementation can be found which uses the debug functions
of the library. However, this requires to have this debug stuff enabled
in the library, but at the moment it is staticly patched out.

So this patch removes the static part from the configuration patch
and introduces a dynamic config file editing during build.

When enabled, this heavily increases the library size, so I added
a warning in the Kconfig help section.

Signed-off-by: Michael Heimpold <mhei@heimpold.de>
package/libs/mbedtls/Makefile
package/libs/mbedtls/patches/200-config.patch

index 4f29135..de91ff2 100644 (file)
@@ -9,7 +9,7 @@ include $(TOPDIR)/rules.mk
 
 PKG_NAME:=mbedtls
 PKG_VERSION:=2.16.0
-PKG_RELEASE:=1
+PKG_RELEASE:=2
 PKG_USE_MIPS16:=0
 
 PKG_SOURCE:=$(PKG_NAME)-$(PKG_VERSION)-gpl.tgz
@@ -20,6 +20,8 @@ PKG_BUILD_PARALLEL:=1
 PKG_LICENSE:=GPL-2.0+
 PKG_CPE_ID:=cpe:/a:arm:mbed_tls
 
+PKG_CONFIG_DEPENDS:=CONFIG_LIBMBEDTLS_DEBUG_C
+
 include $(INCLUDE_DIR)/package.mk
 include $(INCLUDE_DIR)/cmake.mk
 
@@ -42,6 +44,20 @@ $(call Package/mbedtls/Default)
   ABI_VERSION:=12
 endef
 
+define Package/libmbedtls/config
+config LIBMBEDTLS_DEBUG_C
+       depends on PACKAGE_libmbedtls
+       bool "Enable debug functions"
+       default n
+       help
+        This option enables mbedtls library's debug functions.
+       
+        It increases the uncompressed libmbedtls binary size
+        by around 60 KiB (for an ARMv5 platform).
+       
+        Usually, you don't need this, so don't select this if you're unsure.
+endef
+
 define Package/mbedtls-util
 $(call Package/mbedtls/Default)
   SECTION:=utils
@@ -71,6 +87,17 @@ CMAKE_OPTIONS += \
        -DENABLE_TESTING:Bool=OFF \
        -DENABLE_PROGRAMS:Bool=ON
 
+define Build/Configure
+       $(Build/Configure/Default)
+
+       awk 'BEGIN { rc = 1 } \
+            /#define MBEDTLS_DEBUG_C/ { $$$$0 = "$(if $(CONFIG_LIBMBEDTLS_DEBUG_C),,// )#define MBEDTLS_DEBUG_C"; rc = 0 } \
+            { print } \
+            END { exit(rc) }' $(PKG_BUILD_DIR)/include/mbedtls/config.h \
+            >$(PKG_BUILD_DIR)/include/mbedtls/config.h.new && \
+       mv $(PKG_BUILD_DIR)/include/mbedtls/config.h.new $(PKG_BUILD_DIR)/include/mbedtls/config.h
+endef
+
 define Build/InstallDev
        $(INSTALL_DIR) $(1)/usr/include
        $(CP) $(PKG_INSTALL_DIR)/usr/include/mbedtls $(1)/usr/include/
index ca4f4c7..825d407 100644 (file)
  
  /**
   * \def MBEDTLS_CHACHA20_C
-@@ -2120,7 +2120,7 @@
-  *
-  * This module provides debugging functions.
-  */
--#define MBEDTLS_DEBUG_C
-+//#define MBEDTLS_DEBUG_C
- /**
-  * \def MBEDTLS_DES_C
 @@ -2149,7 +2149,7 @@
   * \warning   DES is considered a weak cipher and its use constitutes a
   *            security risk. We recommend considering stronger ciphers instead.