Rename esp-mbedtls to mbedtls-rs (#107)

* Rename esp-mbedtls to mbedtls-rs

* chore: auto-push built libraries

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: ivmarkov

.github/workflows/ci.yml

@@ -1,6 +1,6 @@
-# This CI builds the `esp-mbedtls*` crates and their examples.
+# This CI builds the `mbedtls-rs*` crates and their examples.
 #
-# If a change is detected within `esp-mbedtls-sys/`, a rebuild is triggered and this CI will automatically
+# If a change is detected within `mbedtls-rs-sys/`, a rebuild is triggered and this CI will automatically
 # rebuild the libraries using the xtask. Then the tests are executed against the rebuilt libraries.
 #
 # If no rebuild occurs, the examples are built against the latest libraries present in the main branch.
@@ -110,13 +110,13 @@ jobs:
       #       ./
       #       xtask
 
-      - name: Detect esp-mbedtls-sys/ changes
+      - name: Detect mbedtls-rs-sys/ changes
         uses: dorny/paths-filter@v3
         id: detect-changes
         with:
           filters: |
             libs:
-              - 'esp-mbedtls-sys/**'
+              - 'mbedtls-rs-sys/**'
 
       - name: Detect host target triple
         run: |
@@ -157,7 +157,7 @@ jobs:
           steps.detect-changes.outputs.libs == 'true' ||
           contains(github.event.pull_request.labels.*.name, 'rebuild-libs')
         run: |
-          rm -rf esp-mbedtls-sys/libs/*
+          rm -rf mbedtls-rs-sys/libs/*
           cargo +stable xtask gen xtensa-esp32-none-elf
           cargo +stable xtask gen xtensa-esp32s2-none-elf
           cargo +stable xtask gen xtensa-esp32s3-none-elf
@@ -171,11 +171,11 @@ jobs:
           contains(github.event.pull_request.labels.*.name, 'rebuild-libs')
         uses: actions/upload-artifact@v4
         with:
-          name: esp-mbedtls-sys
+          name: mbedtls-rs-sys
           retention-days: 1
           path: |
-            esp-mbedtls-sys/libs
-            esp-mbedtls-sys/src
+            mbedtls-rs-sys/libs
+            mbedtls-rs-sys/src
 
   build-mcu:
     name: Build-MCU
@@ -321,16 +321,16 @@ jobs:
       - name: Download artifacts
         uses: actions/download-artifact@v4
         with:
-          name: esp-mbedtls-sys
+          name: mbedtls-rs-sys
           # Required because else artifacts will be put into the base directory
-          path: esp-mbedtls-sys/
+          path: mbedtls-rs-sys/
 
       - name: Commit and push libraries to ${{ github.head_ref || github.ref_name }}
         run: |
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
-          git add esp-mbedtls-sys/libs
-          git add esp-mbedtls-sys/src
+          git add mbedtls-rs-sys/libs
+          git add mbedtls-rs-sys/src
           # Only commit and push when there are changes
           git diff --cached --quiet || (
             git commit -m "chore: auto-push built libraries"

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "mbedtls"]
-	path = esp-mbedtls-sys/mbedtls
+	path = mbedtls-rs-sys/mbedtls
 	url = https://github.com/espressif/mbedtls

Cargo.toml

@@ -1,8 +1,8 @@
 [workspace]
 resolver = "2"
 members = [
-    "esp-mbedtls",
-    "esp-mbedtls-sys",
+    "mbedtls-rs",
+    "mbedtls-rs-sys",
 ]
 
 exclude = ["examples", "xtask"]

README.md

@@ -1,6 +1,6 @@
-# esp-mbedtls
+# mbedtls-rs
 
-This repository hosts the [esp-mbedtls](esp-mbedtls), [esp-mbedtls-sys](esp-mbedtls-sys) and [examples](examples) crates.
+This repository hosts the [mbedtls-rs](mbedtls-rs), [mbedtls-rs-sys](mbedtls-rs-sys) and [examples](examples) crates.
 
 For more information, consult the respective README of each crate.
 

esp-mbedtls/Cargo.toml

@@ -1,4 +1,4 @@
-# `esp-mbedtls` Examples
+# `mbedtls-rs` Examples
 
 The examples currently run on the following platforms:
 
@@ -111,4 +111,4 @@ Similar to `server` but utilizing the true HTTP server from `edge-http`
 
 ### crypto_self_tests
 
-Runs the MbedTLS crypto self tests for all hookable MbedTLS algorithms in `esp-mbedtls-sys`
+Runs the MbedTLS crypto self tests for all hookable MbedTLS algorithms in `mbedtls-rs-sys`

examples/README.md

@@ -2,9 +2,9 @@
 
 use core::ffi::CStr;
 
-use esp_mbedtls::blocking::io::{Read, Write};
-use esp_mbedtls::blocking::Session;
-use esp_mbedtls::{SessionConfig, SessionError, TlsReference};
+use mbedtls_rs::blocking::io::{Read, Write};
+use mbedtls_rs::blocking::Session;
+use mbedtls_rs::{SessionConfig, SessionError, TlsReference};
 
 use log::info;
 

examples/common/blocking_client.rs

@@ -1,8 +1,8 @@
 //! A platform-agnostic HTTPS 1.0 server using the blocking API.
 
-use esp_mbedtls::blocking::io::{Read, Write};
-use esp_mbedtls::blocking::Session;
-use esp_mbedtls::{SessionConfig, SessionError, TlsReference};
+use mbedtls_rs::blocking::io::{Read, Write};
+use mbedtls_rs::blocking::Session;
+use mbedtls_rs::{SessionConfig, SessionError, TlsReference};
 
 use log::{info, warn};
 
@@ -51,7 +51,7 @@ where
             core::str::from_utf8(&buf[..headers_end]).unwrap_or("???")
         );
 
-        session.write_all(b"HTTP/1.0 200 OK\r\nContent-Type: text/plain\r\nConnection: Close\r\n\r\nHello from esp-mbedtls!\r\n")?;
+        session.write_all(b"HTTP/1.0 200 OK\r\nContent-Type: text/plain\r\nConnection: Close\r\n\r\nHello from mbedtls-rs!\r\n")?;
     } else {
         info!("No valid HTTP request received");
     }

examples/common/blocking_server.rs

@@ -2,7 +2,7 @@
 
 use core::ffi::CStr;
 
-use esp_mbedtls::{Certificate, ClientSessionConfig, Credentials, ServerSessionConfig, X509};
+use mbedtls_rs::{Certificate, ClientSessionConfig, Credentials, ServerSessionConfig, X509};
 
 const CA_BUNDLE: &CStr = match CStr::from_bytes_with_nul(
     concat!(include_str!("certs/ca-bundle-small.pem"), "\0").as_bytes(),
@@ -24,7 +24,7 @@ pub fn client_conf<'a>(mtls: bool, server_name: Option<&'a CStr>) -> ClientSessi
     if mtls {
         conf.creds = Some(Credentials {
             certificate: Certificate::new_no_copy(CERT).unwrap(),
-            private_key: esp_mbedtls::PrivateKey::new(X509::DER(KEY), None).unwrap(),
+            private_key: mbedtls_rs::PrivateKey::new(X509::DER(KEY), None).unwrap(),
         });
     }
 
@@ -38,7 +38,7 @@ pub fn server_conf(mtls: bool) -> ServerSessionConfig<'static> {
         ca_chain: Some(cert.clone()),
         ..ServerSessionConfig::new(Credentials {
             certificate: cert.clone(),
-            private_key: esp_mbedtls::PrivateKey::new(X509::DER(KEY), None).unwrap(),
+            private_key: mbedtls_rs::PrivateKey::new(X509::DER(KEY), None).unwrap(),
         })
     };
 

examples/common/certs.rs

@@ -1,4 +1,4 @@
-# Certificates for the `esp-mbedtls` Examples
+# Certificates for the `mbedtls-rs` Examples
 
 This folder contains certificates used by the examples:
 - `ca-bundle.pem`
@@ -9,12 +9,12 @@ This folder contains certificates used by the examples:
     ```
 - `ca-bundle-small.pem`
   - A manual extraction of just two root CAs from `ca-bundle.pem` which are known to be used by the websites used in the client examples (`httpbin.org` and `certauth.cryptomix.com`)
-  - Done for reducing memory and flash size when using `esp-mbedtls`
+  - Done for reducing memory and flash size when using `mbedtls-rs`
 - `cert.der` / `cert.pem` + `key.der` / `key.pem`
   - Self-signed certificate used by the server examples and its corresponding key
   - Can be re-generated with:
     ```sh
-    openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -sha256 -days 3650 -nodes -subj "/CN=esp-mbedtls.local"
+    openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -sha256 -days 3650 -nodes -subj "/CN=mbedtls-rs.local"
     openssl x509 -in cert.pem -out cert.der -outform DER
     openssl rsa -in key.pem -out key.der -outform DER
     ```