Chilkat.Cert PHP Reference
Chilkat.Cert
* This is a freeware class/component/library.
Digital certificate component / class
Object Creation
$obj = new COM("Chilkat.Cert");
Properties
string CspName (read-only)
If the HasKeyContainer property is true, 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.
bool Expired (read-only)
Has a value of true 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.
bool ForClientAuthentication (read-only)
true if this certificate can be used for client authentication, otherwise false.
bool ForCodeSigning (read-only)
true if this certificate can be used for code signing, otherwise false.
bool ForSecureEmail (read-only)
true if this certificate can be used for sending secure email, otherwise false.
bool ForServerAuthentication (read-only)
true if this certificate can be used for server authentication, otherwise false.
bool ForTimeStamping (read-only)
true if this certificate can be used for time stamping, otherwise false.
bool HasKeyContainer (read-only)
Indicates whether this certificate is linked to a key container. If true then the certificate is linked to a key container (usually containing a private key). If false, 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.
int IntendedKeyUsage (read-only)
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
bool IsRoot (read-only)
true if this is the root certificate, otherwise false.
string IssuerC (read-only)
The certificate issuer's country.
string IssuerCN (read-only)
The certificate issuer's common name.
string IssuerDN (read-only)
The issuer's full distinguished name.
string IssuerE (read-only)
The certificate issuer's email address.
string IssuerL (read-only)
The certificate issuer's locality, which could be a city, count, township, or other geographic region.
string IssuerO (read-only)
The certificate issuer's organization, which is typically the company name.
string IssuerOU (read-only)
The certificate issuer's organizational unit, which is the unit within the organization.
string IssuerS (read-only)
The certificate issuer's state or province.
string KeyContainerName (read-only)
If the HasKeyContainer property is true, 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.
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 MachineKeyset (read-only)
If the HasKeyContainer property is true, 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 true, the key container is within the machine keyset. If false, 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.
bool Revoked (read-only)
true 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 false, 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).
string Rfc822Name (read-only)
The RFC-822 name of the certificate.
string SerialNumber (read-only)
The certificate's serial number.
string Sha1Thumbprint (read-only)
Hexidecimal string of the SHA-1 thumbprint for the certificate.
bool SignatureVerified (read-only)
True if the certificate and all certificates in the chain of authority have valid signatures. This information is not available when running on Windows 95/98 computers.
bool Silent (read-only)
If the HasKeyContainer property is true, 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 false a warning dialog will be displayed. If true 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.
string SubjectC (read-only)
The certificate subject's country.
string SubjectCN (read-only)
The certificate subject's common name.
string SubjectDN (read-only)
The certificate subject's full distinguished name.
string SubjectE (read-only)
The certificate subject's email address.
string SubjectL (read-only)
The certificate subject's locality, which could be a city, count, township, or other geographic region.
string SubjectO (read-only)
The certificate subject's organization, which is typically the company name.
string SubjectOU (read-only)
The certificate subject's organizational unit, which is the unit within the organization.
string SubjectS (read-only)
The certificate subject's state or province.
bool TrustedRoot (read-only)
True if the certificate has a trusted root authority. This information is not available when running on Windows 95/98 computers.
Date ValidFrom (read-only)
The date this certificate becomes (or became) valid.
Date ValidTo (read-only)
The date this certificate becomes (or became) invalid.
string Version (read-only)
The version of this component, such as "1.0"
Methods
bool CheckRevoked()
Returns 1 if the certificate has been revoked, 0 if not revoked, and -1 if unable to check the revocation status.
VARIANT ExportCertDer()
Exports the digital certificate to ASN.1 DER format. Returns 1 for success, 0 for failure.
bool ExportCertDerFile(string filename)
Exports the digital certificate to ASN.1 DER format binary file. Returns 1 for success, 0 for failure.
string ExportCertPem()
Exports the digital certificate to an unencrypted PEM formatted string. Returns a null on failure
bool ExportCertPemFile(string filename)
Exports the digital certificate to an unencrypted PEM formatted file. Returns 1 for success, 0 for failure.
Chilkat.PrivateKey ExportPrivateKey()
Exports the certificate's private key.
Chilkat.PublicKey ExportPublicKey()
Exports the certificate's public key.
bool ExportToPfxFile(string pfxFilename, string password, int includeChain)
To be documented soon...
string GetEncoded()
Returns an encoded string representation of the certificate, which can be passed to SetFromEncoded to recreate the certificate object. Returns a null on failure
bool HasPrivateKey()
Returns true if the private key is installed on the local system for the certificate. This information is not available when running on Windows 95/98 computers.
bool IsExpired()
Used to determine if the certificate is expired.
bool LinkPrivateKey(string keyContainerName, int machineKeyset, int forSigning)
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 (true), or from the keyset specific to the logged-on user (false). 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.
bool LoadByCommonName(string name)
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.
bool LoadByEmailAddress(string emailAddress)
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.
bool LoadFromBase64(string encodedCert)
Loads an ASN.1 or DER encoded certificate represented in a Base64 string.
bool LoadFromBinary(VARIANT binaryBlob)
Loads an ASN.1 or DER encoded certificate represented as a binary blob.
bool LoadFromFile(string filename)
Loads a certificate from a .cer, .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.
bool LoadPfxData(VARIANT pfxData, string password)
To be documented soon...
bool LoadPfxFile(string pfxFilename, string password)
To be documented soon...
bool PemFileToDerFile(string pemFilename, string derFilename)
Converts a PEM file to a DER file. Returns 1 for success, 0 for failure.
void SaveLastError(string filename)
Saves the last error information to an XML formatted file.
bool SaveToFile(string filename)
Saves a certificate object to a .cer file. Returns 1 for success, 0 for failure.
bool SetFromEncoded(string encodedCert)
Initializes the certificate object from an encoded string created by the GetEncoded method.
void TestCert()
To be documented soon...
|