@ohos.dlpPermission (数据防泄漏)(系统接口)

数据防泄漏（DLP）是系统提供的系统级的数据防泄漏解决方案，提供跨设备的文件的权限管理、加密存储、授权访问等能力。

说明：

本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.dlpPermission (数据防泄漏)。

导入模块

import { dlpPermission } from '@kit.DataProtectionKit';

dlpPermission.getDLPGatheringPolicy

getDLPGatheringPolicy(): Promise<GatheringPolicyType>

查询DLP沙箱聚合策略。使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

返回值：

类型	说明
Promise<GatheringPolicyType>	Promise对象。返回当前DLP沙箱聚合策略。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
19100001	Invalid parameter value.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  let res: Promise<dlpPermission.GatheringPolicyType> = dlpPermission.getDLPGatheringPolicy(); // 获取沙箱聚合策略。
  console.info('res', JSON.stringify(res));
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}

dlpPermission.getDLPGatheringPolicy

getDLPGatheringPolicy(callback: AsyncCallback<GatheringPolicyType>): void

查询DLP沙箱聚合策略。使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
callback	AsyncCallback<GatheringPolicyType>	是	回调函数。err为undefine时表示查询成功；否则为错误对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Incorrect parameter types.
19100001	Invalid parameter value.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  dlpPermission.getDLPGatheringPolicy((err, res) => {
    if (err != undefined) {
      console.error('getDLPGatheringPolicy error,', err.code, err.message);
    } else {
      console.info('res', JSON.stringify(res));
    }
  }); // 获取沙箱聚合策略。
} catch (err) {
  console.error('getDLPGatheringPolicy error,', (err as BusinessError).code, (err as BusinessError).message);
}

dlpPermission.installDLPSandbox

installDLPSandbox(bundleName: string, access: DLPFileAccess, userId: number, uri: string): Promise<DLPSandboxInfo>

安装一个应用的DLP沙箱。使用Promise方式异步返回结果返回应用沙箱信息。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
bundleName	string	是	应用包名。最小7字节，最大128字节。
access	DLPFileAccess	是	DLP文件授权类型。
userId	number	是	当前的用户ID，通过账号子系统获取的OS账号ID，默认主用户ID：100。
uri	string	是	DLP文件的URI。不超过4095字节。

返回值：

类型	说明
Promise<DLPSandboxInfo>	Promise对象。安装沙箱应用，返回应用沙箱信息。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
try {
  let res: Promise<dlpPermission.DLPSandboxInfo> = dlpPermission.installDLPSandbox('com.ohos.note', dlpPermission.DLPFileAccess.READ_ONLY, 100, uri); // 安装DLP沙箱。
  console.info('res', JSON.stringify(res));
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}

dlpPermission.installDLPSandbox

installDLPSandbox(bundleName: string, access: DLPFileAccess, userId: number, uri:string, callback: AsyncCallback<DLPSandboxInfo>): void

安装一个应用的DLP沙箱。使用callback方式异步返回应用沙箱信息。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
bundleName	string	是	应用包名。最小7字节，最大128字节。
access	DLPFileAccess	是	DLP文件授权类型。
userId	number	是	当前的用户ID，通过账号子系统获取的系账号ID，默认主用户ID：100。
uri	string	是	DLP文件的URI。不超过4095字节。
callback	AsyncCallback<DLPSandboxInfo>	是	获取应用沙箱信息的回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
try {
  dlpPermission.installDLPSandbox('com.ohos.note', dlpPermission.DLPFileAccess.READ_ONLY, 100, uri, (err, res) => {
    if (err != undefined) {
      console.error('installDLPSandbox error,', err.code, err.message);
    } else {
      console.info('res', JSON.stringify(res));
    }
  }); // 安装DLP沙箱。
} catch (err) {
  console.error('installDLPSandbox error,', (err as BusinessError).code, (err as BusinessError).message);
}

dlpPermission.uninstallDLPSandbox

uninstallDLPSandbox(bundleName: string, userId: number, appIndex: number): Promise<void>

