Export (0) Print
Expand All

KeyedHashAlgorithm Class

Represents the abstract class from which all implementations of keyed hash algorithms must derive.

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

[ComVisibleAttribute(true)]
public abstract class KeyedHashAlgorithm : HashAlgorithm

The KeyedHashAlgorithm type exposes the following members.

  NameDescription
Protected methodKeyedHashAlgorithmInitializes a new instance of the KeyedHashAlgorithm class.
Top

  NameDescription
Public propertyCanReuseTransformGets a value indicating whether the current transform can be reused. (Inherited from HashAlgorithm.)
Public propertyCanTransformMultipleBlocksWhen overridden in a derived class, gets a value indicating whether multiple blocks can be transformed. (Inherited from HashAlgorithm.)
Public propertyHashGets the value of the computed hash code. (Inherited from HashAlgorithm.)
Public propertyHashSizeGets the size, in bits, of the computed hash code. (Inherited from HashAlgorithm.)
Public propertyInputBlockSizeWhen overridden in a derived class, gets the input block size. (Inherited from HashAlgorithm.)
Public propertyKeyGets or sets the key to use in the hash algorithm.
Public propertyOutputBlockSizeWhen overridden in a derived class, gets the output block size. (Inherited from HashAlgorithm.)
Top

  NameDescription
