!7 modify README_zh.md and add README.md

Merge pull request !7 from YayaWang/noEmployeeNum_ChangeID_13345673_wanghaixiang
This commit is contained in:
openharmony_ci 2021-03-22 14:43:45 +08:00 committed by Gitee
commit 23e853131c
2 changed files with 64 additions and 9 deletions

36
README.md Executable file
View File

@ -0,0 +1,36 @@
# HUKS<a name="EN-US_TOPIC_0000001133264329"></a>
- [Introduction](#section19960105154710)
- [Directory Structure](#section11146193674920)
- [Repositories Involved](#section1554141575016)
## Introduction<a name="section19960105154710"></a>
HUKS is a universal key management service. It provides KeyStore and Crypto APIs for applications to perform key management, encryption, and decryption operations.
HUKS consists of native APIs, the hardware abstraction layer \(HAL\), and Core Module.
1. Native APIs are implemented using the C language to ensure consistency among all devices, and include the APIs for key generation, encryption, and decryption.
2. HAL shields differences between hardware and OSs and defines the unified APIs for HUKS. It contains platform algorithm libraries, file systems, and logs.
3. Core Module depends on the HAL and provides core functions such as encryption and decryption, signature verification, and key storage.
## Directory Structure<a name="section11146193674920"></a>
```
base/security
├── huks
│ ├── frameworks
│ │ └── huks_lite HUKS code implementation
│ └── interfaces
│ └── innerkits
│ └── huks_lite HUKS APIs
```
## Repositories Involved<a name="section1554141575016"></a>
[Security subsystem](https://gitee.com/openharmony/docs/blob/master/en/readme/security-subsystem.md)
**security\_huks**
[security\_deviceauth](https://gitee.com/openharmony/security_deviceauth/blob/master/README.md)

View File

@ -1,17 +1,36 @@
# HUKS<a name="ZH-CN_TOPIC_0000001121676906"></a>
# HUKS组件<a name="ZH-CN_TOPIC_0000001133264329"></a>
- [简介](#section19960105154710)
- [目录](#section11146193674920)
- [相关仓](#section1554141575016)
## 简介<a name="section19960105154710"></a>
## 1. 简介
在分布式场景下不同终端设备的硬件能力和运行系统环境都不尽相同。这些设备在分布式场景下均需要建立信任关系最典型的应用即是HiChain可信互联那么就需要这样一个统一的密钥管理服务来做到接口一致密钥数据格式一致同时提供业界标准的加解密算法实现。HUKS基于此来提供统一的密钥管理、加解密等能力。
HUKS是通用密钥管理服务向应用提供KeyStore及Crypto接口API包括密钥管理及加解密等功能。
HUKS模块整体分为北向接口南向适配层以及核心的功能模块
1. HUKS 北向接口提供统一的对外API用C语言实现保持所有设备一致主要包括密钥生成API、加解密API等
2. HUKS Core Module依赖HAL层提供核心功能如加解密、签名验签、密钥存储等;
3. HUKS HAL层屏蔽底层硬件和OS的差异定义HUKS需要的统一底层API主要包括平台算法库、IO和LOG等。
1. HUKS 北向接口提供统一的对外API用C语言实现保持所有设备一致主要包括密钥生成API、加解密API等
2. HUKS HAL层屏蔽底层硬件和OS的差异定义HUKS需要的统一底层API主要包括平台算法库、IO和LOG等;
3. HUKS Core Module依赖HAL层提供核心功能如加解密、签名验签、密钥存储等。
## 2. 约束
## 目录<a name="section11146193674920"></a>
```
base/security
├── huks
│ ├── frameworks
│ │ └── huks_lite HUKS代码实现
│ └── interfaces
│ └── innerkits
│ └── huks_lite HUKS提供接口
```
## 相关仓<a name="section1554141575016"></a>
[安全子系统](https://gitee.com/openharmony/docs/blob/master/zh-cn/readme/%E5%AE%89%E5%85%A8%E5%AD%90%E7%B3%BB%E7%BB%9F.md)
**security\_huks**
[security\_deviceauth](https://gitee.com/openharmony/security_deviceauth/blob/master/README_zh.md)
当前版本提供的源码及接口API为试验版本后续版本可能存在较大变更其它组件及应用应尽量避免使用该模块接口及功能以免对业务造成影响。