卸载一个应用的DLP沙箱。使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
bundleName	string	是	应用包名。最小7字节，最大128字节。
userId	number	是	当前的用户ID，通过账号子系统获取的系统账号ID，默认主用户ID：100。
appIndex	number	是	DLP沙箱号。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
try {
  dlpPermission.installDLPSandbox('com.ohos.note', dlpPermission.DLPFileAccess.READ_ONLY, 100, uri).then((res)=>{
    console.info('res', JSON.stringify(res));
    dlpPermission.uninstallDLPSandbox('com.ohos.note', 100, res.appIndex); // 卸载DLP沙箱。
  }); // 安装DLP沙箱。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}

dlpPermission.uninstallDLPSandbox

uninstallDLPSandbox(bundleName: string, userId: number, appIndex: number, callback: AsyncCallback<void>): void

卸载一个应用的DLP沙箱。使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
bundleName	string	是	应用包名。最小7字节，最大128字节。
userId	number	是	当前的用户ID，通过账号子系统获取的系统账号ID，默认主用户ID：100。
appIndex	number	是	DLP沙箱号，即installDLPSandbox接口调用成功后的返回值。
callback	AsyncCallback<void>	是	获取卸载结果的回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
try {
  dlpPermission.installDLPSandbox('com.ohos.note', dlpPermission.DLPFileAccess.READ_ONLY, 100, uri).then((res)=>{
    console.info('res', JSON.stringify(res));
    dlpPermission.uninstallDLPSandbox('com.ohos.note', 100, res.appIndex, (err, res) => {
      if (err != undefined) {
        console.error('uninstallDLPSandbox error,', err.code, err.message);
      } else {
        console.info('res', JSON.stringify(res));
      }
    });
  }); // 安装DLP沙箱。
} catch (err) {
  console.error('uninstallDLPSandbox error,', (err as BusinessError).code, (err as BusinessError).message);
}

dlpPermission.on('uninstallDLPSandbox')

on(type: 'uninstallDLPSandbox', listener: Callback<DLPSandboxState>): void

注册监听DLP沙箱卸载事件。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
type	'uninstallDLPSandbox'	是	监听事件类型。固定值为'uninstallDLPSandbox'：DLP沙箱卸载事件。
listener	Callback<DLPSandboxState>	是	沙箱应用卸载事件的回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
19100001	Invalid parameter value.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  dlpPermission.on('uninstallDLPSandbox', (info: dlpPermission.DLPSandboxState) => {
    console.info('uninstallDLPSandbox event', info.appIndex, info.bundleName)
  }); // 订阅。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错
}

dlpPermission.off('uninstallDLPSandbox')

off(type: 'uninstallDLPSandbox', listener?: Callback<DLPSandboxState>): void

取消监听DLP沙箱卸载事件。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
type	'uninstallDLPSandbox'	是	监听事件类型。固定值为'uninstallDLPSandbox'：DLP沙箱卸载事件。
listener	Callback<DLPSandboxState>	否	沙箱应用卸载事件的回调。默认为空，表示取消该类型事件的所有回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
19100001	Invalid parameter value.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  dlpPermission.off('uninstallDLPSandbox', (info: dlpPermission.DLPSandboxState) => {
    console.info('uninstallDLPSandbox event', info.appIndex, info.bundleName)
  }); // 取消订阅。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}

DLPFile

管理DLPFile的实例，表示一个DLP文件对象，需要通过generateDLPFile/openDLPFile获取DLPFile的示例。

属性

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Security.DataLossPrevention

名称	类型	只读	必填	说明
dlpProperty	DLPProperty	否	是	表示DLP文件授权相关信息。

addDLPLinkFile

addDLPLinkFile(linkFileName: string): Promise<void>

在FUSE文件系统(Filesystem in Userspace)添加link文件(FUSE文件系统中映射到密文的虚拟文件，对该文件的读写操作会同步到DLP文件)。使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
linkFileName	string	是	用于fuse文件系统的link文件名。不超过255字节。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.addDLPLinkFile('test.txt.dlp.link'); // 添加link文件。
    dlpFile.closeDLPFile(); //关闭DLP对象。
  }); // 打开DLP文件。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}
fileIo.closeSync(file);

addDLPLinkFile

