diff mbox series

[v1,1/1] package/mbedtls: Move test binaries to subdirectory

Message ID 20240916170340.13019-1-brpi@duering-andreas.de
State Changes Requested
Headers show
Series [v1,1/1] package/mbedtls: Move test binaries to subdirectory | expand

Commit Message

Andreas Düring Sept. 16, 2024, 5:03 p.m. UTC
The mbedtls package has a config option BR2_PACKAGE_MBEDTLS_PROGRAMS,
which enables some test programs to be built and installed.
However, some of the test programs have unfortunate names,
e.g. "hello" and "strerror", which may lead to name collisions (?)
and also otherwise "pollute" /usr/bin/.

Add a patch to the CMakeLists.txt files, so that the binaries go
to /usr/bin/mbedtls.

Signed-off-by: Andreas Düring <brpi@duering-andreas.de>
---
 ...001-install-programs-to-subdirectory.patch | 103 ++++++++++++++++++
 1 file changed, 103 insertions(+)
 create mode 100644 package/mbedtls/0001-install-programs-to-subdirectory.patch

Comments

Thomas Petazzoni Oct. 26, 2024, 3:50 p.m. UTC | #1
Hello Andreas,

On Mon, 16 Sep 2024 19:03:40 +0200
Andreas Düring via buildroot <buildroot@buildroot.org> wrote:

> The mbedtls package has a config option BR2_PACKAGE_MBEDTLS_PROGRAMS,
> which enables some test programs to be built and installed.
> However, some of the test programs have unfortunate names,
> e.g. "hello" and "strerror", which may lead to name collisions (?)
> and also otherwise "pollute" /usr/bin/.
> 
> Add a patch to the CMakeLists.txt files, so that the binaries go
> to /usr/bin/mbedtls.
> 
> Signed-off-by: Andreas Düring <brpi@duering-andreas.de>

Thanks a lot for raising this issue, and proposing this patch.

However, as Arnout has pointed out, we need the patch to be submitted
upstream, and an "Upstream:" tag with the reference to the upstream
submission (email, pull request, etc.).

In addition, why would programs go in /usr/bin/mbedtls? Isn't the right
course action to rename those programs so that they don't have
conflicting names? Like mbedtls-hello, mbedtls-strerror, etc. ?

This is really something to take and discuss with upstream.

Thanks!

Thomas
diff mbox series

Patch

diff --git a/package/mbedtls/0001-install-programs-to-subdirectory.patch b/package/mbedtls/0001-install-programs-to-subdirectory.patch
new file mode 100644
index 0000000000..5a28dcfc31
--- /dev/null
+++ b/package/mbedtls/0001-install-programs-to-subdirectory.patch
@@ -0,0 +1,103 @@ 
+Install mbedtls test programs to a subdirectory
+
+This is to avoid collisions (e.g. "hello").
+
+Signed-off-by: Andreas Düring <brpi@duering-andreas.de>
+Index: mbedtls-2.28.8/programs/aes/CMakeLists.txt
+===================================================================
+--- mbedtls-2.28.8.orig/programs/aes/CMakeLists.txt
++++ mbedtls-2.28.8/programs/aes/CMakeLists.txt
+@@ -8,5 +8,5 @@ foreach(exe IN LISTS executables)
+ endforeach()
+ 
+ install(TARGETS ${executables}
+-        DESTINATION "bin"
++        DESTINATION "bin/mbedtls"
+         PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)
+Index: mbedtls-2.28.8/programs/hash/CMakeLists.txt
+===================================================================
+--- mbedtls-2.28.8.orig/programs/hash/CMakeLists.txt
++++ mbedtls-2.28.8/programs/hash/CMakeLists.txt
+@@ -9,5 +9,5 @@ foreach(exe IN LISTS executables)
+ endforeach()
+ 
+ install(TARGETS ${executables}
+-        DESTINATION "bin"
++        DESTINATION "bin/mbedtls"
+         PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)
+Index: mbedtls-2.28.8/programs/pkey/CMakeLists.txt
+===================================================================
+--- mbedtls-2.28.8.orig/programs/pkey/CMakeLists.txt
++++ mbedtls-2.28.8/programs/pkey/CMakeLists.txt
+@@ -35,5 +35,5 @@ foreach(exe IN LISTS executables_mbedcry
+ endforeach()
+ 
+ install(TARGETS ${executables_mbedtls} ${executables_mbedcrypto}
+-        DESTINATION "bin"
++        DESTINATION "bin/mbedtls"
+         PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)
+Index: mbedtls-2.28.8/programs/psa/CMakeLists.txt
+===================================================================
+--- mbedtls-2.28.8.orig/programs/psa/CMakeLists.txt
++++ mbedtls-2.28.8/programs/psa/CMakeLists.txt
+@@ -18,4 +18,4 @@ install(TARGETS ${executables}
+ 
+ install(PROGRAMS
+             key_ladder_demo.sh
+-        DESTINATION "bin")
++        DESTINATION "bin/mbedtls")
+Index: mbedtls-2.28.8/programs/random/CMakeLists.txt
+===================================================================
+--- mbedtls-2.28.8.orig/programs/random/CMakeLists.txt
++++ mbedtls-2.28.8/programs/random/CMakeLists.txt
+@@ -10,5 +10,5 @@ foreach(exe IN LISTS executables)
+ endforeach()
+ 
+ install(TARGETS ${executables}
+-        DESTINATION "bin"
++        DESTINATION "bin/mbedtls"
+         PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)
+Index: mbedtls-2.28.8/programs/ssl/CMakeLists.txt
+===================================================================
+--- mbedtls-2.28.8.orig/programs/ssl/CMakeLists.txt
++++ mbedtls-2.28.8/programs/ssl/CMakeLists.txt
+@@ -50,5 +50,5 @@ if(THREADS_FOUND)
+ endif(THREADS_FOUND)
+ 
+ install(TARGETS ${executables}
+-        DESTINATION "bin"
++        DESTINATION "bin/mbedtls"
+         PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)
+Index: mbedtls-2.28.8/programs/test/CMakeLists.txt
+===================================================================
+--- mbedtls-2.28.8.orig/programs/test/CMakeLists.txt
++++ mbedtls-2.28.8/programs/test/CMakeLists.txt
+@@ -64,5 +64,5 @@ foreach(exe IN LISTS executables_libs ex
+ endforeach()
+ 
+ install(TARGETS ${executables_libs} ${executables_mbedcrypto}
+-        DESTINATION "bin"
++        DESTINATION "bin/mbedtls"
+         PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)
+Index: mbedtls-2.28.8/programs/util/CMakeLists.txt
+===================================================================
+--- mbedtls-2.28.8.orig/programs/util/CMakeLists.txt
++++ mbedtls-2.28.8/programs/util/CMakeLists.txt
+@@ -13,5 +13,5 @@ foreach(exe IN LISTS executables)
+ endforeach()
+ 
+ install(TARGETS ${executables}
+-        DESTINATION "bin"
++        DESTINATION "bin/mbedtls"
+         PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)
+Index: mbedtls-2.28.8/programs/x509/CMakeLists.txt
+===================================================================
+--- mbedtls-2.28.8.orig/programs/x509/CMakeLists.txt
++++ mbedtls-2.28.8/programs/x509/CMakeLists.txt
+@@ -27,5 +27,5 @@ endforeach()
+ target_link_libraries(cert_app ${mbedtls_target})
+ 
+ install(TARGETS ${executables}
+-        DESTINATION "bin"
++        DESTINATION "bin/mbedtls"
+         PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)