Cert Tcl Reference Documentation

Cert

Current Version: 9.5.0.73

Digital certificate component / class

Object Creation

set myCert [new CkCert]

Properties

AuthorityKeyId
string
# ckStr is a CkString
CkCert_get_AuthorityKeyId $myCert $ckStr
set strVal [CkCert_get_authorityKeyId $myCert]
Introduced in version 9.5.0.40

The authority key identifier of the certificate in base64 string format. This is only present if the certificate contains the extension OID 2.5.29.35.

top
AvoidWindowsPkAccess
boolean 1/0
set boolVal [CkCert_get_AvoidWindowsPkAccess $myCert]
CkCert_put_AvoidWindowsPkAccess $myCert $boolVal

Applies only when running on a Microsoft Windows operating system. If 1, then any method that returns a certificate will not try to also access the associated private key, assuming one exists. This is useful if the certificate was installed with high-security such that a private key access would trigger the Windows OS to display a security warning dialog. The default value of this property is 0.

top
CertVersion
integer
set intVal [CkCert_get_CertVersion $myCert]

The version of the certificate (1, 2, or 3). A value of 0 indicates an error -- the most likely cause being that the certificate object is empty (i.e. was never loaded with a certificate). Note: This is not the version of the software, it is the version of the X.509 certificate object. The version of the Chilkat certificate software is indicated by the Version property.

top
CspName
string
# ckStr is a CkString
CkCert_get_CspName $myCert $ckStr
set strVal [CkCert_get_cspName $myCert]

(Relevant only when running on a Microsoft Windows operating system.) If the HasKeyContainer property is 1, then the certificate is linked to a key container and this property contains the name of the associated CSP (cryptographic service provider). When a certificate is linked to a key container , the following properties will provide information about the key container and private key: CspName, KeyContainerName, MachineKeyset, and Silent.

top
DebugLogFilePath
string
# ckStr is a CkString
CkCert_get_DebugLogFilePath $myCert $ckStr
set strVal [CkCert_get_debugLogFilePath $myCert]
CkCert_put_DebugLogFilePath $myCert $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
Expired
boolean 1/0
set boolVal [CkCert_get_Expired $myCert]

Has a value of 1 if the certificate or any certificate in the chain of authority has expired. (This information is not available when running on Windows 95/98 computers.)

top
ForClientAuthentication
boolean 1/0
set boolVal [CkCert_get_ForClientAuthentication $myCert]

1 if this certificate can be used for client authentication, otherwise 0.

top
ForCodeSigning
boolean 1/0
set boolVal [CkCert_get_ForCodeSigning $myCert]

1 if this certificate can be used for code signing, otherwise 0.

top
ForSecureEmail
boolean 1/0
set boolVal [CkCert_get_ForSecureEmail $myCert]

1 if this certificate can be used for sending secure email, otherwise 0.

top
ForServerAuthentication
boolean 1/0
set boolVal [CkCert_get_ForServerAuthentication $myCert]

1 if this certificate can be used for server authentication, otherwise 0.

top
ForTimeStamping
boolean 1/0
set boolVal [CkCert_get_ForTimeStamping $myCert]

1 if this certificate can be used for time stamping, otherwise 0.

top
HasKeyContainer
boolean 1/0
set boolVal [CkCert_get_HasKeyContainer $myCert]

(Relevant only when running on a Microsoft Windows operating system.) Indicates whether this certificate is linked to a key container. If 1 then the certificate is linked to a key container (usually containing a private key). If 0, then it is not.

When a certificate is linked to a key container , the following properties will provide information about the key container and private key: CspName, KeyContainerName, MachineKeyset, and Silent.

top
IntendedKeyUsage
unsigned integer
set intVal [CkCert_get_IntendedKeyUsage $myCert]

Bitflags indicating the intended usages of the certificate. The flags are:
Digital Signature: 0x80
Non-Repudiation: 0x40
Key Encipherment: 0x20
Data Encipherment: 0x10
Key Agreement: 0x08
Certificate Signing: 0x04
CRL Signing: 0x02
Encipher-Only: 0x01

