使用libssh2建立安全的SSH连接：C++开发者的综合指南

原创

Lion Long

发布于 2024-12-05 23:14:34

30500

代码可运行

文章被收录于专栏：C++技术干货C++技术干货

运行总次数：0

代码可运行

“好事”发生

开始之前推荐一篇实用的文章：《计算机网络知识》，作者：【一起重学前端】。

https://cloud.tencent.com/developer/article/2474032

文章概述了三种计算机网络体系结构（OSI、TCP/IP、五层），包括正向代理和反向代理的区别与应用场景，以及CDN的工作原理。是一篇非常好的前端学习文章，值得一看。

接下来开始我们的正文。

一、介绍

SSH和安全连接的重要性是不可忽视的。在今天的互联网环境中，保护敏感数据和网络通信的安全至关重要。

通过使用SSH建立安全连接，可以确保数据在传输过程中是加密的。这意味着即使在网络上拦截到数据包，攻击者也无法读取其内容。
SSH提供了多种身份验证方法，如密码验证、公钥验证和证书验证。这些方法可以防止未经授权的用户访问远程系统，并确保只有合法用户能够建立连接。
SSH使用了公钥加密来验证服务器的身份，从而防止中间人攻击。所以用户可以确认他们连接到的是真实的服务器，而不是一个恶意的第三方。
SSH还提供了数据完整性检查，通过使用消息认证码（MAC）来验证数据在传输过程中是否被篡改。这确保了数据在传输过程中的完整性。
SSH是一种被广泛接受和使用的安全协议，它有一系列的安全性标准和最佳实践。使用SSH可以确保连接符合这些标准，并提供可靠的安全性。

libssh2是一个用于C/C++开发的开源库，用于实现SSH客户端和服务器的功能。它提供了一组API，使开发者能够使用SSH协议建立安全连接，并进行远程命令执行、文件传输等操作。

libssh2提供了广泛的功能，包括SSH2协议的各种认证方法（如密码、公钥、证书等），支持远程命令执行和文件传输，以及对SSH会话和通道的管理。
libssh2可在多个操作系统上运行，包括Windows、Linux、macOS等。这使得开发者可以将其应用于各种环境和项目中。
libssh2的API设计简洁明了，易于集成到现有的C/C++代码中。它提供了一致的接口，使开发者能够方便地使用SSH功能，而无需深入了解SSH协议的复杂细节。
libssh2是一个开源项目，拥有活跃的社区支持。这意味着开发者可以自由地访问源代码、提出问题、报告错误，并参与项目的开发和改进。

通过使用libssh2，可以轻松地构建安全的SSH客户端和服务器应用程序，实现远程管理、自动化任务执行等功能。

二、准备工作

安装和配置libssh2：

