CertChain C Reference Documentation
CertChain
Current Version: 10.1.3
Contains certificates in a chain of authentication to a trusted root.
Create/Dispose
HCkCertChain instance = CkCertChain_Create(); // ... CkCertChain_Dispose(instance);
Creates an instance of the HCkCertChain object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkCertChain_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkCertChain_Dispose.
Properties
DebugLogFilePath
void CkCertChain_putDebugLogFilePath(HCkCertChain cHandle, const char *newVal);
const char *CkCertChain_debugLogFilePath(HCkCertChain cHandle);
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
const char *CkCertChain_lastErrorHtml(HCkCertChain cHandle);
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
const char *CkCertChain_lastErrorText(HCkCertChain cHandle);
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
const char *CkCertChain_lastErrorXml(HCkCertChain cHandle);
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
void CkCertChain_putLastMethodSuccess(HCkCertChain cHandle, BOOL newVal);
Indicates the success or failure of the most recent method call: TRUE means success, FALSE 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
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.
topNumExpiredCerts
Returns the number of certificates in the chain that have expired.
topReachesRoot
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.
topUncommonOptions
void CkCertChain_putUncommonOptions(HCkCertChain cHandle, const char *newVal);
const char *CkCertChain_uncommonOptions(HCkCertChain cHandle);
Can be set to a comma separated list of keywords to specify uncommon options. The current uncommon options are:
- PkiPathV1.ExcludeRoot Exclude the root certificate in the X509PKIPathv1 method.
Utf8
void CkCertChain_putUtf8(HCkCertChain cHandle, BOOL newVal);
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.
topVerboseLogging
void CkCertChain_putVerboseLogging(HCkCertChain cHandle, BOOL newVal);
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.
topVersion
const char *CkCertChain_version(HCkCertChain cHandle);
Methods
GetCert
IsRootTrusted
Returns TRUE if the root of the certificate chain is a certificate found in trustedRoots.
topLoadX5C
Loads a certificate chain from the "x5c" parameter of a JWK (JSON Web Key).
Returns TRUE for success, FALSE for failure.
topVerifyCertSignatures
Verifies the certificate signatures to the root. Returns TRUE if all certificate signatures are valid.
topX509PKIPathv1
const char *CkCertChain_x509PKIPathv1(HCkCertChain cHandle);
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 TRUE for success, FALSE for failure.
top