top
IsRoot
boolean 1/0
set boolVal [CkCert_get_IsRoot $myCert]

1 if this is the root certificate, otherwise 0.

top
IssuerC
string
# ckStr is a CkString
CkCert_get_IssuerC $myCert $ckStr
set strVal [CkCert_get_issuerC $myCert]

The certificate issuer's country.

top
IssuerCN
string
# ckStr is a CkString
CkCert_get_IssuerCN $myCert $ckStr
set strVal [CkCert_get_issuerCN $myCert]

The certificate issuer's common name.

top
IssuerDN
string
# ckStr is a CkString
CkCert_get_IssuerDN $myCert $ckStr
set strVal [CkCert_get_issuerDN $myCert]

The issuer's full distinguished name.

top
IssuerE
string
# ckStr is a CkString
CkCert_get_IssuerE $myCert $ckStr
set strVal [CkCert_get_issuerE $myCert]

The certificate issuer's email address.

top
IssuerL
string
# ckStr is a CkString
CkCert_get_IssuerL $myCert $ckStr
set strVal [CkCert_get_issuerL $myCert]

The certificate issuer's locality, which could be a city, count, township, or other geographic region.

top
IssuerO
string
# ckStr is a CkString
CkCert_get_IssuerO $myCert $ckStr
set strVal [CkCert_get_issuerO $myCert]

The certificate issuer's organization, which is typically the company name.

top
IssuerOU
string
# ckStr is a CkString
CkCert_get_IssuerOU $myCert $ckStr
set strVal [CkCert_get_issuerOU $myCert]

The certificate issuer's organizational unit, which is the unit within the organization.

top
IssuerS
string
# ckStr is a CkString
CkCert_get_IssuerS $myCert $ckStr
set strVal [CkCert_get_issuerS $myCert]

The certificate issuer's state or province.

top
KeyContainerName
string
# ckStr is a CkString
CkCert_get_KeyContainerName $myCert $ckStr
set strVal [CkCert_get_keyContainerName $myCert]

(Relevant only when running on a Microsoft Windows operating system.) If the HasKeyContainer property is 1, then the certificate is linked to a key container and this property contains the name of the key container.

When a certificate is linked to a key container , the following properties will provide information about the key container and private key: CspName, KeyContainerName, MachineKeyset, and Silent.

top
LastErrorHtml
string
# ckStr is a CkString
CkCert_get_LastErrorHtml $myCert $ckStr
set strVal [CkCert_get_lastErrorHtml $myCert]

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
CkCert_get_LastErrorText $myCert $ckStr
set strVal [CkCert_get_lastErrorText $myCert]

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
CkCert_get_LastErrorXml $myCert $ckStr
set strVal [CkCert_get_lastErrorXml $myCert]

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 [CkCert_get_LastMethodSuccess $myCert]
CkCert_put_LastMethodSuccess $myCert $boolVal
Introduced in version 9.5.0.52

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
MachineKeyset
boolean 1/0
set boolVal [CkCert_get_MachineKeyset $myCert]

(Relevant only when running on a Microsoft Windows operating system.) If the HasKeyContainer property is 1, then the certificate is linked to a key container and this property indicates whether the key container is in the machine's keyset or in the keyset specific to the logged on user's account. If 1, the key container is within the machine keyset. If 0, it's in the user's keyset.

When a certificate is linked to a key container , the following properties will provide information about the key container and private key: CspName, KeyContainerName, MachineKeyset, and Silent.

top
OcspUrl
string
# ckStr is a CkString
CkCert_get_OcspUrl $myCert $ckStr
set strVal [CkCert_get_ocspUrl $myCert]

If present in the certificate's extensions, returns the OCSP URL of the certificate. (The Online Certificate Status Protocol (OCSP) is an Internet protocol used for obtaining the revocation status of an X.509 digital certificate.)

top
PrivateKeyExportable
boolean 1/0
set boolVal [CkCert_get_PrivateKeyExportable $myCert]

(Relevant only when running on a Microsoft Windows operating system.) Indicates whether the private key was installed with security settings that allow it to be re-exported.

