XmlCertVault PHP ActiveX Reference Documentation

XmlCertVault

Current Version: 10.1.2

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

Object Creation

Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.XmlCertVault");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.XmlCertVault");

Properties

DebugLogFilePath

string DebugLogFilePath

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.

LastBinaryResult

VARIANT LastBinaryResult (read-only)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to true. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

string LastErrorHtml (read-only)

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

string LastErrorText (read-only)

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

string LastErrorXml (read-only)

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 LastMethodSuccess

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.

LastStringResult

string LastStringResult (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

int LastStringResultLen (read-only)

The length, in characters, of the string contained in the LastStringResult property.

MasterPassword

string MasterPassword

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.

VerboseLogging

bool VerboseLogging

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

string Version (read-only)

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(Chilkat.Cert 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(VARIANT 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(Chilkat.CertChain 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(string encodedBytes, string 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(string 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(string 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(string path, string 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(Chilkat.Pfx 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(VARIANT pfxBytes, string 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(string encodedBytes, string encoding, string 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(string path, string password)

Introduced in version 9.5.0.40

Adds a PFX file to the XML vault.

Returns true for success, false for failure.

GetXml

string GetXml()

Introduced in version 9.5.0.40

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

Returns null on failure

LoadXml

bool LoadXml(string xml)

Introduced in version 9.5.0.40

Loads from an XML string.

Returns true for success, false for failure.

LoadXmlFile

bool LoadXmlFile(string path)

Introduced in version 9.5.0.40

Loads from an XML file.

Returns true for success, false for failure.

SaveXml

bool SaveXml(string path)

Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns true for success, false for failure.