openHiTLS快速入门

Welcome to the openHiTLS Tutorial!

欢迎学习 openHiTLS 教程！

This tutorial will guide you through installing, integrating, and using openHiTLS.
此教程将会指导您如何安装、集成和使用 openHiTLS。

What Is openHiTLS?

什么是 openHiTLS？

openHiTLS is a C/C++ library for building cryptographic security capabilities.
openHiTLS 是一款构建密码学安全能力的 C/C++ 库。

It provides cryptographic algorithms and TLS protocol stacks that comply with public standards.
它提供符合公开标准的密码学算法和 TLS 协议栈。

Installing openHiTLS

安装 openHiTLS

1. Download related codes.
   下载相关代码

   • openHiTLS download address: GitCode - 全球开发者的开源社区,开源代码托管平台
     openHiTLS 下载地址：GitCode - 全球开发者的开源社区,开源代码托管平台
   • libboundscheck download address: libboundscheck: Enhanced safety functions
     libboundscheck 下载地址：libboundscheck: Enhanced safety functions

   Note: Download libboundscheck to the openHiTLS/platform/Secure_C directory.
   说明： 需要将 libboundscheck 下载至 openHiTLS/platform/Secure_C 目录。

2. Build and install openHiTLS.
   构建并安装 openHiTLS

Run the following commands in the openHiTLS root directory:
在 openHiTLS 根路径下执行以下命令：

mkdir build
cd build
cmake ..
make && make install

Integrating openHiTLS in Your C/C++ Project

在您的 C/C++ 项目中集成 openHiTLS

1. Call the APIs provided by openHiTLS in your project code.
   按照 openHiTLS 的 API 手册，在您的项目代码中调用其提供的接口。

2. Add openHiTLS header files and library paths to your project dependencies.
   将 openHiTLS 的头文件和库路径加入到您的项目依赖中。

The following uses the gcc compiler as an example:
以下以 gcc 编译器为例：

# Use -I to specify the path of the header file and -L to specify the path of the dynamic library.  
# 使用 -I 指定 openHiTLS 头文件路径，使用 -L 指定动态库路径。  
gcc application.c -lhitls_crypto -lhitls_tls -lhitls_bsl -lboundscheck -I <openHiTLS 头文件路径> -L <openHiTLS 动态库路径>

Getting Started with openHiTLS

开始使用 openHiTLS

After the preceding steps, you can start leveraging the security capabilities provided by openHiTLS.
完成上述操作后，您可以开始使用 openHiTLS 提供的安全能力。