@ohos.enterprise.securityManager（安全管理）

本模块提供设备安全管理的能力，包括查询安全补丁状态、查询文件加密状态等。

说明：

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

本模块接口仅可在Stage模型下使用。

本模块接口仅对设备管理应用开放，且调用接口前需激活设备管理应用，具体请参考MDM Kit开发指南。

导入模块

import { securityManager } from '@kit.MDMKit';

securityManager.uninstallUserCertificate

uninstallUserCertificate(admin: Want, certUri: string): Promise<void>

卸载用户证书，使用Promise异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let aliasStr = "certName";
securityManager.uninstallUserCertificate(wantTemp, aliasStr).then(() => {
  console.info(`Succeeded in uninstalling user certificate.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to uninstall user certificate. Code is ${err.code}, message is ${err.message}`);
});

securityManager.installUserCertificate

installUserCertificate(admin: Want, certificate: CertBlob): Promise<string>

安装用户证书，使用Promise异步回调。

需要权限： ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { common, Want } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let certFileArray: Uint8Array = new Uint8Array();
// The variable context needs to be initialized in MainAbility's onCreate callback function
// test.cer needs to be placed in the rawfile directory
const context = this.getUIContext().getHostContext() as common.UIAbilityContext;
context.resourceManager.getRawFileContent("test.cer").then((value) => {
  certFileArray = value;
  securityManager.installUserCertificate(wantTemp, { inData: certFileArray, alias: "cert_alias_xts" })
    .then((result) => {
      console.info(`Succeeded in installing user certificate, result : ${JSON.stringify(result)}`);
    }).catch((err: BusinessError) => {
    console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`);
  })
}).catch((err: BusinessError) => {
  console.error(`Failed to get raw file content. message: ${err.message}`);
  return;
});

securityManager.installUserCertificate¹⁸⁺

installUserCertificate(admin: Want, certificate: CertBlob, accountId: number): string

支持按系统账户安装用户证书。

需要权限： ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { common, Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let certFileArray: Uint8Array = new Uint8Array();
let accountId: number = 100;
// The variable context needs to be initialized in MainAbility's onCreate callback function
// test.cer needs to be placed in the rawfile directory
const context = this.getUIContext().getHostContext() as common.UIAbilityContext;
context.resourceManager.getRawFileContent("test.cer").then((value) => {
  certFileArray = value;
  try {
    let result: string = securityManager.installUserCertificate(wantTemp, { inData: certFileArray, alias: "cert_alias_xts" }, accountId);
    console.info(`Succeeded in installing user certificate. result: ${result}`);
  } catch (err) {
    console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`);
  }
});

securityManager.getUserCertificates¹⁸⁺

getUserCertificates(admin: Want, accountId: number): Array<string>

获取指定系统账户下的用户证书信息。

需要权限： ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let accountId: number = 100;
try {
  let result: Array<string> = securityManager.getUserCertificates(wantTemp, accountId);
  console.info(`Succeeded in getting the uri list of user Certificates. result: ${JSON.stringify(result)}`);
} catch (err) {
  console.error(`Failed to get the uri list of user Certificates. Code: ${err.code}, message: ${err.message}`);
}

securityManager.getSecurityStatus

getSecurityStatus(admin: Want, item: string): string

获取当前设备安全策略信息。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

try {
  let result: string = securityManager.getSecurityStatus(wantTemp, 'patch');
  console.info(`Succeeded in getting security patch tag. tag: ${result}`);
} catch (err) {
  console.error(`Failed to get security patch tag. Code: ${err.code}, message: ${err.message}`);
}

securityManager.setPasswordPolicy

setPasswordPolicy(admin: Want, policy: PasswordPolicy): void

设置设备口令策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

let policy: securityManager.PasswordPolicy = {
  complexityRegex: '^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d]{8,}$',
  validityPeriod: 1,
  additionalDescription: '至少八个字符，至少一个大写字母，一个小写字母，一个数字和一个特殊字符',
}
try {
    securityManager.setPasswordPolicy(wantTemp, policy);
    console.info(`Succeeded in setting password policy.`);
} catch(err) {
    console.error(`Failed to set password policy. Code: ${err.code}, message: ${err.message}`);
}

securityManager.getPasswordPolicy

getPasswordPolicy(admin: Want): PasswordPolicy

获取设备口令策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};

try {
    let result: securityManager.PasswordPolicy = securityManager.getPasswordPolicy(wantTemp);
    console.info(`Succeeded in getting password policy, result : ${JSON.stringify(result)}`);
} catch(err) {
    console.error(`Failed to get password policy. Code: ${err.code}, message: ${err.message}`);
}

