XmlCertVault Tcl Reference Documentation

XmlCertVault

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

LastErrorHtml (string)

# ckStr is a CkString
CkXmlCertVault_get_LastErrorHtml $myXmlCertVault $ckStr
set strVal [CkXmlCertVault_get_lastErrorHtml $myXmlCertVault]

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.

LastErrorText (string)

# ckStr is a CkString
CkXmlCertVault_get_LastErrorText $myXmlCertVault $ckStr
set strVal [CkXmlCertVault_get_lastErrorText $myXmlCertVault]

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.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml (string)

# ckStr is a CkString
CkXmlCertVault_get_LastErrorXml $myXmlCertVault $ckStr
set strVal [CkXmlCertVault_get_lastErrorXml $myXmlCertVault]

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.

LastMethodSuccess (boolean 1/0)

set boolVal [CkXmlCertVault_get_LastMethodSuccess $myXmlCertVault]
CkXmlCertVault_put_LastMethodSuccess $myXmlCertVault $boolVal

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

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.

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.

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.

Version (string)

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

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

Methods

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# path is a string
set status [CkXmlCertVault_SaveLastError $path]

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

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