|
|
@@ -1,80 +1,81 @@
|
|
|
# mbedTLS
|
|
|
|
|
|
-## 1、介绍
|
|
|
+[中文页](README_ZH.md) | English
|
|
|
|
|
|
-**mbedTLS**（前身 PolarSSL）是一个由 ARM 公司开源和维护的 SSL/TLS 算法库。其使用 C 编程语言以最小的编码占用空间实现了 SSL/TLS 功能及各种加密算法，易于理解、使用、集成和扩展，方便开发人员轻松地在嵌入式产品中使用 SSL/TLS 功能。
|
|
|
+## 1 Introduction
|
|
|
|
|
|
-该 [mbedtls](https://github.com/RT-Thread-packages/mbedtls) 软件包是 **RT-Thread** 基于 [ARMmbed/mbedtls](https://github.com/ARMmbed/mbedtls/) 开源库 [v2.6.0 版本](https://github.com/ARMmbed/mbedtls/tree/72ea31b026e1fc61b01662474aa5125817b968bc)的移植，有关 mbedTLS 的更多信息，请参阅 [软件包详细介绍](docs/introduction.md) 。
|
|
|
+**mbedTLS** (formerly PolarSSL) is an SSL/TLS algorithm library open sourced and maintained by ARM. It uses the C programming language to implement the SSL/TLS function and various encryption algorithms with the smallest code footprint, which is easy to understand, use, integrate and extend, and it is convenient for developers to easily use the SSL/TLS function in embedded products.
|
|
|
|
|
|
-### 1.1 目录结构
|
|
|
+The [mbedtls](https://github.com/RT-Thread-packages/mbedtls) package is **RT-Thread** based on [ARMmbed/mbedtls](https://github.com/ARMmbed/mbedtls/ ) Porting of the open source library [v2.6.0 version](https://github.com/ARMmbed/mbedtls/tree/72ea31b026e1fc61b01662474aa5125817b968bc). For more information about mbedTLS, please refer to [Package Details](docs/introduction.md ).
|
|
|
|
|
|
-| 名称 | 说明 |
|
|
|
-| ---- | ---- |
|
|
|
-| certs | CA 证书存放目录 |
|
|
|
-| docs | 文档目录 |
|
|
|
-| mbedtls | ARM mbedtls 源码 |
|
|
|
-| ports | 移植文件目录 |
|
|
|
-| samples | 示例文件目录 |
|
|
|
-| LICENSE | 许可证文件 |
|
|
|
-| README.md | 软件包使用说明 |
|
|
|
-| SConscript | RT-Thread 默认的构建脚本 |
|
|
|
+### 1.1 Directory structure
|
|
|
|
|
|
-### 1.2 许可证
|
|
|
+| Name | Description |
|
|
|
+| ---- | ---- |
|
|
|
+| certs | CA certificate storage directory |
|
|
|
+| docs | Document directory |
|
|
|
+| mbedtls | ARM mbedtls source code |
|
|
|
+| ports | Migration file directory |
|
|
|
+| samples | Sample file directory |
|
|
|
+| LICENSE | License File |
|
|
|
+| README.md | Package Instructions |
|
|
|
+| SConscript | RT-Thread default build script |
|
|
|
|
|
|
-Apache License Version 2.0 协议许可。
|
|
|
+### 1.2 License
|
|
|
|
|
|
-## 2、获取软件包
|
|
|
+Apache License Version 2.0 agreement license.
|
|
|
|
|
|
-在使用的 BSP 目录下，使用 ENV 工具打开 menuconfig 来获取软件包。
|
|
|
+## 2. Get the software package
|
|
|
|
|
|
-- 配置软件包并使能示例
|
|
|
+Under the BSP directory used, use the ENV tool to open menuconfig to obtain the software package.
|
|
|
+
|
|
|
+- Configure software packages and enable examples
|
|
|
|
|
|
```c
|
|
|
RT-Thread online packages --->
|
|
|
- security packages --->
|
|
|
- Select Root Certificate ---> # 选择证书文件
|
|
|
- [*] mbedtls: An portable and flexible SSL/TLS library --- # 打开 mbedtls 软件包
|
|
|
- [*] Store the AES tables in ROM # 将 AES 表存储在 ROM 中，优化内存占用
|
|
|
- (2) Maximum window size used # 用于点乘的最大“窗口”大小（2-7，该值越小内存占用也越小）
|
|
|
- (3584) Maxium fragment length in bytes # 配置数据帧大小（0x7200 错误可尝试增加该大小）
|
|
|
- [*] Enable a mbedtls client example # 开启 mbedtls 测试例程
|
|
|
- [ ] Enable Debug log output # 开启调试 log 输出
|
|
|
- version (latest) ---> # 选择软件包版本，默认为最新版本
|
|
|
+ security packages --->
|
|
|
+ Select Root Certificate ---> # Select certificate file
|
|
|
+ [*] mbedtls: An portable and flexible SSL/TLS library --- # Open the mbedtls package
|
|
|
+ [*] Store the AES tables in ROM # Store the AES tables in ROM to optimize memory usage
|
|
|
+ (2) Maximum window size used # The maximum "window" size used for dot multiplication (2-7, the smaller the value, the smaller the memory usage)
|
|
|
+ (3584) Maxium fragment length in bytes # Configure the data frame size (0x7200 error can try to increase the size)
|
|
|
+ [*] Enable a mbedtls client example # Open mbedtls test routine
|
|
|
+ [] Enable Debug log output # Enable debug log output
|
|
|
+ version (latest) ---> # Select the package version, the default is the latest version
|
|
|
```
|
|
|
|
|
|
-- 选择证书文件
|
|
|
+- Select certificate file
|
|
|
|
|
|
```c
|
|
|
RT-Thread online packages --->
|
|
|
- security packages --->
|
|
|
- [*] mbedtls: An portable and flexible SSL/TLS library --- # 打开 mbedtls 软件包
|
|
|
- Select Root Certificate ---> # 选择证书文件
|
|
|
- [ ] Using all default CA(Use preset CA certificates. Take up more memory)
|
|
|
- [ ] Using user CA(copy your Root CA file to mbedtls package "certs" directory)
|
|
|
- [*] Using Digital Signature Trust Root CA # 测试例程需要使用的证书
|
|
|
+ security packages --->
|
|
|
+ [*] mbedtls: An portable and flexible SSL/TLS library --- # Open the mbedtls package
|
|
|
+ Select Root Certificate ---> # Select certificate file
|
|
|
+ [] Using all default CA(Use preset CA certificates. Take up more memory)
|
|
|
+ [] Using user CA(copy your Root CA file to mbedtls package "certs" directory)
|
|
|
+ [*] Using Digital Signature Trust Root CA # The certificate used by the test routine
|
|
|
```
|
|
|
|
|
|
- - `Using all default CA` 配置选项会将 `certs/default` 目录下的所有预置证书加入编译，将占用很大的内存
|
|
|
- - `Using user CA` 配置选项允许用户将自己需要的证书文件加入编译，需要用户将证书文件拷贝到 `certs` 根目录
|
|
|
- - 更多使用说明请参阅 [软件包详细介绍](docs/introduction.md)
|
|
|
-
|
|
|
-- 使用 `pkgs --update` 命令下载软件包
|
|
|
+- The `Using all default CA` configuration option will add all the preset certificates in the `certs/default` directory to the compilation, which will take up a lot of memory
|
|
|
+- The `Using user CA` configuration option allows users to add the certificate files they need to the compilation, requiring the user to copy the certificate files to the root directory of `certs`
|
|
|
+- For more instructions, please refer to [Detailed Description of Package](docs/introduction.md)
|
|
|
+- Use the `pkgs --update` command to download the package
|
|
|
|
|
|
-## 3、使用 mbedtls
|
|
|
+## 3. Use mbedtls
|
|
|
|
|
|
-- 如何从零开始使用，请参考 [用户手册](docs/user-guide.md)
|
|
|
-- 完整的 API 文档，请参考 [API 手册](docs/api.md)
|
|
|
-- 详细的示例介绍，请参考 [示例文档](docs/samples.md)
|
|
|
-- mbedtls 协议工作原理，请参考 [工作原理](docs/principle.md)
|
|
|
-- mbedtls RAM 和 ROM 优化，请阅读 [资源占用优化指南](docs/footprint-optimization-guide.md)
|
|
|
-- 更多**详细介绍文档**位于 [`/docs`](/docs) 文件夹下，**使用软件包进行开发前请务必查看**
|
|
|
+- How to use from scratch, please refer to [User Manual](docs/user-guide.md)
|
|
|
+- For complete API documentation, please refer to [API Manual](docs/api.md)
|
|
|
+- For detailed sample introduction, please refer to [Sample Document](docs/samples.md)
|
|
|
+- For the working principle of mbedtls protocol, please refer to [Working Principle](docs/principle.md)
|
|
|
+- mbedtls RAM and ROM optimization, please read [Resource Occupation Optimization Guide](docs/footprint-optimization-guide.md)
|
|
|
+- More **Detailed introduction documents** are located in the [`/docs`](/docs) folder, **Please check before using the package for development**
|
|
|
|
|
|
-## 4、参考资料
|
|
|
+## 4. Reference materials
|
|
|
|
|
|
-- mbedTLS官方网站：https://tls.mbed.org/
|
|
|
-- ARMmbed GitHub：[mbedtls](https://github.com/ARMmbed/mbedtls/tree/72ea31b026e1fc61b01662474aa5125817b968bc)
|
|
|
+- mbedTLS official website: https://tls.mbed.org/
|
|
|
+- ARMmbed GitHub: [mbedtls](https://github.com/ARMmbed/mbedtls/tree/72ea31b026e1fc61b01662474aa5125817b968bc)
|
|
|
|
|
|
-## 5、 联系方式 & 感谢
|
|
|
+## 5. Contact & Thanks
|
|
|
|
|
|
-- 维护： RT-Thread 开发团队
|
|
|
-- 主页： https://github.com/RT-Thread-packages/mbedtls
|
|
|
+- Maintenance: RT-Thread development team
|
|
|
+- Homepage: https://github.com/RT-Thread-packages/mbedtls
|
yangjie11