Data Loss Prevention Kit開發指導

DLP是系統提供的系統級的數據防泄漏解決方案，提供一種稱為DLP的文件格式。后綴格式為“原始文件名（包含原始文件后綴）.dlp”，例如: “test.docx.dlp”，文件由授權憑證和原始文件密文組成。

通過端云協同認證（需要聯網）來獲取文件的訪問授權，授權類型包含只讀、編輯、文件擁有者三種。

• 只讀：能讀取文件內容但不能修改。
• 編輯：能夠讀寫文件內容，但不能修改文件權限配置。
• 文件擁有者：可讀寫文件、修改權限配置、恢復原始原始文件等。
• 開發前請熟悉鴻蒙開發指導文檔 ：gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md點擊或者復制轉到。

應用需要訪問DLP文件時，系統會自動安裝應用的DLP沙箱分身應用，相當于完全獨立的應用，數據和配置會繼承原應用，但相互之間并不共享。分身應用在運行時會處于DLP沙箱環境中，訪問外部的權限會被限制，以防止數據的泄漏。每當打開一個新的DLP文件會生成一個應用沙箱分身，沙箱應用之間也是相互隔離的，當應用關閉后應用分身會自動卸載，沙箱期間產生的臨時數據也會丟棄。

正常情況下，應用不會感知到沙箱的存在，訪問的也是解密后的明文，和訪問普通文件沒有區別，但由于DLP沙箱會限制其訪問外部的權限（例如網絡、剪切板、截屏、錄屏、藍牙等）。為了更好的用戶體驗，需要應用進行適配，例如文件只讀的情況下，不應顯示“保存”按鈕，不應主動聯網等。

沙箱限制

當應用進入DLP沙箱狀態時，可以申請的權限將受到限制，根據DLP文件授權類型不同，限制也不相同，如下表：

接口說明

開發步驟

1. 引入[dlpPermission]模塊。

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

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 '@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); // 失敗報錯
   }
   fileIo.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 '@kit.DataLossPreventionKit';
import { common, UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

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); // 失敗報錯
}

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

14. 查詢當前系統是否提供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); // 失敗報錯
});

審核編輯 黃宇