CertChain Tcl Reference Documentation

CertChain

Current Version: 9.5.0.97

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

Object Creation

set myCertChain [new CkCertChain]

Properties

DebugLogFilePath
string
# ckStr is a CkString
CkCertChain_get_DebugLogFilePath $myCertChain $ckStr
set strVal [CkCertChain_get_debugLogFilePath $myCertChain]
CkCertChain_put_DebugLogFilePath $myCertChain $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
string
# ckStr is a CkString
CkCertChain_get_LastErrorHtml $myCertChain $ckStr
set strVal [CkCertChain_get_lastErrorHtml $myCertChain]

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
string
# ckStr is a CkString
CkCertChain_get_LastErrorText $myCertChain $ckStr
set strVal [CkCertChain_get_lastErrorText $myCertChain]

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
string
# ckStr is a CkString
CkCertChain_get_LastErrorXml $myCertChain $ckStr
set strVal [CkCertChain_get_lastErrorXml $myCertChain]

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
boolean 1/0
set boolVal [CkCertChain_get_LastMethodSuccess $myCertChain]
CkCertChain_put_LastMethodSuccess $myCertChain $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.

top
NumCerts
integer
set intVal [CkCertChain_get_NumCerts $myCertChain]
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
integer
set intVal [CkCertChain_get_NumExpiredCerts $myCertChain]
Introduced in version 9.5.0.40

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

top
ReachesRoot
boolean 1/0
set boolVal [CkCertChain_get_ReachesRoot $myCertChain]
Introduced in version 9.5.0.44

1 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
boolean 1/0
set boolVal [CkCertChain_get_Utf8 $myCertChain]
CkCertChain_put_Utf8 $myCertChain $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.

top
VerboseLogging
boolean 1/0
set boolVal [CkCertChain_get_VerboseLogging $myCertChain]
CkCertChain_put_VerboseLogging $myCertChain $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.

top
Version
string
# ckStr is a CkString
CkCertChain_get_Version $myCertChain $ckStr
set strVal [CkCertChain_get_version $myCertChain]

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

More Information and Examples
top

Methods

GetCert
# returns a CkCert
# index is an integer
set ret_cert [CkCertChain_GetCert $index]
Introduced in version 9.5.0.40

Returns the Nth certificate in the chain.

Returns NULL on failure

top
IsRootTrusted
# trustedRoots is a CkTrustedRoots
set retBool [CkCertChain_IsRootTrusted $trustedRoots]
Introduced in version 9.5.0.40

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

top
LoadX5C
# jwk is a CkJsonObject
set status [CkCertChain_LoadX5C $jwk]
Introduced in version 9.5.0.66

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

Returns 1 for success, 0 for failure.

top
VerifyCertSignatures
set retBool [CkCertChain_VerifyCertSignatures]
Introduced in version 9.5.0.40

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

top
X509PKIPathv1
# outStr is a CkString (output)
set status [CkCertChain_X509PKIPathv1 $outStr]
set retStr [CkCertChain_x509PKIPathv1 $myCertChain]
Introduced in version 9.5.0.88

Returns the base64 representation of an X509PKIPathv1 containing the certificates in this chain. This is typically used in an X.509 Binary Security Token. It is a PKIPath that contains an ordered list of X.509 public certificates packaged in a PKIPath. The X509PKIPathv1 token type may be used to represent a certificate path. (This is sometimes used in XAdES signatures.)

Returns 1 for success, 0 for failure.

top