Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“53574e54a11295d69470b5194ce9a16399b2f68e”上不存在“...operators/git@gitcode.net:s920243400/PaddleDetection.git”
未验证 提交 f3dd0541 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!21722 UserAuth补充API10接口文档 

Merge pull request !21722 from liuziwei/master
上级 24d8b4ef c828c67f
隐藏空白更改
内联 并排
Showing with 67 addition and 137 deletion
zh-cn/application-dev/security/userauth-guidelines.md
浏览文件 @ f3dd0541
# 用户认证开发指导 # 用户认证开发指导
> **说明：** > **说明：**
> 该开发指导需配合API version 9版本的SDK使用。 > 该开发指导需配合API version 10版本的SDK使用。
## 场景介绍 ## 场景介绍
当前用户认证支持人脸识别和指纹识别，可应用于设备解锁、应用登录、支付等身份认证场景。 当前用户认证支持Pin码认证、人脸识别和指纹识别，可应用于设备解锁、应用登录、支付等身份认证场景。
## 接口说明 ## 接口说明
...@@ -18,11 +18,11 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ...@@ -18,11 +18,11 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
| 接口名称 | 功能描述 | | 接口名称 | 功能描述 |
| ---------- | ----------------------- | | ---------- | ----------------------- |
| getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void | 根据指定的认证类型、认证等级，检测当前设备是否支持相应的认证能力。 | | getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void | 根据指定的认证类型、认证等级，检测当前设备是否支持相应的认证能力。 |
| getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel : AuthTrustLevel): AuthInstance | 获取AuthInstance对象，用于执行用户身份认证。 | | getUserAuthInstance(authParam: AuthParam, widgetParam: WidgetParam): UserAuthInstance | 获取UserAuthInstance对象，用于执行用户身份认证，并支持使用统一用户身份认证组件。 |
| on(name : AuthEventKey, callback : AuthEvent) : void | 订阅指定类型的用户认证事件。 | | on(type: 'result', callback: IAuthCallback): void | 订阅用户身份认证结果。 |
| off(name : AuthEventKey) : void | 取消订阅特定类型的认证事件。 | | off(type: 'result', callback?: IAuthCallback): void | 取消订阅用户身份认证结果。 |
| start: void | 执行用户认证。 | | start(): void | 执行用户认证。 |
| cancel: void | 取消本次认证操作。 | | cancel(): void | 取消本次认证操作。 |
## 查询当前设备是否支持相应的认证能力 ## 查询当前设备是否支持相应的认证能力
...@@ -34,7 +34,7 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ...@@ -34,7 +34,7 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
// 查询认证能力是否支持 // 查询认证能力是否支持
try { try {
userIAM_userAuth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1); userIAM_userAuth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
...@@ -48,127 +48,56 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ...@@ -48,127 +48,56 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
### 开发步骤 ### 开发步骤
1. 申请权限。调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)。 1. 申请权限。调用[start](../reference/apis/js-apis-useriam-userauth.md#start10)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)。
2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。 2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。
3. 调用[on](../reference/apis/js-apis-useriam-userauth.md#on9)接口订阅认证结果。 3. 调用[on](../reference/apis/js-apis-useriam-userauth.md#on10)接口订阅认证结果。
4. 调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口发起认证，通过[callback](../reference/apis/js-apis-useriam-userauth.md#callback9)回调返回认证结果。 4. 调用[start](../reference/apis/js-apis-useriam-userauth.md#start10)接口发起认证，通过[callback](../reference/apis/js-apis-useriam-userauth.md#callback10)回调返回认证结果。
5. 调用[off](../reference/apis/js-apis-useriam-userauth.md#off9)接口取消订阅认证结果。 5. 调用[off](../reference/apis/js-apis-useriam-userauth.md#off10)接口取消订阅认证结果。
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); const authParam = {
let authType = userIAM_userAuth.UserAuthType.FACE; challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; authType: [userAuth.UserAuthType.PIN],
authTrustLevel: 10000,
// 获取认证对象 };
let auth; const widgetParam = {
try { title: '请输入密码',
auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); navigationButtonText: '返回',
console.log("get auth instance success"); windowMode: userAuth.WindowModeType.DIALOG_BOX,
} catch (error) { };
console.log("get auth instance failed" + error); let userAuthInstance;
}
// 订阅认证结果
try { try {
auth.on("result", { //获取认证对象
callback: (result: userIAM_userAuth.AuthResultInfo) => { userAuthInstance = userIAM_userAuth.getUserAuthInstance(authParam, widgetParam);
console.log("authV9 result " + result.result); console.log('get userAuth instance success');
console.log("authV9 token " + result.token); //订阅认证结果
console.log("authV9 remainAttempts " + result.remainAttempts); userAuthInstance.on('result', {
console.log("authV9 lockoutDuration " + result.lockoutDuration); onResult (result) {
console.log('userAuthInstance callback result = ' + JSON.stringify(result));
} }
}); });
console.log("subscribe authentication event success"); console.log('auth on success');
userAuthInstance.start();
console.log('auth start success');
} catch (error) { } catch (error) {
console.log("subscribe authentication event failed " + error); console.log('auth on catch error: ' + JSON.stringify(error));
} }
//取消订阅认证结果
// 开始认证
try {
auth.start();
console.info("authV9 start auth success");
} catch (error) {
console.info("authV9 start auth failed, error = " + error);
}
// 取消订阅认证结果
try { try {
auth.off("result"); userAuthInstance.off('result', {
console.info("cancel subscribe authentication event success"); onResult (result) {
} catch (error) { console.log('auth off result: ' + JSON.stringify(result));
console.info("cancel subscribe authentication event failed, error = " + error);
}
```
## 执行认证操作并订阅认证过程中的提示信息
### 开发步骤
1. 申请权限。调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)。
2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。
3. 调用[on](../reference/apis/js-apis-useriam-userauth.md#on9)接口订阅认证过程中的提示信息。
4. 调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口发起认证，通过[callback](../reference/apis/js-apis-useriam-userauth.md#callback9)回调返回认证过程中的提示信息。
5. 调用[off](../reference/apis/js-apis-useriam-userauth.md#off9)接口取消订阅认证过程中的提示信息。
```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
// 获取认证对象
let auth;
try {
auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.log("get auth instance success");
} catch (error) {
console.log("get auth instance failed" + error);
}
// 订阅认证过程中的提示信息
try {
auth.on("tip", {
callback : (result : userIAM_userAuth.TipInfo) => {
switch (result.tip) {
case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_BRIGHT:
// do something;
case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_DARK:
// do something;
default:
// do others
}
} }
}); });
console.log("subscribe authentication event success"); console.log('auth off success');
} catch (error) {
console.log("subscribe authentication event failed " + error);
}
// 开始认证
try {
auth.start();
console.info("authV9 start auth success");
} catch (error) {
console.info("authV9 start auth failed, error = " + error);
}
// 取消订阅认证过程中的提示信息
try {
auth.off("tip");
console.info("cancel subscribe tip information success");
} catch (error) { } catch (error) {
console.info("cancel subscribe tip information failed, error = " + error); console.log('auth catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -176,43 +105,44 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ...@@ -176,43 +105,44 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
### 开发步骤 ### 开发步骤
1. 申请权限。调用[cancel](../reference/apis/js-apis-useriam-userauth.md#cancel9)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)。 1. 申请权限。调用[cancel](../reference/apis/js-apis-useriam-userauth.md#cancel10)接口，需要在module.json5文件的requestPermissions对象中配置ohos.permission.ACCESS_BIOMETRIC权限。更多配置信息请参考[Stage模型应用程序包结构](../quick-start/module-configuration-file.md)。
2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。 2. 指定challenge、[认证类型](../reference/apis/js-apis-useriam-userauth.md#userauthtype8)和[认证等级](../reference/apis/js-apis-useriam-userauth.md#authtrustlevel8)，获取认证对象。
3. 调用[start](../reference/apis/js-apis-useriam-userauth.md#start9)接口发起认证。 3. 调用[start](../reference/apis/js-apis-useriam-userauth.md#start10)接口发起认证。
4. 通过调用[cancel](../reference/apis/js-apis-useriam-userauth.md#cancel9)接口取消本次认证。 4. 通过调用[cancel](../reference/apis/js-apis-useriam-userauth.md#cancel10)接口取消本次认证。
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); const authParam = {
let authType = userIAM_userAuth.UserAuthType.FACE; challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; authType: [userAuth.UserAuthType.PIN],
authTrustLevel: 10000,
// 获取认证对象 };
let auth; const widgetParam = {
try { title: '请输入密码',
auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); navigationButtonText: '返回',
console.log("get auth instance success"); windowMode: userAuth.WindowModeType.DIALOG_BOX,
} catch (error) { };
console.log("get auth instance failed" + error); let userAuthInstance;
}
// 开始认证
try { try {
auth.start(); //获取认证对象
console.info("authV9 start auth success"); userAuthInstance = userIAM_userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
//开始认证
userAuthInstance.start();
console.log('auth start success');
} catch (error) { } catch (error) {
console.info("authV9 start auth failed, error = " + error); console.log('auth catch error: ' + JSON.stringify(error));
} }
// 取消认证 // 取消认证
try { try {
auth.cancel(); userAuthInstance.cancel();
console.info("cancel auth success"); console.log('auth cancel success');
} catch (error) { } catch (error) {
console.info("cancel auth failed, error = " + error); console.log('auth catch error: ' + JSON.stringify(error));
} }
``` ```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或