Skip to content

D
Docs

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

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

fix code 

Signed-off-by: Nliuziweicom <liuziwei12@huawei.com>
上级 3de328fb
隐藏空白更改
内联 并排
Showing with 349 addition and 347 deletion
zh-cn/application-dev/reference/apis/js-apis-useriam-faceauth.md
浏览文件 @ 8560f159
......@@ -72,12 +72,12 @@ setSurfaceId(surfaceId: string): void;
import userIAM_faceAuth from '@ohos.userIAM.faceAuth';
// 该surfaceId应该从XComponent控件获取，此处仅用作示例。
let surfaceId = "123456";
let surfaceId = '123456';
let manager = new userIAM_faceAuth.FaceAuthManager();
try {
manager.setSurfaceId(surfaceId);
console.info("set surface id success");
manager.setSurfaceId(surfaceId);
console.info('set surface id success');
} 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
浏览文件 @ 8560f159
......@@ -31,11 +31,11 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth';
**系统能力**：SystemCapability.UserIAM.UserAuth.Core
| 名称 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| challenge | Uint8Array | 是 | 挑战值，用来防重放攻击。最大长度为32字节，可以填null。 |
| authType | [UserAuthType](#userauthtype8)[] | 是 | 认证类型列表，用来指定用户认证界面提供的认证方法。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 |
| 名称 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| challenge | Uint8Array | 是 | 挑战值，用来防重放攻击。最大长度为32字节，可传Uint8Array([])。 |
| authType | [UserAuthType](#userauthtype8)[] | 是 | 认证类型列表，用来指定用户认证界面提供的认证方法。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 |
## WidgetParam<sup>10+</sup>
......@@ -85,27 +85,26 @@ onResult(result: UserAuthResult): void
```js
import userAuth from '@ohos.userIAM.userAuth';
const authParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: 10000,
const authParam : userAuth.AuthParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
const widgetParam :userAuth.WidgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
};
try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.on('result', {
onResult (result) {
console.log('userAuthInstance callback result = ' + JSON.stringify(result));
}
});
console.log('auth on success');
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.on('result', {
onResult (result) {
console.log('userAuthInstance callback result = ' + JSON.stringify(result));
}
});
console.log('auth on success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
console.log('auth catch error: ' + JSON.stringify(error));
}
```
......@@ -143,27 +142,26 @@ on(type: 'result', callback: IAuthCallback): void
```js
import userAuth from '@ohos.userIAM.userAuth';
const authParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: 10000,
const authParam : userAuth.AuthParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
const widgetParam :userAuth.WidgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
};
try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.on('result', {
onResult (result) {
console.log('userAuthInstance callback result = ' + JSON.stringify(result));
}
});
console.log('auth on success');
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.on('result', {
onResult (result) {
console.log('userAuthInstance callback result = ' + JSON.stringify(result));
}
});
console.log('auth on success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
console.log('auth catch error: ' + JSON.stringify(error));
}
```
......@@ -198,27 +196,26 @@ off(type: 'result', callback?: IAuthCallback): void
```js
import userAuth from '@ohos.userIAM.userAuth';
const authParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: 10000,
const authParam : userAuth.AuthParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
const widgetParam :userAuth.WidgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
};
try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.off('result', {
onResult (result) {
console.log('auth off result: ' + JSON.stringify(result));
}
});
console.log('auth off success');
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.off('result', {
onResult (result) {
console.log('auth off result: ' + JSON.stringify(result));
}
});
console.log('auth off success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
console.log('auth catch error: ' + JSON.stringify(error));
}
```
......@@ -256,23 +253,22 @@ start(): void
```js
import userAuth from '@ohos.userIAM.userAuth';
const authParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: 10000,
const authParam : userAuth.AuthParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
const widgetParam :userAuth.WidgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
};
try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.start();
console.log('auth start success');
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.start();
console.log('auth start success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
console.log('auth catch error: ' + JSON.stringify(error));
}
```
......@@ -301,23 +297,22 @@ cancel(): void
```js
import userAuth from '@ohos.userIAM.userAuth';
const authParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: 10000,
const authParam : userAuth.AuthParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
const widgetParam :userAuth.WidgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
};
try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.cancel();
console.log('auth cancel success');
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.cancel();
console.log('auth cancel success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
console.log('auth catch error: ' + JSON.stringify(error));
}
```
......@@ -361,21 +356,20 @@ getUserAuthInstance(authParam: AuthParam, widgetParam: WidgetParam): UserAuthIns
```js
import userAuth from '@ohos.userIAM.userAuth';
const authParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: 10000,
const authParam : userAuth.AuthParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
const widgetParam :userAuth.WidgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
};
try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
console.log('auth catch error: ' + JSON.stringify(error));
}
```
......@@ -426,21 +420,30 @@ sendNotice(noticeType: NoticeType, eventData: string): void
```js
import userAuth from '@ohos.userIAM.userAuth';
interface EventData {
widgetContextId: number;
event: string;
version: string;
payload: PayLoad;
}
interface PayLoad {
type: Object[];
}
try {
const eventData = {
widgetContextId: 123456,
event: 'EVENT_AUTH_TYPE_READY',
version: '1',
payload: {
type: ['pin']
},
};
const jsonEventData = JSON.stringify(eventData);
let noticeType = userAuth.NoticeType.WIDGET_NOTICE;
userAuth.sendNotice(noticeType, jsonEventData);
console.log('sendNotice success');
const eventData : EventData = {
widgetContextId: 123456,
event: 'EVENT_AUTH_TYPE_READY',
version: '1',
payload: {
type: ['pin']
} as PayLoad,
};
const jsonEventData = JSON.stringify(eventData);
let noticeType = userAuth.NoticeType.WIDGET_NOTICE;
userAuth.sendNotice(noticeType, jsonEventData);
console.log('sendNotice success');
} catch (error) {
console.log('sendNotice catch error: ' + JSON.stringify(error));
console.log('sendNotice catch error: ' + JSON.stringify(error));
}
```
......@@ -481,16 +484,16 @@ import userAuth from '@ohos.userIAM.userAuth';
const userAuthWidgetMgrVersion = 1;
try {
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success');
userAuthWidgetMgr.on('command', {
sendCommand(cmdData) {
console.log('The cmdData is ' + cmdData);
}
})
console.log('subscribe authentication event success');
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success');
userAuthWidgetMgr.on('command', {
sendCommand(cmdData) {
console.log('The cmdData is ' + cmdData);
}
})
console.log('subscribe authentication event success');
} catch (error) {
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}
```
......@@ -527,16 +530,16 @@ import userAuth from '@ohos.userIAM.userAuth';
const userAuthWidgetMgrVersion = 1;
try {
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success');
userAuthWidgetMgr.off('command', {
sendCommand(cmdData) {
console.log('The cmdData is ' + cmdData);
}
})
console.log('cancel subscribe authentication event success');
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success');
userAuthWidgetMgr.off('command', {
sendCommand(cmdData) {
console.log('The cmdData is ' + cmdData);
}
})
console.log('cancel subscribe authentication event success');
} catch (error) {
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}
```
......@@ -585,10 +588,10 @@ import userAuth from '@ohos.userIAM.userAuth';
let userAuthWidgetMgrVersion = 1;
try {
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success');
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success');
} catch (error) {
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}
```
......@@ -619,16 +622,16 @@ import userAuth from '@ohos.userIAM.userAuth';
const userAuthWidgetMgrVersion = 1;
try {
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success');
userAuthWidgetMgr.on('command', {
sendCommand(cmdData) {
console.log('The cmdData is ' + cmdData);
}
})
console.log('subscribe authentication event success');
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success');
userAuthWidgetMgr.on('command', {
sendCommand(cmdData) {
console.log('The cmdData is ' + cmdData);
}
})
console.log('subscribe authentication event success');
} catch (error) {
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}
```
......@@ -706,41 +709,41 @@ let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
// 通过callback获取认证结果
try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
auth.on("result", {
callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.log("authV9 result " + result.result);
console.log("authV9 token " + result.token);
console.log("authV9 remainAttempts " + result.remainAttempts);
console.log("authV9 lockoutDuration " + result.lockoutDuration);
}
});
auth.start();
console.log("authV9 start success");
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
auth.on('result', {
callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.log('authV9 result ' + result.result);
console.log('authV9 token ' + result.token);
console.log('authV9 remainAttempts ' + result.remainAttempts);
console.log('authV9 lockoutDuration ' + result.lockoutDuration);
}
} as userIAM_userAuth.AuthEvent);
auth.start();
console.log('authV9 start success');
} catch (error) {
console.log("authV9 error = " + error);
// do error
console.log('authV9 error = ' + error);
// do error
}
// 通过callback获取认证过程中的提示信息
try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
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
}
}
});
auth.start();
console.log("authV9 start success");
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
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
}
}
} as userIAM_userAuth.AuthEvent);
auth.start();
console.log('authV9 start success');
} catch (error) {
console.log("authV9 error = " + error);
// do error
console.log('authV9 error = ' + error);
// do error
}
```
......@@ -790,34 +793,34 @@ let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
// 订阅认证结果
auth.on("result", {
callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.log("authV9 result " + result.result);
console.log("authV9 token " + result.token);
console.log("authV9 remainAttempts " + result.remainAttempts);
console.log("authV9 lockoutDuration " + result.lockoutDuration);
}
});
// 订阅认证过程中的提示信息
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
}
}
});
auth.start();
console.log("authV9 start success");
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
// 订阅认证结果
auth.on('result', {
callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.log('authV9 result ' + result.result);
console.log('authV9 token ' + result.token);
console.log('authV9 remainAttempts ' + result.remainAttempts);
console.log('authV9 lockoutDuration ' + result.lockoutDuration);
}
});
// 订阅认证过程中的提示信息
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
}
}
} as userIAM_userAuth.AuthEvent);
auth.start();
console.log('authV9 start success');
} catch (error) {
console.log("authV9 error = " + error);
// do error
console.log('authV9 error = ' + error);
// do error
}
```
......@@ -856,34 +859,23 @@ 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("result", {
callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.log("authV9 result " + result.result);
console.log("authV9 token " + result.token);
console.log("authV9 remainAttempts " + result.remainAttempts);
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");
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
// 订阅认证结果
auth.on('result', {
callback: (result: userIAM_userAuth.AuthResultInfo) => {
console.log('authV9 result ' + result.result);
console.log('authV9 token ' + result.token);
console.log('authV9 remainAttempts ' + result.remainAttempts);
console.log('authV9 lockoutDuration ' + result.lockoutDuration);
}
});
// 取消订阅结果
auth.off('result');
console.info('cancel subscribe authentication event success');
} catch (error) {
console.info("cancel subscribe authentication event failed, error = " + error);
console.info('cancel subscribe authentication event failed, error =' + error);
// do error
}
```
......@@ -931,11 +923,11 @@ let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
auth.start();
console.info("authV9 start auth success");
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
auth.start();
console.info('authV9 start auth success');
} catch (error) {
console.info("authV9 start auth failed, error = " + error);
console.info('authV9 start auth failed, error = ' + error);
}
```
......@@ -975,11 +967,11 @@ let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
auth.cancel();
console.info("cancel auth success");
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
auth.cancel();
console.info('cancel auth success');
} catch (error) {
console.info("cancel auth failed, error = " + error);
console.info('cancel auth failed, error = ' + error);
}
```
......@@ -1001,7 +993,7 @@ getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | ------------------------ |
| challenge | Uint8Array | 是 | 挑战值，最大长度为32字节，可以填null。 |
| challenge | Uint8Array | 是 | 挑战值，最大长度为32字节，可以传Uint8Array([])。 |
| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 |
......@@ -1032,10 +1024,10 @@ let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
try {
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.info("get auth instance success");
let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
console.info('let auth instance success');
} catch (error) {
console.info("get auth instance success failed, error = " + error);
console.info('get auth instance success failed, error = ' + error);
}
```
......@@ -1075,10 +1067,10 @@ getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): vo
import userIAM_userAuth from '@ohos.userIAM.userAuth';
try {
userIAM_userAuth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
console.info("current auth trust level is supported");
userIAM_userAuth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
console.info('current auth trust level is supported');
} catch (error) {
console.info("current auth trust level is not supported, error = " + error);
console.info('current auth trust level is not supported, error = ' + error);
}
```
......@@ -1157,7 +1149,7 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();
let version = auth.getVersion();
console.info("auth version = " + version);
console.info('auth version = ' + version);
```
### getAvailableStatus<sup>(deprecated)</sup>
......@@ -1194,9 +1186,9 @@ import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();
let checkCode = auth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
if (checkCode == userIAM_userAuth.ResultCode.SUCCESS) {
console.info("check auth support success");
console.info('check auth support success');
} else {
console.error("check auth support fail, code = " + checkCode);
console.error('check auth support fail, code = ' + checkCode);
}
```
......@@ -1217,7 +1209,7 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | ------------------------ |
| challenge | Uint8Array | 是 | 挑战值，可以填null。 |
| challenge | Uint8Array | 是 | 挑战值，可以传Uint8Array([])。 |
| authType | [UserAuthType](#userauthtype8) | 是 | 认证类型，当前支持FACE。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证信任等级。 |
| callback | [IUserAuthCallback](#iuserauthcallbackdeprecated) | 是 | 回调函数。 |
......@@ -1234,20 +1226,21 @@ auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLev
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
try {
console.info("auth onResult result = " + result);
console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo));
if (result == userIAM_userAuth.ResultCode.SUCCESS) {
// 此处添加认证成功逻辑
} else {
// 此处添加认证失败逻辑
}
} catch (e) {
console.info("auth onResult error = " + e);
}
let challenge = new Uint8Array([]);
auth.auth(challenge, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
try {
console.info('auth onResult result = ' + result);
console.info('auth onResult extraInfo = ' + JSON.stringify(extraInfo));
if (result == userIAM_userAuth.ResultCode.SUCCESS) {
// 此处添加认证成功逻辑
} else {
// 此处添加认证失败逻辑
}
} catch (e) {
console.info('auth onResult error = ' + e);
}
}
});
```
......@@ -1286,9 +1279,9 @@ let contextId = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7]);
let auth = new userIAM_userAuth.UserAuth();
let cancelCode = auth.cancelAuth(contextId);
if (cancelCode == userIAM_userAuth.ResultCode.SUCCESS) {
console.info("cancel auth success");
console.info('cancel auth success');
} else {
console.error("cancel auth fail");
console.error('cancel auth fail');
}
```
......@@ -1323,20 +1316,21 @@ onResult: (result : number, extraInfo : AuthResult) => void
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
try {
console.info("auth onResult result = " + result);
console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo));
if (result == userIAM_userAuth.ResultCode.SUCCESS) {
// 此处添加认证成功逻辑
} else {
// 此处添加认证失败逻辑
}
} catch (e) {
console.info("auth onResult error = " + e);
}
let challenge = new Uint8Array([]);
auth.auth(challenge, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
try {
console.info('auth onResult result = ' + result);
console.info('auth onResult extraInfo = ' + JSON.stringify(extraInfo));
if (result == userIAM_userAuth.ResultCode.SUCCESS) {
// 此处添加认证成功逻辑
} else {
// 此处添加认证失败逻辑
}
} catch (e) {
console.info('auth onResult error = ' + e);
}
}
});
```
......@@ -1365,16 +1359,30 @@ onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
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);
}
let challenge = new Uint8Array([]);
auth.auth(challenge, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
try {
console.info('auth onResult result = ' + result);
console.info('auth onResult extraInfo = ' + JSON.stringify(extraInfo));
if (result == userIAM_userAuth.ResultCode.SUCCESS) {
// 此处添加认证成功逻辑
} 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);
}
}
});
```
......@@ -1497,6 +1505,8 @@ getAuthenticator(): Authenticator
**示例：**
```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let authenticator = userIAM_userAuth.getAuthenticator();
```
......@@ -1537,13 +1547,15 @@ callback返回值：
**示例：**
```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let authenticator = userIAM_userAuth.getAuthenticator();
authenticator.execute("FACE_ONLY", "S2", (error, code)=>{
if (code === userIAM_userAuth.ResultCode.SUCCESS) {
console.info("auth success");
return;
}
console.error("auth fail, code = " + code);
authenticator.execute('FACE_ONLY', 'S2', (error, code)=>{
if (code === userIAM_userAuth.ResultCode.SUCCESS) {
console.info('auth success');
return;
}
console.error('auth fail, code = ' + code);
});
```
......@@ -1577,11 +1589,13 @@ execute(type : AuthType, level : SecureLevel): Promise&lt;number&gt;
**示例：**
```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let authenticator = userIAM_userAuth.getAuthenticator();
authenticator.execute("FACE_ONLY", "S2").then((code)=>{
console.info("auth success");
authenticator.execute('FACE_ONLY', 'S2').then((code)=>{
console.info('auth success');
}).catch((error)=>{
console.error("auth fail, code = " + error);
console.error('auth fail, code = ' + error);
});
```
......
zh-cn/application-dev/security/userauth-guidelines.md
浏览文件 @ 8560f159
......@@ -33,6 +33,7 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
| ATL2 | FRR=10%时，FAR≤0.002%，7%<SAR≤20% | 能精确识别用户个体，有一定的活体检测能力，如基于普通测距和佩戴检测的手表作为可信持有物的认证。 | 维持设备解锁状态、应用登录 |
| ATL1 | FRR=10%时，FAR≤1%，7%<SAR≤20% | 能识别用户个体，有一定的活体检测能力，如声纹认证。 | 业务风控、一般个人数据查询、精准业务推荐、个性化服务 |
## 查询当前设备是否支持相应的认证能力
### 开发步骤
......@@ -47,9 +48,9 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
// 查询认证能力是否支持
try {
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) {
console.info("current auth trust level is not supported, error = " + error);
console.info('current auth trust level is not supported, error = ' + error);
}
```
......@@ -70,43 +71,37 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
const authParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: 10000,
const authParam : userIAM_userAuth.AuthParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userIAM_userAuth.UserAuthType.PIN],
authTrustLevel: userIAM_userAuth.AuthTrustLevel.ATL1,
};
const widgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
const widgetParam : userIAM_userAuth.WidgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
};
let userAuthInstance;
try {
//获取认证对象
userAuthInstance = userIAM_userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
//订阅认证结果
userAuthInstance.on('result', {
onResult (result) {
console.log('userAuthInstance callback result = ' + JSON.stringify(result));
}
});
console.log('auth on success');
userAuthInstance.start();
console.log('auth start success');
} catch (error) {
console.log('auth on catch error: ' + JSON.stringify(error));
}
//取消订阅认证结果
try {
userAuthInstance.off('result', {
onResult (result) {
console.log('auth off result: ' + JSON.stringify(result));
}
});
console.log('auth off success');
//获取认证对象
let userAuthInstance = userIAM_userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
//订阅认证结果
userAuthInstance.on('result', {
onResult (result) {
console.log('userAuthInstance callback result = ' + JSON.stringify(result));
}
});
console.log('auth on success');
userAuthInstance.start();
console.log('auth start success');
//取消订阅认证结果
userAuthInstance.off('result', {
onResult (result) {
console.log('auth off result: ' + JSON.stringify(result));
}
});
console.log('auth off success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
console.log('auth catch error: ' + JSON.stringify(error));
}
```
......@@ -125,33 +120,26 @@ userIAM_userAuth模块提供了用户认证的相关方法，包括查询认证
```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
const authParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userAuth.UserAuthType.PIN],
authTrustLevel: 10000,
const authParam : userIAM_userAuth.AuthParam = {
challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
authType: [userIAM_userAuth.UserAuthType.PIN],
authTrustLevel: userIAM_userAuth.AuthTrustLevel.ATL1,
};
const widgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
windowMode: userAuth.WindowModeType.DIALOG_BOX,
const widgetParam : userIAM_userAuth.WidgetParam = {
title: '请输入密码',
navigationButtonText: '返回',
};
let userAuthInstance;
try {
//获取认证对象
userAuthInstance = userIAM_userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
//开始认证
userAuthInstance.start();
console.log('auth start success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
}
// 取消认证
try {
userAuthInstance.cancel();
console.log('auth cancel success');
//获取认证对象
let userAuthInstance = userIAM_userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
//开始认证
userAuthInstance.start();
console.log('auth start success');
// 取消认证
userAuthInstance.cancel();
console.log('auth cancel success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(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.
先完成此消息的编辑！
想要评论请 注册 或