refactor: simplify mbedlts compilation script (#91)

* rework compile
Co-authored-by: Aleksandr Kolosov <117081005+akolosov-n@users.noreply.github.com>

Author: JuhaPekkaa

.github/workflows/compile-mbedtls.yml

@@ -51,7 +51,7 @@ jobs:
           VENV_DIR=$(mktemp -d)
           python3 -m venv ${VENV_DIR}
           source ${VENV_DIR}/bin/activate
-          LDFLAGS='-arch x86_64 -arch arm64' CFLAGS='-O2 -arch x86_64 -arch arm64' DLEXT=dylib OSARCH=darwin ./compileMbedtls.sh
+          DLEXT=dylib OSARCH=darwin CMAKE_EXTRA='-DCMAKE_OSX_ARCHITECTURES=arm64;x86_64' ./compileMbedtls.sh
       - name: Archive artifacts
         uses: actions/upload-artifact@v5
         with:
@@ -74,9 +74,7 @@ jobs:
           MBEDTLS_VERSION: ${{ inputs.mbedtlsVersion }}
         run: |
           WINDOWS=1 \
-          OBJEXT=obj \
           CMAKE_EXTRA='-DCMAKE_C_FLAGS=-D__USE_MINGW_ANSI_STDIO=0' \
-          LDFLAGS='-lbcrypt -lws2_32 -lwinmm -lgdi32 -L. -static-libgcc' \
           DLEXT=dll \
           OSARCH=win32-x86-64 \
           ./compileMbedtls.sh

Readme.md

@@ -108,17 +108,15 @@ Linux (x86_64):
 
 Mac (intel and arm):
 
-`LDFLAGS='-arch x86_64 -arch arm64' CFLAGS='-O2 -arch x86_64 -arch arm64' DLEXT=dylib OSARCH=darwin ./compileMbedtls.sh`
+`DLEXT=dylib OSARCH=darwin CMAKE_EXTRA='-DCMAKE_OSX_ARCHITECTURES=arm64;x86_64' ./compileMbedtls.sh`
 
 Windows
 
 - `docker run -it -v$(pwd):/work --rm dockcross/windows-static-x64 \
     sh -c "apt-get update && apt-get install -y python3-venv && \
     WINDOWS=1 \
-    LDFLAGS='-lws2_32 -lwinmm -lgdi32 -lbcrypt -L. -static-libgcc' \
-    DLEXT=dll \
-    OBJEXT=obj \
     CMAKE_EXTRA='-DCMAKE_C_FLAGS=-D__USE_MINGW_ANSI_STDIO=0' \
+    DLEXT=dll \
     OSARCH=win32-x86-64 \
     ./compileMbedtls.sh"`
 

compileMbedtls.sh

@@ -6,10 +6,8 @@ MBEDTLS_VERSION=${MBEDTLS_VERSION:-$DEFAULT_MBEDTLS_VERSION}
 BUILD_DIR=mbedtls-lib/build/mbedtls-${MBEDTLS_VERSION}
 DLEXT="${DLEXT:-so}"
 OSARCH="${OSARCH:-linux-x86-64}"
-CC="${CC:-gcc}"
-LDFLAGS="${LDFLAGS:-}"
-OBJEXT="${OBJEXT:-o}"
 CMAKE_EXTRA="${CMAKE_EXTRA:-}"
+LIB_DIR="mbedtls-lib/bin/$OSARCH"
 
 # prepare build directory
 mkdir -p mbedtls-lib/build
@@ -31,22 +29,25 @@ fi
 python3 ${BUILD_DIR}/scripts/config.py -f "${BUILD_DIR}/include/mbedtls/mbedtls_config.h" unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
 python3 ${BUILD_DIR}/scripts/config.py -f "${BUILD_DIR}/include/mbedtls/mbedtls_config.h" set MBEDTLS_SSL_DTLS_CONNECTION_ID
 
-# Run cmake configuration
-cmake -S "${BUILD_DIR}" -B "${BUILD_DIR}"/build -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_BUILD_TYPE=Release ${CMAKE_EXTRA}
+echo "Configuring CMake..."
+cmake \
+  -S "${BUILD_DIR}" \
+  -B "${BUILD_DIR}"/build \
+  -DUSE_SHARED_MBEDTLS_LIBRARY=On \
+  -DCMAKE_BUILD_TYPE=Release \
+  ${CMAKE_EXTRA}
 
-cmake --build "${BUILD_DIR}"/build --target lib
+echo "Building MbedTLS..."
+cmake --build "${BUILD_DIR}"/build --parallel --target lib
 
 # create single shared library
-LIB_DIR="mbedtls-lib/bin/$OSARCH"
 mkdir -p ${LIB_DIR}
 rm -f ${LIB_DIR}/* 2>/dev/null || true
 
-$CC -shared \
-    ${BUILD_DIR}/build/library/CMakeFiles/mbedtls.dir/*.${OBJEXT} \
-    ${BUILD_DIR}/build/library/CMakeFiles/mbedx509.dir/*.${OBJEXT} \
-    ${BUILD_DIR}/build/tf-psa-crypto/core/CMakeFiles/tfpsacrypto.dir/*.${OBJEXT} \
-    ${BUILD_DIR}/build/tf-psa-crypto/drivers/builtin/CMakeFiles/builtin.dir/src/*.${OBJEXT} \
-    -o ${LIB_DIR}/libmbedtls-${MBEDTLS_VERSION}.${DLEXT} ${LDFLAGS}
+# copy shared libraries
+cp "${BUILD_DIR}/build/library/libmbedtls.${DLEXT}" "${LIB_DIR}/libmbedtls.${DLEXT}"
+cp "${BUILD_DIR}/build/library/libmbedx509.${DLEXT}" "${LIB_DIR}/libmbedx509.${DLEXT}"
+cp "${BUILD_DIR}/build/library/libtfpsacrypto"*.${DLEXT} "${LIB_DIR}/libtfpsacrypto.${DLEXT}"
 
 # generate kotlin object with memory sizes
 gcc mbedtls-lib/mbedtls_sizeof_generator.c \

kotlin-mbedtls-metrics/build.gradle.kts

@@ -14,4 +14,9 @@ dependencies {
 
 tasks.test {
     useJUnitPlatform()
+    // On Windows, native libraries must be found via PATH or explicitly set, as dynamic linking is used to load them.
+    if (System.getProperty("os.name").lowercase().contains("win")) {
+        val osArch = "win32-x86-64"
+        systemProperty("jna.library.path", file("../mbedtls-lib/bin/$osArch").absolutePath)
+    }
 }

kotlin-mbedtls-netty/build.gradle.kts

@@ -22,4 +22,9 @@ dependencies {
 
 tasks.test {
     useJUnitPlatform()
+    // On Windows, native libraries must be found via PATH or explicitly set, as dynamic linking is used to load them.
+    if (System.getProperty("os.name").lowercase().contains("win")) {
+        val osArch = "win32-x86-64"
+        systemProperty("jna.library.path", file("../mbedtls-lib/bin/$osArch").absolutePath)
+    }
 }

kotlin-mbedtls/build.gradle.kts

@@ -23,6 +23,11 @@ dependencies {
 
 tasks.test {
     useJUnitPlatform()
+    // On Windows, native libraries must be found via PATH or explicitly set, as dynamic linking is used to load them.
+    if (System.getProperty("os.name").lowercase().contains("win")) {
+        val osArch = "win32-x86-64"
+        systemProperty("jna.library.path", file("../mbedtls-lib/bin/$osArch").absolutePath)
+    }
 }
 
 jmh {

kotlin-mbedtls/src/main/kotlin/org/opencoap/ssl/MbedtlsApi.kt

@@ -23,28 +23,23 @@ import com.sun.jna.Function
 import com.sun.jna.Memory
 import com.sun.jna.Native
 import com.sun.jna.NativeLibrary
-import com.sun.jna.Platform
 import com.sun.jna.Pointer
 import org.slf4j.LoggerFactory
 import java.nio.ByteBuffer
-import java.util.Properties
 
 /*
 Defines mbedtls native functions that can be used from jvm.
  */
 internal object MbedtlsApi {
-    private val libraryName = javaClass.classLoader.getResourceAsStream("mbedtls.properties").use { resource ->
-        Properties().apply { load(resource) }.let { props ->
-            val mbedtlsVersion = props.getProperty("mbedtlsVersion")
-            if (Platform.isWindows()) "libmbedtls-$mbedtlsVersion" else "mbedtls-$mbedtlsVersion"
-        }
-    }
-    private val LIB_MBEDTLS = NativeLibrary.getInstance(libraryName)
+
+    private var LIB_TFPSACRYPTO: NativeLibrary = NativeLibrary.getInstance("tfpsacrypto")
+    private var LIB_MBEDX509: NativeLibrary = NativeLibrary.getInstance("mbedx509")
+    private var LIB_MBEDTLS: NativeLibrary = NativeLibrary.getInstance("mbedtls")
 
     init {
         Native.register(LIB_MBEDTLS)
-        Native.register(Crypto::class.java, LIB_MBEDTLS)
-        Native.register(X509::class.java, LIB_MBEDTLS)
+        Native.register(X509::class.java, LIB_MBEDX509)
+        Native.register(Crypto::class.java, LIB_TFPSACRYPTO)
 
         configureLogThreshold()
     }
@@ -82,10 +77,6 @@ internal object MbedtlsApi {
     external fun mbedtls_ssl_set_mtu(sslContext: Pointer, mtu: Int)
     external fun mbedtls_ssl_get_peer_cert(sslContext: Pointer): Pointer?
     external fun mbedtls_ssl_set_hostname(sslContext: Pointer, hostname: String?): Int
-    external fun psa_crypto_init(): Int
-
-    // mbedtls/error.h
-    external fun mbedtls_strerror(errnum: Int, buffer: Pointer, buflen: Int)
 
     const val MBEDTLS_ERR_SSL_TIMEOUT = -0x6800
     const val MBEDTLS_ERR_SSL_WANT_READ = -0x6900
@@ -140,6 +131,9 @@ internal object MbedtlsApi {
         external fun mbedtls_pk_init(ctx: Pointer)
         external fun mbedtls_pk_free(ctx: Pointer)
         external fun mbedtls_pk_parse_key(ctx: Pointer, key: ByteArray, keyLen: Int, pwd: Pointer?, pwdLen: Int): Int
+
+        // psa/crypto.h
+        external fun psa_crypto_init(): Int
     }
 
     internal object X509 {
@@ -148,5 +142,8 @@ internal object MbedtlsApi {
         external fun mbedtls_x509_crt_init(cert: Pointer)
         external fun mbedtls_x509_crt_free(cert: Pointer)
         external fun mbedtls_x509_crt_parse_der(chain: Pointer, buf: ByteArray, len: Int): Int
+
+        // mbedtls/error.h
+        external fun mbedtls_strerror(errnum: Int, buffer: Pointer, buflen: Int)
     }
 }

kotlin-mbedtls/src/main/kotlin/org/opencoap/ssl/SslConfig.kt

@@ -21,6 +21,7 @@ import com.sun.jna.Memory
 import com.sun.jna.Pointer
 import org.opencoap.ssl.MbedtlsApi.Crypto.mbedtls_pk_free
 import org.opencoap.ssl.MbedtlsApi.Crypto.mbedtls_pk_parse_key
+import org.opencoap.ssl.MbedtlsApi.Crypto.psa_crypto_init
 import org.opencoap.ssl.MbedtlsApi.X509.mbedtls_x509_crt_free
 import org.opencoap.ssl.MbedtlsApi.X509.mbedtls_x509_crt_parse_der
 import org.opencoap.ssl.MbedtlsApi.mbedtls_ssl_conf_authmode
@@ -47,7 +48,6 @@ import org.opencoap.ssl.MbedtlsApi.mbedtls_ssl_set_hostname
 import org.opencoap.ssl.MbedtlsApi.mbedtls_ssl_set_mtu
 import org.opencoap.ssl.MbedtlsApi.mbedtls_ssl_set_timer_cb
 import org.opencoap.ssl.MbedtlsApi.mbedtls_ssl_setup
-import org.opencoap.ssl.MbedtlsApi.psa_crypto_init
 import org.opencoap.ssl.MbedtlsApi.verify
 import org.slf4j.LoggerFactory
 import java.io.Closeable

kotlin-mbedtls/src/main/kotlin/org/opencoap/ssl/SslException.kt

@@ -17,6 +17,7 @@
 package org.opencoap.ssl
 
 import com.sun.jna.Memory
+import org.opencoap.ssl.MbedtlsApi.X509.mbedtls_strerror
 import java.util.Locale
 
 open class SslException(message: String) : Exception(message) {
@@ -29,7 +30,7 @@ open class SslException(message: String) : Exception(message) {
 
         internal fun translateError(error: Int): String {
             val buffer = Memory(100)
-            MbedtlsApi.mbedtls_strerror(error, buffer, buffer.size().toInt())
+            mbedtls_strerror(error, buffer, buffer.size().toInt())
             return buffer.getString(0).trim()
         }
     }

kotlin-mbedtls/src/main/resources/mbedtls.properties

@@ -13,5 +13,3 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
-mbedtlsVersion=4.0.0