top
Revoked
boolean 1/0
set boolVal [CkCert_get_Revoked $myCert]

1 if the certificate or any certificate in the chain of authority has been revoked. This information is not available when running on Windows 95/98 computers. Note: If this property is 0, it could mean that it was not able to check the revocation status. Because of this uncertainty, a CheckRevoked method has been added. It returns an integer indicating one of three possible states: 1 (revoked) , 0 (not revoked), -1 (unable to check revocation status).

top
Rfc822Name
string
# ckStr is a CkString
CkCert_get_Rfc822Name $myCert $ckStr
set strVal [CkCert_get_rfc822Name $myCert]

The RFC-822 name of the certificate. (Also known as the Subject Alternative Name.)

If the certificate contains a list of Subject Alternative Names, such as a list of host names to be protected by a single SSL certificate, then this property will contain the comma separated list of names.

top
SelfSigned
boolean 1/0
set boolVal [CkCert_get_SelfSigned $myCert]

1 if this is a self-signed certificate, otherwise 0.

top
SerialNumber
string
# ckStr is a CkString
CkCert_get_SerialNumber $myCert $ckStr
set strVal [CkCert_get_serialNumber $myCert]

The certificate's serial number as a hexidecimal string.

top
Sha1Thumbprint
string
# ckStr is a CkString
CkCert_get_Sha1Thumbprint $myCert $ckStr
set strVal [CkCert_get_sha1Thumbprint $myCert]

Hexidecimal string of the SHA-1 thumbprint for the certificate.

top
SignatureVerified
boolean 1/0
set boolVal [CkCert_get_SignatureVerified $myCert]

Returns 1 if the certificate and all certificates in the chain of authority have valid signatures, otherwise returns 0.

top
Silent
boolean 1/0
set boolVal [CkCert_get_Silent $myCert]

(Relevant only when running on a Microsoft Windows operating system.) If the HasKeyContainer property is 1, then the certificate is linked to a key container and this property indicates whether accessing the private key will cause the operating system to launch an interactive warning dialog. If 0 a warning dialog will be displayed. If 1 then private key accesses are silent.

When a certificate is linked to a key container , the following properties will provide information about the key container and private key: CspName, KeyContainerName, MachineKeyset, and Silent.

top
SubjectC
string
# ckStr is a CkString
CkCert_get_SubjectC $myCert $ckStr
set strVal [CkCert_get_subjectC $myCert]

The certificate subject's country.

top
SubjectCN
string
# ckStr is a CkString
CkCert_get_SubjectCN $myCert $ckStr
set strVal [CkCert_get_subjectCN $myCert]

The certificate subject's common name.

top
SubjectDN
string
# ckStr is a CkString
CkCert_get_SubjectDN $myCert $ckStr
set strVal [CkCert_get_subjectDN $myCert]

The certificate subject's full distinguished name.

top
SubjectE
string
# ckStr is a CkString
CkCert_get_SubjectE $myCert $ckStr
set strVal [CkCert_get_subjectE $myCert]

The certificate subject's email address.

top
SubjectKeyId
string
# ckStr is a CkString
CkCert_get_SubjectKeyId $myCert $ckStr
set strVal [CkCert_get_subjectKeyId $myCert]
Introduced in version 9.5.0.40

The subject key identifier of the certificate in base64 string format. This is only present if the certificate contains the extension OID 2.5.29.14.

top
SubjectL
string
# ckStr is a CkString
CkCert_get_SubjectL $myCert $ckStr
set strVal [CkCert_get_subjectL $myCert]

The certificate subject's locality, which could be a city, count, township, or other geographic region.

top
SubjectO
string
# ckStr is a CkString
CkCert_get_SubjectO $myCert $ckStr
set strVal [CkCert_get_subjectO $myCert]

The certificate subject's organization, which is typically the company name.

top
SubjectOU
string
# ckStr is a CkString
CkCert_get_SubjectOU $myCert $ckStr
set strVal [CkCert_get_subjectOU $myCert]

The certificate subject's organizational unit, which is the unit within the organization.