securityManager.setAppClipboardPolicy

setAppClipboardPolicy(admin: Want, tokenId: number, policy: ClipboardPolicy): void

设置设备剪贴板策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let tokenId: number = 586874394;
try {
    securityManager.setAppClipboardPolicy(wantTemp, tokenId, securityManager.ClipboardPolicy.IN_APP);
    console.info(`Succeeded in setting clipboard policy.`);
} catch(err) {
    console.error(`Failed to set clipboard policy. Code: ${err.code}, message: ${err.message}`);
}

securityManager.getAppClipboardPolicy

getAppClipboardPolicy(admin: Want, tokenId?: number): string

获取设备剪贴板策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let tokenId: number = 586874394;
try {
    let result: string = securityManager.getAppClipboardPolicy(wantTemp, tokenId);
    console.info(`Succeeded in getting password policy, result : ${result}`);
} catch(err) {
    console.error(`Failed to set clipboard policy. Code: ${err.code}, message: ${err.message}`);
}

securityManager.setAppClipboardPolicy¹⁸⁺

setAppClipboardPolicy(admin: Want, bundleName: string, accountId: number, policy: ClipboardPolicy): void

设置指定包名和用户Id的设备剪贴板策略。当前只支持最多保存100个策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let bundleName: string = 'com.example.myapplication';
let accountId: number = 100;
try {
    securityManager.setAppClipboardPolicy(wantTemp, bundleName, accountId, securityManager.ClipboardPolicy.IN_APP);
    console.info(`Succeeded in setting clipboard policy.`);
} catch(err) {
    console.error(`Failed to set clipboard policy. Code: ${err.code}, message: ${err.message}`);
}

securityManager.getAppClipboardPolicy¹⁸⁺

getAppClipboardPolicy(admin: Want, bundleName: string, accountId: number): string

获取指定包名和用户Id的设备剪贴板策略。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let bundleName: string = 'com.example.myapplication';
let accountId: number = 100;
try {
    let result: string = securityManager.getAppClipboardPolicy(wantTemp, bundleName, accountId);
    console.info(`Succeeded in getting password policy, result : ${result}`);
} catch(err) {
    console.error(`Failed to set clipboard policy. Code: ${err.code}, message: ${err.message}`);
}

securityManager.setWatermarkImage¹⁴⁺

setWatermarkImage(admin: Want, bundleName: string, source: string|image.PixelMap, accountId: number): void

设置水印策略，当前仅支持2in1设备使用。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let bundleName: string = 'com.example.myapplication';
let source: string = '/data/storage/el1/base/test.png';
let accountId: number = 100;
try {
    securityManager.setWatermarkImage(wantTemp, bundleName, source, accountId);
    console.info(`Succeeded in setting set watermarkImage policy.`);
} catch(err) {
    console.error(`Failed to set watermarkImage policy. Code: ${err.code}, message: ${err.message}`);
}

securityManager.cancelWatermarkImage¹⁴⁺

cancelWatermarkImage(admin: Want, bundleName: string, accountId: number): void

取消水印策略，当前仅支持2in1设备使用。

需要权限： ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

参数：

错误码：

以下错误码的详细介绍请参见企业设备管理错误码和通用错误码。

示例：

import { Want } from '@kit.AbilityKit';

let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let bundleName: string = 'com.example.myapplication';
let accountId: number = 100;
try {
    securityManager.cancelWatermarkImage(wantTemp, bundleName, accountId);
    console.info(`Succeeded in setting cancel watermarkImage policy.`);
} catch(err) {
    console.error(`Failed to cancel watermarkImage policy. Code: ${err.code}, message: ${err.message}`);
}

CertBlob

证书信息。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

PasswordPolicy

设备口令策略。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

ClipboardPolicy

设备剪贴板策略。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Mdm Kit（企业设备管理服务）

harmony 鸿蒙企业设备管理错误码

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility（企业设备管理扩展能力）

harmony 鸿蒙@ohos.enterprise.accountManager（账户管理）(系统接口)

harmony 鸿蒙@ohos.enterprise.accountManager（账户管理）

harmony 鸿蒙@ohos.enterprise.adminManager（企业设备管理）(系统接口)

harmony 鸿蒙@ohos.enterprise.adminManager (admin权限管理)

harmony 鸿蒙@ohos.enterprise.applicationManager（应用管理）(系统接口)

harmony 鸿蒙@ohos.enterprise.applicationManager（应用管理）

harmony 鸿蒙@ohos.enterprise.bluetoothManager（蓝牙管理）(系统接口)