This topic has not yet been rated - Rate this topic

X509Store Class

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

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

Namespace:  System.Security.Cryptography.X509Certificates
Assembly:  System (in System.dll)
public sealed class X509Store

The X509Store type exposes the following members.

  Name Description
Public method X509Store() Initializes a new instance of the X509Store class using the personal certificates of the current user store.
Public method X509Store(IntPtr) Initializes a new instance of the X509Store class using an Intptr handle to an HCERTSTORE store.
Public method X509Store(StoreLocation) Initializes a new instance of the X509Store class using the specified StoreLocation value.
Public method X509Store(StoreName) Initializes a new instance of the X509Store class using the specified StoreName value.
Public method X509Store(String) Initializes a new instance of the X509Store class using the specified store name.
Public method X509Store(StoreName, StoreLocation) Initializes a new instance of the X509Store class using the specified StoreName and StoreLocation values.
Public method X509Store(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.
Top
  Name Description
Public property Certificates Returns a collection of certificates located in an X.509 certificate store.
Public property Location Gets the location of the X.509 certificate store.
Public property Name Gets the name of the X.509 certificate store.
Public property StoreHandle Gets an IntPtr handle to an HCERTSTORE store.
Top
  Name Description
Public method Add Adds a certificate to an X.509 certificate store.
Public method AddRange Adds a collection of certificates to an X.509 certificate store.
Public method Close Closes an X.509 certificate store.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Open Opens an X.509 certificate store or creates a new store, depending on OpenFlags flag settings.
Public method Remove Removes a certificate from an X.509 certificate store.
Public method RemoveRange Removes a range of certificates from an X.509 certificate store.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

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

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


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