X509FindType Enumeration
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Specifies the type of value the X509Certificate2Collection..::..Find method searches for.
Namespace: System.Security.Cryptography.X509Certificates
Assembly: System.Security (in System.Security.dll)
Syntax
'Declaration
Public Enumeration X509FindType
public enum X509FindType
public enum class X509FindType
type X509FindType
public enum X509FindType
Members
| Member name | Description | |
|---|---|---|
| FindByThumbprint | The findValue parameter for the Find method must be a string representing the thumbprint of the certificate. | |
| FindBySubjectName | The findValue parameter for the Find method must be a string representing the subject name of the certificate. This is a less specific search than that provided by the FindBySubjectDistinguishedName enumeration value. Using the FindBySubjectName value, the Find method performs a case-insensitive string comparison using the supplied value. For example, if you pass "MyCert" to the Find method, it will find all certificates with the subject name containing that string, regardless of other subject values. Searching by distinguished name is a more precise search. | |
| FindBySubjectDistinguishedName | The findValue parameter for the Find method must be a string representing the subject distinguished name of the certificate. This is a more specific search than that provided by the FindBySubjectName enumeration value. Using the FindBySubjectDistinguishedName value, the Find method performs a case-insensitive string comparison for the entire distinguished name. Searching by subject name is a less precise search. | |
| FindByIssuerName | The findValue parameter for the Find method must be a string representing the issuer name of the certificate. This is a less specific search than that provided by the FindByIssuerDistinguishedName enumeration value. Using the FindByIssuerName value, the Find method performs a case-insensitive string comparison using the supplied value. For example, if you pass "MyCA" to the Find method, it will find all certificates with the issuer name containing that string, regardless of other issuer values. | |
| FindByIssuerDistinguishedName | The findValue parameter for the Find method must be a string representing the issuer distinguished name of the certificate. This is a more specific search than that provided by the FindByIssuerName enumeration value. Using the FindByIssuerDistinguishedName value, the Find method performs a case-insensitive string comparison for the entire distinguished name. Searching by issuer name is a less precise search. | |
| FindBySerialNumber | The findValue parameter for the Find method must be a string representing the serial number of the certificate as it is displayed by the UI. The serial number must be in reverse order because it is an integer. | |
| FindByTimeValid | The findValue parameter for the Find method must be a DateTime value in local time. You can use DateTime..::..Now to find all the currently valid certificates. | |
| FindByTimeNotYetValid | The findValue parameter for the Find method must be a DateTime value in local time. The value does not have to be in the future. For example, you can use FindByTimeNotYetValid to find certificates that became valid in the current year by taking the intersection of the results of a Find operation for FindByTimeNotYetValid for the last day of last year with the results of a Find operation for FindByTimeValid of DateTime..::..Now. | |
| FindByTimeExpired | The findValue parameter for the Find method must be a DateTime value in local time. For example, you can find all the certificates that will be valid until the end of the year by eliminating the results of a Find operation for FindByTimeExpired of the last day of the year from the results of a Find operation for DateTime..::..Now. | |
| FindByTemplateName | The findValue parameter for the Find method must be a string representing the template name of the certificate, such as "ClientAuth". A template name is an X509 version 3 extension that specifies the uses of the certificate. | |
| FindByApplicationPolicy | The findValue parameter for the Find method must be a string representing either the application policy friendly name or the object identifier (OID, or Oid) of the certificate. For example, "Encrypting File System" or "1.3.6.1.4.1.311.10.3.4" can be used. For an application that will be localized, the OID value must be used, because the friendly name is localized. | |
| FindByCertificatePolicy | The findValue parameter for the Find method must be a string representing either the friendly name or the object identifier (OID, or Oid) of the certificate policy. The best practice is to use the OID, such as "1.3.6.1.4.1.311.10.3.4". For an application that will be localized, the OID must be used, because the friendly name is localized. | |
| FindByExtension | The findValue parameter for the Find method must be a string describing the extension to find. The object identifier (OID) is most commonly used to direct the Find method to search for all certificates that have an extension matching that OID value. | |
| FindByKeyUsage | The findValue parameter for the Find method must be either a string representing the key usage or an integer representing a bit mask containing all the requested key usages. For the string value, only one key usage at a time can be specified, but the Find method can be used in a cascading sequence to get the intersection of the requested usages. For example, the findValue parameter can be set to "KeyEncipherment" or an integer (0x30 indicates "KeyEncipherment" and "DataEncipherment"). Values of the X509KeyUsageFlags enumeration can also be used. | |
| FindBySubjectKeyIdentifier | The findValue parameter for the Find method must be a string representing the subject key identifier in hexadecimal, such as "F3E815D45E83B8477B9284113C64EF208E897112", as displayed in the UI. |
Remarks
X509FindType identifies the type of value provided in the findValue parameter for the Find method. You can use X509FindType to search an X509Certificate2 collection by subject name, thumbprint, serial number, valid date range, or other value.
You can use a combination of FindByTime value types to find certificates that are valid in a given time range. The union of certificates returned using FindByTimeValid, FindByTimeNotYetValid, and FindByTimeExpired for a given time represents all certificates in the queried collection.