X509Certificate.GetCertHashString Method

Definition

Namespace:

System.Security.Cryptography.X509Certificates

Assembly:

System.Security.Cryptography.dll

Returns a hexadecimal string that contains the hash value for the X.509v3 certificate.

Overloads

GetCertHashString()	Returns the SHA1 hash value for the X.509v3 certificate as a hexadecimal string.
GetCertHashString(HashAlgorithmName)	Returns a hexadecimal string containing the hash value for the X.509v3 certificate computed using the specified cryptographic hash algorithm.

GetCertHashString()

Source:

X509Certificate.cs

Returns the SHA1 hash value for the X.509v3 certificate as a hexadecimal string.

public:
 virtual System::String ^ GetCertHashString();

public virtual string GetCertHashString ();

abstract member GetCertHashString : unit -> string
override this.GetCertHashString : unit -> string

Public Overridable Function GetCertHashString () As String

Returns

String

The hexadecimal string representation of the X.509 certificate hash value.

Examples

The following example uses the GetCertHashString method to get an X.509 certificate hash value, convert it to a string, and display it to the console.

using namespace System;
using namespace System::Security::Cryptography::X509Certificates;
int main()
{
   
   // The path to the certificate.
   String^ Certificate = "Certificate.cer";
   
   // Load the certificate into an X509Certificate object.
   X509Certificate^ cert = X509Certificate::CreateFromCertFile( Certificate );
   
   // Get the value.
   String^ results = cert->GetCertHashString();
   
   // Display the value to the console.
   Console::WriteLine( results );
}

using System;
using System.Security.Cryptography.X509Certificates;

public class X509
{

    public static void Main()
    {

        // The path to the certificate.
        string Certificate =  "Certificate.cer";

        // Load the certificate into an X509Certificate object.
        X509Certificate cert = X509Certificate.CreateFromCertFile(Certificate);

        // Get the value.
        string results = cert.GetCertHashString();

        // Display the value to the console.
        Console.WriteLine(results);
    }
}

Imports System.Security.Cryptography.X509Certificates

Public Class X509
   
   
   Public Shared Sub Main()
      
      ' The path to the certificate.
      Dim Certificate As String = "Certificate.cer"
      
      ' Load the certificate into an X509Certificate object.
      Dim cert As X509Certificate = X509Certificate.CreateFromCertFile(Certificate)
      
      ' Get the value.
      Dim results As String = cert.GetCertHashString()
      
      ' Display the value to the console.
      Console.WriteLine(results)
   End Sub 
End Class

GetCertHashString(HashAlgorithmName)

Source:

X509Certificate.cs

Returns a hexadecimal string containing the hash value for the X.509v3 certificate computed using the specified cryptographic hash algorithm.

public:
 virtual System::String ^ GetCertHashString(System::Security::Cryptography::HashAlgorithmName hashAlgorithm);

public virtual string GetCertHashString (System.Security.Cryptography.HashAlgorithmName hashAlgorithm);

abstract member GetCertHashString : System.Security.Cryptography.HashAlgorithmName -> string
override this.GetCertHashString : System.Security.Cryptography.HashAlgorithmName -> string

Public Overridable Function GetCertHashString (hashAlgorithm As HashAlgorithmName) As String

Parameters

hashAlgorithm

HashAlgorithmName

The name of the cryptographic hash algorithm to use.

Returns

String

The hexadecimal string representation of the X.509 certificate hash value.

Exceptions

ArgumentException

hashAlgorithm.Name is null or an empty string.

CryptographicException

hashAlgorithm is not a known hash algorithm.