HMACSHA256 Klasse

Definition

Namespace:

System.Security.Cryptography

Assembly:

System.Security.Cryptography.dll

Quelle:

HMACSHA256.cs

Berechnet unter Verwendung der SHA256-Hashfunktion einen Hash-Nachrichtenauthentifizierungscode (HMAC, Hash-based Message Authentication Code).

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

Vererbung

Object

HashAlgorithm

KeyedHashAlgorithm

HMAC

HMACSHA256

Beispiele

Im folgenden Beispiel wird gezeigt, wie sie eine Datei mithilfe des HMACSHA256 -Objekts signieren und dann die Datei überprüfen.

using namespace System;
using namespace System::IO;
using namespace System::Security::Cryptography;

// 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 decodes the file and compares
// the source and the decoded files.
void EncodeFile( array<Byte>^key, String^ sourceFile, String^ destFile )
{
   
   // Initialize the keyed hash object.
   HMACSHA256^ myhmacsha256 = gcnew HMACSHA256( key );
   FileStream^ inStream = gcnew FileStream( sourceFile,FileMode::Open );
   FileStream^ outStream = gcnew FileStream( destFile,FileMode::Create );
   
   // Compute the hash of the input file.
   array<Byte>^hashValue = myhmacsha256->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
   array<Byte>^buffer = gcnew array<Byte>(1024);
   do
   {
      
      // Read from the wrapping CryptoStream.
      bytesRead = inStream->Read( buffer, 0, 1024 );
      outStream->Write( buffer, 0, bytesRead );
   }
   while ( bytesRead > 0 );

   myhmacsha256->Clear();
   
   // Close the streams
   inStream->Close();
   outStream->Close();
   return;
} // end EncodeFile



// Decode the encoded file and compare to original file.
bool DecodeFile( array<Byte>^key, String^ sourceFile )
{
   
   // Initialize the keyed hash object. 
   HMACSHA256^ hmacsha256 = gcnew HMACSHA256( key );
   
   // Create an array to hold the keyed hash value read from the file.
   array<Byte>^storedHash = gcnew array<Byte>(hmacsha256->HashSize / 8);
   
   // Create a FileStream for the source file.
   FileStream^ inStream = gcnew 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.
   array<Byte>^computedHash = hmacsha256->ComputeHash( inStream );
   
   // compare the computed hash with the stored value
   bool err = false;
   for ( int i = 0; i < storedHash->Length; i++ )
   {
      if ( computedHash[ i ] != storedHash[ i ] )
      {
         err = true;
      }
   }
   if (err)
        {
            Console::WriteLine("Hash values differ! Encoded file has been tampered with!");
            return false;
        }
        else
        {
            Console::WriteLine("Hash values agree -- no tampering occurred.");
            return true;
        }

} //end DecodeFile


