HMACSHA1 类 键控哈希算法

HMACSHA1 类

.NET Framework 2.0

其他版本

此主题尚未评级 - 评价此主题

使用 SHA1 哈希函数计算基于哈希值的消息验证代码 (HMAC)。

命名空间:System.Security.Cryptography
程序集:mscorlib（在 mscorlib.dll 中）

语法

---

C#

C++

VB

[ComVisibleAttribute(true)] 
public class HMACSHA1 : HMAC

J#

/** @attribute ComVisibleAttribute(true) */ 
public class HMACSHA1 extends HMAC

JScript

ComVisibleAttribute(true) 
public class HMACSHA1 extends HMAC

备注

---

HMACSHA1 是从 SHA1 哈希函数构造的一种键控哈希算法，被用作 HMAC（基于哈希的消息验证代码）。此 HMAC 进程将密钥与消息数据混合，使用哈希函数对混合结果进行哈希计算，将所得哈希值与该密钥混合，然后再次应用哈希函数。输出的哈希值长度为 160 位。

在发送方和接收方共享机密密钥的前提下，HMAC 可用于确定通过不安全信道发送的消息是否已被篡改。发送方计算原始数据的哈希值，并将原始数据和哈希值放在一个消息中同时传送。接收方重新计算所接收消息的哈希值，并检查计算所得的 HMAC 是否与传送的 HMAC 匹配。

因为更改消息和重新生成正确的哈希值需要密钥，所以对数据或哈希值的任何更改都会导致不匹配。因此，如果原始的哈希值与计算得出的哈希值相匹配，则消息通过身份验证。

SHA-1（安全哈希算法，也称为 SHS、安全哈希标准）是由美国政府发布的一种加密哈希算法。它将从任意长度的字符串生成 160 位的哈希值。

HMACSHA1 接受任何大小的密钥，并产生长度为 160 位的哈希序列。

示例

---

下面的代码示例演示如何使用 HMACSHA1 编码文件以及之后如何解码该文件。

C#

C++

using System;
using System.IO;
using System.Security.Cryptography;

public class HMACSHA1example
{
	// Computes a keyed hash for a source file, creates a target file with the keyed hash
	// prepended to the contents of the source file, then decrypts the file and compares
	// the source and the decrypted files.
	public static void EncodeFile(byte[] key, String sourceFile, String destFile)
	{
		// Initialize the keyed hash object.
		HMACSHA1 myhmacsha1 = new HMACSHA1(key);
		FileStream inStream = new FileStream(sourceFile, FileMode.Open);
		FileStream outStream = new FileStream(destFile, FileMode.Create);
		// Compute the hash of the input file.
		byte[] hashValue = myhmacsha1.ComputeHash(inStream);
		// Reset inStream to the beginning of the file.
		inStream.Position = 0;
		// Write the computed hash value to the output file.
		outStream.Write(hashValue, 0, hashValue.Length);
		// Copy the contents of the sourceFile to the destFile.
		int bytesRead;
		// read 1K at a time
		byte[] buffer = new byte[1024]; 
		do
		{
			// Read from the wrapping CryptoStream.
			bytesRead = inStream.Read(buffer,0,1024); 
			outStream.Write(buffer, 0, bytesRead);
		} while (bytesRead > 0); 
		myhmacsha1.Clear();
		// Close the streams
		inStream.Close();
		outStream.Close();
		return;
	} // end EncodeFile


	// Decrypt the encoded file and compare to original file.
	public static bool DecodeFile(byte[] key, String sourceFile)
	{
		// Initialize the keyed hash object. 
		HMACSHA1 hmacsha1 = new HMACSHA1(key);
		// Create an array to hold the keyed hash value read from the file.
		byte[] storedHash = new byte[hmacsha1.HashSize/8];
		// Create a FileStream for the source file.
		FileStream inStream = new FileStream(sourceFile, FileMode.Open);
		// Read in the storedHash.
		inStream.Read(storedHash, 0, storedHash.Length);
		// Compute the hash of the remaining contents of the file.
		// The stream is properly positioned at the beginning of the content, 
		// immediately after the stored hash value.
		byte[] computedHash = hmacsha1.ComputeHash(inStream);
		// compare the computed hash with the stored value
		for (int i =0; i < storedHash.Length; i++)
		{
			if (computedHash[i] != storedHash[i])
			{
				Console.WriteLine("Hash values differ! Encoded file has been tampered with!");
				return false;
			}
		}
		Console.WriteLine("Hash values agree -- no tampering occurred.");
		return true;
	} //end DecodeFile

	private const string usageText = "Usage: HMACSHA1 inputfile.txt encryptedfile.hsh\nYou must specify the two file names. Only the first file must exist.\n";
	public static void Main(string[] Fileargs)
	{
		//If no file names are specified, write usage text.
		if (Fileargs.Length < 2)
		{
			Console.WriteLine(usageText);
		}
		else
		{
			try
			{
				// Create a random key using a random number generator. This would be the
				//  secret key shared by sender and receiver.
				byte[] secretkey = new Byte[64];
				//RNGCryptoServiceProvider is an implementation of a random number generator.
				RNGCryptoServiceProvider rng = new RNGCryptoServiceProvider();
				// The array is now filled with cryptographically strong random bytes.
				rng.GetBytes(secretkey); 

				// Use the secret key to encode the message file.
				EncodeFile(secretkey, Fileargs[0], Fileargs[1]);

				// Take the encoded file and decode
				DecodeFile(secretkey, Fileargs[1]);
			}
			catch (IOException e)
			{
				Console.WriteLine("Error: File not found",e);
			}
		} //end if-else

	}  //end main
} //end class

