1 out of 1 rated this helpful - Rate this topic

HashAlgorithm Class

Represents the base class from which all implementations of cryptographic hash algorithms must derive.

Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)
[ComVisibleAttribute(true)]
public abstract class HashAlgorithm : ICryptoTransform, 
	IDisposable

The HashAlgorithm type exposes the following members.

  Name Description
Protected method HashAlgorithm Initializes a new instance of the HashAlgorithm class.
Top
  Name Description
Public property CanReuseTransform Gets a value indicating whether the current transform can be reused.
Public property CanTransformMultipleBlocks When overridden in a derived class, gets a value indicating whether multiple blocks can be transformed.
Public property Hash Gets the value of the computed hash code.
Public property HashSize Gets the size, in bits, of the computed hash code.
Public property InputBlockSize When overridden in a derived class, gets the input block size.
Public property OutputBlockSize When overridden in a derived class, gets the output block size.
Top
  Name Description
Public method Clear Releases all resources used by the HashAlgorithm class.
Public method ComputeHash(Byte[]) Computes the hash value for the specified byte array.
Public method ComputeHash(Stream) Computes the hash value for the specified Stream object.
Public method ComputeHash(Byte[], Int32, Int32) Computes the hash value for the specified region of the specified byte array.
Public method Static member Create() Creates an instance of the default implementation of a hash algorithm.
Public method Static member Create(String) Creates an instance of the specified implementation of a hash algorithm.
Public method Dispose() Releases all resources used by the current instance of the HashAlgorithm class.
Protected method Dispose(Boolean) Releases the unmanaged resources used by the HashAlgorithm and optionally releases the managed resources.
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 HashCore When overridden in a derived class, routes data written to the object into the hash algorithm for computing the hash.
Protected method HashFinal When overridden in a derived class, finalizes the hash computation after the last data is processed by the cryptographic stream object.
Public method Initialize Initializes an implementation of the HashAlgorithm class.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TransformBlock Computes the hash value for the specified region of the input byte array and copies the specified region of the input byte array to the specified region of the output byte array.
Public method TransformFinalBlock Computes the hash value for the specified region of the specified byte array.
Top
  Name Description
Protected field HashSizeValue Represents the size, in bits, of the computed hash code.
Protected field HashValue Represents the value of the computed hash code.
Protected field State Represents the state of the hash computation.
Top

Hash functions are fundamental to modern cryptography. These functions map binary strings of an arbitrary length to small binary strings of a fixed length, known as hash values. A cryptographic hash function has the property that it is computationally infeasible to find two distinct inputs that hash to the same value. Hash functions are commonly used with digital signatures and for data integrity.

The hash is used as a unique value of fixed size representing a large amount of data. Hashes of two sets of data should match if the corresponding data also matches. Small changes to the data result in large unpredictable changes in the hash.

Notes to Inheritors

When you inherit from the HashAlgorithm class, you must override the following members: HashCore and HashFinal.

The following code example computes the SHA1CryptoServiceProvider hash for an array. This example assumes that there is a predefined byte array dataArray[]. SHA1CryptoServiceProvider is a derived class of HashAlgorithm.


HashAlgorithm sha = new SHA1CryptoServiceProvider();
byte[] result = sha.ComputeHash(dataArray);


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.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
VB.NET File Integrity Checksum Hash
  
Imports System.Security.Cryptography
Imports System.IO
Public Class FileChecksum
Private Const BUF_SIZE As Integer = 65536
''' <summary>
''' Returns the file integrity checksum hash, otherwise an empty string.
''' </summary>
Public Shared Function IntegrityCheck(ByVal filePath As String) As String
Dim dataBuffer(BUF_SIZE - 1) As Byte
Dim dataBufferDummy(BUF_SIZE - 1) As Byte
Dim dataBytesRead As Integer = 0
Dim hashResult As String = String.Empty
Dim hashAlg As HashAlgorithm = Nothing
Dim fs As FileStream = Nothing
Try
hashAlg = New MD5CryptoServiceProvider ' or New SHA1CryptoServiceProvider
fs = New FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.None, BUF_SIZE)
Do
dataBytesRead = fs.Read(dataBuffer, 0, BUF_SIZE)
hashAlg.TransformBlock(dataBuffer, 0, dataBytesRead, dataBufferDummy, 0)
Loop Until dataBytesRead = 0
hashAlg.TransformFinalBlock(dataBuffer, 0, 0)
hashResult = BitConverter.ToString(hashAlg.Hash).Replace("-", "").ToLower
Catch ex As IOException
MsgBox(ex.Message, MsgBoxStyle.Critical, "IntegrityCheck")
Catch ex As UnauthorizedAccessException
MsgBox(ex.Message, MsgBoxStyle.Critical, "IntegrityCheck")
Finally
If Not fs Is Nothing Then
fs.Close()
fs.Dispose()
fs = Nothing
End If
If Not hashAlg Is Nothing Then
hashAlg.Clear() 'Dispose()
hashAlg = Nothing
End If
End Try
Return hashResult
End Function
End Class