libssh2项目CMake构建指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00599/article/details/149011709

libssh2项目CMake构建指南

前言

libssh2是一个功能强大的客户端C库，实现了SSH2协议。本文将详细介绍如何使用CMake构建系统来编译和安装libssh2库，帮助开发者快速上手并集成到自己的项目中。

构建准备

在开始构建libssh2之前，需要确保系统中已安装以下组件：

CMake 3.7或更高版本：现代跨平台构建系统
加密库之一（必须选择至少一个）：
- OpenSSL：广泛使用的开源加密工具包
- wolfSSL：轻量级嵌入式SSL/TLS库
- Libgcrypt：GNU加密库
- WinCNG：Windows原生加密API（Vista及以上版本）
- mbedTLS：ARM开发的嵌入式SSL/TLS库

基础构建步骤

对于大多数开发者来说，使用默认配置构建是最快捷的方式：

# 创建构建目录并编译（CMake 3.13+）
cmake -B build_dir
cmake --build build_dir

# 传统方式（所有CMake版本）
mkdir build_dir && cd build_dir
cmake ..
cmake --build .

构建完成后，相关文件将存放在以下位置：

库文件：bin/src/
示例程序：bin/example/
测试程序：bin/tests/

高级配置选项

libssh2提供了丰富的CMake选项来自定义构建过程：

基本构建选项

# 构建静态库（默认开启）
-DBUILD_STATIC_LIBS=ON

# 构建动态库（默认开启）
-DBUILD_SHARED_LIBS=ON

加密后端选择

# 指定加密后端（留空则自动选择）
-DCRYPTO_BACKEND=OpenSSL
# 或
-DCRYPTO_BACKEND=Libgcrypt
# 或
-DCRYPTO_BACKEND=WinCNG
# 或
-DCRYPTO_BACKEND=mbedTLS

其他功能选项

# 启用ZLIB压缩（默认关闭）
-DENABLE_ZLIB_COMPRESSION=ON

# 启用调试日志（Release默认关闭，Debug默认开启）
-DENABLE_DEBUG_LOGGING=ON

# 禁用内存安全清除（不推荐）
-DCLEAR_MEMORY=OFF

# 启用代码静态检查
-DLINT=ON

特殊加密后端支持

除了标准加密库外，libssh2还支持：

BoringSSL：Google开发的OpenSSL分支
AWS-LC：亚马逊提供的加密库

构建时需要额外指定路径：

-DCRYPTO_BACKEND=OpenSSL -DOPENSSL_ROOT_DIR=<安装路径>

测试构建结果

构建完成后，建议运行测试验证功能完整性：

cmake --build . --target test
# 或
cmake --build . --target RUN_TESTS

安装到系统

将libssh2安装到系统目录便于其他项目使用：

cmake -DCMAKE_INSTALL_PREFIX=/custom/path ..
cmake --build .
cmake --build . --target install

项目集成指南

非CMake项目集成

安装后，按照常规方式在项目中链接libssh2库，具体方法取决于您的构建系统。

CMake项目集成

对于使用CMake的项目，集成非常简单：

find_package(libssh2 REQUIRED CONFIG)
target_link_libraries(my_target libssh2::libssh2)

超级构建模式

推荐使用CMake的超级构建模式，可以自动下载、构建并集成libssh2：

include(ExternalProject)

ExternalProject_Add(
    libssh2
    URL <libssh2下载地址>
    URL_HASH SHA256=<校验值>
    INSTALL_COMMAND "")

ExternalProject_Add(
    MyProject DEPENDS libssh2
    SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src
    INSTALL_COMMAND "")