addDLPLinkFile(linkFileName: string, callback: AsyncCallback<void>): void

在FUSE中添加link文件，使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
linkFileName	string	是	用于fuse文件系统的link文件名。不超过255字节。
callback	AsyncCallback<void>	是	获取添加结果的回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.addDLPLinkFile('test.txt.dlp.link', async (err, res) => {
      if (err != undefined) {
        console.error('addDLPLinkFile error,', err.code, err.message);
        await dlpFile.closeDLPFile(); //关闭DLP对象。
      } else {
        console.info('res', JSON.stringify(res));
      }
    });
  }); // 打开DLP文件。
} catch (err) {
  console.error('addDLPLinkFile error,', (err as BusinessError).code, (err as BusinessError).message);
}

stopFuseLink

stopFuseLink(): Promise<void>

停止FUSE关联读写。使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.addDLPLinkFile('test.txt.dlp.link'); // 添加link文件。
    dlpFile.stopFuseLink(); // 暂停link读写。
    dlpFile.closeDLPFile(); //关闭DLP对象。
  }); // 打开DLP文件。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}
fileIo.closeSync(file);

stopFuseLink

stopFuseLink(callback: AsyncCallback<void>): void

停止FUSE关联读写，使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	获取停止结果的回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Incorrect parameter types.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.addDLPLinkFile('test.txt.dlp.link'); // 添加link文件。
    dlpFile.stopFuseLink(async (err, res) => {
      if (err != undefined) {
        console.error('stopFuseLink error,', err.code, err.message);
        await dlpFile.closeDLPFile(); //关闭DLP对象。
      } else {
        console.info('res', JSON.stringify(res));
      }
    });
  }); // 打开DLP文件。
} catch (err) {
  console.error('stopFuseLink error,', (err as BusinessError).code, (err as BusinessError).message);
}

resumeFuseLink

resumeFuseLink(): Promise<void>

恢复FUSE关联读写。使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.addDLPLinkFile('test.txt.dlp.link'); // 添加link文件。
    dlpFile.stopFuseLink(); // 暂停link读写。
    dlpFile.resumeFuseLink(); // 恢复link读写。
    dlpFile.closeDLPFile(); //关闭DLP对象。
  }); // 打开DLP文件。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}
fileIo.closeSync(file);

resumeFuseLink

resumeFuseLink(callback: AsyncCallback<void>): void

恢复FUSE关联读写，使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	获取恢复结果的回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Incorrect parameter types.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.addDLPLinkFile('test.txt.dlp.link'); // 添加link文件。
    dlpFile.stopFuseLink(); // 暂停link读写。
    dlpFile.resumeFuseLink(async (err, res) => {
      if (err != undefined) {
        console.error('resumeFuseLink error,', err.code, err.message);
        await dlpFile.closeDLPFile(); //关闭DLP对象。
      } else {
        console.info('res', JSON.stringify(res));
      }
    });
  }); // 打开DLP文件。
} catch (err) {
  console.error('resumeFuseLink error,', (err as BusinessError).code, (err as BusinessError).message);
}

replaceDLPLinkFile

replaceDLPLinkFile(linkFileName: string): Promise<void>

替换link文件。使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
linkFileName	string	是	用于fuse文件系统的link文件名。不超过255字节。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.addDLPLinkFile('test.txt.dlp.link'); // 添加link文件。
    dlpFile.stopFuseLink(); // 暂停link读写。
    dlpFile.replaceDLPLinkFile('test_new.txt.dlp.link'); // 替换link文件。
    dlpFile.resumeFuseLink(); // 恢复link读写。
    dlpFile.closeDLPFile(); //关闭DLP对象。
  }); // 打开DLP文件。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}
fileIo.closeSync(file);

replaceDLPLinkFile

replaceDLPLinkFile(linkFileName: string, callback: AsyncCallback<void>): void

