TrustedRoots Tcl Reference Documentation
TrustedRoots
Current Version: 10.1.2
Used to set and manage the CA root certificates trusted by your application. This applies to PKCS7 (S/MIME) signature validation and SSL/TLS server certificates.
Object Creation
set myTrustedRoots [new CkTrustedRoots]
Properties
DebugLogFilePath
# ckStr is a CkString
CkTrustedRoots_get_DebugLogFilePath $myTrustedRoots $ckStr
set strVal [CkTrustedRoots_get_debugLogFilePath $myTrustedRoots]
CkTrustedRoots_put_DebugLogFilePath $myTrustedRoots $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
CkTrustedRoots_get_LastErrorHtml $myTrustedRoots $ckStr
set strVal [CkTrustedRoots_get_lastErrorHtml $myTrustedRoots]
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
CkTrustedRoots_get_LastErrorText $myTrustedRoots $ckStr
set strVal [CkTrustedRoots_get_lastErrorText $myTrustedRoots]
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
CkTrustedRoots_get_LastErrorXml $myTrustedRoots $ckStr
set strVal [CkTrustedRoots_get_lastErrorXml $myTrustedRoots]
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
set boolVal [CkTrustedRoots_get_LastMethodSuccess $myTrustedRoots]
CkTrustedRoots_put_LastMethodSuccess $myTrustedRoots $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.
topNumCerts
set intVal [CkTrustedRoots_get_NumCerts $myTrustedRoots]
The number of certificates contained within this object.
This is the number of certificates explicitly added by the methods AddCert, AddJavaKeyStore, and LoadCaCertsPem.
topRejectSelfSignedCerts
set boolVal [CkTrustedRoots_get_RejectSelfSignedCerts $myTrustedRoots]
CkTrustedRoots_put_RejectSelfSignedCerts $myTrustedRoots $boolVal
Indicates whether all self-signed certificates are to be rejected in SSL/TLS connections. The default value of this property is 0.
Note: This is for the case where the server certificate chain of authentication is 1 certificate long (i.e. the TLS server certificate itself is self-signed).
topTrustSystemCaRoots
set boolVal [CkTrustedRoots_get_TrustSystemCaRoots $myTrustedRoots]
CkTrustedRoots_put_TrustSystemCaRoots $myTrustedRoots $boolVal
Indicates whether the operating system's CA root certificates are automatically trusted.
On a Windows operating system, this would be the registry-based CA certificate stores. On a Linux system, this could be /etc/ssl/certs/ca-certificates.crt, if it exists. The default value is 1. Set this property equal to 0 to prevent Chilkat from automatically trusting system-provided root CA certificates.
Utf8
set boolVal [CkTrustedRoots_get_Utf8 $myTrustedRoots]
CkTrustedRoots_put_Utf8 $myTrustedRoots $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.
topVerboseLogging
set boolVal [CkTrustedRoots_get_VerboseLogging $myTrustedRoots]
CkTrustedRoots_put_VerboseLogging $myTrustedRoots $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.
topVersion
# ckStr is a CkString
CkTrustedRoots_get_Version $myTrustedRoots $ckStr
set strVal [CkTrustedRoots_get_version $myTrustedRoots]
Methods
Activate
Activates this collection of trusted roots as the set of CA and self-signed root certificates that are to be trusted Chilkat-wide for PKCS7 signature validation and SSL/TLS server certificate validation.
AddCert
set retBool [CkTrustedRoots_AddCert $cert]
AddJavaKeyStore
set status [CkTrustedRoots_AddJavaKeyStore $keystore]
Adds the trusted certificates from a Java key store to the collection of trusted roots.
Returns 1 for success, 0 for failure.
AddJavaKeyStoreAsync (1)
# keystore is a CkJavaKeyStore
set ret_task [CkTrustedRoots_AddJavaKeyStoreAsync $keystore]
Creates an asynchronous task to call the AddJavaKeyStore method with the arguments provided.
Returns NULL on failure
topDeactivate
Deactivates a previous set of activated trusted roots so that all roots / self-signed certificates are implicitly trusted.
Returns 1 for success, 0 for failure.
topGetCert
# index is an integer
set ret_cert [CkTrustedRoots_GetCert $index]
Returns the Nth cert contained within this object. The 1st certificate is at index 0.
Returns NULL on failure
LoadCaCertsPem
set retBool [CkTrustedRoots_LoadCaCertsPem $path]
Loads a CA bundle in PEM format. This is a file containing CA root certificates that are to be trusted. An example of one such file is the CA certs from mozilla.org exported to a cacert.pem file by the mk-ca-bundle tool located here: http://curl.haxx.se/docs/caextract.html.
Note: This can also be called to load the /etc/ssl/certs/ca-certificates.crt file on Linux systems.
LoadCaCertsPemAsync (1)
# path is a string
set ret_task [CkTrustedRoots_LoadCaCertsPemAsync $path]
Creates an asynchronous task to call the LoadCaCertsPem method with the arguments provided.
Returns NULL on failure
topLoadTaskCaller
set status [CkTrustedRoots_LoadTaskCaller $task]