X509Certificate2.PrivateKey Property

Definition

Namespace:

System.Security.Cryptography.X509Certificates

Assemblies:

netstandard.dll, System.Security.Cryptography.dll

Source:

X509Certificate2.cs

Caution

X509Certificate2.PrivateKey is obsolete. Use the appropriate method to get the private key, such as GetRSAPrivateKey, or use the CopyWithPrivateKey method to create a new instance with a private key.

Gets or sets the AsymmetricAlgorithm object that represents the private key associated with a certificate.

C#

[System.Obsolete("X509Certificate2.PrivateKey is obsolete. Use the appropriate method to get the private key, such as GetRSAPrivateKey, or use the CopyWithPrivateKey method to create a new instance with a private key.", DiagnosticId="SYSLIB0028", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
public System.Security.Cryptography.AsymmetricAlgorithm? PrivateKey { get; set; }

Property Value

AsymmetricAlgorithm

An AsymmetricAlgorithm object, which is either an RSA or DSA cryptographic service provider.

Attributes

ObsoleteAttribute

Exceptions

CryptographicException

The key value is not an RSA or DSA key, or the key is unreadable.

ArgumentNullException

The value being set for this property is null.

NotSupportedException

The key algorithm for this private key is not supported.

CryptographicUnexpectedOperationException

The X.509 keys do not match.

ArgumentException

The cryptographic service provider key is null.

PlatformNotSupportedException

.NET Core and .NET 5+ only: An attempt was made to set this property.

Examples

The following code example opens the current user certificate store, selects only active certificates, then allows the user to select one or more certificates. The example then writes certificate information to the console.

C#

using System;
using System.Security.Cryptography;
using System.Security.Permissions;
using System.IO;
using System.Security.Cryptography.X509Certificates;

class CertSelect
{
    static void Main()
    {
        X509Store store = new X509Store("MY",StoreLocation.CurrentUser);
        store.Open(OpenFlags.ReadOnly | OpenFlags.OpenExistingOnly);

        X509Certificate2Collection collection = (X509Certificate2Collection)store.Certificates;
        X509Certificate2Collection fcollection = (X509Certificate2Collection)collection.Find(X509FindType.FindByTimeValid,DateTime.Now,false);
        X509Certificate2Collection scollection = X509Certificate2UI.SelectFromCollection(fcollection, "Test Certificate Select","Select a certificate from the following list to get information on that certificate",X509SelectionFlag.MultiSelection);
        Console.WriteLine("Number of certificates: {0}{1}",scollection.Count,Environment.NewLine);

        foreach (X509Certificate2 x509 in scollection)
        {
            try
            {
                byte[] rawdata = x509.RawData;
                Console.WriteLine("Content Type: {0}{1}",X509Certificate2.GetCertContentType(rawdata),Environment.NewLine);
                Console.WriteLine("Friendly Name: {0}{1}",x509.FriendlyName,Environment.NewLine);
                Console.WriteLine("Certificate Verified?: {0}{1}",x509.Verify(),Environment.NewLine);
                Console.WriteLine("Simple Name: {0}{1}",x509.GetNameInfo(X509NameType.SimpleName,true),Environment.NewLine);
                Console.WriteLine("Signature Algorithm: {0}{1}",x509.SignatureAlgorithm.FriendlyName,Environment.NewLine);
                Console.WriteLine("Public Key: {0}{1}",x509.PublicKey.Key.ToXmlString(false),Environment.NewLine);
                Console.WriteLine("Certificate Archived?: {0}{1}",x509.Archived,Environment.NewLine);
                Console.WriteLine("Length of Raw Data: {0}{1}",x509.RawData.Length,Environment.NewLine);
                X509Certificate2UI.DisplayCertificate(x509);
                x509.Reset();
            }
            catch (CryptographicException)
            {
                Console.WriteLine("Information could not be written out for this certificate.");
            }
        }
        store.Close();
    }
}

Remarks

Currently this property supports only RSA or DSA keys, so it returns either an RSA or a DSA object in .NET Core or an RSACryptoServiceProvider or a DSACryptoServiceProvider object in .NET Framework. If no private key is associated with the certificate, it returns null.

Upozornenie

If you set this property to null or to another key without first deleting it, a private key file is left on the disk.

To properly delete the private key associated with this property, set PersistKeyInCsp to false, and then call the Clear method.

Applies to