替换link文件，使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
linkFileName	string	是	用于fuse文件系统的link文件名。不超过255字节。
callback	AsyncCallback<void>	是	获取替换结果的回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.addDLPLinkFile('test.txt.dlp.link'); // 添加link文件。
    dlpFile.stopFuseLink(); // 暂停link读写。
    dlpFile.replaceDLPLinkFile('test_new.txt.dlp.link', async (err, res) => { // 替换link文件。
      if (err != undefined) {
        console.error('replaceDLPLinkFile error,', err.code, err.message);
        await dlpFile.closeDLPFile(); //关闭DLP对象。
      } else {
        console.info('res', JSON.stringify(res));
        await dlpFile.resumeFuseLink(); // 恢复link读写。
      }
    });
  }); // 打开DLP文件。
} catch (err) {
  console.error('error,', (err as BusinessError).code, (err as BusinessError).message);
}

deleteDLPLinkFile

deleteDLPLinkFile(linkFileName: string): Promise<void>

删除fuse文件系统中创建的link文件。使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
linkFileName	string	是	用于fuse文件系统的link文件名。不超过255字节。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.addDLPLinkFile('test.txt.dlp.link'); // 添加link文件。
    dlpFile.deleteDLPLinkFile('test.txt.dlp.link'); // 删除link文件。
    dlpFile.closeDLPFile(); //关闭DLP对象。
  }); // 打开DLP文件。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}
fileIo.closeSync(file);

deleteDLPLinkFile

deleteDLPLinkFile(linkFileName: string, callback: AsyncCallback<void>): void

删除link文件，使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
linkFileName	string	是	用于fuse文件系统的link文件名。不超过255字节。
callback	AsyncCallback<void>	是	获取删除结果的回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.addDLPLinkFile('test.txt.dlp.link'); // 添加link文件。
    dlpFile.deleteDLPLinkFile('test.txt.dlp.link', async (err, res) => { // 删除link文件。
      if (err != undefined) {
        console.error('deleteDLPLinkFile error,', err.code, err.message);
        await dlpFile.closeDLPFile(); //关闭DLP对象。
      } else {
        console.info('res', JSON.stringify(res));
      }
    });
  }); // 打开DLP文件。
} catch (err) {
  console.error('error,', (err as BusinessError).code, (err as BusinessError).message);
}

recoverDLPFile

recoverDLPFile(plaintextFd: number): Promise<void>

移除DLP文件的权限控制，恢复成明文文件。使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
plaintextFd	number	是	目标明文文件的fd。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100002	Credential task error.
19100003	Credential task time out.
19100004	Credential service error.
19100005	Credential authentication server error.
19100008	The file is not a DLP file.
19100009	Failed to operate the DLP file.
19100010	The DLP file is read only.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

let destFile = fileIo.openSync("destUri");
try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.recoverDLPFile(destFile.fd); // 还原DLP文件。
    dlpFile.closeDLPFile(); //关闭DLP对象。
  }); // 打开DLP文件。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}
fileIo.closeSync(file);
fileIo.closeSync(destFile);

recoverDLPFile

recoverDLPFile(plaintextFd: number, callback: AsyncCallback<void>): void

移除DLP文件的权限控制，恢复成明文文件，使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
plaintextFd	number	是	目标明文文件的fd。
callback	AsyncCallback<void>	是	获取恢复结果的回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100002	Credential task error.
19100003	Credential task time out.
19100004	Credential service error.
19100005	Credential authentication server error.
19100008	The file is not a DLP file.
19100009	Failed to operate the DLP file.
19100010	The DLP file is read only.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

let destFile = fileIo.openSync("destUri");
try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.recoverDLPFile(destFile.fd, async (err, res) => { // 还原DLP文件。
      if (err != undefined) {
        console.error('recoverDLPFile error,', err.code, err.message);
        await dlpFile.closeDLPFile(); //关闭DLP对象。
      } else {
        console.info('res', JSON.stringify(res));
      }
    });
  }); // 打开DLP文件。
} catch (err) {
  console.error('error,', (err as BusinessError).code, (err as BusinessError).message);
}

closeDLPFile

closeDLPFile(): Promise<void>

关闭DLPFile，释放对象。使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

说明：

dlpFile不再使用，应该关闭释放内存，且对象不应继续使用。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.closeDLPFile(); //关闭DLP对象。
  }); // 打开DLP文件。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}
fileIo.closeSync(file);

closeDLPFile

closeDLPFile(callback: AsyncCallback<void>): void

