add doc senario description

Match-id-9e8cecbeb03e420f14f8418d168fe89fd143c509
This commit is contained in:
authName 2023-11-29 22:45:39 +08:00 committed by userName
parent 1a1733e984
commit 62f87d20d2

View File

@ -3,29 +3,26 @@
[toc]
## 场景1保护密码类数据
### 场景说明
用户在应用/浏览器上登录账号时,可以选择“记住密码”,如下图所示。此时应用/浏览器可以将用户密码存储在ASSET中由ASSET保证用户密码的机密性。
用户再次进入登录界面时,应用/浏览器可从ASSET中查询用户密码明文并自动填充到密码输入框用户只需点击“登录”按钮即可完成账号登录极大地提升了用户的登录体验。
<img src="../../figures/login.png" alt="login" style="zoom:40%;" />
> **说明:**
>
> 密码类数据可以是密码、登录令牌、信用卡号等用户敏感数据。
### 场景描述
用户在应用/浏览器中登录账号时,可以选择“记住密码”(如图)。针对此种场景,应用/浏览器可以将用户密码存储在ASSET中由ASSET保证用户密码的安全性。
用户再次打开登录界面时,应用/浏览器可以从ASSET中查询用户密码并将其自动填充到密码输入框用户只需点击“登录”按钮即可完成账号登录极大地提升了用户体验。
<img src="../../figures/login.png" alt="login" style="zoom:40%;" />
### 关键流程
应用/浏览器调用ASSET完成上述功能可以参照以下流程进行开发场景
应用/浏览器调用ASSET保护密码类数据后文统称为“关键资产”可以参照以下流程进行开发。
### <img src="../../figures/flowchat-no-auth-required.png" alt="flowchat" style="zoom:40%;" />
1. 业务查询符合条件的关键资产属性,根据是否查询出结果判断关键资产是否存在,开发步骤参考[查询无需用户认证的关键资产](#查询无需用户认证的关键资产) **// todo 待修改**
1. 业务查询符合条件的关键资产属性,根据查询成功/失败,判断关键资产是否存在。开发步骤参考[查询无需用户认证的关键资产](#查询无需用户认证的关键资产) **// todo 待修改**
2. 如果关键资产不存在,新增关键资产,开发步骤参考 **// todo 待修改***
* 删除关键资产,开发步骤参考 **// todo 待修改**
* 修改关键资产,开发步骤参考 **// todo 待修改**
@ -49,27 +46,21 @@ Asset在基础关键资产管理能力之外提供了可选的用户认证访
## 新增关键资产
- 接口和必选参数介绍
### 接口介绍
接口和使用方式可参考
接口文档链接
[function add(attributes: AssetMap, callback: AsyncCallback<void>): void](../reference/apis/js-apis-asset.md#asset.add)
[function add(attributes: AssetMap): Promise<void>](../reference/apis/js-apis-asset.md#asset.add-1)
参数列表:
| 必选参数名称 | 描述 |
| -------- | -------- |
| ALIAS | 关键资产别名,每条关键资产的唯一索引 |
| SECRET | 关键资产明文 |
- 代码示例
xxx
- 可选参数介绍
| 可选参数名称 | 描述 |
| -------- | -------- |
| ACCESSIBILITY | 访问控制属性,取值范围详见[asset.Accessibility](../reference/apis/js-apis-asset.md#asset.Accessibility) |
@ -88,7 +79,14 @@ Asset在基础关键资产管理能力之外提供了可选的用户认证访
| IS_PERSISTENT | 关键资产在应用卸载时是否需要保留<br>**需要权限ohos.permission.STORE_PERSISTENT_DATA** |
- 约束和限制(会话??性能??并发??存储数量??)
### 代码示例
xxx
### 约束和限制
会话??性能??并发??存储数量??
## 查询关键资产
@ -288,4 +286,4 @@ attributesToUpdate的可选参数有
| DATA_LABEL_NORMAL_1 | 关键资产附属信息,内容由业务自定义且无完整性保护 |
| DATA_LABEL_NORMAL_2 | 关键资产附属信息,内容由业务自定义且无完整性保护 |
| DATA_LABEL_NORMAL_3 | 关键资产附属信息,内容由业务自定义且无完整性保护 |
| DATA_LABEL_NORMAL_4 | 关键资产附属信息,内容由业务自定义且无完整性保护 |
| DATA_LABEL_NORMAL_4 | 关键资产附属信息,内容由业务自定义且无完整性保护 |