int main()
{
   array<String^>^Fileargs = Environment::GetCommandLineArgs();
   String^ usageText = "Usage: HMACSHA256 inputfile.txt encodedfile.hsh\nYou must specify the two file names. Only the first file must exist.\n";
   
   //If no file names are specified, write usage text.
   if ( Fileargs->Length < 3 )
   {
      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.
         array<Byte>^secretkey = gcnew array<Byte>(64);
         
         //RNGCryptoServiceProvider is an implementation of a random number generator.
         RNGCryptoServiceProvider^ rng = gcnew 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[ 1 ], Fileargs[ 2 ] );
         
         // Take the encoded file and decode
         DecodeFile( secretkey, Fileargs[ 2 ] );
      }
      catch ( IOException^ e ) 
      {
         Console::WriteLine( "Error: File not found", e );
      }

   }
} //end main

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];
            //RNGCryptoServiceProvider is an implementation of a random number generator.
            using (RNGCryptoServiceProvider rng = new RNGCryptoServiceProvider())
            {
                // 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) {}
            'RNGCryptoServiceProvider is an implementation of a random number generator.
            Using rng As New RNGCryptoServiceProvider()
                ' 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

Hinweise

HMACSHA256 ist ein Schlüsselhashalgorithmus, der aus der SHA-256-Hashfunktion erstellt und als hashbasierter Nachrichtenauthentifizierungscode (Hash-based Message Authentication Code, HMAC) verwendet wird. Der HMAC-Prozess mischt einen geheimen Schlüssel mit den Nachrichtendaten, hasht das Ergebnis mit der Hashfunktion, mischt diesen Hashwert erneut mit dem geheimen Schlüssel und wendet dann die Hashfunktion ein zweites Mal an. Der Ausgabehash ist 256 Bit lang.

Ein HMAC kann verwendet werden, um zu bestimmen, ob eine nachricht, die über einen unsicheren Kanal gesendet wurde, manipuliert wurde, sofern Absender und Empfänger einen geheimen Schlüssel teilen. Der Absender berechnet den Hashwert für die ursprünglichen Daten und sendet sowohl die ursprünglichen Daten als auch den Hashwert als einzelne Nachricht. Der Empfänger berechnet den Hashwert für die empfangene Nachricht neu und überprüft, ob der berechnete HMAC mit dem übertragenen HMAC übereinstimmt.

Jede Änderung der Daten oder des Hashwerts führt zu einem Konflikt, da Kenntnisse des geheimen Schlüssels erforderlich sind, um die Nachricht zu ändern und den richtigen Hashwert zu reproduzieren. Wenn also die ursprünglichen und berechneten Hashwerte übereinstimmen, wird die Nachricht authentifiziert.

HMACSHA256 akzeptiert Schlüssel jeder Größe und erzeugt eine Hashsequenz mit einer Länge von 256 Bit.

Konstruktoren

HMACSHA256()	Initialisiert eine neue Instanz der HMACSHA256-Klasse mit einem zufällig erzeugten Schlüssel.
HMACSHA256(Byte[])	Initialisiert eine neue Instanz der HMACSHA256-Klasse mit den angegebenen Schlüsseldaten.

Felder

HashSizeInBits	Die vom HMAC SHA256-Algorithmus erzeugte Hashgröße in Bits.
HashSizeInBytes	Die vom HMAC SHA256-Algorithmus erzeugte Hashgröße in Bytes.
HashSizeValue	Stellt die Größe des berechneten Hashcodes in Bits dar. (Geerbt von HashAlgorithm)
HashValue	Stellt den Wert des errechneten Hashcodes dar. (Geerbt von HashAlgorithm)
KeyValue	Der im Hashalgorithmus zu verwendende Schlüssel. (Geerbt von KeyedHashAlgorithm)
State	Stellt den Zustand der Hashberechnung dar. (Geerbt von HashAlgorithm)

Eigenschaften

BlockSizeValue	Ruft die für den Hashwert verwendete Blockgröße ab oder legt diese fest. (Geerbt von HMAC)
CanReuseTransform	Ruft einen Wert ab, der angibt, ob die aktuelle Transformation wiederverwendet werden kann. (Geerbt von HashAlgorithm)
CanTransformMultipleBlocks	Ruft beim Überschreiben in einer abgeleiteten Klasse einen Wert ab, der angibt, ob mehrere Blöcke transformiert werden können. (Geerbt von HashAlgorithm)
Hash	Ruft den Wert des berechneten Hashcodes ab. (Geerbt von HashAlgorithm)
HashName	Ruft den Namen des für die Hashoperation verwendeten Hashalgorithmus ab oder legt diesen fest. (Geerbt von HMAC)
HashSize	Ruft die Größe des berechneten Hashcodes in Bits ab. (Geerbt von HashAlgorithm)
InputBlockSize	Ruft beim Überschreiben in einer abgeleiteten Klasse die Eingabeblockgröße ab. (Geerbt von HashAlgorithm)
Key	Ruft den Schlüssel für die HMAC-Berechnung ab oder legt diesen fest.
OutputBlockSize	Ruft beim Überschreiben in einer abgeleiteten Klasse die Ausgabeblockgröße ab. (Geerbt von HashAlgorithm)

Methoden

Clear()	Gibt alle von der HashAlgorithm-Klasse verwendeten Ressourcen frei. (Geerbt von HashAlgorithm)
ComputeHash(Byte[])	Errechnet den Hashwert für das angegebene Bytearray. (Geerbt von HashAlgorithm)
ComputeHash(Byte[], Int32, Int32)	Berechnet den Hashwert für den angegebenen Bereich des angegebenen Bytearrays. (Geerbt von HashAlgorithm)
ComputeHash(Stream)	Berechnet den Hashwert für das angegebene Stream-Objekt. (Geerbt von HashAlgorithm)
ComputeHashAsync(Stream, CancellationToken)	Berechnet den Hashwert für das angegebene Stream-Objekt asynchron. (Geerbt von HashAlgorithm)
Dispose()	Gibt alle von der aktuellen Instanz der HashAlgorithm-Klasse verwendeten Ressourcen frei. (Geerbt von HashAlgorithm)
Dispose(Boolean)	Gibt die von HMACSHA256 verwendeten nicht verwalteten Ressourcen und optional die verwalteten Ressourcen frei.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
HashCore(Byte[], Int32, Int32)	Leitet in das Objekt geschriebene Daten in den HMAC-Algorithmus für die Berechnung vom HMAC weiter.
HashCore(ReadOnlySpan<Byte>)	Leitet in das Objekt geschriebene Daten in den HMAC-Algorithmus für die Berechnung vom HMAC weiter.
HashData(Byte[], Byte[])	Berechnet den HMAC der Daten mithilfe des SHA256-Algorithmus.
HashData(Byte[], Stream)	Berechnet den HMAC eines Streams mithilfe des SHA256-Algorithmus.
HashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)	Berechnet den HMAC der Daten mithilfe des SHA256-Algorithmus.
HashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Span<Byte>)	Berechnet den HMAC der Daten mithilfe des SHA256-Algorithmus.
HashData(ReadOnlySpan<Byte>, Stream)	Berechnet den HMAC eines Streams mithilfe des SHA256-Algorithmus.
HashData(ReadOnlySpan<Byte>, Stream, Span<Byte>)	Berechnet den HMAC eines Streams mithilfe des SHA256-Algorithmus.
HashDataAsync(Byte[], Stream, CancellationToken)	Berechnet den HMAC eines Datenstroms mithilfe des SHA256-Algorithmus asynchron.
HashDataAsync(ReadOnlyMemory<Byte>, Stream, CancellationToken)	Berechnet den HMAC eines Datenstroms mithilfe des SHA256-Algorithmus asynchron.
HashDataAsync(ReadOnlyMemory<Byte>, Stream, Memory<Byte>, CancellationToken)	Berechnet den HMAC eines Datenstroms mithilfe des SHA256-Algorithmus asynchron.
HashFinal()	Schließt die HMAC-Berechnung ab, nachdem die letzten Daten vom Algorithmus verarbeitet wurden.
Initialize()	Setzt den Hashalgorithmus auf seinen ursprünglichen Zustand zurück.
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)
TransformBlock(Byte[], Int32, Int32, Byte[], Int32)	Errechnet den Hashwert für den angegebenen Bereich des Eingabebytearrays und kopiert den angegebenen Bereich des Eingabebytearrays in den angegebenen Bereich des Ausgabebytearrays. (Geerbt von HashAlgorithm)
TransformFinalBlock(Byte[], Int32, Int32)	Berechnet den Hashwert für den angegebenen Bereich des angegebenen Bytearrays. (Geerbt von HashAlgorithm)
TryComputeHash(ReadOnlySpan<Byte>, Span<Byte>, Int32)	Versucht, den Hashwert für das angegebene Bytearray zu berechnen. (Geerbt von HashAlgorithm)
TryHashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Span<Byte>, Int32)	Versucht, den HMAC der Daten mithilfe des SHA256-Algorithmus zu berechnen.
TryHashFinal(Span<Byte>, Int32)	Versucht, die HMAC-Berechnung abzuschließen, nachdem die letzten Daten vom HMAC-Algorithmus verarbeitet wurden.

Weitere Informationen

• Kryptografische Dienste