关闭DLPFile，释放对象，使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

说明：

dlpFile不再使用，应该关闭释放内存，且对象不应继续使用。

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	获取关闭结果的回调。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Incorrect parameter types.
19100001	Invalid parameter value.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.closeDLPFile((err, res) => { // 关闭DLP文件。
      if (err != undefined) {
        console.error('closeDLPFile error,', err.code, err.message);
      } else {
        console.info('res', JSON.stringify(res));
      }
      fileIo.closeSync(file);
    });
  }); // 打开DLP文件。
} catch (err) {
  console.error('error,', (err as BusinessError).code, (err as BusinessError).message);
  fileIo.closeSync(file);
}

dlpPermission.generateDLPFile

generateDLPFile(plaintextFd: number, ciphertextFd: number, property: DLPProperty): Promise<DLPFile>

将明文文件加密生成权限受控文件，仅在授权列表内的用户可以打开，授权又分为完全控制权限和只读权限。获取DLPFile管理对象，使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
plaintextFd	number	是	待加密明文文件的fd。
ciphertextFd	number	是	目标加密文件的fd。
property	DLPProperty	是	授权用户信息：授权用户列表、owner账号、联系人账号。

返回值：

类型	说明
Promise<DLPFile>	Promise对象。返回对象表示成功生成DLP文件，返回null表示失败。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100002	Credential task error.
19100003	Credential task time out.
19100004	Credential service error.
19100005	Credential authentication server error.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';

let dlpUri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt";
let file = fileIo.openSync(uri);
let dlp = fileIo.openSync(dlpUri);
try {
  let dlpProperty: dlpPermission.DLPProperty = {
    ownerAccount: 'zhangsan',
    ownerAccountType: dlpPermission.AccountType.DOMAIN_ACCOUNT,
    authUserList: [],
    contactAccount: 'zhangsan',
    offlineAccess: true,
    ownerAccountID: 'xxxxxxx',
    everyoneAccessList: []
  };
  dlpPermission.generateDLPFile(file.fd, dlp.fd, dlpProperty).then((dlpFile)=>{
    dlpFile.closeDLPFile(); //关闭DLP对象。
  }); // 生成DLP文件。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}
fileIo.closeSync(file);
fileIo.closeSync(dlp);

dlpPermission.generateDLPFile

generateDLPFile(plaintextFd: number, ciphertextFd: number, property: DLPProperty, callback: AsyncCallback<DLPFile>): void

DLP管理应用调用该接口，将明文文件加密生成权限受控文件，仅在授权列表内的用户可以打开，授权又分为完全控制权限和只读权限。获取DLPFile管理对象，使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
plaintextFd	number	是	待加密明文文件的fd。
ciphertextFd	number	是	目标加密文件的fd。
property	DLPProperty	是	授权用户信息：授权用户列表、owner账号、联系人账号。
callback	AsyncCallback<DLPFile>	是	回调函数。返回DLPFile对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100002	Credential task error.
19100003	Credential task time out.
19100004	Credential service error.
19100005	Credential authentication server error.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';

let dlpUri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt";
let file = fileIo.openSync(uri);
let dlp = fileIo.openSync(dlpUri);
try {
  let dlpProperty: dlpPermission.DLPProperty = {
    ownerAccount: 'zhangsan',
    ownerAccountType: dlpPermission.AccountType.DOMAIN_ACCOUNT,
    authUserList: [],
    contactAccount: 'zhangsan',
    offlineAccess: true,
    ownerAccountID: 'xxxxxxx',
    everyoneAccessList: []
  };
  dlpPermission.generateDLPFile(file.fd, dlp.fd, dlpProperty, (err, res) => { // 生成DLP文件。
    if (err != undefined) {
      console.error('generateDLPFile error,', err.code, err.message);
    } else {
      console.info('res', JSON.stringify(res));
    }
  });
} catch (err) {
  console.error('error,', (err as BusinessError).code, (err as BusinessError).message);
  fileIo.closeSync(file);
}

dlpPermission.openDLPFile¹¹⁺

openDLPFile(ciphertextFd: number, appId: string): Promise<DLPFile>

打开DLP文件。获取DLPFile管理对象，使用Promise方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
ciphertextFd	number	是	加密文件的fd。
appId	string	是	调用方身份。最小8字节，最大1024字节。

返回值：

类型	说明
Promise<DLPFile>	Promise对象。返回对象表示打开生成DLP文件，返回null表示失败。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100002	Credential task error.
19100003	Credential task time out.
19100004	Credential service error.
19100005	Credential authentication server error.
19100008	The file is not a DLP file.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.
19100018	Not authorized application.
19100019	The DLP file has expired.
19100020	No network connection.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId).then((dlpFile)=>{
    dlpFile.closeDLPFile(); //关闭DLP对象。
  }); // 打开DLP文件。
} catch (err) {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失败报错。
}
fileIo.closeSync(file);

