CkTrustedRoots Ruby Reference Documentation

CkTrustedRoots

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

obj = Chilkat::CkTrustedRoots.new()

Properties

# strVal is a string
# ckStr is a CkString
trustedRoots.get_DebugLogFilePath(ckStr);
strVal = trustedRoots.debugLogFilePath();
trustedRoots.put_DebugLogFilePath(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.

# strVal is a string
# ckStr is a CkString
trustedRoots.get_LastErrorHtml(ckStr);
strVal = trustedRoots.lastErrorHtml();

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.

# strVal is a string
# ckStr is a CkString
trustedRoots.get_LastErrorText(ckStr);
strVal = trustedRoots.lastErrorText();

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

# strVal is a string
# ckStr is a CkString
trustedRoots.get_LastErrorXml(ckStr);
strVal = trustedRoots.lastErrorXml();

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.

# boolVal is a boolean
boolVal = trustedRoots.get_LastMethodSuccess();
trustedRoots.put_LastMethodSuccess(boolVal);

Introduced in version 9.5.0.52

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

# intVal is an integer
intVal = trustedRoots.get_NumCerts();

Introduced in version 9.5.0.38

The number of certificates contained within this object.

This is the number of certificates explicitly added by the methods AddCert, AddJavaKeyStore, and LoadCaCertsPem.

# boolVal is a boolean
boolVal = trustedRoots.get_TrustSystemCaRoots();
trustedRoots.put_TrustSystemCaRoots(boolVal);

Introduced in version 9.5.0.41

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 true. Set this property equal to false to prevent Chilkat from automatically trusting system-provided root CA certificates.

HTTP - Verify Server is a Trusted Root CA

# boolVal is a boolean
boolVal = trustedRoots.get_Utf8();
trustedRoots.put_Utf8(boolVal);

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

# boolVal is a boolean
boolVal = trustedRoots.get_VerboseLogging();
trustedRoots.put_VerboseLogging(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.

# strVal is a string
# ckStr is a CkString
trustedRoots.get_Version(ckStr);
strVal = trustedRoots.version();

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

Methods

retBool = trustedRoots.Activate();

Introduced in version 9.5.0.38

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.

HTTP - Verify Server is a Trusted Root CA

# cert is a CkCert
retBool = trustedRoots.AddCert(cert);

Introduced in version 9.5.0.41

Adds a certificate to the collection of trusted roots.

Use a Custom Set of Trusted Root Certificates

# keystore is a CkJavaKeyStore
status = trustedRoots.AddJavaKeyStore(keystore);

Introduced in version 9.5.0.44

Adds the trusted certificates from a Java key store to the collection of trusted roots.

Returns true for success, false for failure.

Load Certs from Java KeyStore into Trusted CA Roots

# returns a CkTask
# keystore is a CkJavaKeyStore
ret_task = trustedRoots.AddJavaKeyStoreAsync(keystore);

Introduced in version 9.5.0.44

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 nil on failure

How to Run an Asynchronous Task

status = trustedRoots.Deactivate();

Introduced in version 9.5.0.40

Deactivates a previously set of activated trusted roots so that all roots / self-signed certificates are implicitly trusted.

Returns true for success, false for failure.

# returns a CkCert
# index is an integer
ret_cert = trustedRoots.GetCert(index);

Introduced in version 9.5.0.38

Returns the Nth cert contained within this object. The 1st certificate is at index 0.

Returns nil on failure

Load CA Cert Bundle into Trusted Roots

# path is a string
retBool = trustedRoots.LoadCaCertsPem(path);

Introduced in version 9.5.0.38

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.

Load CA Cert Bundle into Trusted Roots

# returns a CkTask
# path is a string
ret_task = trustedRoots.LoadCaCertsPemAsync(path);

Introduced in version 9.5.0.38

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 nil on failure

How to Run an Asynchronous Task

# path is a string
status = trustedRoots.SaveLastError(path);

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

Returns true for success, false for failure.