HMACSHA256 Osztály

Definíció

Névtér:

System.Security.Cryptography

Szerelvények:

netstandard.dll, System.Security.Cryptography.dll

Forrás:

HMACSHA256.cs

Hash-alapú üzenethitelesítési kódot (HMAC) számít ki a SHA256 kivonatoló függvény használatával.

public ref class HMACSHA256 : System::Security::Cryptography::HMAC

public class HMACSHA256 : System.Security.Cryptography.HMAC

type HMACSHA256 = class
    inherit HMAC

Public Class HMACSHA256
Inherits HMAC

Öröklődés

Object

HashAlgorithm

KeyedHashAlgorithm

HMAC

HMACSHA256

Példák

Az alábbi példa bemutatja, hogyan írhat alá egy fájlt az HMACSHA256 objektum használatával, majd hogyan ellenőrizheti a fájlt.

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

public class HMACSHA256example
{

    public static void Main(string[] Fileargs)
    {
        string dataFile;
        string signedFile;
        //If no file names are specified, create them.
        if (Fileargs.Length < 2)
        {
            dataFile = @"text.txt";
            signedFile = "signedFile.enc";

            if (!File.Exists(dataFile))
            {
                // Create a file to write to.
                using (StreamWriter sw = File.CreateText(dataFile))
                {
                    sw.WriteLine("Here is a message to sign");
                }
            }
        }
        else
        {
            dataFile = Fileargs[0];
            signedFile = Fileargs[1];
        }
        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];

            using (RandomNumberGenerator rng = RandomNumberGenerator.Create())
            {
                // The array is now filled with cryptographically strong random bytes.
                rng.GetBytes(secretkey);

                // Use the secret key to sign the message file.
                SignFile(secretkey, dataFile, signedFile);

                // Verify the signed file
                VerifyFile(secretkey, signedFile);
            }
        }
        catch (IOException e)
        {
            Console.WriteLine("Error: File not found", e);
        }
    }  //end main
    // Computes a keyed hash for a source file and creates a target file with the keyed hash
    // prepended to the contents of the source file.
    public static void SignFile(byte[] key, String sourceFile, String destFile)
    {
        // Initialize the keyed hash object.
        using (HMACSHA256 hmac = new HMACSHA256(key))
        {
            using (FileStream inStream = new FileStream(sourceFile, FileMode.Open))
            {
                using (FileStream outStream = new FileStream(destFile, FileMode.Create))
                {
                    // Compute the hash of the input file.
                    byte[] hashValue = hmac.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);
                }
            }
        }
        return;
    } // end SignFile

    // Compares the key in the source file with a new key created for the data portion of the file. If the keys
    // compare the data has not been tampered with.
    public static bool VerifyFile(byte[] key, String sourceFile)
    {
        bool err = false;
        // Initialize the keyed hash object.
        using (HMACSHA256 hmac = new HMACSHA256(key))
        {
            // Create an array to hold the keyed hash value read from the file.
            byte[] storedHash = new byte[hmac.HashSize / 8];
            // Create a FileStream for the source file.
            using (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 = hmac.ComputeHash(inStream);
                // compare the computed hash with the stored value

                for (int i = 0; i < storedHash.Length; i++)
                {
                    if (computedHash[i] != storedHash[i])
                    {
                        err = true;
                    }
                }
            }
        }
        if (err)
        {
            Console.WriteLine("Hash values differ! Signed file has been tampered with!");
            return false;
        }
        else
        {
            Console.WriteLine("Hash values agree -- no tampering occurred.");
            return true;
        }
    } //end VerifyFile
} //end class

Imports System.IO
Imports System.Security.Cryptography

