XmlCertVault CkPython Reference Documentation
CkXmlCertVault
Current Version: 10.1.2
Contains a collection of certificates and PFX files saved in an XML format.
Object Creation
obj = chilkat.CkXmlCertVault()
Properties
DebugLogFilePath
# ckStr is a CkString
xmlCertVault.get_DebugLogFilePath(ckStr);
strVal = xmlCertVault.debugLogFilePath();
xmlCertVault.put_DebugLogFilePath(strVal);
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
# ckStr is a CkString
xmlCertVault.get_LastErrorHtml(ckStr);
strVal = xmlCertVault.lastErrorHtml();
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
# ckStr is a CkString
xmlCertVault.get_LastErrorText(ckStr);
strVal = xmlCertVault.lastErrorText();
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
# ckStr is a CkString
xmlCertVault.get_LastErrorXml(ckStr);
strVal = xmlCertVault.lastErrorXml();
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
boolVal = xmlCertVault.get_LastMethodSuccess();
xmlCertVault.put_LastMethodSuccess(boolVal);
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
# ckStr is a CkString
xmlCertVault.get_MasterPassword(ckStr);
strVal = xmlCertVault.masterPassword();
xmlCertVault.put_MasterPassword(strVal);
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
boolVal = xmlCertVault.get_Utf8();
xmlCertVault.put_Utf8(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.
topVerboseLogging
boolVal = xmlCertVault.get_VerboseLogging();
xmlCertVault.put_VerboseLogging(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.
topVersion
# ckStr is a CkString
xmlCertVault.get_Version(ckStr);
strVal = xmlCertVault.version();
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
# encoding is a string
status = xmlCertVault.AddCertEncoded(encodedBytes, encoding);
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
status = xmlCertVault.AddCertFile(path);
Adds a certificate to the XML vault.
Returns True for success, False for failure.
AddCertString
status = xmlCertVault.AddCertString(certData);
Adds a certificate from any string representation format such as PEM.
Returns True for success, False for failure.
AddPemFile
# password is a string
status = xmlCertVault.AddPemFile(path, password);
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
# password is a string
status = xmlCertVault.AddPfxBinary(pfxBytes, password);
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
# encoding is a string
# password is a string
status = xmlCertVault.AddPfxEncoded(encodedBytes, encoding, 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.
topAddPfxFile
# password is a string
status = xmlCertVault.AddPfxFile(path, password);
GetXml
status = xmlCertVault.GetXml(outStr);
retStr = xmlCertVault.getXml();
Returns the contents of the cert vault as an XML string.
Returns True for success, False for failure.
topLoadXml
status = xmlCertVault.LoadXml(xml);
LoadXmlFile
status = xmlCertVault.LoadXmlFile(path);
SaveXml
status = xmlCertVault.SaveXml(path);