top
SubjectS
string
# ckStr is a CkString
CkCert_get_SubjectS $myCert $ckStr
set strVal [CkCert_get_subjectS $myCert]

The certificate subject's state or province.

top
TrustedRoot
boolean 1/0
set boolVal [CkCert_get_TrustedRoot $myCert]

Returns 1 if the certificate has a trusted root authority, otherwise returns 0.

Note: As of version 9.5.0.41, the notion of what your application deems as trusted becomes more specific. The TrustedRoots class/object was added in v9.5.0.0. Prior to this, a certificate was considered to be anchored by a trusted root if the certificate chain could be established to a root (self-signed) certificate, AND if the root certificate was located somewhere in the Windows registry-based certificate stores. There are two problems with this: (1) it's a Windows-only solution. This property would always return 0 on non-Windows systems, and (2) it might be considered not a strong enough set of conditions for trusting a root certificate.

As of version 9.5.0.41, this property pays attention to the new TrustedRoots class/object, which allows for an application to specificallly indicate which root certificates are to be trusted. Certificates may be added to the TrustedRoots object via the LoadCaCertsPem or AddCert methods, and then activated by calling the TrustedRoots.Activate method. The activated trusted roots are deemed to be trusted in any Chilkat API method/property that needs to make this determination. In addition, the TrustedRoots object has a property named TrustSystemCaRoots, which defaults to 1, which allows for backward compatibility. It will trust CA certificates stored in the Windows registry-based certificate stores, or if on Linux, will trust certificates found in /etc/ssl/certs/ca-certificates.crt.

top
Utf8
boolean 1/0
set boolVal [CkCert_get_Utf8 $myCert]
CkCert_put_Utf8 $myCert $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
ValidFromStr
string
# ckStr is a CkString
CkCert_get_ValidFromStr $myCert $ckStr
set strVal [CkCert_get_validFromStr $myCert]

The date (in RFC822 string format) that this certificate becomes (or became) valid. It is a GMT/UTC date that is returned.

top
ValidToStr
string
# ckStr is a CkString
CkCert_get_ValidToStr $myCert $ckStr
set strVal [CkCert_get_validToStr $myCert]

The date (in RFC822 string format) that this certificate becomes (or became) invalid. It is a GMT/UTC date that is returned.

top
VerboseLogging
boolean 1/0
set boolVal [CkCert_get_VerboseLogging $myCert]
CkCert_put_VerboseLogging $myCert $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
CkCert_get_Version $myCert $ckStr
set strVal [CkCert_get_version $myCert]

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

top

Methods

CheckRevoked
set retInt [CkCert_CheckRevoked]

Returns 1 if the certificate has been revoked, 0 if not revoked, and -1 if unable to check the revocation status.

top
ExportCertDer
# outData is a CkByteData (output)
set status [CkCert_ExportCertDer $outData]

Exports the digital certificate to ASN.1 DER format.

Returns 1 for success, 0 for failure.

top
ExportCertDerBd
# cerData is a CkBinData
set status [CkCert_ExportCertDerBd $cerData]
Introduced in version 9.5.0.70

Exports the digital certificate in ASN.1 DER format to a BinData object.

Returns 1 for success, 0 for failure.

top
ExportCertDerFile
# path is a string
set status [CkCert_ExportCertDerFile $path]

Exports the digital certificate to ASN.1 DER format binary file.

Returns 1 for success, 0 for failure.

top
ExportCertPem
# outStr is a CkString (output)
set status [CkCert_ExportCertPem $outStr]
set retStr [CkCert_exportCertPem $myCert]

Exports the digital certificate to an unencrypted PEM formatted string.

Returns 1 for success, 0 for failure.

top
ExportCertPemFile
# path is a string
set status [CkCert_ExportCertPemFile $path]

Exports the digital certificate to an unencrypted PEM formatted file.

Returns 1 for success, 0 for failure.

top
ExportCertXml
# outStr is a CkString (output)
set status [CkCert_ExportCertXml $outStr]
set retStr [CkCert_exportCertXml $myCert]

