FindOpenSSL 以外の方法でOpenSSLを検出する方法

CMake Modules: FindOpenSSL 詳細解説

FindOpenSSL は、CMake プロジェクトで OpenSSL ライブラリを検出するためのモジュールです。これは、OpenSSL ヘッダーファイルとライブラリファイルの場所を自動的に特定し、プロジェクトで使用できるように設定します。

仕組み

FindOpenSSL は、以下の手順で動作します。

1. システムパスとデフォルトのインストール場所に OpenSSL ライブラリを検索します。
2. OPENSSL_ROOT_DIR 変数が設定されている場合は、そのディレクトリを検索します。
3. pkg-config ユーティリティが利用可能な場合は、それを利用して OpenSSL の情報を取得します。
4. 上記のいずれの方法でも OpenSSL が見つからなかった場合は、エラーメッセージを表示します。

使い方

FindOpenSSL を使用する方法は以下の通りです。

1. CMakeLists.txt ファイルに以下のコードを追加します。

find_package(OpenSSL REQUIRED)

1. OpenSSL_FOUND 変数が TRUE の場合は、OpenSSL が見つかったことを意味します。
2. OpenSSL_INCLUDE_DIR 変数は、OpenSSL ヘッダーファイルの場所を指します。
3. OpenSSL_LIBRARIES 変数は、OpenSSL ライブラリファイルへのパスをリストします。

詳細オプション

FindOpenSSL には、以下の詳細オプションがあります。

• OpenSSL_VERSION_STRING: 探している OpenSSL のバージョンを指定します。
• OpenSSL_USE_STATIC_LIBS: 静的ライブラリを使用することを指定します。
• OpenSSL_USE_PKG_CONFIG: pkg-config ユーティリティを使用することを指定します。

補足

• FindOpenSSL は、多くの CMake プロジェクトで広く使用されています。
• FindOpenSSL は、OpenSSL のバージョン 1.0.0 以降をサポートしています。
• FindOpenSSL は、Windows、Mac OS X、Linux などの多くのプラットフォームで動作します。
• FindOpenSSL は、CMake バージョン 3.2 以降で利用可能です。

例

以下の例は、FindOpenSSL を使用して OpenSSL ライブラリを検出する方法を示しています。

find_package(OpenSSL REQUIRED)

if(OpenSSL_FOUND)
  message(STATUS "OpenSSL version: ${OpenSSL_VERSION}")
  message(STATUS "OpenSSL include dir: ${OpenSSL_INCLUDE_DIR}")
  message(STATUS "OpenSSL library dir: ${OpenSSL_LIBRARY_DIR}")

  # Use OpenSSL in your project
  add_executable(my_app main.cpp)
  target_link_libraries(my_app OpenSSL::ssl OpenSSL::crypto)
else()
  message(FATAL_ERROR "OpenSSL not found")
endif()

FindOpenSSL に関する質問があれば、お気軽に聞いてください。

この情報は参考用であり、予告なく変更される場合があります。

CMake Modules: FindOpenSSL サンプルコード集

このページでは、FindOpenSSL モジュールを使用した様々なサンプルコードを紹介します。これらのサンプルコードは、FindOpenSSL の使い方を理解し、さまざまな状況でどのように使用できるかを示すために用意されています。

• 基本的な使い方

find_package(OpenSSL REQUIRED)

if(OpenSSL_FOUND)
  message(STATUS "OpenSSL version: ${OpenSSL_VERSION}")
  message(STATUS "OpenSSL include dir: ${OpenSSL_INCLUDE_DIR}")
  message(STATUS "OpenSSL library dir: ${OpenSSL_LIBRARY_DIR}")

  # Use OpenSSL in your project
  add_executable(my_app main.cpp)
  target_link_libraries(my_app OpenSSL::ssl OpenSSL::crypto)
else()
  message(FATAL_ERROR "OpenSSL not found")
endif()

• 特定のバージョンの OpenSSL を探す

find_package(OpenSSL REQUIRED
  VERSION 1.1.1)

if(OpenSSL_FOUND)
  message(STATUS "OpenSSL version: ${OpenSSL_VERSION}")
  # ...
else()
  message(FATAL_ERROR "OpenSSL version 1.1.1 not found")
endif()

• 静的ライブラリを使用する

find_package(OpenSSL REQUIRED
  USE_STATIC_LIBS)

if(OpenSSL_FOUND)
  message(STATUS "OpenSSL version: ${OpenSSL_VERSION}")
  # ...
else()
  message(FATAL_ERROR "OpenSSL not found")
endif()

• pkg-config ユーティリティを使用する

find_package(OpenSSL REQUIRED
  USE_PKG_CONFIG)

if(OpenSSL_FOUND)
  message(STATUS "OpenSSL version: ${OpenSSL_VERSION}")
  # ...
else()
  message(FATAL_ERROR "OpenSSL not found")
endif()

• OpenSSL の設定をカスタマイズする

set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "/path/to/custom/modules")

find_package(OpenSSL REQUIRED
  CUSTOM_MODULE_PATH)

if(OpenSSL_FOUND)
  message(STATUS "OpenSSL version: ${OpenSSL_VERSION}")
  # ...
else()
  message(FATAL_ERROR "OpenSSL not found")
endif()

補足

• これらのサンプルコードは、さまざまな状況で FindOpenSSL を使用する方法を示すためのものです。
• 実際のプロジェクトでは、これらのサンプルコードを必要に応じて変更する必要があります。

この情報は参考用であり、予告なく変更される場合があります。

CMakeでOpenSSLを検出するその他の方法

手動で設定する

set(OPENSSL_INCLUDE_DIR "/path/to/openssl/include")
set(OPENSSL_LIBRARIES "/path/to/openssl/lib/libssl.so;/path/to/openssl/lib/libcrypto.so")

# Use OpenSSL in your project
add_executable(my_app main.cpp)
target_link_libraries(my_app ${OPENSSL_LIBRARIES})

注意:

• この方法は、OpenSSLのインストール場所が分かっている場合にのみ使用できます。
• パス設定が間違っていると、ビルドエラーが発生します。

pkg-config ユーティリティを使用する

find_package(PkgConfig REQUIRED)

pkg_check_modules(OPENSSL REQUIRED libssl libcrypto)

# Use OpenSSL in your project
add_executable(my_app main.cpp)
target_link_libraries(my_app ${OPENSSL_LIBRARIES})

注意:

• pkg-config ユーティリティがインストールされている必要があります。
• OpenSSLがpkg-config で登録されている必要があります。

これらのツールを使用して、OpenSSLをダウンロード、ビルド、インストールし、CMakeプロジェクトで使用することができます。

補足

• 上記の方法のどれを選択するかは、プロジェクトの要件と環境によって異なります。
• FindOpenSSL モジュールは、最も簡単で汎用的な方法です。
• 手動設定は、最も柔軟な方法ですが、最も複雑でもあります。
• pkg-config ユーティリティを使用する方法は、最も簡単な方法の一つですが、pkg-config が必要です。
• 外部スクリプトを使用する方法は、最も複雑な方法ですが、最も多くの機能を提供します。

この情報は参考用であり、予告なく変更される場合があります。