Chilkat C# Cert Class Reference
Cert
* This is a freeware class/component/library.
Digital certificate component / class
Object Creation
(C#)
Chilkat.Cert obj = new Chilkat.Cert();
(VB.NET)
Dim obj As New Chilkat.Cert()
Properties
public bool AvoidWindowsPkAccess {get; set; }
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.
public int CertVersion {get; }
The version of the certificate (1, 2, or 3). A value of 0 indicates an error -- the most likely cause being that the certificate object is empty (i.e. was never loaded with a certificate). Note: This is not the version of the software, it is the version of the X.509 certificate object. The version of the Chilkat certificate software is indicated by the Version property.
public string CspName {get; }
(Relevant only when running on a Microsoft Windows operating system.) 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.
public bool Expired {get; }
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.)
public bool ForClientAuthentication {get; }
true if this certificate can be used for client authentication, otherwise false.
public bool ForCodeSigning {get; }
true if this certificate can be used for code signing, otherwise false.
public bool ForSecureEmail {get; }
true if this certificate can be used for sending secure email, otherwise false.
public bool ForServerAuthentication {get; }
true if this certificate can be used for server authentication, otherwise false.
public bool ForTimeStamping {get; }
true if this certificate can be used for time stamping, otherwise false.
public bool HasKeyContainer {get; }
(Relevant only when running on a Microsoft Windows operating system.) 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.
public int IntendedKeyUsage {get; }
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
public bool IsRoot {get; }
true if this is the root certificate, otherwise false.
public string IssuerC {get; }
The certificate issuer's country.
public string IssuerCN {get; }
The certificate issuer's common name.
public string IssuerDN {get; }
The issuer's full distinguished name.
public string IssuerE {get; }
The certificate issuer's email address.
public string IssuerL {get; }
The certificate issuer's locality, which could be a city, count, township, or other geographic region.
public string IssuerO {get; }
The certificate issuer's organization, which is typically the company name.
public string IssuerOU {get; }
The certificate issuer's organizational unit, which is the unit within the organization.
public string IssuerS {get; }
The certificate issuer's state or province.
public string KeyContainerName {get; }
(Relevant only when running on a Microsoft Windows operating system.) 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.
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 bool MachineKeyset {get; }
(Relevant only when running on a Microsoft Windows operating system.) 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.
public string OcspUrl {get; }
To be documented soon...
public bool PrivateKeyExportable {get; }
(Relevant only when running on a Microsoft Windows operating system.) Indicates whether the private key was installed with security settings that allow it to be re-exported.
public bool Revoked {get; }
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).
public string Rfc822Name {get; }
The RFC-822 name of the certificate. (Also known as the Subject Alternative Name.)
public bool SelfSigned {get; }
true if this is a self-signed certificate, otherwise false.
public string SerialNumber {get; }
The certificate's serial number as a hexidecimal string.
public string Sha1Thumbprint {get; }
Hexidecimal string of the SHA-1 thumbprint for the certificate.
public bool SignatureVerified {get; }
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.
public bool Silent {get; }
(Relevant only when running on a Microsoft Windows operating system.) 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.
public string SubjectC {get; }
The certificate subject's country.
public string SubjectCN {get; }
The certificate subject's common name.
public string SubjectDN {get; }
The certificate subject's full distinguished name.
public string SubjectE {get; }
The certificate subject's email address.
public string SubjectL {get; }
The certificate subject's locality, which could be a city, count, township, or other geographic region.
public string SubjectO {get; }
The certificate subject's organization, which is typically the company name.
public string SubjectOU {get; }
The certificate subject's organizational unit, which is the unit within the organization.
public string SubjectS {get; }
The certificate subject's state or province.
public bool TrustedRoot {get; }
True if the certificate has a trusted root authority. This information is not available when running on Windows 95/98 computers.
public DateTime ValidFrom {get; }
The date this certificate becomes (or became) valid.
public DateTime ValidTo {get; }
The date this certificate becomes (or became) invalid.
public bool VerboseLogging {get; set; }
To be documented soon...
public string Version {get; }
The version of this component, such as "1.0"
Methods
public int CheckRevoked();
Returns 1 if the certificate has been revoked, 0 if not revoked, and -1 if unable to check the revocation status.
public byte[] ExportCertDer();
Exports the digital certificate to ASN.1 DER format. Returns a byte array containing the DER encoded certificate. Returns an empty byte array on failure
public bool ExportCertDerFile(string filename);
Exports the digital certificate to ASN.1 DER format binary file. Returns true for success, false for failure.
public string ExportCertPem();
Exports the digital certificate to an unencrypted PEM formatted string. Returns a null on failure
public bool ExportCertPemFile(string filename);
Exports the digital certificate to an unencrypted PEM formatted file. Returns true for success, false for failure.
public string ExportCertXml();
To be documented soon...
public PrivateKey ExportPrivateKey();
Exports the certificate's private key. Returns a Chilkat.PrivateKey object if successful. Otherwise returns null.
public PublicKey ExportPublicKey();
Exports the certificate's public key. Returns a Chilkat.PublicKey object if successful. Otherwise returns null.
public bool ExportToPfxFile(string pfxFilename, string pfxPassword, bool bIncludeCertChain);
Exports the certificate and private key (if available) to a PFX (.pfx or .p12) file. The output PFX is secured using the pfxPassword. If bIncludeCertChain is true, then the certificates in the chain of authority are also included in the PFX output file. Returns true for success, false for failure.
public Cert FindIssuer();
To be documented soon...
public string GetEncoded();
Returns a base64 encoded string representation of the certificate's binary DER format, which can be passed to SetFromEncoded to recreate the certificate object. Returns a null on failure
public string GetPrivateKeyPem();
Exports the certificate's private key to a PEM string (if the private key is available). Returns a null on failure
public bool HasPrivateKey();
Returns true if the private key is installed on the local system for the certificate.
public bool LinkPrivateKey(string keyContainerName, bool bMachineKeyset, bool bForSigning);
(Relevant only when running on a Microsoft Windows operating system.) 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.
public bool LoadByCommonName(string cn);
(Relevant only when running on a Microsoft Windows operating system.) 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. (C#) Select Cert for Encrypted Email
public bool LoadByEmailAddress(string emailAddress);
(Relevant only when running on a Microsoft Windows operating system.) 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. (C#) Select Cert for Encrypted Email
public bool LoadByIssuerAndSerialNumber(string issuerCN, string serialNumber);
(Relevant only when running on a Microsoft Windows operating system.) Searches the Windows Local Machine and Current User registry-based certificate stores for a certificate matching the issuerCN and having an issuer matching the serialNumber. If found, the certificate is loaded and ready for use. Returns true for success, false for failure.
public bool LoadFromBase64(string encodedCert);
Loads an ASN.1 or DER encoded certificate represented in a Base64 string. Returns true for success, false for failure.
public bool LoadFromBinary(byte[] data);
Loads an ASN.1 or DER encoded certificate represented as a binary blob. Returns true for success, false for failure.
public bool LoadFromFile(string filename);
Loads a certificate from a .cer, .crt, .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. Returns true for success, false for failure.
public bool LoadPfxData(byte[] pfxData, string password);
Loads a PFX from an in-memory image of a PFX file. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded. Returns true for success, false for failure.
public bool LoadPfxFile(string pfxFilename, string password);
Loads a PFX file. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded. Returns true for success, false for failure.
public bool PemFileToDerFile(string inFilename, string outFilename);
Converts a PEM file to a DER file. Returns true for success, false for failure.
public bool SaveLastError(string filename);
Saves the last error information to an XML formatted file.
public bool SaveToFile(string filename);
Saves a certificate object to a .cer file. Returns true for success, false for failure.
public bool SetFromEncoded(string encodedCert);
Initializes the certificate object from a base64 encoded string representation of the certificate's binary DER format. Returns true for success, false for failure.
public bool SetPrivateKey(PrivateKey privKey);
Used to associate a private key with the certificate for subsequent (PKCS7) signature creation or decryption. Returns true for success, false for failure.
public bool SetPrivateKeyPem(string privKeyPem);
Same as SetPrivateKey, but the key is provided in unencrypted PEM format. (Note: The privKeyPem is not a file path, it is the actual PEM text.) Returns true for success, false for failure.
|