CkXmlCertVault PHP Extension Reference Documentation

CkXmlCertVault

Current Version: 9.5.0.75

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

Object Creation

$obj = new CkXmlCertVault();

Properties

DebugLogFilePath
string debugLogFilePath();
void put_DebugLogFilePath(string strVal);

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
(read-only)
string lastErrorHtml();

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
(read-only)
string lastErrorText();

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
(read-only)
string lastErrorXml();

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 get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);
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
string masterPassword();
void put_MasterPassword(string strVal);
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 get_Utf8()
void put_Utf8(bool boolVal);

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 get_VerboseLogging()
void put_VerboseLogging(bool boolVal);

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
(read-only)
string version();

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

top

Methods

AddCert
bool AddCert(CkCert 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 AddCertBinary(CkByteData 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 AddCertChain(CkCertChain 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 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.

top
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.

top
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.

top
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.

top
AddPfx
bool AddPfx(CkPfx 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 AddPfxBinary(CkByteData 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.

top
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.

top
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.

top
GetXml
bool GetXml(CkString outStr);
string getXml();
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 LoadXml(string xml);
Introduced in version 9.5.0.40

Loads from an XML string.

Returns true for success, false for failure.

top
LoadXmlFile
bool LoadXmlFile(string path);
Introduced in version 9.5.0.40

Loads from an XML file.

Returns true for success, false for failure.

top
SaveLastError
bool SaveLastError(string 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 SaveXml(string path);
Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns true for success, false for failure.

top