TrustedRoots Tcl Reference Documentation
TrustedRoots
Current Version: 10.0.0
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, 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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml
# ckStr is a CkString
CkTrustedRoots_get_LastErrorHtml $myTrustedRoots $ckStr
set strVal [CkTrustedRoots_get_lastErrorHtml $myTrustedRoots]
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.
topLastErrorText
# ckStr is a CkString
CkTrustedRoots_get_LastErrorText $myTrustedRoots $ckStr
set strVal [CkTrustedRoots_get_lastErrorText $myTrustedRoots]
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.
LastErrorXml
# ckStr is a CkString
CkTrustedRoots_get_LastErrorXml $myTrustedRoots $ckStr
set strVal [CkTrustedRoots_get_lastErrorXml $myTrustedRoots]
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.
topLastMethodSuccess
set boolVal [CkTrustedRoots_get_LastMethodSuccess $myTrustedRoots]
CkTrustedRoots_put_LastMethodSuccess $myTrustedRoots $boolVal
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.
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. (Async methods are available starting in Chilkat v9.5.0.52.)
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns NULL on failure
topLoadTaskCaller
set status [CkTrustedRoots_LoadTaskCaller $task]