Exports a certificate to an XML format where the XML tags are the names of the ASN.1 objects that compose the X.509 certificate. Binary data is either hex or base64 encoded. (The binary data for a "bits" ASN.1 tag is hex encoded, whereas for all other ASN.1 tags, such as "octets", it is base64.)

Returns 1 for success, 0 for failure.

top
ExportPrivateKey
# returns a CkPrivateKey
set ret_privateKey [CkCert_ExportPrivateKey]

Exports the certificate's private key.

Returns NULL on failure

top
ExportPublicKey
# returns a CkPublicKey
set ret_publicKey [CkCert_ExportPublicKey]

Exports the certificate's public key.

Returns NULL on failure

More Information and Examples
top
ExportToPfxBd
# password is a string
# includeCertChain is a boolean
# pfxData is a CkBinData
set status [CkCert_ExportToPfxBd $password $includeCertChain $pfxData]
Introduced in version 9.5.0.70

Exports the certificate and private key (if available) to pfxData. The password is what will be required to access the PFX contents at a later time. If includeCertChain is 1, then the certificates in the chain of authority are also included in the PFX.

Returns 1 for success, 0 for failure.

top
ExportToPfxData
# password is a string
# includeCertChain is a boolean
# outBytes is a CkByteData (output)
set status [CkCert_ExportToPfxData $password $includeCertChain $outData]
Introduced in version 9.5.0.31

Exports the certificate and private key (if available) to an in-memory PFX image. The password is what will be required to access the PFX contents at a later time. If includeCertChain is 1, then the certificates in the chain of authority are also included in the PFX.

Returns 1 for success, 0 for failure.

top
ExportToPfxFile
# pfxFilename is a string
# pfxPassword is a string
# bIncludeCertChain is a boolean
set status [CkCert_ExportToPfxFile $pfxFilename $pfxPassword $bIncludeCertChain]

Exports the certificate and private key (if available) to a PFX (.pfx or .p12) file. The output PFX is secured using the pfxPassword. If bIncludeCertChain is 1, then the certificates in the chain of authority are also included in the PFX output file.

Returns 1 for success, 0 for failure.

top
FindIssuer
# returns a CkCert
set ret_cert [CkCert_FindIssuer]

Finds and returns the issuer certificate. If the certificate is a root or self-issued, then the certificate returned is a copy of the caller certificate. (The IsRoot property can be check to see if the certificate is a root (or self-issued) certificate.)

Returns NULL on failure

top
GetCertChain
# returns a CkCertChain
set ret_certChain [CkCert_GetCertChain]
Introduced in version 9.5.0.40

Returns a certficate chain object containing all the certificates (including this one), in the chain of authentication to the trusted root (if possible). If this certificate object was loaded from a PFX, then the certiicates contained in the PFX are automatically available for building the certificate chain. The UseCertVault method can be called to provide additional certificates that might be required to build the cert chain. Finally, the TrustedRoots object can be used to provide a way of making trusted root certificates available.

Note: Prior to v9.5.0.50, this method would fail if the certificate chain could not be completed to the root. Starting in v9.5.0.50, the incomplete certificate chain will be returned. The certificate chain's ReachesRoot property can be examined to see if the chain was completed to the root.

On Windows systems, the registry-based certificate stores are automatically consulted if needed to locate intermediate or root certificates in the chain.

Returns NULL on failure

top
GetEncoded
# outStr is a CkString (output)
set status [CkCert_GetEncoded $outStr]
set retStr [CkCert_getEncoded $myCert]

Returns a base64 encoded string representation of the certificate's binary DER format, which can be passed to SetFromEncoded to recreate the certificate object.

Returns 1 for success, 0 for failure.

top
GetExtensionAsXml
# oid is a string
# outStr is a CkString (output)
set status [CkCert_GetExtensionAsXml $oid $outStr]
set retStr [CkCert_getExtensionAsXml $myCert $oid]
Introduced in version 9.5.0.49

Returns the certificate extension data in XML format (converted from ASN.1). The oid is an OID, such as the ones listed here: http://www.alvestrand.no/objectid/2.5.29.html

Note: In many cases, the data within the XML is returned base64 encoded. An application may need to take one further step to base64 decode the information contained within the XML.

