X509Store Class

X509Store Class

 

Represents an X.509 store, which is a physical store where certificates are persisted and managed. This class cannot be inherited.

Namespace:   System.Security.Cryptography.X509Certificates
Assembly:  System (in System.dll)

System.Object
  System.Security.Cryptography.X509Certificates.X509Store

public sealed class X509Store : IDisposable

NameDescription
System_CAPS_pubmethodX509Store()

Initializes a new instance of the X509Store class using the personal certificates of the current user store.

System_CAPS_pubmethodX509Store(IntPtr)

Initializes a new instance of the X509Store class using an Intptr handle to an HCERTSTORE store.

System_CAPS_pubmethodX509Store(StoreLocation)

Initializes a new instance of the X509Store class using the specified StoreLocation value.

System_CAPS_pubmethodX509Store(StoreName)

Initializes a new instance of the X509Store class using the specified StoreName value.

System_CAPS_pubmethodX509Store(StoreName, StoreLocation)

Initializes a new instance of the X509Store class using the specified StoreName and StoreLocation values.

System_CAPS_pubmethodX509Store(String)

Initializes a new instance of the X509Store class using the specified store name.

System_CAPS_pubmethodX509Store(String, StoreLocation)

Initializes a new instance of the X509Store class using a string that represents a value from the StoreName enumeration and a value from the StoreLocation enumeration.

NameDescription
System_CAPS_pubpropertyCertificates

Returns a collection of certificates located in an X.509 certificate store.

System_CAPS_pubpropertyLocation

Gets the location of the X.509 certificate store.

System_CAPS_pubpropertyName

Gets the name of the X.509 certificate store.

System_CAPS_pubpropertyStoreHandle

Gets an IntPtr handle to an HCERTSTORE store.

NameDescription
System_CAPS_pubmethodAdd(X509Certificate2)

Adds a certificate to an X.509 certificate store.

System_CAPS_pubmethodAddRange(X509Certificate2Collection)

Adds a collection of certificates to an X.509 certificate store.

System_CAPS_pubmethodClose()

Closes an X.509 certificate store.

System_CAPS_pubmethodDispose()

Releases the resources used by this X509Store.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodOpen(OpenFlags)

Opens an X.509 certificate store or creates a new store, depending on OpenFlags flag settings.

System_CAPS_pubmethodRemove(X509Certificate2)

Removes a certificate from an X.509 certificate store.

System_CAPS_pubmethodRemoveRange(X509Certificate2Collection)

Removes a range of certificates from an X.509 certificate store.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

Use this class to work with an X.509 store.

System_CAPS_importantImportant

Starting with the .NET Framework 4.6, this type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

For apps that target the .NET Framework 4.5.2 and earlier versions, the X509Store class does not implement the IDisposable interface and therefore does not have a Dispose method.

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

 */

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;
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 ();
	}	
}

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft