Security Label

The secuityLabel module provides APIs to manage file data security levels, including obtaining and setting file data security levels.

NOTE
The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import securityLabel from '@ohos.securityLabel';

Usage

Before using the APIs provided by this module to perform operations on a file or directory, obtain the path of the application sandbox as follows:

import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
let path = '';
context.getFilesDir().then((data) => {
    path = data;
})

securityLabel.setSecurityLabel

setSecurityLabel(path:string, type:dataLevel):Promise<void>

Sets the security label for a file in asynchronous mode. This API uses a promise to return the result.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Name	Type	Mandatory	Description
path	string	Yes	File path.
type	dataLevel	Yes	File security level, which can be s0, s1, s2, s3, or s4.

Return value

Type	Description
Promise<void>	Promise used to return the result. An empty value will be returned.

Example

let type = "s4";
securityLabel.setSecurityLabel(path, type).then(function(){
    console.info("setSecurityLabel successfully");
}).catch(function(error){
    console.info("setSecurityLabel failed with error:" + error);
});

securityLabel.setSecurityLabel

setSecurityLabel(path:string, type:dataLevel, callback: AsyncCallback<void>):void

Sets the security label for a file in asynchronous mode. This API uses a callback to return the result.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Name	Type	Mandatory	Description
path	string	Yes	File path.
type	dataLevel	Yes	File security level, which can be s0, s1, s2, s3, or s4.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

let type = "s4";
securityLabel.setSecurityLabel(path, type, function(error){
    console.info("setSecurityLabel:" + JSON.stringify(error));
});

securityLabel.setSecurityLabelSync

setSecurityLabelSync(path:string, type:dataLevel):void

Sets the security label for a file in synchronous mode.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Name	Type	Mandatory	Description
path	string	Yes	File path.
type	dataLevel	Yes	File security level, which can be s0, s1, s2, s3, or s4.

Example

let type = "s4";
securityLabel.setSecurityLabelSync(path, type);

securityLabel.getSecurityLabel

getSecurityLabel(path:string):Promise<string>

Obtains the security label of a file in asynchronous mode. This API uses a promise to return the result.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Name	Type	Mandatory	Description
path	string	Yes	File path.

Return value

Type	Description
Promise<string>	Promise used to return the security label obtained.

Example

let type = "s4";
securityLabel.getSecurityLabel(path).then(function(type){
    console.log("getSecurityLabel successfully:" + type);
}).catch(function(error){
    console.log("getSecurityLabel failed with error:" + error);
});

securityLabel.getSecurityLabel

getSecurityLabel(path:string, callback:AsyncCallback<string>): void

Obtains the security label of a file in asynchronous mode. This API uses a callback to return the result.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Name	Type	Mandatory	Description
path	string	Yes	File path.
callback	AsyncCallback<string>	Yes	Callback used to return the security label obtained.

Example

let type = "s4";
securityLabel.getSecurityLabel(path,function(error, type){
    console.log("getSecurityLabel successfully:" + type);
});

securityLabel.getSecurityLabelSync

getSecurityLabelSync(path:string):string

Obtains the security label of a file in synchronous mode.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Name	Type	Mandatory	Description
path	string	Yes	File path.

Return value

Type	Description
string	Security label obtained.

Example

let result = securityLabel.getSecurityLabelSync(path);
console.log("getSecurityLabel successfully:" + result);