X509Store.Certificates Property
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns a collection of certificates located in an X.509 certificate store.
public:
property System::Security::Cryptography::X509Certificates::X509Certificate2Collection ^ Certificates { System::Security::Cryptography::X509Certificates::X509Certificate2Collection ^ get(); };
public System.Security.Cryptography.X509Certificates.X509Certificate2Collection Certificates { get; }
member this.Certificates : System.Security.Cryptography.X509Certificates.X509Certificate2Collection
Public ReadOnly Property Certificates As X509Certificate2Collection
A collection of certificates.
This section contains two examples. The first example demonstrates how you can open standard X.509 stores and list the number of certificates in each.
The second example demonstrates how you can add and remove single certificates and ranges of certificates.
Example 1
This example tries to open each standard store in each standard location on the current computer. It prints a summary that shows whether each store exists and, if so, the number of certificates it contains.
The example creates an X509Store object for each combination of standard name and standard location. It calls the Open method with the OpenFlags.OpenExistingOnly flag, which opens the physical store only if it already exists. If the physical store exists, the example uses the Name, Location, and Certificates properties to display the number of certificates in the store.
using System;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
public class Example
{
static void Main()
{
Console.WriteLine("\r\nExists Certs Name and Location");
Console.WriteLine("------ ----- -------------------------");
foreach (StoreLocation storeLocation in (StoreLocation[])
Enum.GetValues(typeof(StoreLocation)))
{
foreach (StoreName storeName in (StoreName[])
Enum.GetValues(typeof(StoreName)))
{
X509Store store = new X509Store(storeName, storeLocation);
try
{
store.Open(OpenFlags.OpenExistingOnly);
Console.WriteLine("Yes {0,4} {1}, {2}",
store.Certificates.Count, store.Name, store.Location);
}
catch (CryptographicException)
{
Console.WriteLine("No {0}, {1}",
store.Name, store.Location);
}
}
Console.WriteLine();
}
}
}
/* This example produces output similar to the following:
Exists Certs Name and Location
------ ----- -------------------------
Yes 1 AddressBook, CurrentUser
Yes 25 AuthRoot, CurrentUser
Yes 136 CA, CurrentUser
Yes 55 Disallowed, CurrentUser
Yes 20 My, CurrentUser
Yes 36 Root, CurrentUser
Yes 0 TrustedPeople, CurrentUser
Yes 1 TrustedPublisher, CurrentUser
No AddressBook, LocalMachine
Yes 25 AuthRoot, LocalMachine
Yes 131 CA, LocalMachine
Yes 55 Disallowed, LocalMachine
Yes 3 My, LocalMachine
Yes 36 Root, LocalMachine
Yes 0 TrustedPeople, LocalMachine
Yes 1 TrustedPublisher, LocalMachine
*/
Option Strict On
Imports System.Security.Cryptography
Imports System.Security.Cryptography.X509Certificates
Module Example
Sub Main()
Console.WriteLine(vbCrLf & "Exists Certs Name and Location")
Console.WriteLine("------ ----- -------------------------")
For Each storeLocation As StoreLocation In _
CType([Enum].GetValues(GetType(StoreLocation)), StoreLocation())
For Each storeName As StoreName In _
CType([Enum].GetValues(GetType(StoreName)), StoreName())
Dim store As New X509Store(StoreName, StoreLocation)
Try
store.Open(OpenFlags.OpenExistingOnly)
Console.WriteLine("Yes {0,4} {1}, {2}", _
store.Certificates.Count, store.Name, store.Location)
Catch e As CryptographicException
Console.WriteLine("No {0}, {1}", _
store.Name, store.Location)
End Try
Next
Console.WriteLine()
Next
End Sub
End Module
' This example produces output similar to the following:
'Exists Certs Name and Location
'------ ----- -------------------------
'Yes 1 AddressBook, CurrentUser
'Yes 25 AuthRoot, CurrentUser
'Yes 136 CA, CurrentUser
'Yes 55 Disallowed, CurrentUser
'Yes 20 My, CurrentUser
'Yes 36 Root, CurrentUser
'Yes 0 TrustedPeople, CurrentUser
'Yes 1 TrustedPublisher, CurrentUser
'No AddressBook, LocalMachine
'Yes 25 AuthRoot, LocalMachine
'Yes 131 CA, LocalMachine
'Yes 55 Disallowed, LocalMachine
'Yes 3 My, LocalMachine
'Yes 36 Root, LocalMachine
'Yes 0 TrustedPeople, LocalMachine
'Yes 1 TrustedPublisher, LocalMachine
Example 2
This example opens an X.509 certificate store, adds and deletes certificates, and then closes the store. It assumes that you have three certificates to add to and remove from a local store.
#using <System.dll>
#using <System.Security.dll>
using namespace System;
using namespace System::Security::Cryptography;
using namespace System::Security::Cryptography::X509Certificates;
using namespace System::IO;
int main()
{
//Create new X509 store called teststore from the local certificate store.
X509Store ^ store = gcnew X509Store( "teststore",StoreLocation::CurrentUser );
store->Open( OpenFlags::ReadWrite );
X509Certificate2 ^ certificate = gcnew X509Certificate2;
//Create certificates from certificate files.
//You must put in a valid path to three certificates in the following constructors.
X509Certificate2 ^ certificate1 = gcnew X509Certificate2( "c:\\mycerts\\*****.cer" );
X509Certificate2 ^ certificate2 = gcnew X509Certificate2( "c:\\mycerts\\*****.cer" );
X509Certificate2 ^ certificate5 = gcnew X509Certificate2( "c:\\mycerts\\*****.cer" );
//Create a collection and add two of the certificates.
X509Certificate2Collection ^ collection = gcnew X509Certificate2Collection;
collection->Add( certificate2 );
collection->Add( certificate5 );
//Add certificates to the store.
store->Add( certificate1 );
store->AddRange( collection );
X509Certificate2Collection ^ storecollection = dynamic_cast<X509Certificate2Collection^>(store->Certificates);
Console::WriteLine( "Store name: {0}", store->Name );
Console::WriteLine( "Store location: {0}", store->Location );
System::Collections::IEnumerator^ myEnum = storecollection->GetEnumerator();
while ( myEnum->MoveNext() )
{
X509Certificate2 ^ x509 = safe_cast<X509Certificate2 ^>(myEnum->Current);
Console::WriteLine( "certificate name: {0}", x509->Subject );
}
//Remove a certificate.
store->Remove( certificate1 );
X509Certificate2Collection ^ storecollection2 = dynamic_cast<X509Certificate2Collection^>(store->Certificates);
Console::WriteLine( "{1}Store name: {0}", store->Name, Environment::NewLine );
System::Collections::IEnumerator^ myEnum1 = storecollection2->GetEnumerator();
while ( myEnum1->MoveNext() )
{
X509Certificate2 ^ x509 = safe_cast<X509Certificate2 ^>(myEnum1->Current);
Console::WriteLine( "certificate name: {0}", x509->Subject );
}
//Remove a range of certificates.
store->RemoveRange( collection );
X509Certificate2Collection ^ storecollection3 = dynamic_cast<X509Certificate2Collection^>(store->Certificates);
Console::WriteLine( "{1}Store name: {0}", store->Name, Environment::NewLine );
if ( storecollection3->Count == 0 )
{
Console::WriteLine( "Store contains no certificates." );
}
else
{
System::Collections::IEnumerator^ myEnum2 = storecollection3->GetEnumerator();
while ( myEnum2->MoveNext() )
{
X509Certificate2 ^ x509 = safe_cast<X509Certificate2 ^>(myEnum2->Current);
Console::WriteLine( "certificate name: {0}", x509->Subject );
}
}
//Close the store.
store->Close();
}
using System;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
using System.IO;
public class X509store2
{
public static void Main (string[] args)
{
//Create new X509 store called teststore from the local certificate store.
X509Store store = new X509Store ("teststore", StoreLocation.CurrentUser);
store.Open (OpenFlags.ReadWrite);
X509Certificate2 certificate = new X509Certificate2 ();
//Create certificates from certificate files.
//You must put in a valid path to three certificates in the following constructors.
X509Certificate2 certificate1 = new X509Certificate2 ("c:\\mycerts\\*****.cer");
X509Certificate2 certificate2 = new X509Certificate2 ("c:\\mycerts\\*****.cer");
X509Certificate2 certificate5 = new X509Certificate2 ("c:\\mycerts\\*****.cer");
//Create a collection and add two of the certificates.
X509Certificate2Collection collection = new X509Certificate2Collection ();
collection.Add (certificate2);
collection.Add (certificate5);
//Add certificates to the store.
store.Add (certificate1);
store.AddRange (collection);
X509Certificate2Collection storecollection = (X509Certificate2Collection)store.Certificates;
Console.WriteLine ("Store name: {0}", store.Name);
Console.WriteLine ("Store location: {0}", store.Location);
foreach (X509Certificate2 x509 in storecollection)
{
Console.WriteLine("certificate name: {0}",x509.Subject);
}
//Remove a certificate.
store.Remove (certificate1);
X509Certificate2Collection storecollection2 = (X509Certificate2Collection)store.Certificates;
Console.WriteLine ("{1}Store name: {0}", store.Name, Environment.NewLine);
foreach (X509Certificate2 x509 in storecollection2)
{
Console.WriteLine ("certificate name: {0}", x509.Subject);
}
//Remove a range of certificates.
store.RemoveRange (collection);
X509Certificate2Collection storecollection3 = (X509Certificate2Collection)store.Certificates;
Console.WriteLine ("{1}Store name: {0}", store.Name, Environment.NewLine);
if (storecollection3.Count == 0)
{
Console.WriteLine ("Store contains no certificates.");
}
else
{
foreach (X509Certificate2 x509 in storecollection3)
{
Console.WriteLine ("certificate name: {0}", x509.Subject);
}
}
//Close the store.
store.Close ();
}
}
Imports System.Security.Cryptography
Imports System.Security.Cryptography.X509Certificates
Imports System.IO
Class X509store2
Shared Sub Main(ByVal args() As String)
'Create new X509 store called teststore from the local certificate store.
Dim store As New X509Store("teststore", StoreLocation.CurrentUser)
store.Open(OpenFlags.ReadWrite)
Dim certificate As New X509Certificate2()
'Create certificates from certificate files.
'You must put in a valid path to three certificates in the following constructors.
Dim certificate1 As New X509Certificate2("c:\mycerts\*****.cer")
Dim certificate2 As New X509Certificate2("c:\mycerts\*****.cer")
Dim certificate5 As New X509Certificate2("c:\mycerts\*****.cer")
'Create a collection and add two of the certificates.
Dim collection As New X509Certificate2Collection()
collection.Add(certificate2)
collection.Add(certificate5)
'Add certificates to the store.
store.Add(certificate1)
store.AddRange(collection)
Dim storecollection As X509Certificate2Collection = CType(store.Certificates, X509Certificate2Collection)
Console.WriteLine("Store name: {0}", store.Name)
Console.WriteLine("Store location: {0}", store.Location)
Dim x509 As X509Certificate2
For Each x509 In storecollection
Console.WriteLine("certificate name: {0}", x509.Subject)
Next x509
'Remove a certificate.
store.Remove(certificate1)
Dim storecollection2 As X509Certificate2Collection = CType(store.Certificates, X509Certificate2Collection)
Console.WriteLine("{1}Store name: {0}", store.Name, Environment.NewLine)
Dim x509a As X509Certificate2
For Each x509a In storecollection2
Console.WriteLine("certificate name: {0}", x509a.Subject)
Next x509a
'Remove a range of certificates.
store.RemoveRange(collection)
Dim storecollection3 As X509Certificate2Collection = CType(store.Certificates, X509Certificate2Collection)
Console.WriteLine("{1}Store name: {0}", store.Name, Environment.NewLine)
If storecollection3.Count = 0 Then
Console.WriteLine("Store contains no certificates.")
Else
Dim x509b As X509Certificate2
For Each x509b In storecollection3
Console.WriteLine("certificate name: {0}", x509b.Subject)
Next x509b
End If
'Close the store.
store.Close()
End Sub
End Class
This method returns a snapshot of the X.509 certificate store. Note that subsequent Add or Remove operations performed on the store will not have any effect on the collection that is returned. This snapshot is recalculated each time the property is called, so the use of this property inside an iterative function is not recommended.
منتج | الإصدارات |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.3, 1.4, 1.6, 2.0, 2.1 |
ملاحظات .NET
.NET هو مشروع مصدر مفتوح. حدد رابطًا لتقديم الملاحظات: