Chilkat.CertStore PHP Reference
Chilkat.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.
Object Creation
$obj = new COM("Chilkat.CertStore");
Properties
string LastErrorHtml (read-only)
Error information in HTML format for the last method called.
string LastErrorText (read-only)
Error information in plain-text format for the last method called.
string LastErrorXml (read-only)
Error information in XML format for the last method called.
bool LinkForSigning
If true then the certificates returned by the various FindCert* methods are linked internally with the corresponding private key (if it exists) before being returned. This property must be set to true if the returned digital certificate is to be used for creating a digital signature. The default value of this property is false.
int NumCertificates (read-only)
The number of certificates held in the certificate store.
int NumEmailCerts (read-only)
The number of certificates that can be used for sending secure email within this store.
int VerboseLogging
To be documented soon...
string Version (read-only)
The version of this component, such as "1.0"
Methods
void AddCertificate(Chilkat.Cert cert)
Adds a certificate to the store. If the certificate is already in the store, it is updated with the new information.
bool CreateFileStore(string filename)
Creates a new file-based certificate store. Certificates may be saved to this store by calling AddCertificate. Returns 1 for success, 0 for failure.
bool CreateMemoryStore()
Creates an in-memory certificate store. Certificates may be added by calling AddCertificate. Returns 1 for success, 0 for failure.
bool CreateRegistryStore(string regRoot, string regPath)
Creates a registry-based certificate store. regRoot must be "CurrentUser" or "LocalMachine". regPath is a registry path such as "Software/MyApplication/Certificates". Returns 1 for success, 0 for failure.
Chilkat.Cert FindCertByRfc822Name(string name)
Locates a certificate by its RFC 822 name and returns it if found. Otherwise returns NULL.
Chilkat.Cert FindCertBySerial(string serialNumber)
Finds and returns the certificate that has the matching serial number.
Chilkat.Cert FindCertBySha1Thumbprint(string str)
Finds a certificate by it's SHA-1 thumbprint. The thumbprint is a hexidecimal string.
Chilkat.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.
Chilkat.Cert FindCertBySubjectCN(string commonName)
Finds a certificate where the SubjectCN property (common name) matches exactly (but case insensitive) with the passed string.
Chilkat.Cert FindCertBySubjectE(string emailAddress)
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.
Chilkat.Cert FindCertBySubjectO(string organization)
Finds a certificate where the SubjectO property (organization) matches exactly (but case insensitive) with the passed string.
Chilkat.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.
Chilkat.Cert GetCertificate(int index)
Returns the Nth certificate in the store. The first certificate is at index 0.
Chilkat.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.
bool LoadPfxData(VARIANT pfxData, string password)
Loads a PFX from an in-memory image of a PFX file. Returns 1 for success, 0 for failure.
bool LoadPfxFile(string pfxFilename, string password)
Loads a PFX file. Returns 1 for success, 0 for failure.
bool OpenChilkatStore(int readOnly)
Opens the registry-based local machine certificate store having the path "Software/Chilkat/SystemCertificates". If the certificate store does not exist, it is automatically created. Set readOnly = true if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = true will prevent many "permission denied" errors. Returns 1 for success, 0 for failure.
bool OpenCurrentUserStore(int readOnly)
Opens the registry-based current-user certificate store. Set readOnly = true if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = true will prevent many "permission denied" errors. Returns 1 for success, 0 for failure.
bool OpenFileStore(string filename, int readOnly)
Opens a file-based certificate store. Returns 1 for success, 0 for failure.
bool OpenLocalSystemStore(int readOnly)
Opens the registry-based local machine certificate store. Set readOnly = true if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = true will prevent many "permission denied" errors. Returns 1 for success, 0 for failure.
bool OpenOutlookStore(int readOnly)
Opens the registry-based certificate store used by Outlook. Set readOnly = true if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = true will prevent many "permission denied" errors. Returns 1 for success, 0 for failure.
bool OpenRegistryStore(string regRoot, string regPath, int readOnly)
Opens an arbitrary registry-based certificate store. regRoot must be "CurrentUser" or "LocalMachine". regPath is a registry path such as "Software/MyApplication/Certificates". Returns 1 for success, 0 for failure.
void RemoveCertificate(Chilkat.Cert cert)
Removes the passed certificate from the store. The certificate object passed as the argument can no longer be used once removed.
void SaveLastError(string filename)
Saves the last error information to an XML formatted file.
|