Data Loss Prevention Kit開(kāi)發(fā)指導(dǎo)

DLP是系統(tǒng)提供的系統(tǒng)級(jí)的數(shù)據(jù)防泄漏解決方案，提供一種稱(chēng)為DLP的文件格式。后綴格式為“原始文件名（包含原始文件后綴）.dlp”，例如: “test.docx.dlp”，文件由授權(quán)憑證和原始文件密文組成。

通過(guò)端云協(xié)同認(rèn)證（需要聯(lián)網(wǎng)）來(lái)獲取文件的訪問(wèn)授權(quán)，授權(quán)類(lèi)型包含只讀、編輯、文件擁有者三種。

• 只讀：能讀取文件內(nèi)容但不能修改。
• 編輯：能夠讀寫(xiě)文件內(nèi)容，但不能修改文件權(quán)限配置。
• 文件擁有者：可讀寫(xiě)文件、修改權(quán)限配置、恢復(fù)原始原始文件等。
• 開(kāi)發(fā)前請(qǐng)熟悉鴻蒙開(kāi)發(fā)指導(dǎo)文檔 ：gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md點(diǎn)擊或者復(fù)制轉(zhuǎn)到。

應(yīng)用需要訪問(wèn)DLP文件時(shí)，系統(tǒng)會(huì)自動(dòng)安裝應(yīng)用的DLP沙箱分身應(yīng)用，相當(dāng)于完全獨(dú)立的應(yīng)用，數(shù)據(jù)和配置會(huì)繼承原應(yīng)用，但相互之間并不共享。分身應(yīng)用在運(yùn)行時(shí)會(huì)處于DLP沙箱環(huán)境中，訪問(wèn)外部的權(quán)限會(huì)被限制，以防止數(shù)據(jù)的泄漏。每當(dāng)打開(kāi)一個(gè)新的DLP文件會(huì)生成一個(gè)應(yīng)用沙箱分身，沙箱應(yīng)用之間也是相互隔離的，當(dāng)應(yīng)用關(guān)閉后應(yīng)用分身會(huì)自動(dòng)卸載，沙箱期間產(chǎn)生的臨時(shí)數(shù)據(jù)也會(huì)丟棄。

正常情況下，應(yīng)用不會(huì)感知到沙箱的存在，訪問(wèn)的也是解密后的明文，和訪問(wèn)普通文件沒(méi)有區(qū)別，但由于DLP沙箱會(huì)限制其訪問(wèn)外部的權(quán)限（例如網(wǎng)絡(luò)、剪切板、截屏、錄屏、藍(lán)牙等）。為了更好的用戶(hù)體驗(yàn)，需要應(yīng)用進(jìn)行適配，例如文件只讀的情況下，不應(yīng)顯示“保存”按鈕，不應(yīng)主動(dòng)聯(lián)網(wǎng)等。

沙箱限制

當(dāng)應(yīng)用進(jìn)入DLP沙箱狀態(tài)時(shí)，可以申請(qǐng)的權(quán)限將受到限制，根據(jù)DLP文件授權(quán)類(lèi)型不同，限制也不相同，如下表：

接口說(shuō)明

開(kāi)發(fā)步驟

1. 引入[dlpPermission]模塊。

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

2. 打開(kāi)DLP文件，系統(tǒng)會(huì)自動(dòng)安裝應(yīng)用的DLP沙箱分身應(yīng)用。以下代碼應(yīng)在應(yīng)用頁(yè)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. 查詢(xún)當(dāng)前應(yīng)用是否在沙箱中。

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

4. 查詢(xún)當(dāng)前編輯的文件權(quán)限，根據(jù)文件授權(quán)的不同，DLP沙箱被限制的權(quán)限有所不同，參考[沙箱限制]

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

5. 獲取當(dāng)前可支持DLP方案的文件擴(kuò)展名類(lèi)型列表，用于應(yīng)用判斷能否生成DLP文件，可用在實(shí)現(xiàn)類(lèi)似文件管理器設(shè)置DLP權(quán)限的場(chǎng)景。

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