J#

import System.*;
import System.IO.*;
import System.Security.Cryptography.*;

public class HMACSHA1Example
{
    // Computes a keyed hash for a source file, creates a target file with the
    // keyed hash prepended to the contents of the source file, then decrypts 
    // the file and compares the source and the decrypted files.
    public static void EncodeFile(ubyte key[], String sourceFile, 
        String destFile)
    {
        // Initialize the keyed hash object.
        HMACSHA1 myhmacsha1 = new HMACSHA1(key);
        FileStream inStream = new FileStream(sourceFile, FileMode.Open);
        FileStream outStream = new FileStream(destFile, FileMode.Create);

        // Compute the hash of the input file.
        ubyte hashValue[] = myhmacsha1.ComputeHash(inStream);

        // Reset inStream to the beginning of the file.
        inStream.set_Position(0);

        // Write the computed hash value to the output file.
        outStream.Write(hashValue, 0, hashValue.length);

        // Copy the contents of the sourceFile to the destFile.
        int bytesRead;

        // read 1K at a time
        ubyte buffer[] = new ubyte[1024];
        do {
            // Read from the wrapping CryptoStream.
            bytesRead = inStream.Read(buffer, 0, 1024);
            outStream.Write(buffer, 0, bytesRead);
        } while (bytesRead > 0);
        myhmacsha1.Clear();

        // Close the streams
        inStream.Close();
        outStream.Close();
        return;
    } // end EncodeFile
    
    // Decrypt the encoded file and compare to original file.
    public static boolean DecodeFile(ubyte key[], String sourceFile)
    {
        // Initialize the keyed hash object. 
        HMACSHA1 hmacsha1 = new HMACSHA1(key);

        // Create an array to hold the keyed hash value read from the file.
        ubyte storedHash[] = new ubyte[hmacsha1.get_HashSize() / 8];

        // Create a FileStream for the source file.
        FileStream inStream = new FileStream(sourceFile, FileMode.Open);

        // Read in the storedHash.
        inStream.Read(storedHash, 0, storedHash.length);

        // Compute the hash of the remaining contents of the file.
        // The stream is properly positioned at the beginning of the content, 
        // immediately after the stored hash value.
        ubyte computedHash[] = hmacsha1.ComputeHash(inStream);

        // compare the computed hash with the stored value
        for (int i = 0; i < storedHash.length; i++) {
            if (computedHash.get_Item(i) != storedHash.get_Item(i)) {
                Console.WriteLine("Hash values differ! Encoded file has been " 
                    + " tampered with!");
                return false;
            }
        }
        Console.WriteLine("Hash values agree -- no tampering occurred.");
        return true;
    } //DecodeFile //end DecodeFile


    private static String usageText = "Usage: HMACSHA1 inputfile.txt " 
        + "encryptedfile.hsh\nYou must specify the two file names. Only " 
        + "the first file must exist.\n";


    public static void main(String[] fileargs)
    {
        //If no file names are specified, write usage text.
        if (fileargs.length < 2) {
            Console.WriteLine(usageText);
        }
        else {
            try {
                // Create a random key using a random number generator. This
                // would be the secret key shared by sender and receiver.
                ubyte secretKey[] = new ubyte[64];

                // RNGCryptoServiceProvider is an implementation of a random
                // number generator.
                RNGCryptoServiceProvider rng = new RNGCryptoServiceProvider();

                // The array is now filled with cryptographically strong
                // random bytes.
                rng.GetBytes(secretKey);

                // Use the secret key to encode the message file.
                EncodeFile(secretKey, fileargs[0], fileargs[1]);

                // Take the encoded file and decode
                DecodeFile(secretKey, fileargs[1]);
            }
            catch (IOException e) {
                Console.WriteLine("Error: File not found", e);
            }
        }//end if-else
    } //end main
} //end class HMACSHA1Example

继承层次结构

---

System.Object
    System.Security.Cryptography.HashAlgorithm
      System.Security.Cryptography.KeyedHashAlgorithm
        System.Security.Cryptography.HMAC
         System.Security.Cryptography.HMACSHA1

线程安全

---

此类型的任何公共静态（Visual Basic 中的  Shared）成员都是线程安全的，但不保证所有实例成员都是线程安全的。

平台

---

Windows 98、Windows 2000 SP4、Windows Millennium Edition、Windows Server 2003、Windows XP Media Center Edition、Windows XP Professional x64 Edition、Windows XP SP2、Windows XP Starter Edition

.NET Framework 并不是对每个平台的所有版本都提供支持。有关受支持版本的列表，请参见系统要求。

版本信息

---

.NET Framework

受以下版本支持：2.0、1.1、1.0

请参见

---

参考

HMACSHA1 成员
System.Security.Cryptography 命名空间

其他资源

加密服务