XmlCertVault Lua Reference Documentation
chilkat.XmlCertVault
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.XmlCertVault
Add certificates from
Import an entire
Load PEM files containing one or more certificates and/or private keys,
including encrypted PEM content when a password is supplied.
Add PFX data from a
Use
Export the vault with Collect certificates, certificate chains, PEM data, and PFX private keys in an XML vault.
Chilkat.XmlCertVault stores certificates and private-key
material in a portable XML-based certificate vault. It can add individual
certificates, certificate chains, DER or encoded certificates, PEM files,
certificate strings, and PFX/PKCS12 data from files, memory, encoded text, or
existing Chilkat objects. The vault can then be exported as XML, loaded from
XML, or saved to an XML file for later reuse by other Chilkat certificate and
TLS workflows.
Add certificates
Cert objects, files, PEM strings,
binary DER bytes, or encoded data such as Base64 or hex.
Add certificate chains
CertChain when related issuer and
intermediate certificates should be kept together in the vault.
Add PEM content
Add PFX / PKCS12
Pfx object, file, byte array, or encoded
string, using the PFX password to import private-key material.
Master password protection
MasterPassword to protect access to private keys stored
in the vault.
Load and save XML
GetXml, load it with
LoadXml or LoadXmlFile, and persist it with
SaveXml.
XmlCertVault, set MasterPassword when the
vault will contain private keys, add certificates or PFX/PEM material, then
save the vault with SaveXml or keep the XML string from
GetXml. Later, reload the same vault with LoadXml
or LoadXmlFile and provide the same master password before using
private keys.
MasterPassword, which is required to
access any private keys contained in the XML vault.
Object Creation
local chilkat = require("chilkat")
local xml_cert_vault = chilkat.XmlCertVault.new()Creates the object (chilkat.XmlCertVault() does the same). Lua's garbage collector frees it when it is no longer referenced; xml_cert_vault:dispose() frees it at once, and in Lua 5.4 and later local xml_cert_vault <close> = chilkat.XmlCertVault.new() frees it when the block ends. Calling a method of a disposed object raises an error.
Errors
A method that fails returns nil followed by the error text, as io.open does: local body, err = xml_cert_vault:method(...), where err is the object's last_error_text. Wrap the call in assert() to raise an error with that text instead. Methods that answer a question return true or false, numbers are returned as they are (check last_method_success where the description says a value means failure), and property reads and writes never fail for Chilkat reasons.
Misuse raises a Lua error: a wrong argument type or a missing argument (bad argument #1 to ...), an unknown property name, a write to a read-only property, an out-of-range integer, or an object of the wrong class.
Names are Chilkat's in snake_case: QuickGetStr is quick_get_str, LastErrorText is last_error_text. Properties are fields (xml_cert_vault.verbose_logging = true) and methods use the colon (xml_cert_vault:method(...)). Strings are UTF-8; binary data is a Lua string of bytes. Indexes are 0-based, as in every Chilkat API. Unlocking: call chilkat.unlock_bundle("...") once at startup.
Properties
DebugLogFilePath
local strVal = xml_cert_vault.debug_log_file_path
xml_cert_vault.debug_log_file_path = 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
local strVal = xml_cert_vault.last_error_html
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
local strVal = xml_cert_vault.last_error_text
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
local strVal = xml_cert_vault.last_error_xml
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
local boolVal = xml_cert_vault.last_method_success
xml_cert_vault.last_method_success = 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
MasterPassword
local strVal = xml_cert_vault.master_password
xml_cert_vault.master_password = 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.
topVerboseLogging
local boolVal = xml_cert_vault.verbose_logging
xml_cert_vault.verbose_logging = 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.
Version
local strVal = xml_cert_vault.version
Methods
AddCert
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:add_cert(cert)
Adds a certificate to the XML vault.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
AddCertChain
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:add_cert_chain(cert_chain)
Adds a chain of certificates to the XML vault.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
AddCertEncoded
-- encoding is a string
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:add_cert_encoded(encoded_bytes, 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 on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
AddCertFile
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:add_cert_file(path)
Adds a certificate to the XML vault.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
AddCertString
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:add_cert_string(cert_data)
Adds a certificate from any string representation format such as PEM.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
AddPemFile
-- password is a string
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:add_pem_file(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 on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
AddPfx
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:add_pfx(pfx)
Adds a PFX (PKCS12) to the XML vault.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
AddPfxEncoded
-- encoding is a string
-- password is a string
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:add_pfx_encoded(encoded_bytes, 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 on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
AddPfxFile
-- password is a string
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:add_pfx_file(path, password)
Adds a PFX file to the XML vault.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
GetXml
local str, err = xml_cert_vault:get_xml()
Returns the contents of the cert vault as an XML string.
Returns the string, or nil, err on failure (or when nothing is found). The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
LoadXml
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:load_xml(xml)
Loads from an XML string.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
LoadXmlFile
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:load_xml_file(path)
Loads from an XML file.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
SaveXml
-- ok is true, or nil and err on failure
local ok, err = xml_cert_vault:save_xml(path)
Saves the contents to an XML file.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.