FindMbedTLS.cmake 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. #[=======================================================================[.rst
  2. FindMbedTLS
  3. -----------
  4. FindModule for MbedTLS and associated libraries
  5. .. versionchanged:: 3.0
  6. Updated FindModule to CMake standards
  7. Components
  8. ^^^^^^^^^^
  9. .. versionadded:: 1.0
  10. This module contains provides several components:
  11. ``MbedCrypto``
  12. ``MbedTLS``
  13. ``MbedX509``
  14. Import targets exist for each component.
  15. Imported Targets
  16. ^^^^^^^^^^^^^^^^
  17. .. versionadded:: 2.0
  18. This module defines the :prop_tgt:`IMPORTED` targets:
  19. ``MbedTLS::MbedCrypto``
  20. Crypto component
  21. ``MbedTLS::MbedTLS``
  22. TLS component
  23. ``MbedTLS::MbedX509``
  24. X509 component
  25. Result Variables
  26. ^^^^^^^^^^^^^^^^
  27. This module sets the following variables:
  28. ``MbedTLS_FOUND``
  29. True, if all required components and the core library were found.
  30. ``MbedTLS_VERSION``
  31. Detected version of found MbedTLS libraries.
  32. ``MbedTLS_<COMPONENT>_VERSION``
  33. Detected version of found MbedTLS component library.
  34. Cache variables
  35. ^^^^^^^^^^^^^^^
  36. The following cache variables may also be set:
  37. ``MbedTLS_<COMPONENT>_LIBRARY``
  38. Path to the library component of MbedTLS.
  39. ``MbedTLS_<COMPONENT>_INCLUDE_DIR``
  40. Directory containing ``<COMPONENT>.h``.
  41. #]=======================================================================]
  42. include(FindPackageHandleStandardArgs)
  43. find_package(PkgConfig QUIET)
  44. if(PKG_CONFIG_FOUND)
  45. pkg_check_modules(PC_MbedTLS QUIET mbedtls mbedcrypto mbedx509)
  46. endif()
  47. # MbedTLS_set_soname: Set SONAME on imported library targets
  48. macro(MbedTLS_set_soname component)
  49. if(CMAKE_HOST_SYSTEM_NAME MATCHES "Darwin")
  50. execute_process(
  51. COMMAND sh -c "otool -D '${Mbed${component}_LIBRARY}' | grep -v '${Mbed${component}_LIBRARY}'"
  52. OUTPUT_VARIABLE _output
  53. RESULT_VARIABLE _result
  54. )
  55. if(_result EQUAL 0 AND _output MATCHES "^@rpath/")
  56. set_property(TARGET MbedTLS::Mbed${component} PROPERTY IMPORTED_SONAME "${_output}")
  57. endif()
  58. elseif(CMAKE_HOST_SYSTEM_NAME MATCHES "Linux|FreeBSD")
  59. execute_process(
  60. COMMAND sh -c "objdump -p '${Mbed${component}_LIBRARY}' | grep SONAME"
  61. OUTPUT_VARIABLE _output
  62. RESULT_VARIABLE _result
  63. )
  64. if(_result EQUAL 0)
  65. string(REGEX REPLACE "[ \t]+SONAME[ \t]+([^ \t]+)" "\\1" _soname "${_output}")
  66. set_property(TARGET MbedTLS::Mbed${component} PROPERTY IMPORTED_SONAME "${_soname}")
  67. unset(_soname)
  68. endif()
  69. endif()
  70. unset(_output)
  71. unset(_result)
  72. endmacro()
  73. find_path(
  74. MbedTLS_INCLUDE_DIR
  75. NAMES mbedtls/ssl.h
  76. HINTS "${PC_MbedTLS_INCLUDE_DIRS}"
  77. PATHS /usr/include /usr/local/include
  78. DOC "MbedTLS include directory"
  79. )
  80. if(PC_MbedTLS_VERSION VERSION_GREATER 0)
  81. set(MbedTLS_VERSION ${PC_MbedTLS_VERSION})
  82. elseif(EXISTS "${MbedTLS_INCLUDE_DIR}/mbedtls/build_info.h")
  83. file(
  84. STRINGS
  85. "${MbedTLS_INCLUDE_DIR}/mbedtls/build_info.h"
  86. _VERSION_STRING
  87. REGEX "#define[ \t]+MBEDTLS_VERSION_STRING[ \t]+.+"
  88. )
  89. string(
  90. REGEX REPLACE
  91. ".*#define[ \t]+MBEDTLS_VERSION_STRING[ \t]+\"(.+)\".*"
  92. "\\1"
  93. MbedTLS_VERSION
  94. "${_VERSION_STRING}"
  95. )
  96. elseif(EXISTS "${MbedTLS_INCLUDE_DIR}/mbedtls/version.h")
  97. file(
  98. STRINGS
  99. "${MbedTLS_INCLUDE_DIR}/mbedtls/version.h"
  100. _VERSION_STRING
  101. REGEX "#define[ \t]+MBEDTLS_VERSION_STRING[ \t]+.+"
  102. )
  103. string(
  104. REGEX REPLACE
  105. ".*#define[ \t]+MBEDTLS_VERSION_STRING[ \t]+\"(.+)\".*"
  106. "\\1"
  107. MbedTLS_VERSION
  108. "${_VERSION_STRING}"
  109. )
  110. else()
  111. if(NOT MbedTLS_FIND_QUIETLY)
  112. message(AUTHOR_WARNING "Failed to find MbedTLS version.")
  113. endif()
  114. set(MbedTLS_VERSION 0.0.0)
  115. endif()
  116. find_library(
  117. MbedTLS_LIBRARY
  118. NAMES libmbedtls mbedtls
  119. HINTS "${PC_MbedTLS_LIBRARY_DIRS}"
  120. PATHS /usr/lib /usr/local/lib
  121. DOC "MbedTLS location"
  122. )
  123. find_library(
  124. MbedCrypto_LIBRARY
  125. NAMES libmbedcrypto mbedcrypto
  126. HINTS "${PC_MbedTLS_LIBRARY_DIRS}"
  127. PATHS /usr/lib /usr/local/lib
  128. DOC "MbedCrypto location"
  129. )
  130. find_library(
  131. MbedX509_LIBRARY
  132. NAMES libmbedx509 mbedx509
  133. HINTS "${PC_MbedTLS_LIBRARY_DIRS}"
  134. PATHS /usr/lib /usr/local/lib
  135. DOC "MbedX509 location"
  136. )
  137. if(MbedTLS_LIBRARY AND NOT MbedCrypto_LIBRARY AND NOT MbedX509_LIBRARY)
  138. set(CMAKE_REQUIRED_LIBRARIES "${MbedTLS_LIBRARY}")
  139. set(CMAKE_REQUIRED_INCLUDES "${MbedTLS_INCLUDE_DIR}")
  140. check_symbol_exists(mbedtls_x509_crt_init "mbedtls/x590_crt.h" MbedTLS_INCLUDES_X509)
  141. check_symbol_exists(mbedtls_sha256_init "mbedtls/sha256.h" MbedTLS_INCLUDES_CRYPTO)
  142. unset(CMAKE_REQUIRED_LIBRARIES)
  143. unset(CMAKE_REQUIRED_INCLUDES)
  144. endif()
  145. if(CMAKE_HOST_SYSTEM_NAME MATCHES "Darwin|Windows")
  146. set(MbedTLS_ERROR_REASON "Ensure that obs-deps is provided as part of CMAKE_PREFIX_PATH.")
  147. elseif(CMAKE_HOST_SYSTEM_NAME MATCHES "Linux|FreeBSD")
  148. set(MbedTLS_ERROR_REASON "Ensure that MbedTLS is installed on the system.")
  149. endif()
  150. if(MbedTLS_INCLUDES_X509 AND MbedTLS_INCLUDES_CRYPTO)
  151. find_package_handle_standard_args(
  152. MbedTLS
  153. REQUIRED_VARS MbedTLS_LIBRARY MbedTLS_INCLUDE_DIR
  154. VERSION_VAR MbedTLS_VERSION
  155. REASON_FAILURE_MESSAGE "${MbedTLS_ERROR_REASON}"
  156. )
  157. mark_as_advanced(MbedTLS_LIBRARY MbedTLS_INCLUDE_DIR)
  158. list(APPEND _COMPONENTS TLS)
  159. else()
  160. find_package_handle_standard_args(
  161. MbedTLS
  162. REQUIRED_VARS MbedTLS_LIBRARY MbedCrypto_LIBRARY MbedX509_LIBRARY MbedTLS_INCLUDE_DIR
  163. VERSION_VAR MbedTLS_VERSION
  164. REASON_FAILURE_MESSAGE "${MbedTLS_ERROR_REASON}"
  165. )
  166. mark_as_advanced(MbedTLS_LIBRARY MbedCrypto_LIBRARY MbedX509_LIBRARY MbedTLS_INCLUDE_DIR)
  167. list(APPEND _COMPONENTS TLS Crypto X509)
  168. endif()
  169. unset(MbedTLS_ERROR_REASON)
  170. if(MbedTLS_FOUND)
  171. foreach(component IN LISTS _COMPONENTS)
  172. if(NOT TARGET MbedTLS::Mbed${component})
  173. if(IS_ABSOLUTE "${Mbed${component}_LIBRARY}")
  174. add_library(MbedTLS::Mbed${component} UNKNOWN IMPORTED)
  175. set_property(TARGET MbedTLS::Mbed${component} PROPERTY IMPORTED_LOCATION "${Mbed${component}_LIBRARY}")
  176. else()
  177. add_library(MbedTLS::Mbed${component} INTERFACE IMPORTED)
  178. set_property(TARGET MbedTLS::Mbed${component} PROPERTY IMPORTED_LIBNAME "${Mbed${component}_LIBRARY}")
  179. endif()
  180. mbedtls_set_soname(${component})
  181. set_target_properties(
  182. MbedTLS::MbedTLS
  183. PROPERTIES
  184. INTERFACE_COMPILE_OPTIONS "${PC_MbedTLS_CFLAGS_OTHER}"
  185. INTERFACE_INCLUDE_DIRECTORIES "${MbedTLS_INCLUDE_DIR}"
  186. INTERFACE_LINK_OPTIONS "$<$<AND:$<PLATFORM_ID:Windows>,$<CONFIG:DEBUG>>:/NODEFAULTLIB:MSVCRT>"
  187. VERSION ${MbedTLS_VERSION}
  188. )
  189. endif()
  190. endforeach()
  191. if(MbedTLS_INCLUDES_X509 AND MbedTLS_INCLUDES_CRYPTO)
  192. set(MbedTLS_LIBRARIES ${MbedTLS_LIBRARY})
  193. else()
  194. set(MbedTLS_LIBRARIES ${MbedTLS_LIBRARY} ${MbedCrypto_LIBRARY} ${MbedX509_LIBRARY})
  195. set_property(TARGET MbedTLS::MbedTLS PROPERTY INTERFACE_LINK_LIBRARIES MbedTLS::MbedCrypto MbedTLS::MbedX509)
  196. endif()
  197. endif()
  198. include(FeatureSummary)
  199. set_package_properties(
  200. MbedTLS
  201. PROPERTIES
  202. URL "https://www.trustedfirmware.org/projects/mbed-tls"
  203. DESCRIPTION
  204. "A C library implementing cryptographic primitives, X.509 certificate manipulation, and the SSL/TLS and DTLS protocols."
  205. )