XmlCertVault C++ Reference Documentation

CkXmlCertVault

Current Version: 10.1.2

Contains a collection of certificates and PFX files saved in an XML format.

Object Creation

// Local variable on the stack
CkXmlCertVault obj;

// Dynamically allocate/delete
CkXmlCertVault *pObj = new CkXmlCertVault();
// ...
delete pObj;

Properties

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

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

Example showing how to use DebugLogFilePath.

LastErrorHtml

void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

MasterPassword

void get_MasterPassword(CkString &str);
const char *masterPassword(void);
void put_MasterPassword(const char *ansiOrUtf8Str);

Introduced in version 9.5.0.40

The master password for the vault. Certificates are stored unencrypted, but private keys are stored 256-bit AES encrypted using the individual PFX passwords. The PFX passwords are stored 256-bit AES encrypted using the master password. The master password is required to acces any of the private keys stored within the XML vault.

Utf8

bool get_Utf8(void);
void put_Utf8(bool newVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

VerboseLogging

bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

void get_Version(CkString &str);
const char *version(void);

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddCert

bool AddCert(CkCert &cert);

Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns true for success, false for failure.

AddCertBinary

bool AddCertBinary(CkByteData &certBytes);

Introduced in version 9.5.0.40

Adds a certificate to the XML vault from any binary format, such as DER.

Returns true for success, false for failure.

AddCertChain

bool AddCertChain(CkCertChain &certChain);

Introduced in version 9.5.0.40

Adds a chain of certificates to the XML vault.

Returns true for success, false for failure.

AddCertEncoded

bool AddCertEncoded(const char *encodedBytes, const char *encoding);

Introduced in version 9.5.0.40

Adds a certificate to the XML vault where certificate is passed directly from encoded bytes (such as Base64, Hex, etc.). The encoding is indicated by encoding.

Returns true for success, false for failure.

AddCertFile

bool AddCertFile(const char *path);

Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns true for success, false for failure.

More Information and Examples

PKCS11 Certificate Chain Sign PDF and Provide Certificates in Chain to Root

AddCertString

bool AddCertString(const char *certData);

Introduced in version 9.5.0.40

Adds a certificate from any string representation format such as PEM.

Returns true for success, false for failure.

More Information and Examples

Verify XML Signature having KeyInfo / X509Data / X509IssuerSerial

AddPemFile

bool AddPemFile(const char *path, const char *password);

Introduced in version 9.5.0.40

Adds the contents of a PEM file to the XML vault. The PEM file may be encrypted, and it may contain one or more certificates and/or private keys. The password is optional and only required if the PEM file contains encrypted content that requires a password.

Returns true for success, false for failure.

AddPfx

bool AddPfx(CkPfx &pfx);

Introduced in version 9.5.0.40

Adds a PFX (PKCS12) to the XML vault.

Returns true for success, false for failure.

AddPfxBinary

bool AddPfxBinary(CkByteData &pfxBytes, const char *password);

Introduced in version 9.5.0.40

Adds a PFX to the XML vault where PFX is passed directly from in-memory binary bytes.

Returns true for success, false for failure.

AddPfxEncoded

bool AddPfxEncoded(const char *encodedBytes, const char *encoding, const char *password);

Adds a PFX to the XML vault where PFX is passed directly from encoded bytes (such as Base64, Hex, etc.). The encoding is indicated by encoding.

Returns true for success, false for failure.

AddPfxFile

bool AddPfxFile(const char *path, const char *password);

Introduced in version 9.5.0.40

Adds a PFX file to the XML vault.

Returns true for success, false for failure.

GetXml

bool GetXml(CkString &outStr);
const char *getXml(void);

Introduced in version 9.5.0.40

Returns the contents of the cert vault as an XML string.

Returns true for success, false for failure.

LoadXml

bool LoadXml(const char *xml);

Introduced in version 9.5.0.40

Loads from an XML string.

Returns true for success, false for failure.

LoadXmlFile

bool LoadXmlFile(const char *path);

Introduced in version 9.5.0.40

Loads from an XML file.

Returns true for success, false for failure.

SaveXml

bool SaveXml(const char *path);

Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns true for success, false for failure.