XmlCertVault C# Reference Documentation

XmlCertVault

Current Version: 10.1.2

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

Object Creation

Chilkat.XmlCertVault obj = new Chilkat.XmlCertVault();

Properties

DebugLogFilePath
public string DebugLogFilePath {get; set; }

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.

top
LastErrorHtml
public string LastErrorHtml {get; }

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.

top
LastErrorText
public string LastErrorText {get; }

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.

top
LastErrorXml
public string LastErrorXml {get; }

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.

top
LastMethodSuccess
public bool LastMethodSuccess {get; set; }

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.

top
MasterPassword
public string MasterPassword {get; set; }
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
VerboseLogging
public bool VerboseLogging {get; set; }

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
public string Version {get; }

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

top

Methods

AddCert
public bool AddCert(Cert cert);
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns true for success, false for failure.

top
AddCertBinary
public bool AddCertBinary(byte[] 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
public bool AddCertChain(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.

top
AddCertEncoded
public 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
public 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
public 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
public 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
public bool AddPfx(Pfx 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
public bool AddPfxBinary(byte[] 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
public 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
public 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
public string GetXml();
Introduced in version 9.5.0.40

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

Returns null on failure

top
LoadXml
public 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
public bool LoadXmlFile(string path);
Introduced in version 9.5.0.40

Loads from an XML file.

Returns true for success, false for failure.

top
SaveXml
public 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