Public Class HMACSHA256example

    Public Shared Sub Main(ByVal Fileargs() As String)
        Dim dataFile As String
        Dim signedFile As String
        'If no file names are specified, create them.
        If Fileargs.Length < 2 Then
            dataFile = "text.txt"
            signedFile = "signedFile.enc"

            If Not File.Exists(dataFile) Then
                ' Create a file to write to.
                Using sw As StreamWriter = File.CreateText(dataFile)
                    sw.WriteLine("Here is a message to sign")
                End Using
            End If

        Else
            dataFile = Fileargs(0)
            signedFile = Fileargs(1)
        End If
        Try
            ' Create a random key using a random number generator. This would be the
            '  secret key shared by sender and receiver.
            Dim secretkey() As Byte = New [Byte](63) {}

            Using rng As RandomNumberGenerator = RandomNumberGenerator.Create()
                ' The array is now filled with cryptographically strong random bytes.
                rng.GetBytes(secretkey)

                ' Use the secret key to encode the message file.
                SignFile(secretkey, dataFile, signedFile)

                ' Take the encoded file and decode
                VerifyFile(secretkey, signedFile)
            End Using
        Catch e As IOException
            Console.WriteLine("Error: File not found", e)
        End Try

    End Sub

    ' Computes a keyed hash for a source file and creates a target file with the keyed hash
    ' prepended to the contents of the source file. 
    Public Shared Sub SignFile(ByVal key() As Byte, ByVal sourceFile As String, ByVal destFile As String)
        ' Initialize the keyed hash object.
        Using myhmac As New HMACSHA256(key)
            Using inStream As New FileStream(sourceFile, FileMode.Open)
                Using outStream As New FileStream(destFile, FileMode.Create)
                    ' Compute the hash of the input file.
                    Dim hashValue As Byte() = myhmac.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.
                    Dim bytesRead As Integer
                    ' read 1K at a time
                    Dim buffer(1023) As Byte
                    Do
                        ' Read from the wrapping CryptoStream.
                        bytesRead = inStream.Read(buffer, 0, 1024)
                        outStream.Write(buffer, 0, bytesRead)
                    Loop While bytesRead > 0
                End Using
            End Using
        End Using
        Return

    End Sub
    ' end SignFile

    ' Compares the key in the source file with a new key created for the data portion of the file. If the keys 
    ' compare the data has not been tampered with.
    Public Shared Function VerifyFile(ByVal key() As Byte, ByVal sourceFile As String) As Boolean
        Dim err As Boolean = False
        ' Initialize the keyed hash object. 
        Using hmac As New HMACSHA256(key)
            ' Create an array to hold the keyed hash value read from the file.
            Dim storedHash(hmac.HashSize / 8 - 1) As Byte
            ' Create a FileStream for the source file.
            Using inStream As New FileStream(sourceFile, FileMode.Open)
                ' Read in the storedHash.
                inStream.Read(storedHash, 0, storedHash.Length - 1)
                ' 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.
                Dim computedHash As Byte() = hmac.ComputeHash(inStream)
                ' compare the computed hash with the stored value
                Dim i As Integer
                For i = 0 To storedHash.Length - 2
                    If computedHash(i) <> storedHash(i) Then
                        err = True
                    End If
                Next i
            End Using
        End Using
        If err Then
            Console.WriteLine("Hash values differ! Signed file has been tampered with!")
            Return False
        Else
            Console.WriteLine("Hash values agree -- no tampering occurred.")
            Return True
        End If

    End Function 'VerifyFile 
End Class
'end class

Megjegyzések

HMACSHA256 az SHA-256 kivonatoló függvényből létrehozott, kivonatalapú üzenethitelesítési kódként (HMAC) használt kulcsos kivonatoló algoritmus. A HMAC-folyamat összekever egy titkos kulcsot az üzenetadatokkal, kivonatosítja az eredményt a kivonatoló függvénnyel, ismét összekeveri a kivonat értékét a titkos kulccsal, majd másodszor alkalmazza a kivonatfüggvényt. A kimeneti kivonat hossza 256 bit.