6. 判斷當(dāng)前打開(kāi)文件是否是DLP文件。

   import { dlpPermission } from '@kit.DataLossPreventionKit';
   import { fileIo } from '@kit.CoreFileKit';
   import { BusinessError } from '@kit.BasicServicesKit';
   
   let uri = "file://docs/storage/Users/currentUser/Desktop/test.txt.dlp";
   let file = fileIo.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); // 失敗報(bào)錯(cuò)
   }
   fileIo.closeSync(file);
   

7. 訂閱、取消訂閱DLP打開(kāi)事件。

   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); // 失敗報(bào)錯(cuò)
     }
   }
   subscribe() {
     try {
       dlpPermission.on('openDLPFile', this.event); // 訂閱
     } catch (err) {
       console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失敗報(bào)錯(cuò)
     }
   }
   onCreate() {
    this.subscribe();
   }
   onDestroy() {
    this.unSubscribe();
   }
   

8. 獲取DLP文件打開(kāi)記錄。

   async getDLPFileAccessRecords() {
     try {
       let res:Array< dlpPermission.AccessedDLPFileInfo > = await dlpPermission.getDLPFileAccessRecords(); // 獲取DLP訪問(wèn)列表
       console.info('res', JSON.stringify(res))
     } catch (err) {
       console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失敗報(bào)錯(cuò)
     }
   }
   

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); // 失敗報(bào)錯(cuò)
     }
   }
   

10. 設(shè)置沙箱應(yīng)用配置信息。

async setSandboxAppConfig() {
  try {
    await dlpPermission.setSandboxAppConfig('configInfo'); // 設(shè)置沙箱應(yīng)用配置信息
  } catch (err) {
    console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失敗報(bào)錯(cuò)
  }
}

11. 清理沙箱應(yīng)用配置信息。

async cleanSandboxAppConfig() {
  try {
    await dlpPermission.cleanSandboxAppConfig(); // 清理沙箱應(yīng)用配置信息
  } catch (err) {
    console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失敗報(bào)錯(cuò)
  }
}

12. 查詢(xún)沙箱應(yīng)用配置信息。

async getSandboxAppConfig() {
  try {
    let res:string = await dlpPermission.getSandboxAppConfig(); // 查詢(xún)沙箱應(yīng)用配置信息
    console.info('res', JSON.stringify(res))
  } catch (err) {
    console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失敗報(bào)錯(cuò)
  }
}

13. 以無(wú)邊框形式打開(kāi)DLP權(quán)限管理應(yīng)用。此方法只能在UIAbility上下文中調(diào)用，只支持Stage模式。

import { dlpPermission } from '@kit.DataLossPreventionKit';
import { common, UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  let context = getContext() as common.UIAbilityContext; // 獲取當(dāng)前UIAbilityContext
  let want: Want = {
    "uri": "file://docs/storage/Users/currentUser/Desktop/1.txt",
    "parameters": {
      "displayName": "1.txt"
    }
  }; // 請(qǐng)求參數(shù)
  dlpPermission.startDLPManagerForResult(context, want).then((res) = > {
    console.info('res.resultCode', res.resultCode);
    console.info('res.want', JSON.stringify(res.want));
  }); // 打開(kāi)DLP權(quán)限管理應(yīng)用
} catch (err) {
  console.error('error', err.code, err.message); // 失敗報(bào)錯(cuò)
}

`HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿`

14. 查詢(xún)當(dāng)前系統(tǒng)是否提供DLP特性。

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

dlpPermission.isDLPFeatureProvided().then((res) = > {
  console.info('res', JSON.stringify(res));
}).catch((err: BusinessError) = > {
  console.error('error', (err as BusinessError).code, (err as BusinessError).message); // 失敗報(bào)錯(cuò)
});

審核編輯 黃宇