diff --git a/README-CN.md b/README-CN.md new file mode 100644 index 0000000000000000000000000000000000000000..d419ba867d4b11f3e7b0e3c69301500f87e7cfcd --- /dev/null +++ b/README-CN.md @@ -0,0 +1,235 @@ +欢迎使用 OpenSSL 项目 +===================== + +[![openssl logo]][www.openssl.org] + +[![github actions ci badge]][github actions ci] +[![appveyor badge]][appveyor jobs] + +OpenSSL 是一个强大的、商业级的、功能齐全的开源工具包，适用于 TLS（以前称为 SSL）、DTLS 和 QUIC（目前仅限客户端）协议。 + +协议实现基于一个完整的通用加密库，该库也可以独立使用。还包括一个经过验证符合 FIPS 标准的加密模块。 + +OpenSSL 是 Eric A. Young 和 Tim J. Hudson 开发的 SSLeay 库的后代。 + +OpenSSL项目的官方主页是 [www.openssl.org]。 + +目录 +==== + + - [概述](#概述) + - [下载](#下载) + - [构建和安装](#构建和安装) + - [文档](#文档) + - [许可证](#许可证) + - [支持](#支持) + - [贡献] (#贡献) + - [合法性](#合法性) + +概述 +==== + +OpenSSL 工具包包括： + +- **libssl** +是所有 TLS 协议版本的实现，最高可达 TLSv1.3 （ RFC 8446）、最高 DTLSv1.2 （ RFC 6347） 和 QUIC （目前仅限客户端） 版本 1 协议 （ RFC 9000）。 + +- **libcrypto** +一个功能齐全的通用加密库。它构成了 TLS 实现的基础，但也可以独立使用。 + +- **openssl** +OpenSSL 命令行工具，用于加密任务、测试和分析的瑞士军刀。它可用于 +- 创建关键参数 +- 创建 X.509 证书、CSR 和 CRL +- 消息摘要的计算 +- 加密和解密 +- SSL/TLS/DTLS 以及客户端和服务器测试 +- 客户端测试 +- 处理 S/MIME 签名或加密邮件 +- 以及更多... + +下载 +==== + +用于生产用途 +------------ + +官方版本的源代码压缩包可以从[www.openssl.org/source](https://www.openssl.org/source)下载。OpenSSL 项目不会以二进制形式分发工具包。 + +但是，对于各种操作系统，可以使用OpenSSL工具包的预编译版本。特别是在 Linux 和其他 Unix 操作系统上，通常建议链接到分发服务器或供应商提供的预编译共享库。 + +我们还在 wiki 的二进制文件页面上维护了为各种操作系统（包括 Windows）生成 OpenSSL 二进制文件的第三方列表。 + +用于测试和开发 +-------------- + +虽然理论上也可以使用源码压缩包来完成测试和开发，但拥有包含整个项目历史记录的 git 存储库的本地副本可以让您更深入地了解代码库。 + +官方的 OpenSSL Git 存储库位于 [git.openssl.org]。[github.com/openssl/openssl] 处有一个存储库的 GitHub 镜像，该镜像会在每次提交时从前者自动更新。 + +Git 存储库的本地副本可以通过从原始 OpenSSL 存储库克隆来获取，使用 + + git clone git://git.openssl.org/openssl.git + +或从 GitHub 镜像使用 + + git clone https://github.com/openssl/openssl.git + +如果您打算为 OpenSSL 做出贡献，无论是修复错误还是贡献新功能，您需要在 GitHub 上分叉 OpenSSL 存储库 openssl/openssl 并克隆您的公共分叉。 + + git clone https://github.com/yourname/openssl.git + +这是必要的，因为现在OpenSSL的所有开发都是通过GitHub拉取请求完成的。有关更多详细信息，请参阅参与。 + +构建和安装 +========== + +获取源代码后，请查看 INSTALL 文件，了解有关构建和安装 OpenSSL 的详细说明。对于某些平台，安装说明由特定于平台的文档进行修改。 + + + * [类 UNIX 平台的注意事项](NOTES-UNIX.md) + * [适用于 Android 平台的注意事项](NOTES-ANDROID.md) + * [Windows 平台注意事项](NOTES-WINDOWS.md) + * [带有 DJGPP 的 DOS 平台的注意事项](NOTES-DJGPP.md) + * [OpenVMS 平台注意事项](NOTES-VMS.md) + * [注意事项](NOTES-PERL.md) + * [关于Valgrind的注意事项](NOTES-VALGRIND.md) + +有关从先前版本升级到 OpenSSL 3.x 的具体说明，请参见 ossl-guide-migration（7ossl） 手册页。 + +文档 +==== + +文件 +---- + +源代码分发的顶层有一些 README.md 文件，其中包含有关特定主题的其他信息。 + + + * [有关 OpenSSL QUIC 协议实现的信息](README-QUIC.md) + * [有关 OpenSSL 提供程序体系结构的信息](README-PROVIDERS.md) + * [有关使用 OpenSSL FIPS 验证模块的信息](README-FIPS.md) + * [有关旧版 OpenSSL 引擎架构的信息](README-ENGINES.md) + +指南 +---- + +《OpenSSL 指南》中有一些关于一些重要 OpenSSL 主题的教程和介绍性页面。 + +手册页 +------ + +master 分支和所有当前稳定版本的手册页可在线获得。 + +- [OpenSSL master](https://www.openssl.org/docs/manmaster) +- [OpenSSL 3.0](https://www.openssl.org/docs/man3.0) +- [OpenSSL 3.1](https://www.openssl.org/docs/man3.1) + +演示 +---- + +demos 子文件夹中有许多用于使用各种 OpenSSL 功能的源代码演示。 + +维基 +---- + +wiki.openssl.org 上有一个 Wiki，目前不是很活跃。它包含许多有用的信息，但并非所有信息都是最新的。 + +许可证 +====== + +OpenSSL根据Apache License 2.0 获得许可，这意味着只要您满足其条件，您就可以自由地将其用于商业和非商业目的。 + +有关详细信息，请参阅 LICENSE.txt 文件。 + +支持 +==== + +有多种联系方式。正确的频道取决于您的要求。有关详细信息，请参阅 SUPPORT 文件。 + +贡献 +==== + +如果您有兴趣并愿意为 OpenSSL 项目做出贡献，请查看 CONTRIBUTING 文件。 + +合法性 +====== + +许多国家限制使用或出口密码学。如果您可能受到此类限制，您应该在尝试开发或分发加密代码之前寻求法律建议。 + +版权 +==== + +版权所有 （c） 1998-2023 OpenSSL 项目作者 + +版权所有 （c） 1995-1998 Eric A. Young， Tim J. Hudson + +保留所有权利。 + + + + + +[www.openssl.org]: + + "OpenSSL Homepage" + +[git.openssl.org]: + + "OpenSSL Git Repository" + +[git.openssl.org]: + + "OpenSSL Git Repository" + +[github.com/openssl/openssl]: + + "OpenSSL GitHub Mirror" + +[wiki.openssl.org]: + + "OpenSSL Wiki" + +[ossl-guide-migration(7ossl)]: + + "OpenSSL Migration Guide" + +[RFC 8446]: + + +[RFC 6347]: + + +[RFC 9000]: + + +[Binaries]: + + "List of third party OpenSSL binaries" + +[OpenSSL Guide]: + + "An introduction to OpenSSL" + + + +[openssl logo]: + doc/images/openssl.svg + "OpenSSL Logo" + +[github actions ci badge]: + + "GitHub Actions CI Status" + +[github actions ci]: + + "GitHub Actions CI" + +[appveyor badge]: + + "AppVeyor Build Status" + +[appveyor jobs]: + + "AppVeyor Jobs" +