A HMAC segítségével megállapíthatja, hogy egy nem biztonságos csatornán keresztül küldött üzenet illetéktelenül lett-e módosítva, feltéve, hogy a feladó és a fogadó titkos kulcsot használ. A feladó kiszámítja az eredeti adatok kivonatértékét, és egyetlen üzenetként küldi el az eredeti adatokat és a kivonat értékét is. A fogadó újraszámítja a kapott üzenet kivonatértékét, és ellenőrzi, hogy a kiszámított HMAC megfelel-e az továbbított HMAC-nak.

Az adatok vagy kivonatértékek módosítása nem egyezik, mivel a titkos kulcs ismerete szükséges az üzenet módosításához és a megfelelő kivonatérték reprodukálásához. Ezért ha az eredeti és a kiszámított kivonat értéke megegyezik, az üzenet hitelesítve lesz.

HMACSHA256 bármilyen méretű kulcsot elfogad, és 256 bites kivonatsorozatot hoz létre.

Konstruktorok

Name	Description
HMACSHA256()	Inicializálja az HMACSHA256 osztály új példányát egy véletlenszerűen létrehozott kulccsal.
HMACSHA256(Byte[])	Inicializálja az osztály új példányát HMACSHA256 a megadott kulcsadatokkal.

Mezők

Name	Description
HashSizeInBits	A HMAC SHA-256 algoritmus által előállított kivonatméret bitekben.
HashSizeInBytes	A HMAC SHA-256 algoritmus által előállított kivonat mérete bájtban.
HashSizeValue	A kiszámított kivonatkód bitben megadott méretét jelöli. (Öröklődés forrása HashAlgorithm)
HashValue	A kiszámított kivonatkód értékét jelöli. (Öröklődés forrása HashAlgorithm)
KeyValue	A kivonatoló algoritmusban használandó kulcs. (Öröklődés forrása KeyedHashAlgorithm)
State	A kivonatszámítás állapotát jelöli. (Öröklődés forrása HashAlgorithm)

Tulajdonságok

Name	Description
BlockSizeValue	Lekéri vagy beállítja a kivonatértékben használni kívánt blokkméretet. (Öröklődés forrása HMAC)
CanReuseTransform	Egy értéket kap, amely jelzi, hogy az aktuális átalakítás újra felhasználható-e. (Öröklődés forrása HashAlgorithm)
CanTransformMultipleBlocks	Ha egy származtatott osztályban felül van bírálva, egy értéket kap, amely jelzi, hogy több blokk is átalakítható-e. (Öröklődés forrása HashAlgorithm)
Hash	Lekéri a kiszámított kivonatkód értékét. (Öröklődés forrása HashAlgorithm)
HashName	Lekéri vagy beállítja a kivonatolási algoritmus nevét. (Öröklődés forrása HMAC)
HashSize	Bitekben lekéri a kiszámított kivonatkód méretét. (Öröklődés forrása HashAlgorithm)
InputBlockSize	Ha felül van bírálva egy származtatott osztályban, lekéri a bemeneti blokk méretét. (Öröklődés forrása HashAlgorithm)
Key	Lekéri vagy beállítja a HMAC-számításban használni kívánt kulcsot.
OutputBlockSize	Ha felül van bírálva egy származtatott osztályban, lekéri a kimeneti blokk méretét. (Öröklődés forrása HashAlgorithm)

Metódusok

