Crypto++ CMake

<div align="center">

-+- 构建状态 -+-

[![主分支构建状态][build-status-master-badge]][build-matrix]

-+-

[![最新发布][release-badge]][latest-release] [![提交][last-commit-badge]][commits] [![Linux][linux-badge]][latest-release] [![Windows][windows-badge]][latest-release] [![Mac OS][macos-badge]][latest-release] [![许可证][license-badge]][license]

</div>

简介

本仓库包含了Wei Dai的Crypto++（https://github.com/weidai11/cryptopp）的CMake文件，适用于在现代CMake项目中使用该库的开发者。

请参阅crypto++维护者的这个公告。

这里强调"现代"非常重要。到2022年，我们已经有了一些很好的解决方案来解决开发者过去浪费大量时间的构建问题。特别是CMake，它已经取得了巨大进步，成为C++最广泛使用的构建系统之一。但我们这里讨论的不是CMake 2.x，而是CMake 3.11+，甚至可能是CMake 3.24+。

关于这个主题的更多详情，请参见下文...

目录

• Crypto++ CMake
  • 简介
  • 目录
  • 在您提问之前
  • 版本控制原则
  • 标准用法
  • 使用crypto++的本地副本
  • 请求cryptopp的主分支
  • 其他方式
  • 为什么选择现代CMake？

在您提问之前

• 能否支持旧版本的CMake？你真的不需要3.21...

  不能。

  这是一个有主见的分支，主要目的是始终保持使用最新版本的CMake。我们认为构建系统应该是最新的，不同于编译器和操作系统。如果您想继续使用旧版本，请查看旧仓库。

• 能否修复共享库构建？我真的喜欢DLL...

  我也喜欢，但不行。

  Crypto++没有正确导出符号和管理可见性。您可以向crypto++项目维护者请求这个功能。旧的DLL构建仅用于FIPS版本，具有有限的符号导出。该版本即将结束生命周期，在这里支持它没有意义。

  如果您喜欢DLL，可以按照crypto++维基上的说明制作一个包装器DLL。

  本项目的CMakeLists.txt已经为共享和静态构建做好了准备，但在crypto++准备好之前，共享构建是锁定的。

• 为什么你改变了XXX？它以前是像YYY那样工作的...

  我不知道。

  我在我的项目中使用crypto++，我使用它的方式是通过经验、广泛阅读其他人的经验，以及尽可能遵循现代cmake实践而学习和改进的。我对新方法和建议持开放态度，特别是如果它们通过跟踪的问题、合理的解释和拉取请求提出。如果您有有效的用例，请在问题中记录它，让我们找人帮您实现。这是开源项目 :smiley:

版本控制原则

本项目的发布版本跟踪crypto++的发布版本。换句话说，每当_crypto++_发布新版本时，本项目就会更新以考虑源文件、编译器选项等的变化，并以与_crypto++_相同的版本号发布新版本。

有时，本项目的bug修复会在新的_crypto++_版本发布之前进行。当添加了一定数量的修复，并根据缺陷的严重程度，可能会创建一个额外的发布标签。这些_补丁标签_永远不会对crypto++本身引入任何额外的变更。 主要发布标签的格式为：CRYPTOPP_M_m_p，而补丁标签的格式为CRYPTOPP_M_m_p_f，其中M.m.p代表crypto++的版本，f是每次创建补丁标签时递增的后缀数字。补丁标签将保持与主发布标签相同的crypto++版本。

如往常一样，如果你想获得最新最优的版本，请始终跟踪主分支。

标准用法

• 使用你喜欢的方法获取此项目（克隆为子模块，使用FetchContent获取，使用CPM获取...）

• 在你的主CMakeLists.txt中，添加以下内容：

  add_subdirectory(xxxx)
  # 其中xxx是你放置cryptopp-cmake文件的位置

  就是这样。你将能够链接到cryptopp或作用域别名cryptopp::cryptopp，并让cmake为你处理其他一切。

在test/standard-cpm目录中有一个示例。

使用本地crypto++副本

某些用户可能更喜欢完全断开连接的项目，在这种情况下，crypto++源包和cryptopp-cmake源包都会预先下载并解压到某个位置。

你仍然需要在主CMakeLists.txt中将cryptopp-cmake添加为子目录，并且可以通过CRYPTOPP_SOURCES选项设置使用本地crypto++副本。只需在cmake命令行或CMakeLists.txt中将该选项设置为指向crypto++源目录。剩下的将为你处理。

请求cryptopp的主分支

如果你想测试crypto++的最新版本与cmake，只需在CMakeLists.txt或cmake命令行中设置CRYPTOPP_USE_MASTER_BRANCH选项，并像往常一样将cryptopp-cmake添加为子目录。

其他方式

还有许多其他使用此项目的方式，包括直接选择你需要的文件并将它们添加到你自己的项目中，通过conan获取包等...花些时间阅读源代码，如果你需要新的使用场景，请通过新问题提出建议。

为什么选择现代CMake？

看看在线'Modern CMake'书籍中的安装CMake章节，了解Linux发行版默认安装的CMake版本的最新情况。

更重要的是，在Linux/MacOS/Windows和许多其他操作系统上安装现代版本的CMake非常容易。

查看从3.0版本到现在的CMake发布说明，3.21是一个很好的最低版本要求起点。该版本特别引入了预设和一些不错的生活质量功能，这将使本项目的维护和使用更加简单和愉快。毕竟，没有理由在没有乐趣的情况下做免费的开源工作:smiley: [build-matrix]: https://github.com/abdes/cryptopp-cmake/actions/workflows/cmake-build.yml [build-status-master-badge]: https://github.com/abdes/cryptopp-cmake/actions/workflows/cmake-build.yml/badge.svg?branch=master [commits]: https://github.com/abdes/cryptopp-cmake/commits [last-commit-badge]: https://img.shields.io/github/last-commit/abdes/cryptopp-cmake [latest-release]: https://github.com/abdes/cryptopp-cmake/releases/latest [license-badge]: https://img.shields.io/github/license/abdes/cryptopp-cmake [license]: https://opensource.org/licenses/BSD-3-Clause [linux-badge]: https://img.shields.io/badge/OS-linux-blue [macos-badge]: https://img.shields.io/badge/OS-macOS-blue [release-badge]: https://img.shields.io/github/v/release/abdes/cryptopp-cmake [windows-badge]: https://img.shields.io/badge/OS-windows-blue