KeyedHashAlgorithm 类

定义

显示所有加密哈希算法实现均必须从中派生的抽象类。

C#
public abstract class KeyedHashAlgorithm : System.Security.Cryptography.HashAlgorithm
C#
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class KeyedHashAlgorithm : System.Security.Cryptography.HashAlgorithm
继承
KeyedHashAlgorithm
派生
属性

示例

下面的代码示例演示如何从 KeyedHashAlgorithm 类派生。

C#
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;
    }
}

注解

哈希函数将任意长度的二进制字符串映射到固定长度的小型二进制字符串。 加密哈希函数具有 属性,在计算上无法查找哈希为同一值的两个不同输入。 对数据的小更改会导致哈希中出现不可预测的大型更改。

键控哈希算法是一种依赖于密钥的单向哈希函数,用作消息身份验证代码。 只有知道密钥的人才能验证哈希。 键控哈希算法在不保密的情况下提供真实性。

哈希函数通常与数字签名一起使用并用来保持数据的完整性。 类 HMACSHA1 是键控哈希算法的一个示例。

由于 SHA1 出现冲突问题,Microsoft 建议使用基于 SHA256 或更好的安全模型。

构造函数

KeyedHashAlgorithm()

初始化 KeyedHashAlgorithm 类的新实例。

字段

HashSizeValue

表示计算所得的哈希代码的大小(以位为单位)。

(继承自 HashAlgorithm)
HashValue

表示计算所得的哈希代码的值。

(继承自 HashAlgorithm)
KeyValue

用于哈希算法的密钥。

State

表示哈希计算的状态。

(继承自 HashAlgorithm)

属性

CanReuseTransform

获取一个值,该值指示是否可重复使用当前转换。

(继承自 HashAlgorithm)
CanTransformMultipleBlocks

当在派生类中重写时,获取一个值,该值指示是否可以转换多个块。

(继承自 HashAlgorithm)
Hash

获取计算所得的哈希代码的值。

(继承自 HashAlgorithm)
HashSize

获取计算所得的哈希代码的大小(以位为单位)。

(继承自 HashAlgorithm)
InputBlockSize

当在派生类中重写时,获取输入块的大小。

(继承自 HashAlgorithm)
Key

获取或设置用于哈希算法的密钥。

OutputBlockSize

当在派生类中重写时,获取输出块的大小。

(继承自 HashAlgorithm)

方法

Clear()

释放 HashAlgorithm 类使用的所有资源。

(继承自 HashAlgorithm)
ComputeHash(Byte[])

计算指定字节数组的哈希值。

(继承自 HashAlgorithm)
ComputeHash(Byte[], Int32, Int32)

计算指定字节数组的指定区域的哈希值。

(继承自 HashAlgorithm)
ComputeHash(Stream)

计算指定 Stream 对象的哈希值。

(继承自 HashAlgorithm)
ComputeHashAsync(Stream, CancellationToken)

异步计算指定 Stream 对象的哈希值。

(继承自 HashAlgorithm)
Create()
已过时.
已过时.

创建加密哈希算法的默认实现的实例。

Create(String)
已过时.

创建加密哈希算法的指定实现的实例。

Dispose()

释放 HashAlgorithm 类的当前实例所使用的所有资源。

(继承自 HashAlgorithm)
Dispose(Boolean)

释放由 KeyedHashAlgorithm 占用的非托管资源,还可以另外再释放托管资源。

Equals(Object)

确定指定对象是否等于当前对象。

(继承自 Object)
Finalize()

此成员替代 Finalize() 且该主题可能包括更完整的文档。

允许 Object 在"垃圾回收"回收 Object 之前尝试释放资源并执行其他清理操作。

GetHashCode()

作为默认哈希函数。

(继承自 Object)
GetType()

获取当前实例的 Type

(继承自 Object)
HashCore(Byte[], Int32, Int32)

当在派生类中重写时,将写入对象的数据路由到哈希算法以计算哈希值。

(继承自 HashAlgorithm)
HashCore(ReadOnlySpan<Byte>)

将写入对象的数据路由到哈希算法以计算哈希值。

(继承自 HashAlgorithm)
HashFinal()

在派生类中重写时,在加密哈希算法处理最后一个数据后结束哈希计算。

(继承自 HashAlgorithm)
Initialize()

将哈希算法重置为其初始状态。

(继承自 HashAlgorithm)
MemberwiseClone()

创建当前 Object 的浅表副本。

(继承自 Object)
ToString()

返回表示当前对象的字符串。

(继承自 Object)
TransformBlock(Byte[], Int32, Int32, Byte[], Int32)

计算输入字节数组指定区域的哈希值,并将输入字节数组指定区域复制到输出字节数组的指定区域。

(继承自 HashAlgorithm)
TransformFinalBlock(Byte[], Int32, Int32)

计算指定字节数组的指定区域的哈希值。

(继承自 HashAlgorithm)
TryComputeHash(ReadOnlySpan<Byte>, Span<Byte>, Int32)

尝试计算指定字节数组的哈希值。

(继承自 HashAlgorithm)
TryHashFinal(Span<Byte>, Int32)

在哈希算法处理最后一个数据后,尝试结束哈希计算。

(继承自 HashAlgorithm)

显式接口实现

IDisposable.Dispose()

释放由 HashAlgorithm 占用的非托管资源,还可以另外再释放托管资源。

(继承自 HashAlgorithm)

适用于

产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1

另请参阅