XmlCertVault C Reference Documentation

XmlCertVault

Current Version: 9.5.0.73

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

Create/Dispose

HCkXmlCertVault instance = CkXmlCertVault_Create();
// ...
CkXmlCertVault_Dispose(instance);
HCkXmlCertVault CkXmlCertVault_Create(void);

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

void CkXmlCertVault_Dispose(HCkXmlCertVault handle);

Objects created by calling CkXmlCertVault_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 CkXmlCertVault_Dispose.

Properties

DebugLogFilePath
void CkXmlCertVault_getDebugLogFilePath(HCkXmlCertVault cHandle, HCkString retval);
void CkXmlCertVault_putDebugLogFilePath(HCkXmlCertVault cHandle, const char *newVal);
const char *CkXmlCertVault_debugLogFilePath(HCkXmlCertVault 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.

top
LastErrorHtml
void CkXmlCertVault_getLastErrorHtml(HCkXmlCertVault cHandle, HCkString retval);
const char *CkXmlCertVault_lastErrorHtml(HCkXmlCertVault 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.

top
LastErrorText
void CkXmlCertVault_getLastErrorText(HCkXmlCertVault cHandle, HCkString retval);
const char *CkXmlCertVault_lastErrorText(HCkXmlCertVault 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.

top
LastErrorXml
void CkXmlCertVault_getLastErrorXml(HCkXmlCertVault cHandle, HCkString retval);
const char *CkXmlCertVault_lastErrorXml(HCkXmlCertVault 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.

top
LastMethodSuccess
BOOL CkXmlCertVault_getLastMethodSuccess(HCkXmlCertVault cHandle);
void CkXmlCertVault_putLastMethodSuccess(HCkXmlCertVault 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.

top
MasterPassword
void CkXmlCertVault_getMasterPassword(HCkXmlCertVault cHandle, HCkString retval);
void CkXmlCertVault_putMasterPassword(HCkXmlCertVault cHandle, const char *newVal);
const char *CkXmlCertVault_masterPassword(HCkXmlCertVault 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.

top
Utf8
BOOL CkXmlCertVault_getUtf8(HCkXmlCertVault cHandle);
void CkXmlCertVault_putUtf8(HCkXmlCertVault cHandle, 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.

top
VerboseLogging
BOOL CkXmlCertVault_getVerboseLogging(HCkXmlCertVault cHandle);
void CkXmlCertVault_putVerboseLogging(HCkXmlCertVault 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.

top
Version
void CkXmlCertVault_getVersion(HCkXmlCertVault cHandle, HCkString retval);
const char *CkXmlCertVault_version(HCkXmlCertVault cHandle);

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

top

Methods

AddCert
BOOL CkXmlCertVault_AddCert(HCkXmlCertVault cHandle, HCkCert cert);
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns TRUE for success, FALSE for failure.

top
AddCertBinary
BOOL CkXmlCertVault_AddCertBinary(HCkXmlCertVault cHandle, HCkByteData 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.

top
AddCertChain
BOOL CkXmlCertVault_AddCertChain(HCkXmlCertVault cHandle, HCkCertChain certChain);
Introduced in version 9.5.0.40

Adds a chain of certificates to the XML vault.

Returns TRUE for success, FALSE for failure.

top
AddCertEncoded
BOOL CkXmlCertVault_AddCertEncoded(HCkXmlCertVault cHandle, 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.

top
AddCertFile
BOOL CkXmlCertVault_AddCertFile(HCkXmlCertVault cHandle, const char *path);
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns TRUE for success, FALSE for failure.

top
AddCertString
BOOL CkXmlCertVault_AddCertString(HCkXmlCertVault cHandle, 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.

top
AddPemFile
BOOL CkXmlCertVault_AddPemFile(HCkXmlCertVault cHandle, 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.

top
AddPfx
BOOL CkXmlCertVault_AddPfx(HCkXmlCertVault cHandle, HCkPfx pfx);
Introduced in version 9.5.0.40

Adds a PFX (PKCS12) to the XML vault.

Returns TRUE for success, FALSE for failure.

top
AddPfxBinary
BOOL CkXmlCertVault_AddPfxBinary(HCkXmlCertVault cHandle, HCkByteData 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.

top
AddPfxEncoded
BOOL CkXmlCertVault_AddPfxEncoded(HCkXmlCertVault cHandle, 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.

top
AddPfxFile
BOOL CkXmlCertVault_AddPfxFile(HCkXmlCertVault cHandle, 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.

top
GetXml
BOOL CkXmlCertVault_GetXml(HCkXmlCertVault cHandle, HCkString outStr);
const char *CkXmlCertVault_getXml(HCkXmlCertVault 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.

top
LoadXml
BOOL CkXmlCertVault_LoadXml(HCkXmlCertVault cHandle, const char *xml);
Introduced in version 9.5.0.40

Loads from an XML string.

Returns TRUE for success, FALSE for failure.

top
LoadXmlFile
BOOL CkXmlCertVault_LoadXmlFile(HCkXmlCertVault cHandle, const char *path);
Introduced in version 9.5.0.40

Loads from an XML file.

Returns TRUE for success, FALSE for failure.

top
SaveLastError
BOOL CkXmlCertVault_SaveLastError(HCkXmlCertVault cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

top
SaveXml
BOOL CkXmlCertVault_SaveXml(HCkXmlCertVault cHandle, const char *path);
Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns TRUE for success, FALSE for failure.

top