CkCert C++ Class Reference (Visual C++)
CkCert
* This is a freeware class/component/library.
Digital certificate component / class
Properties
void get_CspName(CkString &str);
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 get_Expired(void);
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 get_ForClientAuthentication(void);
true if this certificate can be used for client authentication, otherwise false.
bool get_ForCodeSigning(void);
true if this certificate can be used for code signing, otherwise false.
bool get_ForSecureEmail(void);
true if this certificate can be used for sending secure email, otherwise false.
bool get_ForServerAuthentication(void);
true if this certificate can be used for server authentication, otherwise false.
bool get_ForTimeStamping(void);
true if this certificate can be used for time stamping, otherwise false.
bool get_HasKeyContainer(void);
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.
unsigned long get_IntendedKeyUsage(void);
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 get_IsRoot(void);
true if this is the root certificate, otherwise false.
void get_IssuerC(CkString &str);
The certificate issuer's country.
void get_IssuerCN(CkString &str);
The certificate issuer's common name.
void get_IssuerDN(CkString &str);
The issuer's full distinguished name.
void get_IssuerE(CkString &str);
The certificate issuer's email address.
void get_IssuerL(CkString &str);
The certificate issuer's locality, which could be a city, count, township, or other geographic region.
void get_IssuerO(CkString &str);
The certificate issuer's organization, which is typically the company name.
void get_IssuerOU(CkString &str);
The certificate issuer's organizational unit, which is the unit within the organization.
void get_IssuerS(CkString &str);
The certificate issuer's state or province.
void get_KeyContainerName(CkString &str);
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.
void LastErrorHtml(CkString &str);
Error information in HTML format for the last method called.
void LastErrorText(CkString &str);
Error information in plain-text format for the last method called.
void LastErrorXml(CkString &str);
Error information in XML format for the last method called.
bool get_MachineKeyset(void);
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 get_Revoked(void);
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).
void get_Rfc822Name(CkString &str);
The RFC-822 name of the certificate.
void get_SerialNumber(CkString &str);
The certificate's serial number.
void get_Sha1Thumbprint(CkString &str);
Hexidecimal string of the SHA-1 thumbprint for the certificate.
bool get_SignatureVerified(void);
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 get_Silent(void);
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.
void get_SubjectC(CkString &str);
The certificate subject's country.
void get_SubjectCN(CkString &str);
The certificate subject's common name.
void get_SubjectDN(CkString &str);
The certificate subject's full distinguished name.
void get_SubjectE(CkString &str);
The certificate subject's email address.
void get_SubjectL(CkString &str);
The certificate subject's locality, which could be a city, count, township, or other geographic region.
void get_SubjectO(CkString &str);
The certificate subject's organization, which is typically the company name.
void get_SubjectOU(CkString &str);
The certificate subject's organizational unit, which is the unit within the organization.
void get_SubjectS(CkString &str);
The certificate subject's state or province.
bool get_TrustedRoot(void);
True if the certificate has a trusted root authority. This information is not available when running on Windows 95/98 computers.
bool get_Utf8(void) const;
void put_Utf8(bool b);
When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.
void get_ValidFrom(SYSTEMTIME &sysTime);
The date this certificate becomes (or became) valid.
void get_ValidTo(SYSTEMTIME &sysTime);
The date this certificate becomes (or became) invalid.
void get_Version(CkString &str);
The version of this component, such as "1.0"
Methods
int CheckRevoked();
Returns 1 if the certificate has been revoked, 0 if not revoked, and -1 if unable to check the revocation status.
bool ExportCertDer(CkByteData & data);
Exports the digital certificate to ASN.1 DER format. Writes the certificate as DER-encoded bytes into the CkByteData object.
bool ExportCertDerFile(const char * filename);
Exports the digital certificate to ASN.1 DER format binary file. Returns true for success, false for failure.
bool ExportCertPem(CkString & str);
Exports the digital certificate to an unencrypted PEM formatted string. Returns true for success, false for failure.
bool ExportCertPemFile(const char * filename);
Exports the digital certificate to an unencrypted PEM formatted file. Returns true for success, false for failure.
CkPrivateKey * ExportPrivateKey();
Exports the certificate's private key. Returns a CkPrivateKey object if successful. Otherwise returns null.
CkPublicKey * ExportPublicKey();
Exports the certificate's public key. Returns a CkPublicKey object if successful. Otherwise returns null.
bool ExportToPfxFile(const char * pfxFilename, const char * password, bool bIncludeChain);
To be documented soon...
bool GetEncoded(CkString & str);
Returns an encoded string representation of the certificate, which can be passed to SetFromEncoded to recreate the certificate object. Returns true for success, false for 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 LinkPrivateKey(const char * keyContainerName, bool bMachineKeyset, bool bForSigning);
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 true for success, false for failure.
bool LoadByCommonName(const char * cn);
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 true for success, false for failure. Select Cert for Encrypted Email
bool LoadByEmailAddress(const char * 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 true for success, false for failure. Select Cert for Encrypted Email
bool LoadFromBase64(const char * encodedCert);
Loads an ASN.1 or DER encoded certificate represented in a Base64 string.
bool LoadFromBinary(const unsigned char * buf, unsigned long bufLen);
Loads an ASN.1 or DER encoded certificate represented as a binary blob.
bool LoadFromFile(const char * 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(CkByteData & pfxData, const char * password);
To be documented soon...
bool LoadPfxData2(const unsigned char * buf, unsigned long bufLen, const char * password);
To be documented soon...
bool LoadPfxFile(const char * filename, const char * password);
To be documented soon...
bool PemFileToDerFile(const char * inFilename, const char * outFilename);
Converts a PEM file to a DER file. Returns true for success, false for failure.
bool SaveLastError(const char * filename);
Saves the last error information to an XML formatted file.
bool SaveToFile(const char * filename);
Saves a certificate object to a .cer file. Returns true for success, false for failure.
bool SetFromEncoded(const char * encodedCert);
Initializes the certificate object from an encoded string created by the GetEncoded method.
const char * cspName();
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.
const char * exportCertPem();
Exports the digital certificate to an unencrypted PEM formatted string.
const char * getEncoded();
Returns an encoded string representation of the certificate, which can be passed to SetFromEncoded to recreate the certificate object.
const char * issuerC();
The certificate issuer's country.
const char * issuerCN();
The certificate issuer's common name.
const char * issuerDN();
The issuer's full distinguished name.
const char * issuerE();
The certificate issuer's email address.
const char * issuerL();
The certificate issuer's locality, which could be a city, count, township, or other geographic region.
const char * issuerO();
The certificate issuer's organization, which is typically the company name.
const char * issuerOU();
The certificate issuer's organizational unit, which is the unit within the organization.
const char * issuerS();
The certificate issuer's state or province.
const char * keyContainerName();
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.
const char * lastErrorHtml();
Error information in HTML format for the last method called.The "const char *" returned by this method will be overwritten or become invalid when other methods returning "const char *" are called. The calling application should copy the returned string to a safe place immediately.
const char * lastErrorText();
Error information in plain-text format for the last method called.The "const char *" returned by this method will be overwritten or become invalid when other methods returning "const char *" are called. The calling application should copy the returned string to a safe place immediately.
const char * lastErrorXml();
Error information in XML format for the last method called.The "const char *" returned by this method will be overwritten or become invalid when other methods returning "const char *" are called. The calling application should copy the returned string to a safe place immediately.
const char * rfc822Name();
The RFC-822 name of the certificate.
const char * serialNumber();
The certificate's serial number.
const char * sha1Thumbprint();
Hexidecimal string of the SHA-1 thumbprint for the certificate.
const char * subjectC();
The certificate subject's country.
const char * subjectCN();
The certificate subject's common name.
const char * subjectDN();
The certificate subject's full distinguished name.
const char * subjectE();
The certificate subject's email address.
const char * subjectL();
The certificate subject's locality, which could be a city, count, township, or other geographic region.
const char * subjectO();
The certificate subject's organization, which is typically the company name.
const char * subjectOU();
The certificate subject's organizational unit, which is the unit within the organization.
const char * subjectS();
The certificate subject's state or province.
const char * version();
The version of this component, such as "1.0"
|