XmlCertVault Tcl Reference Documentation

XmlCertVault

Current Version: 10.1.2

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

Object Creation

set myXmlCertVault [new CkXmlCertVault]

Properties

DebugLogFilePath
string
# ckStr is a CkString
CkXmlCertVault_get_DebugLogFilePath $myXmlCertVault $ckStr
set strVal [CkXmlCertVault_get_debugLogFilePath $myXmlCertVault]
CkXmlCertVault_put_DebugLogFilePath $myXmlCertVault $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.

More Information and Examples
top
LastErrorHtml
string
# ckStr is a CkString
CkXmlCertVault_get_LastErrorHtml $myXmlCertVault $ckStr
set strVal [CkXmlCertVault_get_lastErrorHtml $myXmlCertVault]

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
string
# ckStr is a CkString
CkXmlCertVault_get_LastErrorText $myXmlCertVault $ckStr
set strVal [CkXmlCertVault_get_lastErrorText $myXmlCertVault]

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
string
# ckStr is a CkString
CkXmlCertVault_get_LastErrorXml $myXmlCertVault $ckStr
set strVal [CkXmlCertVault_get_lastErrorXml $myXmlCertVault]

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
boolean 1/0
set boolVal [CkXmlCertVault_get_LastMethodSuccess $myXmlCertVault]
CkXmlCertVault_put_LastMethodSuccess $myXmlCertVault $boolVal

Indicates the success or failure of the most recent method call: 1 means success, 0 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
string
# ckStr is a CkString
CkXmlCertVault_get_MasterPassword $myXmlCertVault $ckStr
set strVal [CkXmlCertVault_get_masterPassword $myXmlCertVault]
CkXmlCertVault_put_MasterPassword $myXmlCertVault $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
boolean 1/0
set boolVal [CkXmlCertVault_get_Utf8 $myXmlCertVault]
CkXmlCertVault_put_Utf8 $myXmlCertVault $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
boolean 1/0
set boolVal [CkXmlCertVault_get_VerboseLogging $myXmlCertVault]
CkXmlCertVault_put_VerboseLogging $myXmlCertVault $boolVal

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
string
# ckStr is a CkString
CkXmlCertVault_get_Version $myXmlCertVault $ckStr
set strVal [CkXmlCertVault_get_version $myXmlCertVault]

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

More Information and Examples
top

Methods

AddCert
# cert is a CkCert
set status [CkXmlCertVault_AddCert $cert]
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

top
AddCertBinary
# certBytes is a CkByteData
set status [CkXmlCertVault_AddCertBinary $certBytes]
Introduced in version 9.5.0.40

Adds a certificate to the XML vault from any binary format, such as DER.

Returns 1 for success, 0 for failure.

top
AddCertChain
# certChain is a CkCertChain
set status [CkXmlCertVault_AddCertChain $certChain]
Introduced in version 9.5.0.40

Adds a chain of certificates to the XML vault.

Returns 1 for success, 0 for failure.

top
AddCertEncoded
# encodedBytes is a string
# encoding is a string
set status [CkXmlCertVault_AddCertEncoded $encodedBytes $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 1 for success, 0 for failure.

top
AddCertFile
# path is a string
set status [CkXmlCertVault_AddCertFile $path]
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

top
AddCertString
# certData is a string
set status [CkXmlCertVault_AddCertString $certData]
Introduced in version 9.5.0.40

Adds a certificate from any string representation format such as PEM.

Returns 1 for success, 0 for failure.

top
AddPemFile
# path is a string
# password is a string
set status [CkXmlCertVault_AddPemFile $path $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 1 for success, 0 for failure.

top
AddPfx
# pfx is a CkPfx
set status [CkXmlCertVault_AddPfx $pfx]
Introduced in version 9.5.0.40

Adds a PFX (PKCS12) to the XML vault.

Returns 1 for success, 0 for failure.

top
AddPfxBinary
# pfxBytes is a CkByteData
# password is a string
set status [CkXmlCertVault_AddPfxBinary $pfxBytes $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 1 for success, 0 for failure.

top
AddPfxEncoded
# encodedBytes is a string
# encoding is a string
# password is a string
set status [CkXmlCertVault_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 1 for success, 0 for failure.

top
AddPfxFile
# path is a string
# password is a string
set status [CkXmlCertVault_AddPfxFile $path $password]
Introduced in version 9.5.0.40

Adds a PFX file to the XML vault.

Returns 1 for success, 0 for failure.

top
GetXml
# outStr is a CkString (output)
set status [CkXmlCertVault_GetXml $outStr]
set retStr [CkXmlCertVault_getXml $myXmlCertVault]
Introduced in version 9.5.0.40

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

Returns 1 for success, 0 for failure.

top
LoadXml
# xml is a string
set status [CkXmlCertVault_LoadXml $xml]
Introduced in version 9.5.0.40

Loads from an XML string.

Returns 1 for success, 0 for failure.

top
LoadXmlFile
# path is a string
set status [CkXmlCertVault_LoadXmlFile $path]
Introduced in version 9.5.0.40

Loads from an XML file.

Returns 1 for success, 0 for failure.

top
SaveXml
# path is a string
set status [CkXmlCertVault_SaveXml $path]
Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns 1 for success, 0 for failure.

top