Fix: Apply COHABITANT_HEADERS logic to location of tool binaries (#3116)

### Problem:

`aws-lc` installs binaries in the BINDIR. The binaries that are
installed are: `bssl`, `c_rehash`, and `openssl`.

On a system with OpenSSL installed, this will cause an error, or it will
cause existing OpenSSL binaries to be overwritten by `aws-lc` ones.

Since aws-lc version 1.71.0 COHABITANT_HEADERS is used to rewrite the
installation location of library and header files. This should be
extended to the binaries.

### Solution:

Use the same COHABITANT_HEADERS logic from #3042 to potentially change
the binary destination.

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license and the ISC license.

---------

Co-authored-by: Justin Smith <justsmth@amazon.com>
Co-authored-by: Justin W Smith <103147162+justsmth@users.noreply.github.com>

Author: edmundlod

CMakeLists.txt

@@ -86,6 +86,7 @@ if(ENABLE_DIST_PKG)
   else()
     set(SET_LIB_SONAME 1)
     set(COHABITANT_HEADERS 1)
+    set(COHABITANT_BINARIES 1)
     if(ENABLE_DIST_PKG_OPENSSL_SHIM)
       set(INSTALL_OPENSSL_SHIM 1)
     else()
@@ -95,15 +96,18 @@ if(ENABLE_DIST_PKG)
 elseif(NOT ENABLE_PRE_SONAME_BUILD AND BUILD_SHARED_LIBS AND UNIX AND NOT APPLE)
   set(SET_LIB_SONAME 1)
   set(COHABITANT_HEADERS 0)
+  set(COHABITANT_BINARIES 0)
   set(INSTALL_OPENSSL_SHIM 1)
 else()
   set(SET_LIB_SONAME 0)
   set(COHABITANT_HEADERS 0)
+  set(COHABITANT_BINARIES 0)
   set(INSTALL_OPENSSL_SHIM 1)
 endif()
 
 message(STATUS "SET_LIB_SONAME: ${SET_LIB_SONAME}")
 message(STATUS "COHABITANT_HEADERS: ${COHABITANT_HEADERS}")
+message(STATUS "COHABITANT_BINARIES: ${COHABITANT_BINARIES}")
 message(STATUS "INSTALL_OPENSSL_SHIM: ${INSTALL_OPENSSL_SHIM}")
 
 if(SET_LIB_SONAME)
@@ -134,6 +138,13 @@ else()
   set(AWSLC_INSTALL_INCLUDEDIR "${CMAKE_INSTALL_INCLUDEDIR}")
 endif()
 
+# Set the install bin prefix based on whether cohabitation is desired
+if(COHABITANT_BINARIES)
+  set(AWSLC_BIN_PREFIX "aws-lc-")
+else()
+  set(AWSLC_BIN_PREFIX "")
+endif()
+
 function(target_add_awslc_include_paths)
   set(options EXCLUDE_PREFIX_HEADERS)
   set(oneValueArgs TARGET SCOPE)

tool-openssl/CMakeLists.txt

@@ -58,6 +58,10 @@ endif()
 
 target_add_awslc_include_paths(TARGET openssl SCOPE PRIVATE)
 
+if(COHABITANT_BINARIES)
+  set_target_properties(openssl PROPERTIES OUTPUT_NAME "${AWSLC_BIN_PREFIX}openssl")
+endif()
+
 install(TARGETS openssl
         RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
         BUNDLE DESTINATION ${CMAKE_INSTALL_BINDIR}
@@ -76,10 +80,16 @@ file(INSTALL
     c_rehash
 )
 
+set(C_REHASH_INSTALL_NAME "c_rehash")
+
+if(COHABITANT_BINARIES)
+  set(C_REHASH_INSTALL_NAME "${AWSLC_BIN_PREFIX}c_rehash")
+endif()
+
 install(
-    PROGRAMS ${CMAKE_CURRENT_SOURCE_DIR}/c_rehash.sh
-    RENAME c_rehash
-    DESTINATION ${CMAKE_INSTALL_BINDIR}
+  PROGRAMS ${CMAKE_CURRENT_SOURCE_DIR}/c_rehash.sh
+  RENAME ${C_REHASH_INSTALL_NAME}
+  DESTINATION ${CMAKE_INSTALL_BINDIR}
 )
 
 if(MSVC AND CMAKE_BUILD_TYPE_LOWER MATCHES "relwithdebinfo" AND FIPS)
@@ -165,3 +175,13 @@ if(BUILD_TESTING)
     add_dependencies(tool_openssl_test openssl)
     set_test_location(tool_openssl_test)
 endif()
+
+# Create binary symlinks for OpenSSL compatibility
+if(INSTALL_OPENSSL_SHIM AND COHABITANT_BINARIES)
+  install(CODE "
+    execute_process(COMMAND \${CMAKE_COMMAND} -E create_symlink
+      \"${AWSLC_BIN_PREFIX}openssl\" \"\$ENV{DESTDIR}\${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_BINDIR}/openssl\")
+    execute_process(COMMAND \${CMAKE_COMMAND} -E create_symlink
+      \"${AWSLC_BIN_PREFIX}c_rehash\" \"\$ENV{DESTDIR}\${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_BINDIR}/c_rehash\")
+  ")
+endif()

tool/CMakeLists.txt

@@ -41,6 +41,10 @@ else()
   endif()
 endif()
 
+if(COHABITANT_BINARIES)
+  set_target_properties(bssl PROPERTIES OUTPUT_NAME "${AWSLC_BIN_PREFIX}bssl")
+endif()
+
 install(TARGETS bssl
         RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
         BUNDLE DESTINATION ${CMAKE_INSTALL_BINDIR}