Returns 1 for success, 0 for failure.

top
GetPrivateKeyPem
# outStr is a CkString (output)
set status [CkCert_GetPrivateKeyPem $outStr]
set retStr [CkCert_getPrivateKeyPem $myCert]

Exports the certificate's private key to a PEM string (if the private key is available).

Returns 1 for success, 0 for failure.

top
GetSpkiFingerprint
# hashAlg is a string
# encoding is a string
# outStr is a CkString (output)
set status [CkCert_GetSpkiFingerprint $hashAlg $encoding $outStr]
set retStr [CkCert_getSpkiFingerprint $myCert $hashAlg $encoding]
Introduced in version 9.5.0.55

Returns the SPKI Fingerprint suitable for use in pinning. (See RFC 7469.) An SPKI Fingerprint is defined as the output of a known cryptographic hash algorithm whose input is the DER-encoded ASN.1 representation of the Subject Public Key Info (SPKI) of an X.509 certificate. The hashAlg specifies the hash algorithm and may be "sha256", "sha384", "sha512", "sha1", "md2", "md5", "haval", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The encoding specifies the encoding, and may be "base64", "hex", or any of the encoding modes specified in the article at the link below.

Returns 1 for success, 0 for failure.

More Information and Examples
top
GetValidFromDt
# returns a CkDateTime
set ret_ckDateTime [CkCert_GetValidFromDt]

Returns the date/time this certificate becomes (or became) valid.

Returns NULL on failure

top
GetValidToDt
# returns a CkDateTime
set ret_ckDateTime [CkCert_GetValidToDt]

Returns the date/time this certificate becomes (or became) invalid.

Returns NULL on failure

top
HasPrivateKey
set retBool [CkCert_HasPrivateKey]

Returns true if the private key is installed on the local system for the certificate.

top
LinkPrivateKey
# keyContainerName is a string
# bMachineKeyset is a boolean
# bForSigning is a boolean
set status [CkCert_LinkPrivateKey $keyContainerName $bMachineKeyset $bForSigning]

(Relevant only when running on a Microsoft Windows operating system.) Associates a private key with a certificate. The private key is specified by providing the name of the key container where it can be found. The 2nd argument indicates whether the key container is from the machine-wide keyset (1), or from the keyset specific to the logged-on user (0). Private keys can be imported into a key container by calling the KeyContainer's ImportPrivateKey method. Once a certificate has been linked, the private key is available for creating digital signatures or decrypting. Note: Certificates imported from a PFX or from a Certificate Authority will already be "linked" and it is not necessary to call this method.

Returns 1 for success, 0 for failure.

top
LoadByCommonName
# cn is a string
set status [CkCert_LoadByCommonName $cn]

(Relevant only when running on a Microsoft Windows operating system.) Searches the Windows Local Machine and Current User registry-based certificate stores for a certificate having the common name specified. If found, the certificate is loaded and ready for use.

Returns 1 for success, 0 for failure.

top
LoadByEmailAddress
# emailAddress is a string
set status [CkCert_LoadByEmailAddress $emailAddress]

(Relevant only when running on a Microsoft Windows operating system.) Searches the Windows Local Machine and Current User registry-based certificate stores for a certificate containing the email address specified. If found, the certificate is loaded and ready for use.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LoadByIssuerAndSerialNumber
# issuerCN is a string
# serialNumber is a string
set status [CkCert_LoadByIssuerAndSerialNumber $issuerCN $serialNumber]

(Relevant only when running on a Microsoft Windows operating system.) Searches the Windows Local Machine and Current User registry-based certificate stores for a certificate matching the issuerCN and having an issuer matching the serialNumber. If found, the certificate is loaded and ready for use.

Returns 1 for success, 0 for failure.

top
LoadFromBase64
# encodedCert is a string
set status [CkCert_LoadFromBase64 $encodedCert]

Loads an ASN.1 or DER encoded certificate represented in a Base64 string.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LoadFromBd
# certBytes is a CkBinData
set status [CkCert_LoadFromBd $certBytes]
Introduced in version 9.5.0.70

