HashAlgorithm.ComputeHash 方法

定義

命名空間:

System.Security.Cryptography

組件:

System.Security.Cryptography.dll

計算輸入資料的雜湊值。

多載

ComputeHash(Byte[])	計算指定位元組陣列的雜湊值。
ComputeHash(Stream)	計算指定 Stream 物件的雜湊值。
ComputeHash(Byte[], Int32, Int32)	計算所指定位元組陣列中指定區域的雜湊值。

ComputeHash(Byte[])

來源:

HashAlgorithm.cs

計算指定位元組陣列的雜湊值。

public byte[] ComputeHash (byte[] buffer);

參數

buffer

Byte[]

要用來計算雜湊碼的輸入。

傳回

Byte[]

計算出來的雜湊碼。

例外狀況

ArgumentNullException

buffer 為 null。

ObjectDisposedException

物件已經處置。

範例

下列範例會 SHA256 計算字串的哈希值，並將哈希傳回為64個字元的十六進位格式字串。 此程式代碼範例所建立的哈希字串與任何平臺上的任何 SHA256 哈希函式 (相容，) 建立 64 個字元的十六進位格式哈希字串。

using System;
using System.Security.Cryptography;
using System.Text;

public class Program
{
    public static void Main()
    {
        string source = "Hello World!";
        using (SHA256 sha256Hash = SHA256.Create())
        {
            string hash = GetHash(sha256Hash, source);

            Console.WriteLine($"The SHA256 hash of {source} is: {hash}.");

            Console.WriteLine("Verifying the hash...");

            if (VerifyHash(sha256Hash, source, hash))
            {
                Console.WriteLine("The hashes are the same.");
            }
            else
            {
                Console.WriteLine("The hashes are not same.");
            }
        }
    }

    private static string GetHash(HashAlgorithm hashAlgorithm, string input)
    {

        // Convert the input string to a byte array and compute the hash.
        byte[] data = hashAlgorithm.ComputeHash(Encoding.UTF8.GetBytes(input));

        // Create a new Stringbuilder to collect the bytes
        // and create a string.
        var sBuilder = new StringBuilder();

        // Loop through each byte of the hashed data
        // and format each one as a hexadecimal string.
        for (int i = 0; i < data.Length; i++)
        {
            sBuilder.Append(data[i].ToString("x2"));
        }

        // Return the hexadecimal string.
        return sBuilder.ToString();
    }

    // Verify a hash against a string.
    private static bool VerifyHash(HashAlgorithm hashAlgorithm, string input, string hash)
    {
        // Hash the input.
        var hashOfInput = GetHash(hashAlgorithm, input);

        // Create a StringComparer an compare the hashes.
        StringComparer comparer = StringComparer.OrdinalIgnoreCase;

        return comparer.Compare(hashOfInput, hash) == 0;
    }
}
// The example displays the following output:
//    The SHA256 hash of Hello World! is: 7f83b1657ff1fc53b92dc18148a1d65dfc2d4b1fa3d677284addd200126d9069.
//    Verifying the hash...
//    The hashes are the same.

ComputeHash(Stream)

來源:

HashAlgorithm.cs

計算指定 Stream 物件的雜湊值。

public byte[] ComputeHash (System.IO.Stream inputStream);

參數

inputStream

Stream

要用來計算雜湊碼的輸入。

傳回

Byte[]

計算出來的雜湊碼。

例外狀況

ObjectDisposedException

物件已經處置。

範例

下列範例會 SHA256 計算目錄中所有檔案的哈希。

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

public class HashDirectory
{
    public static void Main(string[] args)
    {
        if (args.Length < 1)
        {
            Console.WriteLine("No directory selected.");
            return;
        }

        string directory = args[0];
        if (Directory.Exists(directory))
        {
            // Create a DirectoryInfo object representing the specified directory.
            var dir = new DirectoryInfo(directory);
            // Get the FileInfo objects for every file in the directory.
            FileInfo[] files = dir.GetFiles();
            // Initialize a SHA256 hash object.
            using (SHA256 mySHA256 = SHA256.Create())
            {
                // Compute and print the hash values for each file in directory.
                foreach (FileInfo fInfo in files)
                {
                    using (FileStream fileStream = fInfo.Open(FileMode.Open))
                    {
                        try
                        {
                            // Create a fileStream for the file.
                            // Be sure it's positioned to the beginning of the stream.
                            fileStream.Position = 0;
                            // Compute the hash of the fileStream.
                            byte[] hashValue = mySHA256.ComputeHash(fileStream);
                            // Write the name and hash value of the file to the console.
                            Console.Write($"{fInfo.Name}: ");
                            PrintByteArray(hashValue);
                        }
                        catch (IOException e)
                        {
                            Console.WriteLine($"I/O Exception: {e.Message}");
                        }
                        catch (UnauthorizedAccessException e)
                        {
                            Console.WriteLine($"Access Exception: {e.Message}");
                        }
                    }
                }
            }
        }
        else
        {
            Console.WriteLine("The directory specified could not be found.");
        }
    }

    // Display the byte array in a readable format.
    public static void PrintByteArray(byte[] array)
    {
        for (int i = 0; i < array.Length; i++)
        {
            Console.Write($"{array[i]:X2}");
            if ((i % 4) == 3) Console.Write(" ");
        }
        Console.WriteLine();
    }
}

ComputeHash(Byte[], Int32, Int32)

來源:

HashAlgorithm.cs

計算所指定位元組陣列中指定區域的雜湊值。

public byte[] ComputeHash (byte[] buffer, int offset, int count);

參數

buffer

Byte[]

要用來計算雜湊碼的輸入。

offset

Int32

位元組陣列中的座標，從此處開始使用資料。

count

Int32

陣列中要用作資料的位元組數目。

傳回

Byte[]

計算出來的雜湊碼。

例外狀況

ArgumentException

count 是無效的值。

-或-

buffer 長度無效。

ArgumentNullException

buffer 為 null。

ArgumentOutOfRangeException

offset 超出範圍。 這個參數需要非負數的數字。

ObjectDisposedException

物件已經處置。