How to build mbedtls for esp32s3?

[yanshay]

To debug #60 I want to see mbedtls debug logs and for that I need to enable debug logs in the C code.
For that I need to build the mbedtls libraries for esp32s3.
I tried many things but I can't find how to do it and couldn't find any documentation on that.

I need to do that on revision d5e29f8 which is the last one that can be compiled on 0.22 (the latter can't and my application is already on 0.22).

I run cargo xtask compile and I get the below error.
I have CC env var from the error message set to /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/xtensa-esp32s3-elf-gcc

(I'm using fish shell on Mac if it's of any relevance)

    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.03s
     Running `xtask/target/debug/xtask compile`
[2025-01-06T11:27:07Z INFO  xtask] Initializing directory for compiling ESP32
[2025-01-06T11:27:07Z INFO  xtask] Compiling mbedtls
CMAKE_GENERATOR_xtensa-esp32-none-elf = None
CMAKE_GENERATOR_xtensa_esp32_none_elf = None
TARGET_CMAKE_GENERATOR = None
CMAKE_GENERATOR = None
CMAKE_PREFIX_PATH_xtensa-esp32-none-elf = None
CMAKE_PREFIX_PATH_xtensa_esp32_none_elf = None
TARGET_CMAKE_PREFIX_PATH = None
CMAKE_PREFIX_PATH = None
CMAKE_xtensa-esp32-none-elf = None
CMAKE_xtensa_esp32_none_elf = None
TARGET_CMAKE = None
CMAKE = None
running: cd "/var/folders/wj/jcd1lgbj66vbjv265c23j1kc0000gn/T/tmp.ZimRpNISeLKl/target.eJ8A7Gi9Urx1/build" && CMAKE_PREFIX_PATH="" LC_ALL="C" "cmake" "/var/folders/wj/jcd1lgbj66vbjv265c23j1kc0000gn/T/tmp.ZimRpNISeLKl/tmpsrc.cj890vrdb3Rd/mbedtls" "-DUSE_SHARED_MBEDTLS_LIBRARY=OFF" "-DUSE_STATIC_MBEDTLS_LIBRARY=ON" "-DENABLE_PROGRAMS=OFF" "-DENABLE_TESTING=OFF" "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON" "-DCMAKE_TOOLCHAIN_FILE=/Users/yanshay/OpenSourceProj/forked/esp-mbedtls-sha/xtask/toolchains/toolchain-clang-esp32.cmake" "-DCMAKE_INSTALL_PREFIX=/var/folders/wj/jcd1lgbj66vbjv265c23j1kc0000gn/T/tmp.ZimRpNISeLKl/target.eJ8A7Gi9Urx1" "-DCMAKE_C_FLAGS= -ffunction-sections -fdata-sections" "-DCMAKE_CXX_FLAGS= -ffunction-sections -fdata-sections --target=xtensa-none-elf" "-DCMAKE_ASM_FLAGS= -ffunction-sections -fdata-sections" "-DCMAKE_BUILD_TYPE=Release"
CMake Deprecation Warning at CMakeLists.txt:21 (cmake_minimum_required):
  Compatibility with CMake < 3.10 will be removed from a future version of
  CMake.

  Update the VERSION argument <min> value.  Or, use the <min>...<max> syntax
  to tell CMake that the project requires at least <min> but has been updated
  to work with policies introduced by <max> or earlier.


CMake Error at /opt/homebrew/share/cmake/Modules/CMakeDetermineCompiler.cmake:81 (set_property):
  set_property could not find CACHE variable CMAKE_C_COMPILER.  Perhaps it
  has not yet been created.
Call Stack (most recent call first):
  /opt/homebrew/share/cmake/Modules/CMakeDetermineCCompiler.cmake:65 (_cmake_find_compiler)
  CMakeLists.txt:39 (project)


-- The C compiler identification is unknown
CMake Error at CMakeLists.txt:39 (project):
  No CMAKE_C_COMPILER could be found.

  Tell CMake where to find the compiler by setting either the environment
  variable "CC" or the CMake cache entry CMAKE_C_COMPILER to the full path to
  the compiler, or to the compiler name if it is in the PATH.


-- Configuring incomplete, errors occurred!
thread 'main' panicked at /Users/yanshay/.cargo/registry/src/index.crates.io-6f17d22bba15001f/cmake-0.1.52/src/lib.rs:1115:5:

command did not execute successfully, got: exit status: 1

build script failed, must exit now
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Any assistance would be appreciated.

[AnthonyGrondin]

To compile esp-mbedtls you need to install the LLVM toolchain.

You can do this by providing the --extended-llvm flag when running espup
Example:

espup install -v 1.82.0.0 --extended-llvm

Then if you're on a Unix based system, you need to reconfigure your path with the following to add the additional entries:

. $HOME/export-esp.sh

This should fix up the compilation issues you're having.
Then you can edit each SoC's specific configuration file (config.h) in esp-mbedtls-sys/ and recompile with:

cargo +stable xtask compile
cargo +stable xtask bindings

[AnthonyGrondin]

Yes they're compiled with debug. You could try building with them. The current HEAD is still for [email protected], but nevertheless, there's no direct dependency between both so it's independent of the version of esp-hal you use (minus some ROM functions that sometimes are removed / added / forgotten 🙃 )

[yanshay]

I was able to use the binaries with the debug on that version that's causing the erorrs (where sha was added) and got the logs.

I wanted to compare the logs to the ones from the working version (one commit before), however it couldn't link due to the errors below. Maybe that's the issue? That some things were removed and therefore not supported on the later version?

error: linking with `xtensa-esp32s3-elf-gcc` failed: exit status: 1
  |
  = note: LC_ALL="C" PATH="/Users/yanshay/.rustup/toolchains/esp/lib/rustlib/aarch64-apple-darwin/bin:/Users/yanshay/.rustup/toolchains/esp/lib/rustlib/aarch64-apple-darwin/bin:/Users/yanshay/.rustup/toolchains/esp/lib/rustlib/aarch64-apple-darwin/bin:/Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin:/Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin:/Users/yanshay/.cargo/bin:/Users/yanshay/bin/:/opt/homebrew/bin/:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin:/opt/podman/bin" VSLANG="1033" "xtensa-esp32s3-elf-gcc" "/var/folders/wj/jcd1lgbj66vbjv265c23j1kc0000gn/T/rustct96aMR/symbols.o" "/Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/deps/nfc_filament-7a3c9ffeafc5f5d4.nfc_filament.3984c6374714224c-cgu.0.rcgu.o" "-Wl,--as-needed" "-Wl,-Bstatic" "/Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/deps/libcompiler_builtins-7b97fcd5f3de4700.rlib" "-Wl,-Bdynamic" "-lmbedtls" "-lmbedx509" "-lmbedcrypto" "-lbtbb" "-lbtdm_app" "-lcoexist" "-lcore" "-lespnow" "-lmesh" "-lnet80211" "-lphy" "-lpp" "-lsmartconfig" "-lwapi" "-lwpa_supplicant" "-lprintf" "-Wl,--eh-frame-hdr" "-Wl,-z,noexecstack" "-L" "/Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-hal-1b5c9fac1965b143/out" "-L" "/Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp32s3-10f369350618016d/out" "-L" "/Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/xtensa-lx-ca5689e86a09120d/out" "-L" "/Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/xtensa-lx-rt-20c2d30209e03ce4/out" "-L" "/Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out" "-L" "/Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-wifi-sys-19133c06cc7508ad/out" "-o" "/Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/deps/nfc_filament-7a3c9ffeafc5f5d4" "-Wl,--gc-sections" "-no-pie" "-nodefaultlibs" "-Tlinkall.x" "-nostartfiles"
  = note: /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_free+0x4): undefined reference to `mbedtls_sha512_free'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_free+0x8): undefined reference to `mbedtls_sha256_free'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_free+0xc): undefined reference to `mbedtls_sha1_free'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_clone+0x8): undefined reference to `mbedtls_sha512_clone'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_clone+0xc): undefined reference to `mbedtls_sha256_clone'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_clone+0x10): undefined reference to `mbedtls_sha1_clone'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_setup+0x8): undefined reference to `mbedtls_sha512_init'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_setup+0xc): undefined reference to `mbedtls_sha256_init'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_setup+0x10): undefined reference to `mbedtls_sha1_init'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_starts+0x4): undefined reference to `mbedtls_sha512_starts'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_starts+0x8): undefined reference to `mbedtls_sha256_starts'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_starts+0xc): undefined reference to `mbedtls_sha1_starts'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_update+0x4): undefined reference to `mbedtls_sha512_update'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_update+0x8): undefined reference to `mbedtls_sha256_update'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_update+0xc): undefined reference to `mbedtls_sha1_update'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_finish+0x4): undefined reference to `mbedtls_sha512_finish'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_finish+0x8): undefined reference to `mbedtls_sha256_finish'
          /Users/yanshay/.rustup/toolchains/esp/xtensa-esp-elf/esp-14.2.0_20240906/xtensa-esp-elf/bin/../lib/gcc/xtensa-esp-elf/14.2.0/../../../../xtensa-esp-elf/bin/ld: /Users/yanshay/ProgProj/ESP32/hamster/nfc-filament/target/xtensa-esp32s3-none-elf/release/build/esp-mbedtls-sys-f9583b9167ca5371/out/libmbedcrypto.a(md.c.obj):(.literal.mbedtls_md_finish+0xc): undefined reference to `mbedtls_sha1_finish'
          collect2: error: ld returned 1 exit status

  = note: some `extern` functions couldn't be found; some native libraries may need to be installed or have their path specified
  = note: use the `-l` flag to specify native libraries to link
  = note: use the `cargo:rustc-link-lib` directive to specify the native libraries to link with Cargo (see https://doc.rust-lang.org/cargo/reference/build-scripts.html#rustc-link-lib)

[AnthonyGrondin]

This is a bit of a tricky issue here; You can use the binaries with the debug version, but they also were compiled after SHA acceleration was added, that means that those functions aren't provided by mbedtls anymore, it expects us to provide them, which we do.

But that means you cannot use those libraries without implementing your own version of SHA. It's the opposite with using libs prior to when SHA acceleration was added; you cannot use them while also providing the hardware acceleration SHA, it would conflict with the software implementation provided by mbedtls

[yanshay]

So could it be that those functions do things differently than mbedtls and that's why the tls session can't be established?

So SHA acceleration became mandatory? No way to fallback to the previous mbedtls version?

[yanshay]

Can you maybe help with that and build me binaries with debug for esp32s3 for commit f292457 to compare the sessions?

I'm very concerned that with these latest changes to esp-mbedtls I will no longer be able to use esp-mbedtls new versions and at some point the old version will no longer work with esp-hal and months of time spent on what I developed will reach a dead end.