Name |
Date |
Size |
#Lines |
LOC |
||
|---|---|---|---|---|---|---|
| .. | - | - | ||||
| common/ | 12-May-2024 | - | 749 | 468 | ||
| figures/ | 12-May-2024 | - | ||||
| frameworks/ | 12-May-2024 | - | 17,155 | 13,120 | ||
| interfaces/inner_api/ | 12-May-2024 | - | 1,901 | 548 | ||
| param/ | 12-May-2024 | - | 69 | 59 | ||
| sa_profile/ | 12-May-2024 | - | 93 | 86 | ||
| services/ | 12-May-2024 | - | 10,738 | 8,102 | ||
| test/ | 12-May-2024 | - | 28,420 | 21,870 | ||
| .gitignore | D | 12-May-2024 | 336 | 43 | 33 | |
| CODEOWNERS | D | 12-May-2024 | 2.4 KiB | 30 | 28 | |
| LICENSE | D | 12-May-2024 | 9.9 KiB | 177 | 150 | |
| OAT.xml | D | 12-May-2024 | 981 | 25 | 10 | |
| README.md | D | 12-May-2024 | 2.8 KiB | 66 | 37 | |
| README_ZH.md | D | 12-May-2024 | 7.7 KiB | 131 | 94 | |
| bundle.json | D | 12-May-2024 | 3.5 KiB | 113 | 113 | |
| hisysevent.yaml | D | 12-May-2024 | 2.5 KiB | 58 | 39 |
README.md
1# Unified User Authentication (userauth) 2 3 4 5## Introduction 6 7As a basic component of the User Identity & Access Management (IAM) subsystem, Unified User Authentication (userauth) implements unified user authentication and provides biometric feature authentication APIs to third-party applications. 8 9**Figure 1** userauth architecture 10 11<img src="figures/userauth_architecture.png" alt="userauth_architecture" style="zoom:80%;" /> 12 13 14 15The userauth APIs support user authentication of the target Authentication Trust Level (ATL). The target ATL is specified by the service. The target user ID can be specified by the service (system service or basic system application) or obtained from the system context (third-party application). 16 17## Directory Structure 18 19```undefined 20//base/useriam/user_auth_framework 21├── frameworks # Framework code 22├── interfaces # Directory for storing external interfaces 23│ └── innerkits # Header files exposed to the internal subsystems 24├── sa_profile # Profile of the Service ability 25├── services # Implementation of the Service ability 26├── test # Directory for storing test code 27├── utils # Directory for storing utility code 28├── bundle.json # Component description file 29└── userauth.gni # Build configuration 30``` 31 32 33## Usage 34 35### Available APIs 36 37**Table 1** APIs for unified user authentication 38 39| API | Description | 40| ------ | -------------------------------- | 41| getAvailableStatus(authType : AuthType, authTrustLevel : AuthTrustLevel) : number; | Obtains the available authentication status.| 42| auth(challenge: BigInt, authType : AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): BigInt; | Performs user authentication. | 43 44### Usage Guidelines 45 46- Vendors must implement the following in a Trusted Execution Environment (TEE): 47 481. Authentication scheme: Determine the user authentication scheme based on the user credentials entered and the target ATL. 492. Authentication result evaluation: Evaluate whether the authentication reaches the target ATL based on the authentication result returned by the executor. 50 51- The APIs defined in the header file ```user_auth/v1_0/IUserAuthInterface.idl``` in the [drivers_interface](https://gitee.com/openharmony/drivers_interface) repository must be implemented in a TEE, and the security of user authentication scheme and result evaluation must be ensured. 52 53 54 55## Repositories Involved 56 57**[useriam_user_auth_framework](https://gitee.com/openharmony/useriam_user_auth_framework)** 58 59[useriam_pin_auth](https://gitee.com/openharmony/useriam_pin_auth) 60 61[useriam_face_auth](https://gitee.com/openharmony/useriam_face_auth) 62 63[drivers_peripheral](https://gitee.com/openharmony/drivers_peripheral) 64 65[drivers_interface](https://gitee.com/openharmony/drivers_interface) 66
README_ZH.md
1# 统一用户认证 2 3- [简介](#简介) 4- [目录](#目录) 5- [说明](#说明) 6 - [接口说明](#接口说明) 7 - [使用说明](#使用说明) 8- [相关仓](#相关仓) 9 10 11## 简介 12 13**统一用户认证框架**（user_auth_framework）主要包括三个模块，用户认证、凭据管理和执行器管理。 14 15**用户认证模块**对外提供统一用户身份认证功能，并且开放生物特征认证API给三方应用调用。 16 17**凭据管理模块**提供系统内统一的用户凭据管理（增删改查）接口，向下通过执行器管理模块，调用系统内的执行器资源，完成用户凭据的生命周期管理和安全存储。 18 19**执行器管理模块**提供系统内执行器资源的统一管理和协同调度能力，当前支持口令执行器和人脸执行器的管理。 20 21**图1** 统一用户认证架构图 22<img src="figures/统一用户认证架构图.png" alt="统一用户认证架构图" style="zoom:65%;" /> 23 24## 目录 25 26```undefined 27//base/useriam/user_auth_framework 28├── common # 子系统公共库代码目录 29├── frameworks # 接口层实现代码目录 30│ └── js # js API接口实现代码 31│ └── napi # napi实现代码 32│ └── native # C++代码实现 33├── interfaces # 对外接口存放目录 34│ └── inner_api # 对内部子系统暴露的头文件，供系统服务使用 35│ └── kits # OpenHarmony提供给第三方应用的接口文件 36├── sa_profile # Service Ability 配置文件 37├── services # Service Ability 服务实现 38├── test # 测试代码存放目录 39├── bundle.json # 组件描述文件 40``` 41 42 43## 说明 44 45### **用户认证框架inner_api接口说明** 46 47**表1** 执行器管理相关接口 48 49| 接口名 | 描述 | 50| ------ | -------------------------------- | 51| Register(info : ExecutorInfo, callback : ExecutorRegisterCallback): void; | 执行器注册 | 52| Unregister(info : ExecutorInfo): void; | 执行器反注册 | 53 54**表2** 执行器需要实现的回调接口 55 56| 接口名 | 描述 | 57| ------ | -------------------------------- | 58| OnMessengerReady(messenger : ExecutorMessenger, frameworkPublicKey : vector<uint8_t>, templateIds : vector<uint64_t>) void; | 通知执行器信使可用，传入信使（用于后续与执行器通信） | 59| OnBeginExecute(scheduleId : uint64_t, publicKey : vector<uint8_t>, commandAttrs : Attributes) int32_t; | 通知执行器开始执行认证相关操作，commandAttrs中传入本次操作的属性 | 60| OnEndExecute(scheduleId : uint64_t, commandAttrs : Attributes) int32_t; | 通知执行器结束本次操作 | 61| OnSetProperty(properties : Attributes) int32_t; | 设置属性信息 | 62| OnGetProperty(conditions : Attributes, results : Attributes) int32_t; | 获取属性信息 | 63 64**表3** 信使函数相关接口 65 66| 接口名 | 描述 | 67| ------ | -------------------------------- | 68| SendData(scheduleId : uint64_t, transNum : uint64_t, srcType : ExecutorRole, dstType : ExecutorRole, msg : AuthMessage) int32_t; | 发送消息，消息源为执行器，目的端为认证执行器管理，消息内容由执行器指定，比如返回人脸认证过程中的提示信息（光线过暗） | 69| Finish(scheduleId : uint64_t, srcType : ExecutorRole, resultCode : int32_t, finalResult : Attributes) int32_t; | 操作结束，消息源为执行器，目的端为认证执行器管理，消息内容为本次操作的最终结果 | 70 71**表4** 凭据管理相关接口 72 73| 接口名 | 描述 | 74| ------ | -------------------------------- | 75| OpenSession(userId : int32_t): vector<uint8_t>; | 打开会话 | 76| CloseSession(userId : int32_t): void; | 关闭会话 | 77| AddCredential(userId : int32_t, para : CredentialParameters, callback : UserIdmClientCallback): void; | 录入凭据 | 78| UpdateCredential(userId : int32_t, para : CredentialParameters, callback : UserIdmClientCallback): void; | 修改凭据 | 79| Cancel(userId : int32_t): int32_t; | 取消凭据录入 | 80| DeleteCredential(userId : int32_t, credentialId : uint64_t, authToken : vector<uint8_t>, callback : UserIdmClientCallback): void; | 凭据删除 | 81| DeleteUser(userId : int32_t, authToken : vector<uint8_t>, callback : UserIdmClientCallback): void; | 删除口令，当系统内删除用户口令时，同时删除该用户的全部认证凭据 | 82| EraseUser(userId : int32_t, callback : UserIdmClientCallback): int32_t; | 用于管理员强制删除用户，同时删除该用户的全部认证凭据 | 83| GetCredentialInfo(userId : int32_t, authType : AuthType, callback : GetCredentialInfoCallback): int32_t; | 获取凭据信息 | 84| GetSecUserInfo(userId : int32_t, callback : GetSecUserInfoCallback): int32_t; | 获取用户信息 | 85 86**表5** 用户认证相关接口 87 88| 接口名 | 描述 | 89| ------ | -------------------------------- | 90| GetProperty(userId : int32_t, request : GetPropertyRequest, callback : GetPropCallback) : void; | 获取属性 | 91| SetProperty(userId : int32_t, request : SetPropertyRequest, callback : SetPropCallback) : void; | 设置属性 | 92| BeginAuthentication(userId : int32_t, challenge : vector<uint8_t>, authType : AuthType, atl : AuthTrustLevel, callback : AuthenticationCallback): uint64_t; | 指定ATL和认证方式，完成用户身份认证 | 93| CancelAuthentication(contextId : uint64_t): int32_t; | 取消认证 | 94| BeginIdentification(challenge : vector<uint8_t>, authType : AuthType, callback : IdentificationCallback): uint64_t; | 指定认证类型，完成用户身份识别 | 95| CancelIdentification(contextId : uint64_t): int32_t; | 取消识别 | 96 97### **用户认证框架js接口说明** 98 99**表6** 用户认证模块js接口 100 101| 接口名 | 描述 | 102| ------ | -------------------------------- | 103| getVersion() : number; | 获取版本信息 | 104| getAvailableStatus(authType : AuthType, authTrustLevel : AuthTrustLevel) : number; | 检查当前的认证等级是否支持 | 105| getProperty(request : GetPropertyRequest, callback : AsyncCallback<ExecutorProperty>): void; | 获取属性 | 106| setProperty(request : SetPropertyRequest, callback : AsyncCallback<number>): void; | 设置属性 | 107| auth(challenge : Uint8Array, authType : AuthType, authTrustLevel : AuthTrustLevel, callback : IUserAuthCallback): Uint8Array; | 用户认证 | 108| authUser(userId : number, challenge : Uint8Array, authType : AuthType, authTrustLevel : AuthTrustLevel, callback : IUserAuthCallback): Uint8Array; | 用户认证 | 109| cancelAuth(contextID : Uint8Array) : number; | 取消认证 | 110 111### 使用说明 112 113- 厂商在对接统一用户认证框架时，需要在可信执行环境中实现以下两个功能点： 114 1151. 认证方案生成：根据目标用户录入的认证凭据和目标认证安全等级，决策用户身份认证方案。 1162. 认证结果评估：根据执行器返回的身份认证结果，评估是否达到目标认证安全等级。 117 118- 需在可信执行环境内参考[[drivers_peripheral](https://gitee.com/openharmony/drivers_interface)]仓```user_auth```目录，实现[[drivers_interface](https://gitee.com/openharmony/drivers_interface)]仓内文件```user_auth/v1_0/IUserAuthInterface.idl``` 中定义的接口，保证用户身份认证方案决策和结果评估过程的安全性。 119 120## 相关仓 121 122**[useriam_user_auth_framework](https://gitee.com/openharmony/useriam_user_auth_framework)** 123 124[useriam_pin_auth](https://gitee.com/openharmony/useriam_pin_auth) 125 126[useriam_face_auth](https://gitee.com/openharmony/useriam_face_auth) 127 128[drivers_peripheral](https://gitee.com/openharmony/drivers_peripheral) 129 130[drivers_interface](https://gitee.com/openharmony/drivers_interface) 131