OpenHarmony实战开发-Data Loss Prevention Kit开发指导

DLP是系统提供的系统级的数据防泄漏解决方案，提供一种称为DLP的文件格式。后缀格式为“原始文件名（包含原始文件后缀）.dlp”，例如: “test.docx.dlp”，文件由授权凭证和原始文件密文组成。

通过端云协同认证（需要联网）来获取文件的访问授权，授权类型包含只读、编辑、文档拥有者三种。

• 只读：能读取文档内容但不能修改。
• 编辑：能够读写文档内容，但不能修改文档权限配置。
• 文档拥有者：可读写文件、修改权限配置、恢复原始原始文件等。

应用需要访问DLP文件时，系统会自动安装应用的DLP沙箱分身应用，相当于完全独立的应用，数据和配置会继承原应用，但相互之间并不共享。分身应用在运行时会处于DLP沙箱环境中，访问外部的权限会被限制，以防止数据的泄漏。每当打开一个新的DLP文档会生成一个应用沙箱分身，沙箱应用之间也是相互隔离的，当应用关闭后应用分身会自动卸载，沙箱期间产生的临时数据也会丢弃。

正常情况下，应用不会感知到沙箱的存在，访问的也是解密后的明文，和访问普通文档没有区别，但由于DLP沙箱会限制其访问外部的权限（例如网络、剪切板、截屏、录屏、蓝牙等）。为了更好的用户体验，需要应用进行适配，例如文件只读的情况下，不应显示“保存”按钮，不应主动联网等。

沙箱限制

当应用进入DLP沙箱状态时，可以申请的权限将受到限制，根据DLP文件授权类型不同，限制也不相同，如下表：

接口说明

开发步骤

1.引入dlpPermission模块。

import dlpPermission from '@ohos.dlpPermission';

2.打开DLP文件，系统会自动安装应用的DLP沙箱分身应用。以下代码应在应用页Ability中使用。

async OpenDlpFile(dlpUri: string, fileName: string, fd: number) {
  let want:Want = {
    "action": "ohos.want.action.viewData",
    "bundleName": "com.example.example_bundle_name",
    "abilityName": "exampleAbility",
    "uri": dlpUri,
    "parameters": {
      "fileName": {
        "name": fileName
      },
      "keyFd": {
        "type": "FD",
        "value": fd
      }
    }
  }

  try {
    console.log('openDLPFile:' + JSON.stringify(want));
    console.log('openDLPFile: delegator:' + JSON.stringify(this.context));
    this.context.startAbility(want);
  } catch (err) {
    console.error('openDLPFile startAbility failed', (err as BusinessError).code, (err as BusinessError).message);
    return;
  }
}

以上代码需要在module.json5文件中增加ohos.want.action.viewData：

 "skills":[
    {
      "entities":[
        ...
      ],
      "actions":[
        ...
        "ohos.want.action.viewData"
      ]
    }
  ]

3.查询当前应用是否在沙箱中。

dlpPermission.isInSandbox().then((data)=> {
  console.log('isInSandbox, result: ' + JSON.stringify(data));
}).catch((err:BusinessError) => {
  console.log('isInSandbox: ' + JSON.stringify(err));
});

4.查询当前编辑的文档权限，根据文档授权的不同，DLP沙箱被限制的权限有所不同，参考沙箱限制。

dlpPermission.getDLPPermissionInfo().then((data)=> {
  console.log('getDLPPermissionInfo, result: ' + JSON.stringify(data));
}).catch((err:BusinessError) => {
  console.log('getDLPPermissionInfo: ' + JSON.stringify(err));
});

5.获取当前可支持DLP方案的文件扩展名类型列表，用于应用判断能否生成DLP文档，可用在实现类似文件管理器设置DLP权限的场景。

dlpPermission.getDLPSupportedFileTypes((err, result) => {
  console.log('getDLPSupportedFileTypes: ' + JSON.stringify(err));
  console.log('getDLPSupportedFileTypes: ' + JSON.stringify(result));
});

6.判断当前打开文件是否是DLP文件。

import dlpPermission from '@ohos.dlpPermission';
import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fs.openSync(uri);
try {
  let res = dlpPermission.isDLPFile(file.fd); // 是否加密DLP文件
  console.info('res', res);
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错
}
fs.closeSync(file);

7.订阅、取消订阅DLP打开事件。