下载libssh2：从libssh2的官方网站（https://www.libssh2.org）或源代码存储库下载最新版本的libssh2库。
安装依赖项：在安装libssh2之前，请确保系统中已安装了必要的依赖项，如libcrypto、libssl和zlib等库。可以使用操作系统的包管理器来安装它们。例如，在Ubuntu上，可以运行以下命令安装所需的依赖项： sudo apt-get install libssl-dev zlib1g-dev ```
解压并编译：解压下载的libssh2源代码，并进入解压后的目录。然后运行以下命令来编译源代码： ./configure make 如果使用的是Windows，可以使用CMake来生成适合的编译环境的解决方案文件。
安装库文件：编译成功后，运行以下命令将生成的库文件安装到系统中： sudo make install
配置开发环境：在C/C++项目中配置开发环境以使用libssh2。这包括设置编译器选项和链接库文件。以下是一个简单的示例编译命令： gcc -o my_program my_program.c -lssh2

SSH密钥和身份验证是在SSH（Secure Shell）协议中用于安全身份验证的关键概念。

SSH密钥：SSH密钥是一对由公钥和私钥组成的加密密钥。公钥用于加密数据，而私钥用于解密数据。在SSH身份验证中，用户将公钥保存在服务器上，而私钥保留在本地。当用户尝试连接到服务器时，服务器会向其发送一个加密的随机挑战，用户使用私钥对其进行解密，并将解密后的挑战发送回服务器以验证身份。SSH密钥的优势在于其安全性和便捷性，因为私钥通常受到密码保护，并且可以在多个系统之间共享而无需传输密码。

身份验证方法：SSH支持多种身份验证方法，包括密码身份验证、公钥身份验证和基于主机的身份验证。

密码身份验证：用户通过输入密码进行身份验证。这是最常见的身份验证方法，但也是最不安全的，因为密码可能会被猜测或破解。
公钥身份验证：使用SSH密钥进行身份验证。用户将公钥添加到其帐户的授权密钥列表中，然后在连接时，服务器将检查用户提供的私钥是否与其帐户中的公钥匹配。这种方法安全性较高，因为私钥通常受到密码保护，并且不会在网络上传输密码。
基于主机的身份验证：在主机级别进行身份验证，而不是用户级别。服务器和客户端之间会交换密钥，并在连接过程中使用这些密钥进行身份验证。这种方法可以用于验证服务器的身份，并提供额外的安全性。

通过使用SSH密钥和身份验证方法，用户可以实现更强大的安全性和身份验证控制，以保护远程连接和数据传输。

注意：具体的SSH配置和身份验证方法可能因操作系统、SSH服务器软件和安全策略而有所不同。

三、建立SSH连接

3.1、初始化libssh2库

包含必要的头文件：在C/C++代码中，包含libssh2的头文件。在源文件的开头添加以下行：

#include <libssh2.h>

初始化库：在使用任何libssh2函数之前，需要通过调用libssh2_init()函数来初始化库。该函数初始化底层资源并设置库以进行后续操作。函数原型如下：

int libssh2_init(int flags);

该函数接受一个整数参数flags，用于指定初始化的选项。

flags：用于指定初始化选项的整数值。通常，可以将其设置为0，表示使用默认的初始化选项，或者LIBSSH2_INIT_NO_CRYPTO（0x0001）表示不初始化crypto库。。

libssh2_init函数在使用libssh2库之前调用，用于初始化库的状态和资源。调用该函数将为libssh2库分配和设置所需的内存，并在成功时返回0，表示初始化成功。如果出现错误或初始化失败，函数将返回一个负值，其中的错误代码用于指示具体的初始化错误。

以下是一个示例，展示如何使用libssh2_init函数进行libssh2库的初始化：

int rc = libssh2_init(0);
if (rc != 0) {
    // 初始化失败，处理错误
    // ...
}

注意：libssh2_init函数只需要在应用程序启动时调用一次，用于初始化libssh2库。在使用libssh2的其他功能之前，不需要多次调用该函数。

执行所需操作：一旦库被初始化，就可以继续使用libssh2函数执行与SSH有关的操作。这可以包括建立SSH连接、验证用户身份、执行远程命令、传输文件等。可查阅libssh2文档以及相关函数说明文档。
清理资源：在使用完libssh2库后，使用libssh2_exit()函数清理分配的资源是很重要的。

libssh2_exit();

这个函数释放库使用的任何资源，并进行必要的清理操作。

3.2、连接到远程主机

创建SSH会话：首先，需要创建一个libssh2会话（session）对象，用于维护连接和通信。可以使用libssh2_session_init()或libssh2_session_init_ex()函数来初始化会话对象，并设置必要的参数。 LIBSSH2_SESSION *session; session = libssh2_session_init_ex(NULL, NULL, NULL, NULL); if (session == NULL) { // 初始化会话失败，处理错误 // ... }

libssh2_session_init函数：

LIBSSH2_SESSION *libssh2_session_init(void);

该函数用于创建一个libssh2会话对象，并返回指向该对象的指针。它没有接受任何参数，并在创建成功时返回一个非空指针，否则返回NULL。

使用libssh2_session_init时，使用会话的默认选项，可以调用libssh2_session_set_timeout函数设置超时时间，或者使用libssh2_knownhost_readline函数加载已知主机列表。

libssh2_session_init_ex函数：

LIBSSH2_SESSION *libssh2_session_init_ex(
    libssh2_malloc_func malloc_func,
    libssh2_free_func free_func,
    libssh2_realloc_func realloc_func,
    void *abstract
);

该函数也用于创建libssh2会话对象，并返回指向该对象的指针。与libssh2_session_init不同的是，libssh2_session_init_ex允许传递一些额外的参数来指定自定义的内存管理函数和抽象指针。

malloc_func参数是用于申请内存的自定义函数的指针。你可以传递自己实现的malloc函数，或使用默认的malloc函数。
free_func参数是用于释放内存的自定义函数的指针。你可以传递自己实现的free函数，或使用默认的free函数。
realloc_func参数是用于重新分配内存的自定义函数的指针。你可以传递自己实现的realloc函数，或使用默认的realloc函数。
abstract参数是一个抽象指针，你可以将其用于传递上下文或与内存管理函数一起使用。

使用libssh2_session_init_ex可以根据需求自定义内存管理，以便更好地集成libssh2库到自己的应用程序中。

设置会话参数：可以使用libssh2_session_set_blocking()函数来设置会话的阻塞（blocking）或非阻塞（non-blocking）模式。阻塞模式意味着函数会一直等待操作完成，而非阻塞模式允许在等待时执行其他任务。 libssh2_session_set_blocking(session, 1); // 阻塞模式 // 或 libssh2_session_set_blocking(session, 0); // 非阻塞模式

libssh2_session_set_blocking是libssh2库中的一个函数，用于设置SSH会话的阻塞模式。它的函数签名如下：

void libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking);

该函数接受一个指向LIBSSH2_SESSION会话对象的指针和一个整数参数，用于指定阻塞模式。下面是对这两个参数的解释：

session：指向已创建的SSH会话对象的指针。
blocking：用于设置阻塞模式的整数值。当传入参数为0时，会话进入非阻塞模式；传入参数为非零值时，会话进入阻塞模式。

在阻塞模式下，调用 libssh2 函数时，如果所请求的操作没有立即完成，函数将一直阻塞（即处于等待状态）直到操作完成或超时。这意味着程序在等待操作完成时会暂停执行，直到收到响应或操作完成。

在非阻塞模式下，调用 libssh2 函数时，不会等待操作完成。如果调用一个可能阻塞的操作，函数会立即返回，并根据情况提供适当的错误代码或状态。在非阻塞模式下可以使用独立的方式监控和管理多个会话。

建立连接：使用libssh2_session_startup()函数来建立与远程主机的连接。在此之前，需要通过libssh2_session_handshake()函数进行会话握手。函数原型：

int libssh2_session_handshake(LIBSSH2_SESSION *session, LIBSSH2_SOCKET sock);

该函数接受两个参数：

session：一个指向已创建的SSH会话的指针。
sock：与远程主机通信的套接字。

libssh2_session_handshake()函数用于在SSH会话中进行握手操作，它执行以下任务：

启动SSH协议版本交换。
协商加密、认证和其他安全参数。
使用密钥交换算法协商会话密钥。
验证远程主机的主机密钥。

函数返回值：

成功握手时，返回值为0。
当需要进一步读取或写入套接字数据时，返回LIBSSH2_ERROR_EAGAIN。
在握手过程中发生错误时，返回负值，表示错误的错误代码。

函数调用示例：

int rc = libssh2_session_handshake(session, sock);
if (rc == 0) {
    // 握手成功，可以继续进行其他操作
} else if (rc == LIBSSH2_ERROR_EAGAIN) {
    // 需要进一步读取或写入套接字数据
} else {
    // 握手失败，处理错误
}

在使用libssh2库进行SSH连接时，一般会在创建SSH会话后立即调用libssh2_session_handshake()函数进行握手操作。握手成功后，就可以继续使用libssh2库提供的其他函数执行各种SSH操作，如执行命令、传输文件等。

身份验证：完成连接后，需要使用合适的身份验证方法对客户端进行身份验证。常见的身份验证方法包括密码、公钥和证书认证。可以使用相关函数，如libssh2_userauth_password()，libssh2_userauth_publickey_fromfile()等来进行身份验证。 // 例如，使用密码进行身份验证 int rc = libssh2_userauth_password(session, username, password); if (rc != 0) { // 身份验证失败，处理错误 // ... }
执行操作：完成身份验证后，可以执行远程命令、进行文件传输等操作。根据需求，使用相应的libssh2函数，如libssh2_channel_exec()等来执行操作。 LIBSSH2_CHANNEL *channel; channel = libssh2_channel_open_session(session); if (channel == NULL) { // 打开会话通道失败，处理错误 // ... } int rc = libssh2_channel_exec(channel, command); if (rc != 0) { // 远程命令执行失败，处理错误 // ... } 其中的command可以是要执行的远程命令。
断开连接和清理：完成所有操作后，需要断开与远程主机的连接，并进行必要的清理操作。使用libssh2_session_disconnect()函数和libssh2_session_free()函数来断开连接并释放会话资源。 libssh2_session_disconnect(session, "Goodbye"); libssh2_session_free(session);

3.4、完整示例

下面是一个使用libssh2连接到远程主机的完整示例：

#include <stdio.h>
#include <stdlib.h>
#include <libssh2.h>

int main()
{
    // 初始化libssh2库
    int rc = libssh2_init(0);
    if (rc != 0) {
        fprintf(stderr, "Failed to initialize libssh2. Error code %d
", rc);
        return 1;
    }

    // 创建SSH会话
    LIBSSH2_SESSION *session;
    session = libssh2_session_init();
    if (session == NULL) {
        fprintf(stderr, "Failed to create session
");
        return 1;
    }

    // 设置会话阻塞模式
    libssh2_session_set_blocking(session, 1);

    // 建立连接
    const char *hostname = "REMOTE_HOST";
    const int port = 22;
    const char *username = "REMOTE_USERNAME";
    const char *password = "REMOTE_PASSWORD";
    int socket = socket_connect(hostname, port); // 自定义函数，用于建立socket连接
    if (socket < 0) {
        fprintf(stderr, "Failed to connect to the remote host
");
        return 1;
    }

    rc = libssh2_session_handshake(session, socket);
    if (rc != 0) {
        fprintf(stderr, "Session handshake failed
");
        return 1;
    }

    rc = libssh2_userauth_password(session, username, password);
    if (rc != 0) {
        fprintf(stderr, "Authentication failed
");
        return 1;
    }

    // 执行远程命令
    LIBSSH2_CHANNEL *channel = libssh2_channel_open_session(session);
    if (channel == NULL) {
        fprintf(stderr, "Failed to open a channel
");
        return 1;
    }

    rc = libssh2_channel_exec(channel, "REMOTE_COMMAND");
    if (rc != 0) {
        fprintf(stderr, "Failed to execute remote command
");
        return 1;
    }

    // 读取并打印远程命令输出
    char buffer[1024];
    int nbytes;
    while ((nbytes = libssh2_channel_read(channel, buffer, sizeof(buffer) - 1)) > 0) {
        buffer[nbytes] = '\0';
        printf("%s", buffer);
    }

    // 断开连接和清理
    libssh2_channel_close(channel);
    libssh2_channel_free(channel);
    libssh2_session_disconnect(session, "Goodbye");
    libssh2_session_free(session);
    libssh2_exit();

    return 0;
}

四、文件传输

4.1、上传文件到远程主机

要使用libssh2上传文件到远程主机，按照以下步骤进行操作：

引入libssh2库，在代码中引入相关的头文件。
与远程主机建立SSH连接。
在建立SSH连接后，使用libssh2_sftp_init函数打开一个SFTP会话。
使用libssh2_sftp_open函数打开本地文件和远程文件。
使用libssh2_sftp_read和libssh2_sftp_write函数从本地文件读取数据并写入远程文件，实现文件的传输。
使用libssh2_sftp_close函数关闭本地文件和远程文件，然后使用libssh2_sftp_shutdown函数关闭SFTP会话。
最后，使用libssh2_session_disconnect和libssh2_session_free函数断开SSH连接，并释放相关资源。

以下是一个简单的C++代码示例：

#include <iostream>
#include <libssh2.h>
#include <libssh2_sftp.h>

int main() {
    // 初始化libssh2库
    int rc = libssh2_init(0);
    if (rc != 0) {
        std::cerr << "Failed to initialize libssh2. Error code: " << rc << std::endl;
        return 1;
    }

    // 建立SSH连接
    LIBSSH2_SESSION* session = libssh2_session_init();
    if (!session) {
        std::cerr << "Failed to create SSH session." << std::endl;
        return 1;
    }

    // 设置远程主机的IP地址和端口号
    const char* ip = "remote_host_ip";
    int port = 22;

    // 连接远程主机
    rc = libssh2_session_startup(session, socket);
    if (rc != 0) {
        std::cerr << "Failed to establish SSH connection. Error code: " << rc << std::endl;
        return 1;
    }

    // 进行身份验证（用户名和密码）
    const char* username = "your_username";
    const char* password = "your_password";
    rc = libssh2_userauth_password(session, username, password);
    if (rc != 0) {
        std::cerr << "Failed to authenticate. Error code: " << rc << std::endl;
        return 1;
    }

    // 打开SFTP会话
    LIBSSH2_SFTP* sftp_session = libssh2_sftp_init(session);
    if (!sftp_session) {
        std::cerr << "Failed to initialize SFTP session." << std::endl;
        return 1;
    }

    // 打开本地文件
    const char* local_file = "path_to_local_file";
    FILE* local_file_handle = fopen(local_file, "rb");
    if (!local_file_handle) {
        std::cerr << "Failed to open local file: " << local_file << std::endl;
        return 1;
    }

    // 打开远程文件
    const char* remote_file = "path_to_remote_file";
    LIBSSH2_SFTP_HANDLE* sftp_handle = libssh2_sftp_open(sftp_session, remote_file,
                                                        LIBSSH2_FXF_WRITE | LIBSSH2_FXF_CREAT | LIBSSH2_FXF_TRUNC,
                                                        LIBSSH2_SFTP_S_IRUSR | LIBSSH2_SFTP_S_IWUSR | LIBSSH2_SFTP_S_IRGRP | LIBSSH2_SFTP_S_IROTH);
    if (!sftp_handle) {
        std::cerr << "Failed to open remote file: " << remote_file << std::endl;
        return 1;
    }

    // 传输文件内容
    char buffer[1024];
    size_t bytes_read;
    ssize_t bytes_written;
    while ((bytes_read = fread(buffer, 1, sizeof(buffer), local_file_handle)) > 0) {
        bytes_written = libssh2_sftp_write(sftp_handle, buffer, bytes_read);
        if (bytes_written != bytes_read) {
            std::cerr << "Failed to write to remote file." << std::endl;
            return 1;
        }
    }

    // 关闭本地文件和远程文件
    fclose(local_file_handle);
    libssh2_sftp_close(sftp_handle);

    // 关闭SFTP会话和SSH连接
    libssh2_sftp_shutdown(sftp_session);
    libssh2_session_disconnect(session, "Goodbye");
    libssh2_session_free(session);

    // 清理libssh2库
    libssh2_exit();
    
    return 0;
}

4.2、下载文件到本地主机

一个简单的C++代码示例：

#include <iostream>
#include <libssh2.h>
#include <libssh2_sftp.h>

int main() {
    // 初始化libssh2库
    int rc = libssh2_init(0);
    if (rc != 0) {
        std::cerr << "Failed to initialize libssh2. Error code: " << rc << std::endl;
        return 1;
    }

    // 建立SSH连接
    LIBSSH2_SESSION* session = libssh2_session_init();
    if (!session) {
        std::cerr << "Failed to create SSH session." << std::endl;
        return 1;
    }

    // 设置远程主机的IP地址和端口号
    const char* ip = "remote_host_ip";
    int port = 22;

    // 连接远程主机
    rc = libssh2_session_startup(session, socket);
    if (rc != 0) {
        std::cerr << "Failed to establish SSH connection. Error code: " << rc << std::endl;
        return 1;
    }

    // 进行身份验证（用户名和密码）
    const char* username = "your_username";
    const char* password = "your_password";
    rc = libssh2_userauth_password(session, username, password);
    if (rc != 0) {
        std::cerr << "Failed to authenticate. Error code: " << rc << std::endl;
        return 1;
    }

    // 打开SFTP会话
    LIBSSH2_SFTP* sftp_session = libssh2_sftp_init(session);
    if (!sftp_session) {
        std::cerr << "Failed to initialize SFTP session." << std::endl;
        return 1;
    }

    // 打开远程文件
    const char* remote_file = "path_to_remote_file";
    LIBSSH2_SFTP_HANDLE* sftp_handle = libssh2_sftp_open(sftp_session, remote_file, LIBSSH2_FXF_READ, 0);
    if (!sftp_handle) {
        std::cerr << "Failed to open remote file: " << remote_file << std::endl;
        return 1;
    }

    // 打开本地文件
    const char* local_file = "path_to_local_file";
    FILE* local_file_handle = fopen(local_file, "wb");
    if (!local_file_handle) {
        std::cerr << "Failed to open local file: " << local_file << std::endl;
        return 1;
    }

    // 下载文件内容
    char buffer[1024];
    ssize_t bytes_read;
    ssize_t bytes_written;
    while ((bytes_read = libssh2_sftp_read(sftp_handle, buffer, sizeof(buffer))) > 0) {
        bytes_written = fwrite(buffer, 1, bytes_read, local_file_handle);
        if (bytes_written != bytes_read) {
            std::cerr << "Failed to write to local file." << std::endl;
            return 1;
        }
    }

    // 关闭本地文件和远程文件
    fclose(local_file_handle);
    libssh2_sftp_close(sftp_handle);

    // 关闭SFTP会话和SSH连接
    libssh2_sftp_shutdown(sftp_session);
    libssh2_session_disconnect(session, "Goodbye");
    libssh2_session_free(session);

    // 清理libssh2库
    libssh2_exit();
    
    return 0;
}

五、总结

本文全面介绍了使用libssh2库建立安全的SSH连接的过程。通过对文章的阅读，读者可以了解到如何使用libssh2库进行SSH连接的准备工作，以及建立SSH连接的具体步骤。文章还提供了文件传输的示例，帮助读者了解如何使用libssh2库进行文件上传和下载操作。通过本文的指导，C++开发者可以更好地利用libssh2库来实现安全的SSH连接和远程服务器管理。