Loads an X.509 certificate from the ASN.1 DER encoded bytes contained in certBytes.

Returns 1 for success, 0 for failure.

top
LoadFromBinary
# data is a CkByteData
set status [CkCert_LoadFromBinary $data]

Loads an X.509 certificate from ASN.1 DER encoded bytes.

Returns 1 for success, 0 for failure.

top
LoadFromFile
# path is a string
set status [CkCert_LoadFromFile $path]

Loads a certificate from a .cer, .crt, .p7b, or .pem file. This method accepts certificates from files in any of the following formats:
1. DER encoded binary X.509 (.CER)
2. Base-64 encoded X.509 (.CER)
3. Cryptographic Message Syntax Standard - PKCS #7 Certificates (.P7B)
4. PEM format
This method decodes the certificate based on the contents if finds within the file, and not based on the file extension. If your certificate is in a file having a different extension, try loading it using this method before assuming it won't work. This method does not load .p12 or .pfx (PKCS #12) files.

Returns 1 for success, 0 for failure.

top
LoadPem
# strPem is a string
set status [CkCert_LoadPem $strPem]
Introduced in version 9.5.0.49

Loads the certificate from a PEM string.

Returns 1 for success, 0 for failure.

top
LoadPfxBd
# pfxData is a CkBinData
# password is a string
set status [CkCert_LoadPfxBd $pfxData $password]
Introduced in version 9.5.0.70

Loads the certificate from the PFX contained in pfxData. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns 1 for success, 0 for failure.

top
LoadPfxData
# pfxData is a CkByteData
# password is a string
set status [CkCert_LoadPfxData $pfxData $password]

Loads a PFX from an in-memory image of a PFX file. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns 1 for success, 0 for failure.

top
LoadPfxFile
# pfxPath is a string
# password is a string
set status [CkCert_LoadPfxFile $pfxPath $password]

Loads a PFX file. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns 1 for success, 0 for failure.

top
LoadTaskResult
# task is a CkTask
set status [CkCert_LoadTaskResult $task]
Introduced in version 9.5.0.52

Loads the certificate from a completed asynchronous task.

Returns 1 for success, 0 for failure.

top
PemFileToDerFile
# fromPath is a string
# toPath is a string
set status [CkCert_PemFileToDerFile $fromPath $toPath]

Converts a PEM file to a DER file.

Returns 1 for success, 0 for failure.

top
SaveLastError
# path is a string
set status [CkCert_SaveLastError $path]

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

Returns 1 for success, 0 for failure.

top
SaveToFile
# path is a string
set status [CkCert_SaveToFile $path]

Saves a certificate object to a .cer file.

Returns 1 for success, 0 for failure.

top
SetFromEncoded
# encodedCert is a string
set status [CkCert_SetFromEncoded $encodedCert]

Initializes the certificate object from a base64 encoded string representation of the certificate's binary DER format.

Returns 1 for success, 0 for failure.

top
SetPrivateKey
# privKey is a CkPrivateKey
set status [CkCert_SetPrivateKey $privKey]

Used to associate a private key with the certificate for subsequent (PKCS7) signature creation or decryption.

Returns 1 for success, 0 for failure.

top
SetPrivateKeyPem
# privKeyPem is a string
set status [CkCert_SetPrivateKeyPem $privKeyPem]

Same as SetPrivateKey, but the key is provided in unencrypted PEM format. (Note: The privKeyPem is not a file path, it is the actual PEM text.)

Returns 1 for success, 0 for failure.

top
UseCertVault
# vault is a CkXmlCertVault
set status [CkCert_UseCertVault $vault]
Introduced in version 9.5.0.40

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates for help in building certificate chains and verifying the certificate signature to the trusted root.

Returns 1 for success, 0 for failure.

top
VerifySignature
set retBool [CkCert_VerifySignature]
Introduced in version 9.5.0.40

Verifies the certificate signature, as well as the signatures of all certificates in the chain of authentication to the trusted root. Returns 1 if all signatures are verified to the trusted root. Otherwise returns 0.

top