@ohos.net.networkSecurity (Network Security)

The networkSecurity module provides the network security verification capability. Specifically, it provides APIs for applications to verify the certificate chains in use.

NOTE

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

Modules to Import

import networkSecurity from '@ohos.net.networkSecurity';
import { BusinessError } from '@ohos.base';

Sample Code

import networkSecurity from '@ohos.net.networkSecurity';

// Define certificate blobs
const cert: networkSecurity.CertBlob = {
  type: networkSecurity.CertType.CERT_TYPE_PEM,
  data: '-----BEGIN CERTIFICATE-----\n... (certificate data) ...\n-----END CERTIFICATE-----',
};

const caCert: networkSecurity.CertBlob = {
  type: networkSecurity.CertType.CERT_TYPE_PEM,
  data: '-----BEGIN CERTIFICATE-----\n... (CA certificate data) ...\n-----END CERTIFICATE-----',
};

// Perform asynchronous certificate verification
networkSecurity.certVerification(cert, caCert)
  .then((result) => {
    console.info('Certificate verification result:', result);
  })
  .catch((error: BusinessError) => {
    console.error('Certificate verification failed:', error);
  });

NOTE
Be sure to replace the certificate data in the example with the actual certificate data.

CertType

Enumerates certificate types.

System capability: SystemCapability.Communication.NetStack

Name	Value	Description
CERT_TYPE_PEM	0	PEM certificate
CERT_TYPE_DER	1	DER certificate.

CertBlob

Defines the certificate data.

System capability: SystemCapability.Communication.NetStack

Name	Type	Mandatory	Description
type	CertType	Yes	Certificate type.
data	string \| ArrayBuffer	Yes	Certificate data.

networkSecurity.certVerification

certVerification(cert: CertBlob, caCert?: CertBlob): Promise<number>

Obtains the preset CA certificate and custom CA certificate from the certificate management module, and verifies the certificate chain passed by the application.

System capability: SystemCapability.Communication.NetStack

Parameters

Name	Type	Mandatory	Description
cert	CertBlob	Yes	Certificate chain to be verified.
caCert	CertBlob	No	Custom CA certificate chain.

Return values:

Type	Description
Promise<number>	Promise used to return the result. The value 0 indicates that the certificate verification is successful, and a non-0 value indicates that the verification has failed.

Error codes

ID	Error Message
401	Parameter error.
2305001	Unspecified error.
2305002	Unable to get issuer certificate.
2305003	Unable to get certificate revocation list (CRL).
2305004	Unable to decrypt certificate signature.
2305005	Unable to decrypt CRL signature.
2305006	Unable to decode issuer public key.
2305007	Certificate signature failure.
2305008	CRL signature failure.
2305009	Certificate is not yet valid.
2305010	Certificate has expired.
2305011	CRL is not yet valid.
2305012	CRL has expired.
2305023	Certificate has been revoked.
2305024	Invalid certificate authority (CA).
2305027	Certificate is untrusted.

NOTE
If any of the preceding error codes is reported during certificate verification, rectify the error based on the detailed information about the error description.

Example

import networkSecurity from '@ohos.net.networkSecurity';
import { BusinessError } from '@ohos.base';

// Define certificate blobs
const cert:networkSecurity.CertBlob = {
  type: networkSecurity.CertType.CERT_TYPE_PEM,
  data: '-----BEGIN CERTIFICATE-----\n... (certificate data) ...\n-----END CERTIFICATE-----',
};

const caCert:networkSecurity.CertBlob = {
  type: networkSecurity.CertType.CERT_TYPE_PEM,
  data: '-----BEGIN CERTIFICATE-----\n... (CA certificate data) ...\n-----END CERTIFICATE-----',
};

// Perform asynchronous certificate verification
networkSecurity.certVerification(cert, caCert)
  .then((result) => {
    console.info('Certificate verification result:', result);
  })
  .catch((error: BusinessError) => {
    console.error('Certificate verification failed:', error);
  });

NOTE
Be sure to replace the certificate data in the example with the actual certificate data.

networkSecurity.certVerificationSync

certVerificationSync(cert: CertBlob, caCert?: CertBlob): number

Obtains the preset CA certificate and custom CA certificate from the certificate management module, and verifies the certificate chain passed by the application.

System capability: SystemCapability.Communication.NetStack

Parameters

Name	Type	Mandatory	Description
cert	CertBlob	Yes	Certificate chain to be verified.
caCert	CertBlob	No	Custom CA certificate chain.

Return values:

Type	Description
number	Certificate chain verification result. The value 0 indicates that the certificate verification is successful, and a non-0 value indicates that the verification has failed.

Error codes

ID	Error Message
401	Parameter error.
2305001	Unspecified error.
2305002	Unable to get issuer certificate.
2305003	Unable to get certificate revocation list (CRL).
2305004	Unable to decrypt certificate signature.
2305005	Unable to decrypt CRL signature.
2305006	Unable to decode issuer public key.
2305007	Certificate signature failure.
2305008	CRL signature failure.
2305009	Certificate is not yet valid.
2305010	Certificate has expired.
2305011	CRL is not yet valid.
2305012	CRL has expired.
2305023	Certificate has been revoked.
2305024	Invalid certificate authority (CA).
2305027	Certificate is untrusted.

NOTE
If any of the preceding error codes is reported during certificate verification, rectify the error based on the detailed information about the error description.

Example

import networkSecurity from '@ohos.net.networkSecurity';
import { BusinessError } from '@ohos.base';

// Create certificate blobs
const cert: networkSecurity.CertBlob = {
  type: networkSecurity.CertType.CERT_TYPE_PEM,
  data: '-----BEGIN CERTIFICATE-----\n...'
};

const caCert: networkSecurity.CertBlob = {
  type: networkSecurity.CertType.CERT_TYPE_PEM,
  data: '-----BEGIN CERTIFICATE-----\n...'
};

// Asynchronous verification
networkSecurity.certVerification(cert, caCert)
  .then((result) => {
    console.info('Verification Result:', result);
  })
  .catch((error) => {
    console.error('Verification Error:', error);
  });

// Synchronous verification
let resultSync: number = networkSecurity.certVerificationSync(cert, caCert);
console.info('Synchronous Verification Result:', resultSync);

NOTE
Be sure to replace the certificate data in the example with the actual certificate data.