diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 68983bc1262b5202c336fbf68fd6e91498c6e93a..0000000000000000000000000000000000000000 --- a/README.en.md +++ /dev/null @@ -1,36 +0,0 @@ -# useriam_userauth - -#### Description -{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**} - -#### Software Architecture -Software architecture description - -#### Installation - -1. xxxx -2. xxxx -3. xxxx - -#### Instructions - -1. xxxx -2. xxxx -3. xxxx - -#### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - - -#### Gitee Feature - -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README.md b/README.md index b2e23592afae84ce91a65cfed721d7edd6ee1390..68983bc1262b5202c336fbf68fd6e91498c6e93a 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,36 @@ # useriam_userauth -#### 介绍 -{**以下是 Gitee 平台说明，您可以替换此简介** -Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台 -无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)} +#### Description +{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**} -#### 软件架构 -软件架构说明 +#### Software Architecture +Software architecture description - -#### 安装教程 +#### Installation 1. xxxx 2. xxxx 3. xxxx -#### 使用说明 +#### Instructions 1. xxxx 2. xxxx 3. xxxx -#### 参与贡献 +#### Contribution -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +1. Fork the repository +2. Create Feat_xxx branch +3. Commit your code +4. Create Pull Request -#### 特技 +#### Gitee Feature -1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md +2. Gitee blog [blog.gitee.com](https://blog.gitee.com) +3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) +4. The most valuable open source project [GVP](https://gitee.com/gvp) +5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) +6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README_ZH.md b/README_ZH.md new file mode 100644 index 0000000000000000000000000000000000000000..57d827455ccaa43a0f36eda39ad407a98531bee0 --- /dev/null +++ b/README_ZH.md @@ -0,0 +1,97 @@ +# useriam_userauth + +- [简介](#简介) +- [目录](#目录) +- [编译构建](#编译构建) + - [准备](#准备) + - [获取源码](#获取源码) + - [编译构建](#编译构建) + +- [说明](#说明) + - [接口说明](#接口说明) + - [使用说明](#使用说明) +- [相关仓](#相关仓) + + +## 简介 + +**统一用户认证（userauth）**是用户IAM子系统的基础部件之一，对外提供统一用户身份认证功能，并且开放生物特征认证API给三方应用调用。 + +**图1** 统一用户认证架构图 + +口令认证架构图 + + + +用户认证接口支持针对目标用户完成达到目标认证结果可信等级（ATL）的用户身份认证。其中目标ATL由业务指定，目标用户id可以由业务指定（系统服务或系统基础应用），也可以从系统上下文获取（三方应用）。 + +## 目录 + +```undefined +//base/user_iam/user_auth +├── ohos.build # 组件描述文件 +├── userauth.gni # 构建配置 +├── frameworks # 框架代码 +├── interfaces # 对外接口存放目录 +│ ├── innerkits # 对内部子系统暴露的头文件，供系统服务使用 +│ └── kits # 对三方应用暴露的头文件 +├── sa_profile # Service Ability 配置文件 +├── services # Service Ability 服务实现 +├── test # 测试代码存放目录 +└── utils # 测试代码存放目录 +``` + +## 编译构建 + + +### 准备 + +开发者需要在Linux上搭建编译环境： + +- [Ubuntu编译环境准备](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/quick-start/quickstart-lite-env-setup-linux.md) +- Hi3518EV300单板：参考[环境搭建](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/quick-start/quickstart-lite-steps-hi3518-setting.md) +- Hi3516DV300单板：参考[环境搭建](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/quick-start/quickstart-lite-steps-hi3516-setting.md) + +### 获取源码 + +在Linux服务器上下载并解压一套源代码，源码获取方式参考[源码获取](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/get-code/sourcecode-acquire.md)。 + +### 编译构建 + +开发者开发第一个应用程序可参考： + +- [helloworld for Hi3518EV300](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/quick-start/quickstart-lite-steps-hi3518-running.md) + +- [helloworld for Hi3516DV300](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/quick-start/quickstart-lite-steps-hi3516-running.md) + + +## 说明 + +### 接口说明 + +**表1** API + +| 接口名 | 描述 | +| ------ | -------------------------------- | +| getAvailabeStatus(authType : AuthType, authTrustLevel : AuthTurstLevel) : number; | 指定ATL，查询是否支持目标认证方式 | +| auth(challenge: BigInt, authType : AuthType, authTrustLevel: AuthTurstLevel, callback: IUserAuthCallback): BigInt; | 指定ATL和认证方式，完成用户身份认证 | + +### 使用说明 + +厂商在对接统一用户认证框架时，需要在可信执行环境中实现以下两个功能点： + +1. 认证方案生成：根据目标用户录入的认证凭据和目标认证安全等级，决策用户身份认证方案； +2. 认证结果评估：根据执行器返回的身份认证结果，评估是否达到目标认证安全等级。 + +## 相关仓 + +[useriam_coauth](https://gitee.com/openharmony-sig/useriam_coauth) + +[useriam_useridm](https://gitee.com/openharmony-sig/useriam_useridm) + +**[useriam_userauth](https://gitee.com/openharmony-sig/useriam_userauth)** + +[useriam_pinauth](https://gitee.com/openharmony-sig/useriam_pinauth) + +[useriam_faceauth](https://gitee.com/openharmony/useriam_faceauth) + diff --git "a/figures/\347\273\237\344\270\200\347\224\250\346\210\267\350\256\244\350\257\201\346\236\266\346\236\204\345\233\276.png" "b/figures/\347\273\237\344\270\200\347\224\250\346\210\267\350\256\244\350\257\201\346\236\266\346\236\204\345\233\276.png" new file mode 100644 index 0000000000000000000000000000000000000000..69107ae83c30a16dea0c6b2c364a28f4ced70137 Binary files /dev/null and "b/figures/\347\273\237\344\270\200\347\224\250\346\210\267\350\256\244\350\257\201\346\236\266\346\236\204\345\233\276.png" differ