XmlCertVault React Native Reference Documentation

XmlCertVault

Current Version: 11.6.1

Chilkat.XmlCertVault

Collect certificates, certificate chains, PEM data, and PFX private keys in an XML vault.

Chilkat.XmlCertVault stores certificates and private-key material in a portable XML-based certificate vault. It can add individual certificates, certificate chains, DER or encoded certificates, PEM files, certificate strings, and PFX/PKCS12 data from files, memory, encoded text, or existing Chilkat objects. The vault can then be exported as XML, loaded from XML, or saved to an XML file for later reuse by other Chilkat certificate and TLS workflows.

Add certificates

Add certificates from Cert objects, files, PEM strings, binary DER bytes, or encoded data such as Base64 or hex.

Add certificate chains

Import an entire CertChain when related issuer and intermediate certificates should be kept together in the vault.

Add PEM content

Load PEM files containing one or more certificates and/or private keys, including encrypted PEM content when a password is supplied.

Add PFX / PKCS12

Add PFX data from a Pfx object, file, byte array, or encoded string, using the PFX password to import private-key material.

Master password protection

Use MasterPassword to protect access to private keys stored in the vault.

Load and save XML

Export the vault with GetXml, load it with LoadXml or LoadXmlFile, and persist it with SaveXml.

Common pattern: Create an XmlCertVault, set MasterPassword when the vault will contain private keys, add certificates or PFX/PEM material, then save the vault with SaveXml or keep the XML string from GetXml. Later, reload the same vault with LoadXml or LoadXmlFile and provide the same master password before using private keys.

Security note: Certificates are stored unencrypted, but private keys are stored using 256-bit AES encryption. The individual PFX passwords are also stored encrypted with the vault's MasterPassword, which is required to access any private keys contained in the XML vault.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, XmlCertVault } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const xmlCertVault = new XmlCertVault()
// ... the native object is released when `xmlCertVault` is garbage collected, or now with xmlCertVault.dispose()

new XmlCertVault()

Creates the underlying native Chilkat object. XmlCertVault is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: a method whose only outcome is success or failure returns void and throws on failure; a method producing a string or an object returns it and throws where Chilkat would have returned null. The error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  xmlCertVault.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // XmlCertVault.someMethod(...): <reason>
  console.log(xmlCertVault.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await xmlCertVault.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // XmlCertVault.someMethodAsync: <reason>
}

Properties

DebugLogFilePath

// read/write
debugLogFilePath: string

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

XmlCertVault React Native Reference Documentation

XmlCertVault

Current Version: 11.6.1

Collect certificates, certificate chains, PEM data, and PFX private keys in an XML vault.

Add certificates

Add certificate chains

Add PEM content

Add PFX / PKCS12

Master password protection

Load and save XML

Object Creation

Errors

Properties

DebugLogFilePath

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

MasterPassword

VerboseLogging

Version

Methods

AddCert

AddCertChain

AddCertEncoded

AddCertFile

AddCertString

AddPemFile

AddPfx

AddPfxEncoded

AddPfxFile

GetXml

LoadXml

LoadXmlFile

SaveXml