解决libwebsockets在Android平台编译时遇到的OpenSSL相关问题

问题背景

在Android平台上使用libwebsockets进行交叉编译时，开发者可能会遇到与OpenSSL相关的各种编译错误。这些问题通常出现在配置阶段或实际编译过程中，特别是当使用较新版本的OpenSSL（如1.1.1u）时。

常见错误分析

OpenSSL头文件检测失败

在CMake配置阶段，系统可能会报告无法找到某些OpenSSL头文件或函数，例如：

-- Looking for openssl/ecdh.h
-- Looking for openssl/ecdh.h - not found
-- Looking for SSL_CTX_set1_param
-- Looking for SSL_CTX_set1_param - not found

这些错误实际上可能是由于其他底层问题导致的CMake测试失败，而非OpenSSL确实缺少这些API。

HMAC_CTX结构体问题

编译过程中可能出现如下错误：

lws-genhash.h:85:18: error: field has incomplete type 'HMAC_CTX' (aka 'struct hmac_ctx_st')
        HMAC_CTX ctx;

这是由于OpenSSL 1.1.x版本中HMAC_CTX结构体的定义发生了变化，而CMake未能正确检测到这一变化。

解决方案

正确的CMake配置参数

针对Android平台的交叉编译，推荐使用以下CMake配置参数：

cmake -B $BUILD_DIR \
    -S ../libwebsockets-4.3.5 \
    -DCMAKE_TOOLCHAIN_FILE=../libwebsockets-4.3.5/contrib/cross-aarch64-android.cmake \
    -DANDROID_ABI="$arch" \
    -DLWS_PLAT_ANDROID=ON \
    -DCMAKE_INSTALL_PREFIX="$install_dir" \
    -DLWS_WITH_SSL=ON \
    -DOPENSSL_ROOT_DIR=${OPENSSL_DIR} \
    -DOPENSSL_INCLUDE_DIRS=${OPENSSL_DIR}/include \
    -DOPENSSL_LIBRARYS="${OPENSSL_DIR}/lib/libssl.a;${OPENSSL_DIR}/lib/libcrypto.a" \
    -DLWS_OPENSSL_INCLUDE_DIRS="${OPENSSL_DIR}/include/" \
    -DLWS_OPENSSL_LIBRARIES="${OPENSSL_DIR}/lib/libssl.a;${OPENSSL_DIR}/lib/libcrypto.a" \
    -DLWS_HAVE_HMAC_CTX_new=1 \
    -DLWS_WITH_STATIC=ON \
    -DLWS_WITH_SHARED=OFF \
    -DLWS_WITHOUT_TESTAPPS=ON

关键点说明：

1. 明确指定OpenSSL的根目录、包含目录和库文件路径
2. 设置DLWS_HAVE_HMAC_CTX_new=1以解决HMAC_CTX相关错误
3. 启用静态库编译，禁用测试应用以减少编译复杂度

调试CMake测试失败

当遇到CMake测试失败时，可以检查build/CMakeFiles/CMakeConfigureLog.yaml文件，搜索相关关键字（如HMAC_CTX）以了解实际发生的错误。

信号处理相关错误

在编译过程中可能会遇到如下错误：

/sysroot/usr/include/bits/signal_types.h:78:20: error: expected ';' at end of declaration list
struct sigaction { __SIGACTION_BODY };

这类错误通常是由于系统头文件被意外修改或预处理宏定义冲突导致的。建议检查：

1. 是否在代码中定义了sigaction宏
2. 系统头文件是否完整
3. 编译环境是否配置正确

最佳实践建议

1. 使用匹配的OpenSSL版本：虽然libwebsockets支持多种OpenSSL版本，但建议使用与项目推荐版本匹配的OpenSSL。

2. 完整的工具链配置：确保Android NDK工具链配置完整，特别是系统头文件和库路径设置正确。

3. 逐步调试：遇到编译错误时，先解决第一个报错，因为后续错误可能是由第一个错误引发的。

4. 社区贡献：如果发现是平台特定问题，建议在解决问题后向社区贡献补丁，帮助其他开发者避免同样的问题。

通过以上方法和注意事项，开发者应该能够成功在Android平台上编译使用libwebsockets与OpenSSL的组合。