Chilkat C# CertStore Class Reference

CertStore

* This is a freeware class/component/library.

Represents a certificate store. The certificate store can be registry-based, file-based, or in-memory. Allows certificates to be added, removed, or retrieved.

Properties

public string LastErrorHtml {get; }

Error information in HTML format for the last method called.

public string LastErrorText {get; }

Error information in plain-text format for the last method called.

public string LastErrorXml {get; }

Error information in XML format for the last method called.

public int NumCertificates {get; }

The number of certificates held in the certificate store.

public int NumEmailCerts {get; }

The number of certificates that can be used for sending secure email within this store.

public string Version {get; }

The version of this component, such as "1.0"

Methods

public bool AddCertificate(Cert cert);

Adds a certificate to the store. If the certificate is already in the store, it is updated with the new information.

public Cert FindCertBySerial(string str);

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

public Cert FindCertBySubject(string 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.

public Cert FindCertBySubjectCN(string str);

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

public Cert FindCertBySubjectE(string 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.

public Cert FindCertBySubjectO(string str);

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

public Cert FindCertForEmail(string emailAddress);

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.

public Cert GetCertificate(int index);

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

public Cert GetEmailCert(int index);

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.

public bool LoadPfxData(byte[] pfxData, string password);

To be documented soon...

public bool LoadPfxFile(string pfxFilename, string password);

To be documented soon...

public bool RemoveCertificate(Cert cert);

Removes the passed certificate from the store. The certificate object passed as the argument can no longer be used once removed.

public bool SaveLastError(string filename);

Saves the last error information to an XML formatted file.