Public methodClearReleases all resources used by the HashAlgorithm class. (Inherited from HashAlgorithm.)
Public methodComputeHash(Byte[])Computes the hash value for the specified byte array. (Inherited from HashAlgorithm.)
Public methodComputeHash(Stream)Computes the hash value for the specified Stream object. (Inherited from HashAlgorithm.)
Public methodComputeHash(Byte[], Int32, Int32)Computes the hash value for the specified region of the specified byte array. (Inherited from HashAlgorithm.)
Public methodStatic memberCreate()Creates an instance of the default implementation of a keyed hash algorithm.
Public methodStatic memberCreate(String)Creates an instance of the specified implementation of a keyed hash algorithm.
Public methodDispose()Releases all resources used by the current instance of the HashAlgorithm class. (Inherited from HashAlgorithm.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the KeyedHashAlgorithm and optionally releases the managed resources. (Overrides HashAlgorithm.Dispose(Boolean).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodHashCoreWhen overridden in a derived class, routes data written to the object into the hash algorithm for computing the hash. (Inherited from HashAlgorithm.)
Protected methodHashFinalWhen overridden in a derived class, finalizes the hash computation after the last data is processed by the cryptographic stream object. (Inherited from HashAlgorithm.)
Public methodInitializeInitializes an implementation of the HashAlgorithm class. (Inherited from HashAlgorithm.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTransformBlockComputes 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. (Inherited from HashAlgorithm.)
Public methodTransformFinalBlockComputes the hash value for the specified region of the specified byte array. (Inherited from HashAlgorithm.)
Top

  NameDescription
Protected fieldHashSizeValueRepresents the size, in bits, of the computed hash code. (Inherited from HashAlgorithm.)
Protected fieldHashValueRepresents the value of the computed hash code. (Inherited from HashAlgorithm.)
Protected fieldKeyValueThe key to use in the hash algorithm.
Protected fieldStateRepresents the state of the hash computation. (Inherited from HashAlgorithm.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIDisposable.DisposeReleases the unmanaged resources used by the HashAlgorithm and optionally releases the managed resources. (Inherited from HashAlgorithm.)
Top

Hash functions map binary strings of an arbitrary length to small binary strings of a fixed length. A cryptographic hash function has the property that it is computationally infeasible to find two distinct inputs that hash to the same value. Small changes to the data result in large, unpredictable changes in the hash.

A keyed hash algorithm is a key-dependent, one-way hash function used as a message authentication code. Only someone who knows the key can verify the hash. Keyed hash algorithms provide authenticity without secrecy.

Hash functions are commonly used with digital signatures and for data integrity. The HMACSHA1 class is an example of a keyed hash algorithm.

The following code example demonstrates how to derive from the KeyedHashAlgorithm class.

using System;
using System.Security.Cryptography;

public class TestHMACMD5
{
    static private void PrintByteArray(Byte[] arr)
    {
        int i;
        Console.WriteLine("Length: " + arr.Length);
        for (i = 0; i < arr.Length; i++)
        {
            Console.Write("{0:X}", arr[i]);
            Console.Write("    ");
            if ((i + 9) % 8 == 0) Console.WriteLine();
        }
        if (i % 8 != 0) Console.WriteLine();
    }
    public static void Main()
    {
        // Create a key. 
        byte[] key1 = { 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b };
        // Pass the key to the constructor of the HMACMD5 class.  
        HMACMD5 hmac1 = new HMACMD5(key1);

        // Create another key. 
        byte[] key2 = System.Text.Encoding.ASCII.GetBytes("KeyString");
        // Pass the key to the constructor of the HMACMD5 class.  
        HMACMD5 hmac2 = new HMACMD5(key2);

        // Encode a string into a byte array, create a hash of the array, 
        // and print the hash to the screen. 
        byte[] data1 = System.Text.Encoding.ASCII.GetBytes("Hi There");
        PrintByteArray(hmac1.ComputeHash(data1));

        // Encode a string into a byte array, create a hash of the array, 
        // and print the hash to the screen. 
        byte[] data2 = System.Text.Encoding.ASCII.GetBytes("This data will be hashed.");
        PrintByteArray(hmac2.ComputeHash(data2));
    }
}
public class HMACMD5 : KeyedHashAlgorithm
{
    private MD5 hash1;
    private MD5 hash2;
    private bool bHashing = false;

    private byte[] rgbInner = new byte[64];
    private byte[] rgbOuter = new byte[64];

    public HMACMD5(byte[] rgbKey)
    {
        HashSizeValue = 128;
        // Create the hash algorithms.
        hash1 = MD5.Create();
        hash2 = MD5.Create();
        // Get the key. 
        if (rgbKey.Length > 64)
        {
            KeyValue = hash1.ComputeHash(rgbKey);
            // No need to call Initialize; ComputeHash does it automatically.
        }
        else
        {
            KeyValue = (byte[])rgbKey.Clone();
        }
        // Compute rgbInner and rgbOuter. 
        int i = 0;
        for (i = 0; i < 64; i++)
        {
            rgbInner[i] = 0x36;
            rgbOuter[i] = 0x5C;
        }
        for (i = 0; i < KeyValue.Length; i++)
        {
            rgbInner[i] ^= KeyValue[i];
            rgbOuter[i] ^= KeyValue[i];
        }
    }

    public override byte[] Key
    {
        get { return (byte[])KeyValue.Clone(); }
        set
        {
            if (bHashing)
            {
                throw new Exception("Cannot change key during hash operation");
            }
            if (value.Length > 64)
            {
                KeyValue = hash1.ComputeHash(value);
                // No need to call Initialize; ComputeHash does it automatically.
            }
            else
            {
                KeyValue = (byte[])value.Clone();
            }
            // Compute rgbInner and rgbOuter. 
            int i = 0;
            for (i = 0; i < 64; i++)
            {
                rgbInner[i] = 0x36;
                rgbOuter[i] = 0x5C;
            }
            for (i = 0; i < KeyValue.Length; i++)
            {
                rgbInner[i] ^= KeyValue[i];
                rgbOuter[i] ^= KeyValue[i];
            }
        }
    }
    public override void Initialize()
    {
        hash1.Initialize();
        hash2.Initialize();
        bHashing = false;
    }
    protected override void HashCore(byte[] rgb, int ib, int cb)
    {
        if (bHashing == false)
        {
            hash1.TransformBlock(rgbInner, 0, 64, rgbInner, 0);
            bHashing = true;
        }
        hash1.TransformBlock(rgb, ib, cb, rgb, ib);
    }

    protected override byte[] HashFinal()
    {
        if (bHashing == false)
        {
            hash1.TransformBlock(rgbInner, 0, 64, rgbInner, 0);
            bHashing = true;
        }
        // Finalize the original hash.
        hash1.TransformFinalBlock(new byte[0], 0, 0);
        // Write the outer array.
        hash2.TransformBlock(rgbOuter, 0, 64, rgbOuter, 0);
        // Write the inner hash and finalize the hash.
        hash2.TransformFinalBlock(hash1.Hash, 0, hash1.Hash.Length);
        bHashing = false;
        return hash2.Hash;
    }
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft