XmlCertVault Delphi DLL Reference Documentation

XmlCertVault

Current Version: 10.1.2

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

Create/Dispose

var
myObject: HCkXmlCertVault;

begin
myObject := CkXmlCertVault_Create();

// ...

CkXmlCertVault_Dispose(myObject);
end;

function CkXmlCertVault_Create: HCkXmlCertVault; stdcall;

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

procedure CkXmlCertVault_Dispose(handle: HCkXmlCertVault); stdcall;

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.

Properties

DebugLogFilePath

procedure CkXmlCertVault_getDebugLogFilePath(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall;
procedure CkXmlCertVault_putDebugLogFilePath(objHandle: HCkXmlCertVault; newPropVal: PWideChar); stdcall;
function CkXmlCertVault__debugLogFilePath(objHandle: HCkXmlCertVault): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

procedure CkXmlCertVault_getLastErrorHtml(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall;
function CkXmlCertVault__lastErrorHtml(objHandle: HCkXmlCertVault): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkXmlCertVault_getLastErrorText(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall;
function CkXmlCertVault__lastErrorText(objHandle: HCkXmlCertVault): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkXmlCertVault_getLastErrorXml(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall;
function CkXmlCertVault__lastErrorXml(objHandle: HCkXmlCertVault): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkXmlCertVault_getLastMethodSuccess(objHandle: HCkXmlCertVault): wordbool; stdcall;
procedure CkXmlCertVault_putLastMethodSuccess(objHandle: HCkXmlCertVault; newPropVal: wordbool); stdcall;

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

procedure CkXmlCertVault_getMasterPassword(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall;
procedure CkXmlCertVault_putMasterPassword(objHandle: HCkXmlCertVault; newPropVal: PWideChar); stdcall;
function CkXmlCertVault__masterPassword(objHandle: HCkXmlCertVault): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

VerboseLogging

function CkXmlCertVault_getVerboseLogging(objHandle: HCkXmlCertVault): wordbool; stdcall;
procedure CkXmlCertVault_putVerboseLogging(objHandle: HCkXmlCertVault; newPropVal: wordbool); stdcall;

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

procedure CkXmlCertVault_getVersion(objHandle: HCkXmlCertVault; outPropVal: HCkString); stdcall;
function CkXmlCertVault__version(objHandle: HCkXmlCertVault): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddCert

function CkXmlCertVault_AddCert(objHandle: HCkXmlCertVault;
cert: HCkCert): wordbool; stdcall;

Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns True for success, False for failure.

AddCertBinary

function CkXmlCertVault_AddCertBinary(objHandle: HCkXmlCertVault;
certBytes: HCkByteData): wordbool; stdcall;

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

function CkXmlCertVault_AddCertChain(objHandle: HCkXmlCertVault;
certChain: HCkCertChain): wordbool; stdcall;

Introduced in version 9.5.0.40

Adds a chain of certificates to the XML vault.

Returns True for success, False for failure.

AddCertEncoded

function CkXmlCertVault_AddCertEncoded(objHandle: HCkXmlCertVault;
encodedBytes: PWideChar;
encoding: PWideChar): wordbool; stdcall;

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

function CkXmlCertVault_AddCertFile(objHandle: HCkXmlCertVault;
path: PWideChar): wordbool; stdcall;

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

function CkXmlCertVault_AddCertString(objHandle: HCkXmlCertVault;
certData: PWideChar): wordbool; stdcall;

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

function CkXmlCertVault_AddPemFile(objHandle: HCkXmlCertVault;
path: PWideChar;
password: PWideChar): wordbool; stdcall;

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

function CkXmlCertVault_AddPfx(objHandle: HCkXmlCertVault;
pfx: HCkPfx): wordbool; stdcall;

Introduced in version 9.5.0.40

Adds a PFX (PKCS12) to the XML vault.

Returns True for success, False for failure.

AddPfxBinary

function CkXmlCertVault_AddPfxBinary(objHandle: HCkXmlCertVault;
pfxBytes: HCkByteData;
password: PWideChar): wordbool; stdcall;

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

function CkXmlCertVault_AddPfxEncoded(objHandle: HCkXmlCertVault;
    encodedBytes: PWideChar;
    encoding: PWideChar;
    password: PWideChar): wordbool; stdcall;

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

function CkXmlCertVault_AddPfxFile(objHandle: HCkXmlCertVault;
path: PWideChar;
password: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.40

Adds a PFX file to the XML vault.

Returns True for success, False for failure.

GetXml

function CkXmlCertVault_GetXml(objHandle: HCkXmlCertVault;
outStr: HCkString): wordbool; stdcall;
function CkXmlCertVault__getXml(objHandle: HCkXmlCertVault): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LoadXml

function CkXmlCertVault_LoadXml(objHandle: HCkXmlCertVault;
xml: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.40

Loads from an XML string.

Returns True for success, False for failure.

LoadXmlFile

function CkXmlCertVault_LoadXmlFile(objHandle: HCkXmlCertVault;
path: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.40

Loads from an XML file.

Returns True for success, False for failure.

SaveXml

function CkXmlCertVault_SaveXml(objHandle: HCkXmlCertVault;
path: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns True for success, False for failure.