dlpPermission.openDLPFile¹¹⁺

openDLPFile(ciphertextFd: number, appId: string, callback: AsyncCallback<DLPFile>): void

DLP管理应用调用该接口，打开DLP文件。获取DLPFile管理对象，使用callback方式异步返回结果。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
ciphertextFd	number	是	加密文件的fd。
appId	string	是	调用方身份。最小8字节，最大1024字节。
callback	AsyncCallback<DLPFile>	是	回调函数。返回DLPFile对象。

错误码：

以下错误码的详细介绍请参见DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
19100001	Invalid parameter value.
19100002	Credential task error.
19100003	Credential task time out.
19100004	Credential service error.
19100005	Credential authentication server error.
19100008	The file is not a DLP file.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.
19100018	Not authorized application.
19100019	The DLP file has expired.
19100020	No network connection.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
let file = fileIo.openSync(uri);
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO;
let appId = "";
let bundleName = 'com.ohos.note';
let userId = 100;

try{
  bundleManager.getBundleInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
      console.error('error', err.code, err.message);
    } else {
      appId = data.signatureInfo.appId;
    }
  })
} catch (err) {
  console.error('error', err.code, err.message);
}

try {
  dlpPermission.openDLPFile(file.fd, appId, (err, res) => { // 打开DLP文件。
    if (err != undefined) {
      console.error('openDLPFile error,', err.code, err.message);
    } else {
      console.info('res', JSON.stringify(res));
    }
  });
} catch (err) {
  console.error('error,', (err as BusinessError).code, (err as BusinessError).message);
  fileIo.closeSync(file);
}

dlpPermission.generateDlpFileForEnterprise²⁰⁺

generateDLPFileForEnterprise(plaintextFd: number, dlpFd: number, property: DLPProperty, customProperty: CustomProperty): Promise<void>

获取DLPFile管理对象。使用Promise异步回调。

说明：

使用该接口可以将明文文件加密生成权限受控文件，仅拥有完全控制权限的用户可以打开。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ENTERPEISE_ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
plaintextFd	number	是	明文文件的fd。
dlpFd	number	是	加密文件的fd。
property	DLPProperty	是	DLP文件通用策略。
customProperty	CustomProperty	是	企业定制策略。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
19100001	Invalid parameter value.
19100002	Credential service busy due to too many tasks or duplicate tasks.
19100003	Credential task time out.
19100004	Credential service error.
19100005	Credential authentication server error.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';

async function(plainFilePath: string, dlpFilePath: string) {
  let plaintextFd = fileIo.openSync(plainFilePath, fileIo.OpenMode.READ_ONLY).fd;
  let dlpFd = fileIo.openSync(dlpFilePath, fileIo.OpenMode.READ_WRITE | fileIo.OpenMode.CREATE).fd;
  let dlpProperty: dlpPermission.DLPProperty = {
    ownerAccount: 'zhangsan',
    ownerAccountType: dlpPermission.AccountType.DOMAIN_ACCOUNT,
    authUserList: [],
    contactAccount: 'zhangsan',
    offlineAccess: true,
    ownerAccountID: 'xxxxxxx',
    everyoneAccessList: []
  };
  let customProperty: dlpPermission.CustomProperty = {
    enterprise: "customProperty"
  };
  try {
    dlpPermission.generateDlpFileForEnterprise(plaintextFd, dlpFd, dlpProperty, customProperty).then(() => {
      console.info('Successfully generate DLP file for enterprise.');
      fileIo.closeSync(plaintextFd);
      fileIo.closeSync(dlpFd);
    });
  } catch(err) {
    console.error('error,', (err as BusinessError).code, (err as BusinessError).message);
    fileIo.closeSync(plaintextFd);
    fileIo.closeSync(dlpFd);
  }
}

