CMake构建学习条记19-OpenSSL库的构建

1. 概述

OpenSSL是一个开源的加密工具包和库，主要实现了安全套接字层（SSL）和传输层安全（TLS）协议，以及各种加密算法、数字签名、消息摘要、加密证书等功能。这个库可以说是Web开辟尤其是HTTPS通讯的基石了。这里就具体讲解一下如何构建它。
2. 构建过程

2.1 Windows情况

起首要阐明的是OpenSSL目前的版本（我使用的是3.4.0版本）还没有支持使用CMake构建。但是好在作为老牌的开源库，它的构建文档非常详细。先介绍一下Windows情况下的构建，Windows下固然使用MSVC编译器进行构建了，这就要用到MSVC的命令行的工具。我这里使用的是x64 Native Tools Command Prompt for VS 2019，如下图1所示：

除此之外，MSVC的命令nmake好像缺少像linux Make或者CMake的Configure这一步，因此，必要额外安装perl。另外，还必要安装NASM作为汇编器，一般使用这个是为了获得指令集级别的性能优化。安装好这两个程序之后，一般会自动在Path情况变量中增长相应的可实行程序位置。假如没有添加成功，就手动添加一下。当你在CMD终端中分别输入：

1. perl -version
2. nasm -v

复制代码

有相应的版本号出现的时间，就阐明正确安装而且能被体系所识别了，如下所示：

1. C:\Users\Charlee>perl -version
2. Locale 'Chinese (Simplified)_China.936' is unsupported, and may crash the interpreter.
4. This is perl 5, version 38, subversion 2 (v5.38.2) built for MSWin32-x64-multi-thread
6. Copyright 1987-2023, Larry Wall
8. Perl may be copied only under the terms of either the Artistic License or the
9. GNU General Public License, which may be found in the Perl 5 source kit.
11. Complete documentation for Perl, including FAQ lists, should be found on
12. this system using "man perl" or "perldoc perl".  If you have access to the
13. Internet, point your browser at https://www.perl.org/, the Perl Home Page.
15. C:\Users\Charlee>nasm -v
16. NASM version 2.16.01 compiled on Jun  1 2023

复制代码

由于MSVC的命令行工具是基于CMD终端的，也就是使用不了更方便的Powershell终端。这里给出完备的构建bat脚本如下所示，读者必要留意跟自己的情况相适配，并修改相应的设置值：

1. @echo off
2. REM 区域设置
3. set LC_ALL=C
4. set LANG=C
6. REM 配置 Visual Studio 版本
7. SET VS_VERSION=2019
8. SET VS_EDITION=Enterprise
10. REM 配置架构（x64 或 x86）
11. SET TARGET_ARCH=x64
13. REM 设置 OpenSSL 源码目录和目标目录
14. SET OPENSSL_SRC_DIR=../Source/openssl-openssl-3.4.0
15. SET OPENSSL_INSTALL_DIR=%GISBasic%
17. REM 启动 Visual Studio 的开发者命令行环境
18. CALL "C:\Program Files (x86)\Microsoft Visual Studio\%VS_VERSION%\%VS_EDITION%\VC\Auxiliary\Build\vcvarsall.bat" %TARGET_ARCH%
20. IF ERRORLEVEL 1 (
21.     echo Failed to configure Visual Studio environment.
22.     EXIT /B 1
23. )
25. REM 进入 OpenSSL 源码目录
26. CD /D %OPENSSL_SRC_DIR%
28. REM 配置 OpenSSL
29. perl Configure VC-WIN64A --prefix=%OPENSSL_INSTALL_DIR% --release
30. IF ERRORLEVEL 1 (
31.     echo Configuration failed.
32.     EXIT /B 1
33. )
35. REM 构建 OpenSSL
36. nmake
37. IF ERRORLEVEL 1 (
38.     echo Build failed.
39.     EXIT /B 1
40. )
42. REM 测试构建
43. REM nmake test
44. REM IF ERRORLEVEL 1 (
45. REM    echo Tests failed.
46. REM    EXIT /B 1
47. REM )
49. REM 安装到目标目录
50. nmake install
51. IF ERRORLEVEL 1 (
52.     echo Installation failed.
53.     EXIT /B 1
54. )
56. echo Build and installation successful!
57. EXIT /B 0

复制代码

根据笔者的现实测试，OpenSSL提供的构建选项虽然多，但是只有--prefix=%OPENSSL_INSTALL_DIR% --release是生效的，好在release模式也能生成pdb文件，能够满足我的需求了。另外nmake test这一步可以省略，测试构建这一步非常慢。
2.2 Linux情况

在Linux情况下构建OpenSSL就相对简单了，我这里使用的Ubuntu20.4，构建安装到GISBasic情况变量指定的目次中，具体脚本如下：

1. #!/bin/bash
3. BuildDir="./openssl-openssl-3.4.0"
4. InstallDir=$GISBasic
6. # 加载环境变量文件
7. source /etc/environment
9. # 解压缩
10. unzip -q -o "../Source/openssl-openssl-3.4.0.zip" -d "../Source"
12. # 检查构建目录是否存在
13. if [ -d "$BuildDir" ]; then
14.     rm -rf "$BuildDir" # 目录存在，删除它
15. fi
16. # 创建构建目录
17. mkdir -p "$BuildDir"
19. cd "../Source/openssl-openssl-3.4.0"
21. ./Configure --openssldir=$BuildDir --prefix=$InstallDir --release
23. make
25. make install

复制代码

在Openssl的官方文档中提供了非常多的构建设置选项，笔者这里也没有使用太多，后续有必要再进行修改吧。
3. 使用方式

虽然Openssl并没有提供CMake的编译方式，但是构建完成后却提供了OpenSSLConfig.cmake设置文件，能够被CMake正知识别引入。只必要再CMakeList.txt文件中使用如下语句：

1. find_package(OpenSSL REQUIRED)
2. target_link_libraries(${PROJECT_NAME} PRIVATE OpenSSL::SSL)
3. target_link_libraries(${PROJECT_NAME} PRIVATE OpenSSL::Crypto)

复制代码

就可以在我们的主实行程序中使用OpenSSL了。关于这一步读者假如不太明白可以参考一下笔者前面的文章《CMake构建学习条记15-组建第一个程序项目》。
另外，OpenSSL还提供了一个可实行程序，通过这个可实行程序可以创建一个SSL证书。虽然这个创建的证书是自己给自己签发的，不能被浏览器安全认证，但是可以用来做测试https通讯。第一步是创建私钥：

1. openssl genrsa -out server.key 2048

复制代码

这将在当前目次下生成一个名为server.key的2048位RSA私钥。接下来是生成证书签名请求：

1. openssl req -new -key server.key -out server.csr

复制代码

按照提示，输入证书信息。比较关键的是要将Common Name设置程服务器域名或IP地址。假如是本地测试，就填写 localhost。最后就是生成一个有用期为365天的自签名证书server.crt：

1. openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。