CkCertStore Python Reference Documentation

CkCertStore

Current Version: 9.5.0.75

Represents a collection of certificates. The certificates may be loaded from a PFX (PKCS#12) or from a Windows-based certificate store.

Many of the methods of this class are only applicable when running on a MS Windows operating system. The methods for opening, creating, and modifying Windows-based certificate stores (registry-based, file-based, and memory-based) are (of course) Windows-only. However, the methods for loading certs from PFX (PKCS#12), are valid on all supported operating systems, including Linux, MAC OS X, Windows, etc.

Object Creation

obj = chilkat.CkCertStore()

Properties

AvoidWindowsPkAccess
# boolVal is a boolean
boolVal = certStore.get_AvoidWindowsPkAccess();
certStore.put_AvoidWindowsPkAccess(boolVal);

Applies only when running on a Microsoft Windows operating system. If True, 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 False.

top
DebugLogFilePath
# strVal is a string
# ckStr is a CkString
certStore.get_DebugLogFilePath(ckStr);
strVal = certStore.debugLogFilePath();
certStore.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
certStore.get_LastErrorHtml(ckStr);
strVal = certStore.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
certStore.get_LastErrorText(ckStr);
strVal = certStore.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
certStore.get_LastErrorXml(ckStr);
strVal = certStore.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 = certStore.get_LastMethodSuccess();
certStore.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
NumCertificates
# intVal is an integer
intVal = certStore.get_NumCertificates();

The number of certificates held in the certificate store.

top
NumEmailCerts
# intVal is an integer
intVal = certStore.get_NumEmailCerts();

(This property only available on Microsoft Windows operating systems.)
The number of certificates that can be used for sending secure email within this store.

top
Utf8
# boolVal is a boolean
boolVal = certStore.get_Utf8();
certStore.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 = certStore.get_VerboseLogging();
certStore.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
certStore.get_Version(ckStr);
strVal = certStore.version();

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

top

Methods

AddCertificate
# cert is a CkCert
status = certStore.AddCertificate(cert);

(This method only available on Microsoft Windows operating systems.)
Adds a certificate to the store. If the certificate is already in the store, it is updated with the new information.

Returns True for success, False for failure.

top
CreateFileStore
# filename is a string
status = certStore.CreateFileStore(filename);

(This method only available on Microsoft Windows operating systems.)
Creates a new file-based certificate store. Certificates may be saved to this store by calling AddCertificate.

Returns True for success, False for failure.

top
CreateMemoryStore
status = certStore.CreateMemoryStore();

(This method only available on Microsoft Windows operating systems.)
Creates an in-memory certificate store. Certificates may be added by calling AddCertificate.

Returns True for success, False for failure.

top
CreateRegistryStore
# regRoot is a string
# regPath is a string
status = certStore.CreateRegistryStore(regRoot, regPath);

(This method only available on Microsoft Windows operating systems.)
Creates a registry-based certificate store. regRoot must be "CurrentUser" or "LocalMachine". regPath is a registry path such as "Software/MyApplication/Certificates".

Returns True for success, False for failure.

top
FindCertByRfc822Name
# returns a CkCert
# name is a string
ret_cert = certStore.FindCertByRfc822Name(name);

Locates and returns a certificate by its RFC 822 name.

If multiple certificates match, then non-expired certificates will take precedence over expired certificates. In other words, Chilkat will aways return the non-expired certificate over the expired certificate.

Returns None on failure

top
FindCertBySerial
# returns a CkCert
# str is a string
ret_cert = certStore.FindCertBySerial(str);

Finds and returns the certificate that has the matching serial number.

Returns None on failure.

Returns None on failure

top
FindCertBySha1Thumbprint
# returns a CkCert
# str is a string
ret_cert = certStore.FindCertBySha1Thumbprint(str);

Finds a certificate by it's SHA-1 thumbprint. The thumbprint is a hexidecimal string.

Returns None on failure.

Returns None on failure

More Information and Examples
top
FindCertBySubject
# returns a CkCert
# str is a string
ret_cert = certStore.FindCertBySubject(str);

Finds a certificate where one of the Subject properties (SubjectCN, SubjectE, SubjectO, SubjectOU, SubjectL, SubjectST, SubjectC) matches exactly (but case insensitive) with the passed string. A match in SubjectCN will be tried first, followed by SubjectE, and SubjectO. After that, the first match found in SubjectOU, SubjectL, SubjectST, or SubjectC, but in no guaranteed order, is returned. All matches are case insensitive.

Returns None on failure.

Returns None on failure

top
FindCertBySubjectCN
# returns a CkCert
# str is a string
ret_cert = certStore.FindCertBySubjectCN(str);

Finds a certificate where the SubjectCN property (common name) matches exactly (but case insensitive) with the passed string

Returns None on failure.

Returns None on failure

top
FindCertBySubjectE
# returns a CkCert
# str is a string
ret_cert = certStore.FindCertBySubjectE(str);

Finds a certificate where the SubjectE property (email address) matches exactly (but case insensitive) with the passed string. This function differs from FindCertForEmail in that the certificate does not need to match the ForSecureEmail property.

Returns None on failure.

Returns None on failure

top
FindCertBySubjectO
# returns a CkCert
# str is a string
ret_cert = certStore.FindCertBySubjectO(str);

Finds a certificate where the SubjectO property (organization) matches exactly (but case insensitive) with the passed string.

Returns None on failure.

Returns None on failure

top
FindCertForEmail
# returns a CkCert
# emailAddress is a string
ret_cert = certStore.FindCertForEmail(emailAddress);

(This method only available on Microsoft Windows operating systems.)
Finds a certificate that can be used to send secure email to the passed email address. A certificate matches only if the ForSecureEmail property is TRUE, and the email address matches exactly (but case insensitive) with the SubjectE property. Returns NULL if no matches are found.

Returns None on failure.

Returns None on failure

top
GetCertificate
# returns a CkCert
# index is an integer
ret_cert = certStore.GetCertificate(index);

Returns the Nth certificate in the store. The first certificate is at index 0.

Returns None on failure.

Returns None on failure

top
GetEmailCert
# returns a CkCert
# index is an integer
ret_cert = certStore.GetEmailCert(index);

(This method only available on Microsoft Windows operating systems.)
Returns the Nth email certificate in the store. The first certificate is at index 0. Use the NumEmailCertificates property to get the number of email certificates.

Returns None on failure.

Returns None on failure

top
LoadPemFile
# pemPath is a string
status = certStore.LoadPemFile(pemPath);

Loads the certificates contained within a PEM formatted file.

Returns True for success, False for failure.

top
LoadPemStr
# pemString is a string
status = certStore.LoadPemStr(pemString);

Loads the certificates contained within an in-memory PEM formatted string.

Returns True for success, False for failure.

top
LoadPfxData
# pfxData is a CkByteData
# password is a string
status = certStore.LoadPfxData(pfxData, password);

Loads a PFX from an in-memory image of a PFX file. Once loaded, the certificates within the PFX may be searched via the Find* methods. It is also possible to iterate from 0 to NumCertficates-1, calling GetCertificate for each index, to retrieve each certificate within the PFX.

Returns True for success, False for failure.

top
LoadPfxFile
# pfxFilename is a string
# password is a string
status = certStore.LoadPfxFile(pfxFilename, password);

Loads a PFX file. Once loaded, the certificates within the PFX may be searched via the Find* methods. It is also possible to iterate from 0 to NumCertficates-1, calling GetCertificate for each index, to retrieve each certificate within the PFX.

Returns True for success, False for failure.

top
OpenCurrentUserStore
# readOnly is a boolean
status = certStore.OpenCurrentUserStore(readOnly);

(This method is only available on Microsoft Windows operating systems.)
Opens the registry-based Current-User\Personal certificate store. Set readOnly = True if only fetching certificates and not updating the certificate store (i.e. certificates will not be added or removed). Setting readOnly = True causes the certificate store to be opened read-only, and will prevent "permission denied" errors caused by the need for read-write permission.

Once loaded, the certificates within the store may be searched via the Find* methods. An application may also iterate from 0 to NumCertficates-1 and call GetCertificate to access each certificate by index.

Returns True for success, False for failure.

top
OpenFileStore
# filename is a string
# readOnly is a boolean
status = certStore.OpenFileStore(filename, readOnly);

(This method only available on Microsoft Windows operating systems.)
Opens a file-based certificate store.

Once loaded, the certificates within the store may be searched via the Find* methods. An application may also iterate from 0 to NumCertficates-1 and call GetCertificate to access each certificate by index.

Returns True for success, False for failure.

top
OpenLocalSystemStore
# readOnly is a boolean
status = certStore.OpenLocalSystemStore(readOnly);

(This method is only available on Microsoft Windows operating systems.)
Opens the registry-based Local-Computer\Personal certificate store. Set readOnly = True if only fetching certificates and not updating the certificate store (i.e. certificates will not be added or removed). Setting readOnly = True causes the certificate store to be opened read-only, and will prevent "permission denied" errors caused by the need for read-write permission.

Once loaded, the certificates within the store may be searched via the Find* methods. An application may also iterate from 0 to NumCertficates-1 and call GetCertificate to access each certificate by index.

Returns True for success, False for failure.

top
OpenRegistryStore
# regRoot is a string
# regPath is a string
# readOnly is a boolean
status = certStore.OpenRegistryStore(regRoot, regPath, readOnly);

(This method only available on Microsoft Windows operating systems.)
Opens an arbitrary registry-based certificate store. regRoot must be "CurrentUser" or "LocalMachine". regPath is a registry path such as "Software/MyApplication/Certificates".

Setting readOnly = True causes the certificate store to be opened read-only, and will prevent "permission denied" errors caused by the need for read-write permission.

Once loaded, the certificates within the store may be searched via the Find* methods. An application may also iterate from 0 to NumCertficates-1 and call GetCertificate to access each certificate by index.

Returns True for success, False for failure.

top
OpenWindowsStore
# storeLocation is a string
# storeName is a string
# readOnly is a boolean
status = certStore.OpenWindowsStore(storeLocation, storeName, readOnly);
Introduced in version 9.5.0.49

(This method only available on Microsoft Windows operating systems.)
Opens a Microsoft Windows certificate store. storeLocation must be "CurrentUser" or "LocalMachine". storeName is the name of the certificate store to open. It may be any of the following:

  • AddressBook: Certificate store for other users.
  • AuthRoot: Certificate store for third-party certification authorities (CAs).
  • CertificationAuthority: Certificate store for intermediate certification authorities (CAs).
  • Disallowed: Certificate store for revoked certificates.
  • My: Certificate store for personal certificates.
  • Root: Certificate store for trusted root certification authorities (CAs).
  • TrustedPeople: Certificate store for directly trusted people and resources.
  • TrustedPublisher: Certificate store for directly trusted publishers.

Setting readOnly = True causes the certificate store to be opened read-only, and will prevent "permission denied" errors caused by the need for read-write permission.

Once loaded, the certificates within the store may be searched via the Find* methods. An application may also iterate from 0 to NumCertficates-1 and call GetCertificate to access each certificate by index.

Returns True for success, False for failure.

top
RemoveCertificate
# cert is a CkCert
status = certStore.RemoveCertificate(cert);

(This method only available on Microsoft Windows operating systems.)
Removes the passed certificate from the store. The certificate object passed as the argument can no longer be used once removed.

Returns True for success, False for failure.

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

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

Returns True for success, False for failure.

top