dlpPermission.decryptDlpFile²⁰⁺

decryptDlpFile(dlpFd: number, plaintextFd: number): Promise<void>

将DLP文件解密生成明文文件。使用Promise异步回调。

说明：

仅拥有完全控制权限的用户可以解密DLP文件。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ENTERPEISE_ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
dlpFd	number	是	待解密文件的fd。
plaintextFd	number	是	目标解密文件的fd。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
19100001	Invalid parameter value.
19100002	Credential service busy due to too many tasks or duplicate tasks.
19100003	Credential task time out.
19100004	Credential service error.
19100005	Credential authentication server error.
19100009	Failed to operate the DLP file.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';

async function(plainFilePath: string, dlpFilePath: string) {
  let plaintextFd = fileIo.openSync(plainFilePath, fileIo.OpenMode.READ_WRITE | fileIo.OpenMode.CREATE).fd;
  let dlpFd = fileIo.openSync(dlpFilePath, fileIo.OpenMode.READ_ONLY).fd;
  try {
    dlpPermission.decryptDlpFile(dlpFd, plaintextFd).then(() => {
      console.info('Successfully decrypt DLP file.');
      fileIo.closeSync(plaintextFd);
      fileIo.closeSync(dlpFd);
    });
  } catch(err) {
    console.error('error,', (err as BusinessError).code, (err as BusinessError).message);
    fileIo.closeSync(plaintextFd);
    fileIo.closeSync(dlpFd);
  }
}

dlpPermission.queryDlpPolicy²⁰⁺

queryDlpPolicy(dlpFd: number): Promise<string>

在DLP文件中解析文件头，获取DLP明文策略。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.ENTERPEISE_ACCESS_DLP_FILE

系统能力： SystemCapability.Security.DataLossPrevention

参数：

参数名	类型	必填	说明
dlpFd	number	是	待解密文件的fd。

返回值：

类型	说明
Promise<string>	Promise对象，返回当前DLP策略的json字符串。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和DLP服务错误码。

错误码ID	错误信息
201	Permission denied.
202	Non-system applications use system APIs.
19100001	Invalid parameter value.
19100011	The system ability works abnormally.

示例：

import { dlpPermission } from '@kit.DataProtectionKit';
import { fileIo } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';

async function(dlpFilePath: string) {
  let dlpFd = fileIo.openSync(dlpFilePath, fileIo.OpenMode.READ_ONLY).fd;
  try {
    dlpPermission.queryDlpPolicy(dlpFd).then((policy: string) => {
      console.info('DLP policy:' + policy);
      fileIo.closeSync(dlpFd);
    });
  } catch(err) {
    console.error('error,', (err as BusinessError).code, (err as BusinessError).message);
    fileIo.closeSync(dlpFd);
  }
}

DLPSandboxInfo

表示DLP沙箱的信息。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Security.DataLossPrevention

名称	类型	可读	可写	说明
appIndex	number	是	否	表示DLP沙箱应用索引。
tokenID	number	是	否	表示DLP沙箱应用的tokenID。

DLPSandboxState

DLP沙箱身份。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Security.DataLossPrevention

名称	类型	可读	可写	说明
bundleName	string	是	否	表示应用包名。最小7字节，最大128字节。
appIndex	number	是	否	表示DLP沙箱应用索引。

AccountType

授权账号类型的枚举。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Security.DataLossPrevention

名称	值	说明
CLOUD_ACCOUNT	1	表示云账号。
DOMAIN_ACCOUNT	2	表示域账号。

ActionType²⁰⁺

表示在文件设定的权限时间到期后所执行的动作，默认为NOT_OPEN。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Security.DataLossPrevention