event(info: dlpPermission.AccessedDLPFileInfo) {
  console.info('openDlpFile event', info.uri, info.lastOpenTime)
}
unSubscribe() {
  try {
    dlpPermission.off('openDLPFile', this.event); // 取消订阅
  } catch (err) {
    console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错
  }
}
subscribe() {
  try {
    dlpPermission.on('openDLPFile', this.event); // 订阅
  } catch (err) {
    console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错
  }
}
onCreate() {
 this.subscribe();
}
onDestroy() {
 this.unSubscribe();
}

8.获取DLP文件打开记录。

async getDLPFileAccessRecords() {
  try {
    let res:Array<dlpPermission.AccessedDLPFileInfo> = await dlpPermission.getDLPFileAccessRecords(); // 获取DLP访问列表
    console.info('res', JSON.stringify(res))
  } catch (err) {
    console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错
  }
}

9.获取DLP文件保留沙箱记录。

async getRetentionSandboxList() {
  try {
    let res:Array<dlpPermission.RetentionSandboxInfo> = await dlpPermission.getRetentionSandboxList(); // 获取沙箱保留列表
    console.info('res', JSON.stringify(res))
  } catch (err) {
    console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错
  }
}

10.设置沙箱应用配置信息。

async setSandboxAppConfig() {
  try {
    await dlpPermission.setSandboxAppConfig('configInfo'); // 设置沙箱应用配置信息
  } catch (err) {
    console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错
  }
}

11.清理沙箱应用配置信息。

async cleanSandboxAppConfig() {
  try {
    await dlpPermission.cleanSandboxAppConfig(); // 清理沙箱应用配置信息
  } catch (err) {
    console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错
  }
}

12.查询沙箱应用配置信息。

async getSandboxAppConfig() {
  try {
    let res:string = await dlpPermission.getSandboxAppConfig(); // 查询沙箱应用配置信息
    console.info('res', JSON.stringify(res))
  } catch (err) {
    console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错
  }
}

13.以无边框形式打开DLP权限管理应用。此方法只能在UIAbility上下文中调用，只支持Stage模式。

import dlpPermission from '@ohos.dlpPermission';
import common from '@ohos.app.ability.common';
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
import UIAbility from '@ohos.app.ability.UIAbility'
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';

try {
  let context = getContext() as common.UIAbilityContext; // 获取当前UIAbilityContext
  let want: Want = {
    "uri": "file://docs/storage/Users/currentUser/Desktop/1.txt",
    "parameters": {
      "displayName": "1.txt"
    }
  }; // 请求参数
  dlpPermission.startDLPManagerForResult(context, want).then((res) => {
    console.info('res.resultCode', res.resultCode);
    console.info('res.want', JSON.stringify(res.want));
  }); // 打开DLP权限管理应用
} catch (err) {
  console.error('error', err.code, err.message); // 失败报错
}

如果大家还没有掌握鸿蒙，现在想要在最短的时间里吃透它，我这边特意整理了《鸿蒙语法ArkTS、TypeScript、ArkUI、教学视频》以及《鸿蒙生态应用开发白皮书V2.0PDF》《鸿蒙开发学习手册》（共计890页）鸿蒙相关开发资料等…希望对大家有所帮助：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

鸿蒙语法ArkTS、TypeScript、ArkUI等…视频教程：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

OpenHarmony APP开发教程步骤：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

鸿蒙生态应用开发白皮书V2.0PDF：https://docs.qq.com/doc/DZVVkRGRUd3pHSnFG

南北双向高工技能基础：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

应用开发中高级就业技术：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

全网首发-工业级 南向设备开发就业技术：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

《鸿蒙开发学习手册》：

如何快速入门：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

1.基本概念
2.构建第一个ArkTS应用
3.……

开发基础知识：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

1.应用基础知识
2.配置文件
3.应用数据管理
4.应用安全管理
5.应用隐私保护
6.三方应用调用管控机制
7.资源分类与访问
8.学习ArkTS语言
9.……

基于ArkTS 开发：https://docs.qq.com/doc/DZVVBYlhuRkZQZlB3

1.Ability开发
2.UI开发
3.公共事件与通知
4.窗口管理
5.媒体
6.安全
7.网络与链接
8.电话服务
9.数据管理
10.后台任务(Background Task)管理
11.设备管理
12.设备使用信息统计
13.DFX
14.国际化开发
15.折叠屏系列
16.……