XmlCertVault Unicode C Reference Documentation

XmlCertVault

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

Create/Dispose

HCkXmlCertVaultW CkXmlCertVaultW_Create(void);

Creates an instance of the HCkXmlCertVaultW object and returns a handle (i.e. a "void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkXmlCertVaultW_Dispose(HCkXmlCertVaultW handle);

Objects created by calling CkXmlCertVaultW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkXmlCertVaultW_Dispose.

Properties

void CkXmlCertVaultW_getDebugLogFilePath(HCkXmlCertVaultW cHandle, HCkString retval);

void CkXmlCertVaultW_putDebugLogFilePath(HCkXmlCertVaultW cHandle, const wchar_t *newVal);

const wchar_t *CkXmlCertVaultW_debugLogFilePath(HCkXmlCertVaultW cHandle);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

void CkXmlCertVaultW_getLastErrorHtml(HCkXmlCertVaultW cHandle, HCkString retval);

const wchar_t *CkXmlCertVaultW_lastErrorHtml(HCkXmlCertVaultW cHandle);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void CkXmlCertVaultW_getLastErrorText(HCkXmlCertVaultW cHandle, HCkString retval);

const wchar_t *CkXmlCertVaultW_lastErrorText(HCkXmlCertVaultW cHandle);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

void CkXmlCertVaultW_getLastErrorXml(HCkXmlCertVaultW cHandle, HCkString retval);

const wchar_t *CkXmlCertVaultW_lastErrorXml(HCkXmlCertVaultW cHandle);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

BOOL CkXmlCertVaultW_getLastMethodSuccess(HCkXmlCertVaultW cHandle);

void CkXmlCertVaultW_putLastMethodSuccess(HCkXmlCertVaultW cHandle, BOOL newVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

void CkXmlCertVaultW_getMasterPassword(HCkXmlCertVaultW cHandle, HCkString retval);

void CkXmlCertVaultW_putMasterPassword(HCkXmlCertVaultW cHandle, const wchar_t *newVal);

const wchar_t *CkXmlCertVaultW_masterPassword(HCkXmlCertVaultW cHandle);

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.

BOOL CkXmlCertVaultW_getVerboseLogging(HCkXmlCertVaultW cHandle);

void CkXmlCertVaultW_putVerboseLogging(HCkXmlCertVaultW cHandle, 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.

void CkXmlCertVaultW_getVersion(HCkXmlCertVaultW cHandle, HCkString retval);

const wchar_t *CkXmlCertVaultW_version(HCkXmlCertVaultW cHandle);

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

Methods

BOOL CkXmlCertVaultW_AddCert(HCkXmlCertVaultW cHandle, HCkCertW cert);

Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns TRUE for success, FALSE for failure.

BOOL CkXmlCertVaultW_AddCertBinary(HCkXmlCertVaultW cHandle, const unsigned char * 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.

BOOL CkXmlCertVaultW_AddCertChain(HCkXmlCertVaultW cHandle, HCkCertChainW certChain);

Introduced in version 9.5.0.40

Adds a chain of certificates to the XML vault.

Returns TRUE for success, FALSE for failure.

BOOL CkXmlCertVaultW_AddCertEncoded(HCkXmlCertVaultW cHandle, const wchar_t *encodedBytes, const wchar_t *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.

BOOL CkXmlCertVaultW_AddCertFile(HCkXmlCertVaultW cHandle, const wchar_t *path);

Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns TRUE for success, FALSE for failure.

BOOL CkXmlCertVaultW_AddCertString(HCkXmlCertVaultW cHandle, const wchar_t *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.

BOOL CkXmlCertVaultW_AddPemFile(HCkXmlCertVaultW cHandle, const wchar_t *path, const wchar_t *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.

BOOL CkXmlCertVaultW_AddPfx(HCkXmlCertVaultW cHandle, HCkPfxW pfx);

Introduced in version 9.5.0.40

Adds a PFX (PKCS12) to the XML vault.

Returns TRUE for success, FALSE for failure.

BOOL CkXmlCertVaultW_AddPfxBinary(HCkXmlCertVaultW cHandle, const unsigned char * pfxBytes, const wchar_t *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.

BOOL CkXmlCertVaultW_AddPfxEncoded(HCkXmlCertVaultW cHandle, const wchar_t *encodedBytes, const wchar_t *encoding, const wchar_t *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.

BOOL CkXmlCertVaultW_AddPfxFile(HCkXmlCertVaultW cHandle, const wchar_t *path, const wchar_t *password);

Introduced in version 9.5.0.40

Adds a PFX file to the XML vault.

Returns TRUE for success, FALSE for failure.

BOOL CkXmlCertVaultW_GetXml(HCkXmlCertVaultW cHandle, const wchar_t *outStr);

const wchar_t *CkXmlCertVaultW_getXml(HCkXmlCertVaultW cHandle);

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.

BOOL CkXmlCertVaultW_LoadXml(HCkXmlCertVaultW cHandle, const wchar_t *xml);

Introduced in version 9.5.0.40

Loads from an XML string.

Returns TRUE for success, FALSE for failure.

BOOL CkXmlCertVaultW_LoadXmlFile(HCkXmlCertVaultW cHandle, const wchar_t *path);

Introduced in version 9.5.0.40

Loads from an XML file.

Returns TRUE for success, FALSE for failure.

BOOL CkXmlCertVaultW_SaveLastError(HCkXmlCertVaultW cHandle, const wchar_t *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

BOOL CkXmlCertVaultW_SaveXml(HCkXmlCertVaultW cHandle, const wchar_t *path);

Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns TRUE for success, FALSE for failure.