XmlCertVault C Reference Documentation
XmlCertVault
Current Version: 10.1.2
Contains a collection of certificates and PFX files saved in an XML format.
Create/Dispose
HCkXmlCertVault instance = CkXmlCertVault_Create(); // ... CkXmlCertVault_Dispose(instance);
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.
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_putDebugLogFilePath(HCkXmlCertVault cHandle, const char *newVal);
const char *CkXmlCertVault_debugLogFilePath(HCkXmlCertVault cHandle);
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.
LastErrorHtml
const char *CkXmlCertVault_lastErrorHtml(HCkXmlCertVault cHandle);
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.
topLastErrorText
const char *CkXmlCertVault_lastErrorText(HCkXmlCertVault cHandle);
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.
LastErrorXml
const char *CkXmlCertVault_lastErrorXml(HCkXmlCertVault cHandle);
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.
topLastMethodSuccess
void CkXmlCertVault_putLastMethodSuccess(HCkXmlCertVault cHandle, 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.
topMasterPassword
void CkXmlCertVault_putMasterPassword(HCkXmlCertVault cHandle, const char *newVal);
const char *CkXmlCertVault_masterPassword(HCkXmlCertVault cHandle);
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.
topUtf8
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.
topVerboseLogging
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.
topVersion
const char *CkXmlCertVault_version(HCkXmlCertVault cHandle);
Methods
AddCert
AddCertBinary
Adds a certificate to the XML vault from any binary format, such as DER.
Returns TRUE for success, FALSE for failure.
topAddCertChain
AddCertEncoded
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.
topAddCertFile
Adds a certificate to the XML vault.
Returns TRUE for success, FALSE for failure.
AddCertString
Adds a certificate from any string representation format such as PEM.
Returns TRUE for success, FALSE for failure.
AddPemFile
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.
topAddPfx
AddPfxBinary
Adds a PFX to the XML vault where PFX is passed directly from in-memory binary bytes.
Returns TRUE for success, FALSE for failure.
topAddPfxEncoded
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.
topAddPfxFile
GetXml
const char *CkXmlCertVault_getXml(HCkXmlCertVault cHandle);
Returns the contents of the cert vault as an XML string.
Returns TRUE for success, FALSE for failure.
top