Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 145f2fe3 编写于 作者: L liuziweicom
浏览文件
操作

fix code 

Signed-off-by: Nliuziweicom <liuziwei12@huawei.com>
上级 5be5552b
隐藏空白更改
内联 并排
Showing with 230 addition and 227 deletion
zh-cn/application-dev/reference/apis/js-apis-useriam-faceauth.md
浏览文件 @ 145f2fe3
...@@ -72,12 +72,12 @@ setSurfaceId(surfaceId: string): void; ...@@ -72,12 +72,12 @@ setSurfaceId(surfaceId: string): void;
import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; import userIAM_faceAuth from '@ohos.userIAM.faceAuth';
// 该surfaceId应该从XComponent控件获取，此处仅用作示例。 // 该surfaceId应该从XComponent控件获取，此处仅用作示例。
let surfaceId = "123456"; let surfaceId = '123456';
let manager = new userIAM_faceAuth.FaceAuthManager(); let manager = new userIAM_faceAuth.FaceAuthManager();
try { try {
manager.setSurfaceId(surfaceId); manager.setSurfaceId(surfaceId);
console.info("set surface id success"); console.info('set surface id success');
} catch (e) { } catch (e) {
console.error("set surface id failed, error = " + e); console.error('set surface id failed, error = ' + e);
} }
``` ```
zh-cn/application-dev/reference/apis/js-apis-useriam-userauth.md
浏览文件 @ 145f2fe3
...@@ -31,11 +31,11 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth'; ...@@ -31,11 +31,11 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth';
**系统能力**：SystemCapability.UserIAM.UserAuth.Core **系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------- | ---- | ------------------------------------------------------ | | -------------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| challenge | Uint8Array | 是 | 挑战值，用来防重放攻击。最大长度为32字节，可以填null。 | | challenge | Uint8Array | 是 | 挑战值，用来防重放攻击。最大长度为32字节，可传Uint8Array([])。 |
| authType | [UserAuthType](#userauthtype8)[] | 是 | 认证类型列表，用来指定用户认证界面提供的认证方法。 | | authType | [UserAuthType](#userauthtype8)[] | 是 | 认证类型列表，用来指定用户认证界面提供的认证方法。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 |
## WidgetParam<sup>10+</sup> ## WidgetParam<sup>10+</sup>
...@@ -93,19 +93,18 @@ const authParam : userAuth.AuthParam = { ...@@ -93,19 +93,18 @@ const authParam : userAuth.AuthParam = {
const widgetParam :userAuth.WidgetParam = { const widgetParam :userAuth.WidgetParam = {
title: '请输入密码', title: '请输入密码',
navigationButtonText: '返回', navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
}; };
try { try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam); let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success'); console.log('get userAuth instance success');
userAuthInstance.on('result', { userAuthInstance.on('result', {
onResult (result) { onResult (result) {
console.log('userAuthInstance callback result = ' + JSON.stringify(result)); console.log('userAuthInstance callback result = ' + JSON.stringify(result));
} }
}); });
console.log('auth on success'); console.log('auth on success');
} catch (error) { } catch (error) {
console.log('auth catch error: ' + JSON.stringify(error)); console.log('auth catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -151,19 +150,18 @@ const authParam : userAuth.AuthParam = { ...@@ -151,19 +150,18 @@ const authParam : userAuth.AuthParam = {
const widgetParam :userAuth.WidgetParam = { const widgetParam :userAuth.WidgetParam = {
title: '请输入密码', title: '请输入密码',
navigationButtonText: '返回', navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
}; };
try { try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam); let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success'); console.log('get userAuth instance success');
userAuthInstance.on('result', { userAuthInstance.on('result', {
onResult (result) { onResult (result) {
console.log('userAuthInstance callback result = ' + JSON.stringify(result)); console.log('userAuthInstance callback result = ' + JSON.stringify(result));
} }
}); });
console.log('auth on success'); console.log('auth on success');
} catch (error) { } catch (error) {
console.log('auth catch error: ' + JSON.stringify(error)); console.log('auth catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -206,19 +204,18 @@ const authParam : userAuth.AuthParam = { ...@@ -206,19 +204,18 @@ const authParam : userAuth.AuthParam = {
const widgetParam :userAuth.WidgetParam = { const widgetParam :userAuth.WidgetParam = {
title: '请输入密码', title: '请输入密码',
navigationButtonText: '返回', navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
}; };
try { try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam); let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success'); console.log('get userAuth instance success');
userAuthInstance.off('result', { userAuthInstance.off('result', {
onResult (result) { onResult (result) {
console.log('auth off result: ' + JSON.stringify(result)); console.log('auth off result: ' + JSON.stringify(result));
} }
}); });
console.log('auth off success'); console.log('auth off success');
} catch (error) { } catch (error) {
console.log('auth catch error: ' + JSON.stringify(error)); console.log('auth catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -264,15 +261,14 @@ const authParam : userAuth.AuthParam = { ...@@ -264,15 +261,14 @@ const authParam : userAuth.AuthParam = {
const widgetParam :userAuth.WidgetParam = { const widgetParam :userAuth.WidgetParam = {
title: '请输入密码', title: '请输入密码',
navigationButtonText: '返回', navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
}; };
try { try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam); let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success'); console.log('get userAuth instance success');
userAuthInstance.start(); userAuthInstance.start();
console.log('auth start success'); console.log('auth start success');
} catch (error) { } catch (error) {
console.log('auth catch error: ' + JSON.stringify(error)); console.log('auth catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -309,15 +305,14 @@ const authParam : userAuth.AuthParam = { ...@@ -309,15 +305,14 @@ const authParam : userAuth.AuthParam = {
const widgetParam :userAuth.WidgetParam = { const widgetParam :userAuth.WidgetParam = {
title: '请输入密码', title: '请输入密码',
navigationButtonText: '返回', navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
}; };
try { try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam); let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success'); console.log('get userAuth instance success');
userAuthInstance.cancel(); userAuthInstance.cancel();
console.log('auth cancel success'); console.log('auth cancel success');
} catch (error) { } catch (error) {
console.log('auth catch error: ' + JSON.stringify(error)); console.log('auth catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -369,13 +364,12 @@ const authParam : userAuth.AuthParam = { ...@@ -369,13 +364,12 @@ const authParam : userAuth.AuthParam = {
const widgetParam :userAuth.WidgetParam = { const widgetParam :userAuth.WidgetParam = {
title: '请输入密码', title: '请输入密码',
navigationButtonText: '返回', navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
}; };
try { try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam); let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success'); console.log('get userAuth instance success');
} catch (error) { } catch (error) {
console.log('auth catch error: ' + JSON.stringify(error)); console.log('auth catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -426,14 +420,14 @@ sendNotice(noticeType: NoticeType, eventData: string): void ...@@ -426,14 +420,14 @@ sendNotice(noticeType: NoticeType, eventData: string): void
```js ```js
import userAuth from '@ohos.userIAM.userAuth'; import userAuth from '@ohos.userIAM.userAuth';
class EventData { interface EventData {
widgetContextId: number = 0; widgetContextId: number;
event: string = ""; event: string;
version: string = ""; version: string;
payload: PayLoad = { type: ['pin'] }; payload: PayLoad;
} }
class PayLoad { interface PayLoad {
type:Object[] = []; type: Object[];
} }
try { try {
const eventData : EventData = { const eventData : EventData = {
...@@ -490,16 +484,16 @@ import userAuth from '@ohos.userIAM.userAuth'; ...@@ -490,16 +484,16 @@ import userAuth from '@ohos.userIAM.userAuth';
const userAuthWidgetMgrVersion = 1; const userAuthWidgetMgrVersion = 1;
try { try {
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion); let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success'); console.log('get userAuthWidgetMgr instance success');
userAuthWidgetMgr.on('command', { userAuthWidgetMgr.on('command', {
sendCommand(cmdData) { sendCommand(cmdData) {
console.log('The cmdData is ' + cmdData); console.log('The cmdData is ' + cmdData);
} }
}) })
console.log('subscribe authentication event success'); console.log('subscribe authentication event success');
} catch (error) { } catch (error) {
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error)); console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -536,16 +530,16 @@ import userAuth from '@ohos.userIAM.userAuth'; ...@@ -536,16 +530,16 @@ import userAuth from '@ohos.userIAM.userAuth';
const userAuthWidgetMgrVersion = 1; const userAuthWidgetMgrVersion = 1;
try { try {
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion); let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success'); console.log('get userAuthWidgetMgr instance success');
userAuthWidgetMgr.off('command', { userAuthWidgetMgr.off('command', {
sendCommand(cmdData) { sendCommand(cmdData) {
console.log('The cmdData is ' + cmdData); console.log('The cmdData is ' + cmdData);
} }
}) })
console.log('cancel subscribe authentication event success'); console.log('cancel subscribe authentication event success');
} catch (error) { } catch (error) {
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error)); console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -594,10 +588,10 @@ import userAuth from '@ohos.userIAM.userAuth'; ...@@ -594,10 +588,10 @@ import userAuth from '@ohos.userIAM.userAuth';
let userAuthWidgetMgrVersion = 1; let userAuthWidgetMgrVersion = 1;
try { try {
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion); let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success'); console.log('get userAuthWidgetMgr instance success');
} catch (error) { } catch (error) {
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error)); console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -628,16 +622,16 @@ import userAuth from '@ohos.userIAM.userAuth'; ...@@ -628,16 +622,16 @@ import userAuth from '@ohos.userIAM.userAuth';
const userAuthWidgetMgrVersion = 1; const userAuthWidgetMgrVersion = 1;
try { try {
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion); let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success'); console.log('get userAuthWidgetMgr instance success');
userAuthWidgetMgr.on('command', { userAuthWidgetMgr.on('command', {
sendCommand(cmdData) { sendCommand(cmdData) {
console.log('The cmdData is ' + cmdData); console.log('The cmdData is ' + cmdData);
} }
}) })
console.log('subscribe authentication event success'); console.log('subscribe authentication event success');
} catch (error) { } catch (error) {
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error)); console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
} }
``` ```
...@@ -716,39 +710,39 @@ let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; ...@@ -716,39 +710,39 @@ let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
// 通过callback获取认证结果 // 通过callback获取认证结果
try { try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
auth.on("result", { auth.on('result', {
callback: (result: userIAM_userAuth.AuthResultInfo) => { callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.log("authV9 result " + result.result); console.log('authV9 result ' + result.result);
console.log("authV9 token " + result.token); console.log('authV9 token ' + result.token);
console.log("authV9 remainAttempts " + result.remainAttempts); console.log('authV9 remainAttempts ' + result.remainAttempts);
console.log("authV9 lockoutDuration " + result.lockoutDuration); console.log('authV9 lockoutDuration ' + result.lockoutDuration);
} }
} as userIAM_userAuth.AuthEvent); } as userIAM_userAuth.AuthEvent);
auth.start(); auth.start();
console.log("authV9 start success"); console.log('authV9 start success');
} catch (error) { } catch (error) {
console.log("authV9 error = " + error); console.log('authV9 error = ' + error);
// do error // do error
} }
// 通过callback获取认证过程中的提示信息 // 通过callback获取认证过程中的提示信息
try { try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
auth.on("tip", { auth.on('tip', {
callback : (result : userIAM_userAuth.TipInfo) => { callback : (result : userIAM_userAuth.TipInfo) => {
switch (result.tip) { switch (result.tip) {
case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_BRIGHT: case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_BRIGHT:
// do something; // do something;
case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_DARK: case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_DARK:
// do something; // do something;
default: default:
// do others // do others
} }
} }
} as userIAM_userAuth.AuthEvent); } as userIAM_userAuth.AuthEvent);
auth.start(); auth.start();
console.log("authV9 start success"); console.log('authV9 start success');
} catch (error) { } catch (error) {
console.log("authV9 error = " + error); console.log('authV9 error = ' + error);
// do error // do error
} }
``` ```
...@@ -799,34 +793,34 @@ let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); ...@@ -799,34 +793,34 @@ let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE; let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
try { try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
// 订阅认证结果 // 订阅认证结果
auth.on("result", { auth.on('result', {
callback: (result: userIAM_userAuth.AuthResultInfo) => { callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.log("authV9 result " + result.result); console.log('authV9 result ' + result.result);
console.log("authV9 token " + result.token); console.log('authV9 token ' + result.token);
console.log("authV9 remainAttempts " + result.remainAttempts); console.log('authV9 remainAttempts ' + result.remainAttempts);
console.log("authV9 lockoutDuration " + result.lockoutDuration); console.log('authV9 lockoutDuration ' + result.lockoutDuration);
} }
}); });
// 订阅认证过程中的提示信息 // 订阅认证过程中的提示信息
auth.on("tip", { auth.on('tip', {
callback : (result : userIAM_userAuth.TipInfo) => { callback : (result : userIAM_userAuth.TipInfo) => {
switch (result.tip) { switch (result.tip) {
case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_BRIGHT: case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_BRIGHT:
// do something; // do something;
case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_DARK: case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_DARK:
// do something; // do something;
default: default:
// do others // do others
} }
} }
}); } as userIAM_userAuth.AuthEvent);
auth.start(); auth.start();
console.log("authV9 start success"); console.log('authV9 start success');
} catch (error) { } catch (error) {
console.log("authV9 error = " + error); console.log('authV9 error = ' + error);
// do error // do error
} }
``` ```
...@@ -865,34 +859,23 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth'; ...@@ -865,34 +859,23 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth';
let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]); let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE; let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
let auth;
try { try {
auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.log("get auth instance success"); // 订阅认证结果
} catch (error) { auth.on('result', {
console.log("get auth instance failed" + error); callback: (result: userIAM_userAuth.AuthResultInfo) => {
} console.log('authV9 result ' + result.result);
console.log('authV9 token ' + result.token);
try { console.log('authV9 remainAttempts ' + result.remainAttempts);
// 订阅认证结果 console.log('authV9 lockoutDuration ' + result.lockoutDuration);
auth.on("result", { }
callback: (result: userIAM_userAuth.AuthResultInfo) => { });
console.log("authV9 result " + result.result); // 取消订阅结果
console.log("authV9 token " + result.token); auth.off('result');
console.log("authV9 remainAttempts " + result.remainAttempts); console.info('cancel subscribe authentication event success');
console.log("authV9 lockoutDuration " + result.lockoutDuration);
}
});
console.log("subscribe authentication event success");
} catch (error) {
console.log("subscribe authentication event failed " + error);
}
// 取消订阅认证结果
try {
auth.off("result");
console.info("cancel subscribe authentication event success");
} catch (error) { } catch (error) {
console.info("cancel subscribe authentication event failed, error = " + error); console.info('cancel subscribe authentication event failed, error =' + error);
// do error
} }
``` ```
...@@ -940,11 +923,11 @@ let authType = userIAM_userAuth.UserAuthType.FACE; ...@@ -940,11 +923,11 @@ let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
try { try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
auth.start(); auth.start();
console.info("authV9 start auth success"); console.info('authV9 start auth success');
} catch (error) { } catch (error) {
console.info("authV9 start auth failed, error = " + error); console.info('authV9 start auth failed, error = ' + error);
} }
``` ```
...@@ -984,11 +967,11 @@ let authType = userIAM_userAuth.UserAuthType.FACE; ...@@ -984,11 +967,11 @@ let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
try { try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
auth.cancel(); auth.cancel();
console.info("cancel auth success"); console.info('cancel auth success');
} catch (error) { } catch (error) {
console.info("cancel auth failed, error = " + error); console.info('cancel auth failed, error = ' + error);
} }
``` ```
...@@ -1010,7 +993,7 @@ getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel ...@@ -1010,7 +993,7 @@ getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | ------------------------ | | -------------- | ---------------------------------------- | ---- | ------------------------ |
| challenge | Uint8Array | 是 | 挑战值，最大长度为32字节，可以填null。 | | challenge | Uint8Array | 是 | 挑战值，最大长度为32字节，可以传Uint8Array([])。 |
| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 | | authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 |
...@@ -1041,10 +1024,10 @@ let authType = userIAM_userAuth.UserAuthType.FACE; ...@@ -1041,10 +1024,10 @@ let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1; let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
try { try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel); let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.info("get auth instance success"); console.info('let auth instance success');
} catch (error) { } catch (error) {
console.info("get auth instance success failed, error = " + error); console.info('get auth instance success failed, error = ' + error);
} }
``` ```
...@@ -1084,10 +1067,10 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): vo ...@@ -1084,10 +1067,10 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): vo
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);
console.info("current auth trust level is supported"); console.info('current auth trust level is supported');
} catch (error) { } catch (error) {
console.info("current auth trust level is not supported, error = " + error); console.info('current auth trust level is not supported, error = ' + error);
} }
``` ```
...@@ -1166,7 +1149,7 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth'; ...@@ -1166,7 +1149,7 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth(); let auth = new userIAM_userAuth.UserAuth();
let version = auth.getVersion(); let version = auth.getVersion();
console.info("auth version = " + version); console.info('auth version = ' + version);
``` ```
### getAvailableStatus<sup>(deprecated)</sup> ### getAvailableStatus<sup>(deprecated)</sup>
...@@ -1203,9 +1186,9 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth'; ...@@ -1203,9 +1186,9 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth(); let auth = new userIAM_userAuth.UserAuth();
let checkCode = auth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1); let checkCode = auth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
if (checkCode == userIAM_userAuth.ResultCode.SUCCESS) { if (checkCode == userIAM_userAuth.ResultCode.SUCCESS) {
console.info("check auth support success"); console.info('check auth support success');
} else { } else {
console.error("check auth support fail, code = " + checkCode); console.error('check auth support fail, code = ' + checkCode);
} }
``` ```
...@@ -1226,7 +1209,7 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev ...@@ -1226,7 +1209,7 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | ------------------------ | | -------------- | ---------------------------------------- | ---- | ------------------------ |
| challenge | Uint8Array | 是 | 挑战值，可以填null。 | | challenge | Uint8Array | 是 | 挑战值，可以传Uint8Array([])。 |
| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 | | authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 |
| callback | [IUserAuthCallback](#iuserauthcallbackdeprecated) | 是 | 回调函数。 | | callback | [IUserAuthCallback](#iuserauthcallbackdeprecated) | 是 | 回调函数。 |
...@@ -1243,20 +1226,21 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev ...@@ -1243,20 +1226,21 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth(); let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, { let challenge = new Uint8Array([]);
onResult: (result, extraInfo) => { auth.auth(challenge, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
try { onResult: (result, extraInfo) => {
console.info("auth onResult result = " + result); try {
console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo)); console.info('auth onResult result = ' + result);
if (result == userIAM_userAuth.ResultCode.SUCCESS) { console.info('auth onResult extraInfo = ' + JSON.stringify(extraInfo));
// 此处添加认证成功逻辑 if (result == userIAM_userAuth.ResultCode.SUCCESS) {
} else { // 此处添加认证成功逻辑
// 此处添加认证失败逻辑 } else {
} // 此处添加认证失败逻辑
} catch (e) { }
console.info("auth onResult error = " + e); } catch (e) {
} console.info('auth onResult error = ' + e);
} }
}
}); });
``` ```
...@@ -1295,9 +1279,9 @@ let contextId = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7]); ...@@ -1295,9 +1279,9 @@ let contextId = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7]);
let auth = new userIAM_userAuth.UserAuth(); let auth = new userIAM_userAuth.UserAuth();
let cancelCode = auth.cancelAuth(contextId); let cancelCode = auth.cancelAuth(contextId);
if (cancelCode == userIAM_userAuth.ResultCode.SUCCESS) { if (cancelCode == userIAM_userAuth.ResultCode.SUCCESS) {
console.info("cancel auth success"); console.info('cancel auth success');
} else { } else {
console.error("cancel auth fail"); console.error('cancel auth fail');
} }
``` ```
...@@ -1332,20 +1316,21 @@ onResult: (result : number, extraInfo : AuthResult) => void ...@@ -1332,20 +1316,21 @@ onResult: (result : number, extraInfo : AuthResult) => void
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth(); let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, { let challenge = new Uint8Array([]);
onResult: (result, extraInfo) => { auth.auth(challenge, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
try { onResult: (result, extraInfo) => {
console.info("auth onResult result = " + result); try {
console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo)); console.info('auth onResult result = ' + result);
if (result == userIAM_userAuth.ResultCode.SUCCESS) { console.info('auth onResult extraInfo = ' + JSON.stringify(extraInfo));
// 此处添加认证成功逻辑 if (result == userIAM_userAuth.ResultCode.SUCCESS) {
} else { // 此处添加认证成功逻辑
// 此处添加认证失败逻辑 } else {
} // 此处添加认证失败逻辑
} catch (e) { }
console.info("auth onResult error = " + e); } catch (e) {
} console.info('auth onResult error = ' + e);
} }
}
}); });
``` ```
...@@ -1374,16 +1359,30 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void ...@@ -1374,16 +1359,30 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void
import userIAM_userAuth from '@ohos.userIAM.userAuth'; import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth(); let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, { let challenge = new Uint8Array([]);
onAcquireInfo: (module, acquire, extraInfo) => { auth.auth(challenge, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
try { onResult: (result, extraInfo) => {
console.info("auth onAcquireInfo module = " + module); try {
console.info("auth onAcquireInfo acquire = " + acquire); console.info('auth onResult result = ' + result);
console.info("auth onAcquireInfo extraInfo = " + JSON.stringify(extraInfo)); console.info('auth onResult extraInfo = ' + JSON.stringify(extraInfo));
} catch (e) { if (result == userIAM_userAuth.ResultCode.SUCCESS) {
console.info("auth onAcquireInfo error = " + e); // 此处添加认证成功逻辑
} } else {
// 此处添加认证失败逻辑
}
} catch (e) {
console.info('auth onResult error = ' + e);
}
},
onAcquireInfo: (module, acquire, extraInfo) => {
try {
console.info('auth onAcquireInfo module = ' + module);
console.info('auth onAcquireInfo acquire = ' + acquire);
console.info('auth onAcquireInfo extraInfo = ' + JSON.stringify(extraInfo));
} catch (e) {
console.info('auth onAcquireInfo error = ' + e);
} }
}
}); });
``` ```
...@@ -1506,6 +1505,8 @@ getAuthenticator(): Authenticator ...@@ -1506,6 +1505,8 @@ getAuthenticator(): Authenticator
**示例：** **示例：**
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let authenticator = userIAM_userAuth.getAuthenticator(); let authenticator = userIAM_userAuth.getAuthenticator();
``` ```
...@@ -1546,13 +1547,15 @@ callback返回值： ...@@ -1546,13 +1547,15 @@ callback返回值：
**示例：** **示例：**
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let authenticator = userIAM_userAuth.getAuthenticator(); let authenticator = userIAM_userAuth.getAuthenticator();
authenticator.execute("FACE_ONLY", "S2", (error, code)=>{ authenticator.execute('FACE_ONLY', 'S2', (error, code)=>{
if (code === userIAM_userAuth.ResultCode.SUCCESS) { if (code === userIAM_userAuth.ResultCode.SUCCESS) {
console.info("auth success"); console.info('auth success');
return; return;
} }
console.error("auth fail, code = " + code); console.error('auth fail, code = ' + code);
}); });
``` ```
...@@ -1586,11 +1589,13 @@ execute(type : AuthType, level : SecureLevel): Promise&lt;number&gt; ...@@ -1586,11 +1589,13 @@ execute(type : AuthType, level : SecureLevel): Promise&lt;number&gt;
**示例：** **示例：**
```js ```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let authenticator = userIAM_userAuth.getAuthenticator(); let authenticator = userIAM_userAuth.getAuthenticator();
authenticator.execute("FACE_ONLY", "S2").then((code)=>{ authenticator.execute('FACE_ONLY', 'S2').then((code)=>{
console.info("auth success"); console.info('auth success');
}).catch((error)=>{ }).catch((error)=>{
console.error("auth fail, code = " + error); console.error('auth fail, code = ' + error);
}); });
``` ```
......
zh-cn/application-dev/security/userauth-guidelines.md
浏览文件 @ 145f2fe3
...@@ -48,9 +48,9 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ...@@ -48,9 +48,9 @@ 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);
console.info("current auth trust level is supported"); console.info('current auth trust level is supported');
} catch (error) { } catch (error) {
console.info("current auth trust level is not supported, error = " + error); console.info('current auth trust level is not supported, error = ' + error);
} }
``` ```
...@@ -79,7 +79,6 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ...@@ -79,7 +79,6 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
const widgetParam : userIAM_userAuth.WidgetParam = { const widgetParam : userIAM_userAuth.WidgetParam = {
title: '请输入密码', title: '请输入密码',
navigationButtonText: '返回', navigationButtonText: '返回',
windowMode: userIAM_userAuth.WindowModeType.DIALOG_BOX,
}; };
try { try {
//获取认证对象 //获取认证对象
...@@ -129,7 +128,6 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证 ...@@ -129,7 +128,6 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
const widgetParam : userIAM_userAuth.WidgetParam = { const widgetParam : userIAM_userAuth.WidgetParam = {
title: '请输入密码', title: '请输入密码',
navigationButtonText: '返回', navigationButtonText: '返回',
windowMode: userIAM_userAuth.WindowModeType.DIALOG_BOX,
}; };
try { try {
//获取认证对象 //获取认证对象
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或