名称	值	说明
NOT_OPEN	0	表示超过权限管控时间后，用户无权限打开DLP文件。
OPEN	1	表示超过权限管控时间后，登录账号的用户拥有编辑权限。

AuthUser

表示授权用户数据。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Security.DataLossPrevention

名称	类型	只读	必填	说明
authAccount	string	否	是	表示被授权用户账号。不超过255字节。
authAccountType	AccountType	否	是	表示被授权用户账号类型。
dlpFileAccess	DLPFileAccess	否	是	表示被授予的权限。
permExpiryTime	number	否	是	表示授权到期时间。

CustomProperty²⁰⁺

表示自定义策略。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Security.DataLossPrevention

名称	类型	只读	可选	说明
enterprise	string	否	否	表示企业定制策略的json字符串。长度不超过4M（单位：兆）。

DLPProperty

表示授权相关信息。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Security.DataLossPrevention

名称	类型	只读	必填	说明
ownerAccount	string	否	是	表示权限设置者账号。不超过255字节。
ownerAccountID	string	否	是	表示权限设置者账号的ID。不超过255字节。
ownerAccountType	AccountType	否	是	表示权限设置者账号类型。
authUserList	Array<AuthUser>	否	否	表示授权用户列表，默认为空。
contactAccount	string	否	是	表示联系人账号。不超过255字节。
offlineAccess	boolean	否	是	表示是否是离线打开。true表示允许离线打开，false表示不可离线打开。
everyoneAccessList	Array<DLPFileAccess>	否	否	表示授予所有人的权限，默认为空。
expireTime¹¹⁺	number	否	否	表示文件权限到期时间戳，默认为空。
actionUponExpiry²⁰⁺	ActionType	否	否	表示到期后文件是否允许打开（打开后拥有编辑权限），仅在expireTime不为空时生效。

GatheringPolicyType

DLP沙箱聚合策略类型的枚举。沙箱聚合表示同一权限类型的DLP文件，在同一个沙箱内打开，例如在同一个沙箱内使用不同tab页打开；沙箱非聚合表示不同DLP文件在不同沙箱打开。

系统能力： SystemCapability.Security.DataLossPrevention

系统接口： 此接口为系统接口。

参数：

名称	值	说明
GATHERING	1	表示沙箱聚合。
NON_GATHERING	2	表示沙箱非聚合。

OpenHarmony/docs .gitee-modal { width: 500px !important; }

@ohos.dlpPermission (数据防泄漏)(系统接口)

导入模块

dlpPermission.getDLPGatheringPolicy

dlpPermission.getDLPGatheringPolicy

dlpPermission.installDLPSandbox

dlpPermission.installDLPSandbox

dlpPermission.uninstallDLPSandbox

dlpPermission.uninstallDLPSandbox

dlpPermission.on('uninstallDLPSandbox')

dlpPermission.off('uninstallDLPSandbox')

DLPFile

属性

addDLPLinkFile

addDLPLinkFile

stopFuseLink

stopFuseLink

resumeFuseLink

resumeFuseLink

replaceDLPLinkFile

replaceDLPLinkFile

deleteDLPLinkFile

deleteDLPLinkFile

recoverDLPFile

recoverDLPFile

closeDLPFile

closeDLPFile

dlpPermission.generateDLPFile

dlpPermission.generateDLPFile

dlpPermission.openDLPFile11+

dlpPermission.openDLPFile11+

dlpPermission.generateDlpFileForEnterprise20+

dlpPermission.decryptDlpFile20+

dlpPermission.queryDlpPolicy20+

DLPSandboxInfo

DLPSandboxState

AccountType

ActionType20+

AuthUser

CustomProperty20+

DLPProperty

GatheringPolicyType

简介

发行版 (1)

OpenHarmony 开源评估指数

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者 (3043)

语言

近期动态

搜索帮助

OpenHarmony/docs

dlpPermission.openDLPFile¹¹⁺

dlpPermission.openDLPFile¹¹⁺

dlpPermission.generateDlpFileForEnterprise²⁰⁺

dlpPermission.decryptDlpFile²⁰⁺

dlpPermission.queryDlpPolicy²⁰⁺

ActionType²⁰⁺

CustomProperty²⁰⁺