CkCertChain Ruby Reference Documentation

CkCertChain

Current Version: 9.5.0.75

Contains certificates in a chain of authentication to a trusted root.

Object Creation

obj = Chilkat::CkCertChain.new()

Properties

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

top
LastErrorHtml
# strVal is a string
# ckStr is a CkString
certChain.get_LastErrorHtml(ckStr);
strVal = certChain.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.

top
LastErrorText
# strVal is a string
# ckStr is a CkString
certChain.get_LastErrorText(ckStr);
strVal = certChain.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.

top
LastErrorXml
# strVal is a string
# ckStr is a CkString
certChain.get_LastErrorXml(ckStr);
strVal = certChain.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.

top
LastMethodSuccess
# boolVal is a boolean
boolVal = certChain.get_LastMethodSuccess();
certChain.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.

top
NumCerts
# intVal is an integer
intVal = certChain.get_NumCerts();
Introduced in version 9.5.0.40

The number of certificates in the chain. The end-user subscriber certificate is at index 0. This is the certificate most removed from the trusted root. Intermediate certificates are at indices 1 to NumCerts - 2. The trusted root (or self-signed certificate) is at index NumCerts - 1.

top
NumExpiredCerts
# intVal is an integer
intVal = certChain.get_NumExpiredCerts();
Introduced in version 9.5.0.40

Returns the number of certificates in the chain that have expired.

top
ReachesRoot
# boolVal is a boolean
boolVal = certChain.get_ReachesRoot();
Introduced in version 9.5.0.44

true if this certificate chain extends all the way to the root certificate. The root certificate is either a trusted CA root or a self-signed certificate. In both cases, the issuer of a root certificate is itself.

top
Utf8
# boolVal is a boolean
boolVal = certChain.get_Utf8();
certChain.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.

top
VerboseLogging
# boolVal is a boolean
boolVal = certChain.get_VerboseLogging();
certChain.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.

top
Version
# strVal is a string
# ckStr is a CkString
certChain.get_Version(ckStr);
strVal = certChain.version();

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

top

Methods

GetCert
# returns a CkCert
# index is an integer
ret_cert = certChain.GetCert(index);
Introduced in version 9.5.0.40

Returns the Nth certificate in the chain.

Returns nil on failure

top
IsRootTrusted
# trustedRoots is a CkTrustedRoots
retBool = certChain.IsRootTrusted(trustedRoots);
Introduced in version 9.5.0.40

Returns true if the root of the certificate chain is a certificate found in trustedRoots.

top
LoadX5C
# jwk is a CkJsonObject
status = certChain.LoadX5C(jwk);
Introduced in version 9.5.0.66

Loads a certificate chain from the "x5c" parameter of a JWK (JSON Web Key).

Returns true for success, false for failure.

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

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

Returns true for success, false for failure.

top
VerifyCertSignatures
retBool = certChain.VerifyCertSignatures();
Introduced in version 9.5.0.40

Verifies the certificate signatures to the root. Returns true if all certificate signatures are valid.

top