Name	Description
Clear()	Az osztály által HashAlgorithm használt összes erőforrást felszabadítja. (Öröklődés forrása HashAlgorithm)
ComputeHash(Byte[], Int32, Int32)	Kiszámítja a megadott bájttömb megadott régiójának kivonatértékét. (Öröklődés forrása HashAlgorithm)
ComputeHash(Byte[])	Kiszámítja a megadott bájttömb kivonatértékét. (Öröklődés forrása HashAlgorithm)
ComputeHash(Stream)	Kiszámítja a megadott Stream objektum kivonatértékét. (Öröklődés forrása HashAlgorithm)
ComputeHashAsync(Stream, CancellationToken)	Aszinkron módon kiszámítja a megadott Stream objektum kivonatértékét. (Öröklődés forrása HashAlgorithm)
Dispose()	Az osztály aktuális példánya által használt összes erőforrást felszabadítja HashAlgorithm . (Öröklődés forrása HashAlgorithm)
Dispose(Boolean)	Felszabadítja a felügyelt erőforrások által HMACSHA256 használt nem felügyelt erőforrásokat, és opcionálisan felszabadítja a felügyelt erőforrásokat.
Equals(Object)	Meghatározza, hogy a megadott objektum egyenlő-e az aktuális objektummal. (Öröklődés forrása Object)
GetHashCode()	Ez az alapértelmezett kivonatoló függvény. (Öröklődés forrása Object)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
HashCore(Byte[], Int32, Int32)	Átirányítja az objektumba írt adatokat a HMAC-algoritmusba a HMAC kiszámításához.
HashCore(ReadOnlySpan<Byte>)	Átirányítja az objektumba írt adatokat a HMAC-algoritmusba a HMAC kiszámításához.
HashData(Byte[], Byte[])	Az adatok HMAC-ját az SHA-256 algoritmussal számítja ki.
HashData(Byte[], Stream)	Egy stream HMAC-ját számítja ki az SHA-256 algoritmus használatával.
HashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Span<Byte>)	Az adatok HMAC-ját az SHA-256 algoritmussal számítja ki.
HashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)	Az adatok HMAC-ját az SHA-256 algoritmussal számítja ki.
HashData(ReadOnlySpan<Byte>, Stream, Span<Byte>)	Egy stream HMAC-ját számítja ki az SHA-256 algoritmus használatával.
HashData(ReadOnlySpan<Byte>, Stream)	Egy stream HMAC-ját számítja ki az SHA-256 algoritmus használatával.
HashDataAsync(Byte[], Stream, CancellationToken)	Aszinkron módon kiszámítja egy stream HMAC-ját az SHA-256 algoritmus használatával.
HashDataAsync(ReadOnlyMemory<Byte>, Stream, CancellationToken)	Aszinkron módon kiszámítja egy stream HMAC-ját az SHA-256 algoritmus használatával.
HashDataAsync(ReadOnlyMemory<Byte>, Stream, Memory<Byte>, CancellationToken)	Aszinkron módon kiszámítja egy stream HMAC-ját az SHA-256 algoritmus használatával.
HashFinal()	Véglegesíti a HMAC-számítást, miután az algoritmus az utolsó adatokat feldolgozta.
Initialize()	Alaphelyzetbe állítja a kivonatoló algoritmust a kezdeti állapotára.
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)
TransformBlock(Byte[], Int32, Int32, Byte[], Int32)	Kiszámítja a bemeneti bájttömb megadott régiójának kivonatértékét, és átmásolja a bemeneti bájttömb megadott régióját a kimeneti bájttömb megadott régiójába. (Öröklődés forrása HashAlgorithm)
TransformFinalBlock(Byte[], Int32, Int32)	Kiszámítja a megadott bájttömb megadott régiójának kivonatértékét. (Öröklődés forrása HashAlgorithm)
TryComputeHash(ReadOnlySpan<Byte>, Span<Byte>, Int32)	Megkísérli kiszámítani a megadott bájttömb kivonatértékét. (Öröklődés forrása HashAlgorithm)
TryHashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Span<Byte>, Int32)	Megpróbálja kiszámítani az adatok HMAC-ját az SHA-256 algoritmus használatával.
TryHashFinal(Span<Byte>, Int32)	A HMAC-számítás véglegesítésére tett kísérletek az utolsó adatok HMAC-algoritmus általi feldolgozása után.

Lásd még

• Titkosítási szolgáltatások