HMACSHA256 Sınıf

Tanım

Ad Alanı:

System.Security.Cryptography

Bütünleştirilmiş Kod:

System.Security.Cryptography.dll

Kaynak:

HMACSHA256.cs

Karma işlevini kullanarak SHA256 Karma Tabanlı İleti Kimlik Doğrulama Kodunu (HMAC) hesaplar.

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

Devralma

Object

HashAlgorithm

KeyedHashAlgorithm

HMAC

HMACSHA256

Örnekler

Aşağıdaki örnekte, nesnesini kullanarak bir dosyanın nasıl imzalanması HMACSHA256 ve ardından dosyanın nasıl doğrulanması gösterilmektedir.

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

Açıklamalar

HMACSHA256 , SHA-256 karma işlevinden oluşan ve Karma Tabanlı İleti Kimlik Doğrulama Kodu (HMAC) olarak kullanılan anahtarlı karma algoritması türüdür. HMAC işlemi bir gizli anahtarı ileti verileriyle birleştirir, sonucu karma işleviyle karıştırır, bu karma değeri gizli anahtarla yeniden karıştırır ve ardından karma işlevini ikinci kez uygular. Çıktı karmasının uzunluğu 256 bittir.

HMAC, gönderenin ve alıcının bir gizli anahtarı paylaşması koşuluyla güvenli olmayan bir kanal üzerinden gönderilen iletinin üzerinde oynanıp oynanmadığını belirlemek için kullanılabilir. Gönderen, özgün verilerin karma değerini hesaplar ve hem özgün verileri hem de karma değeri tek bir ileti olarak gönderir. Alıcı, alınan iletideki karma değeri yeniden hesaplar ve hesaplanan HMAC'nin iletilen HMAC ile eşleşip eşleşmediğini denetler.

İletiyi değiştirmek ve doğru karma değeri yeniden oluşturmak için gizli anahtar bilgisi gerektiğinden, verilerde veya karma değerde yapılan değişiklikler uyuşmazlık oluşturur. Bu nedenle, özgün ve hesaplanan karma değerleri eşleşiyorsa iletinin kimliği doğrulanır.

HMACSHA256 herhangi bir boyuttaki anahtarları kabul eder ve 256 bit uzunluğunda bir karma dizisi üretir.

Oluşturucular

HMACSHA256()	Rastgele oluşturulan bir anahtarla sınıfının yeni bir örneğini HMACSHA256 başlatır.
HMACSHA256(Byte[])	Belirtilen anahtar verileriyle sınıfının yeni bir örneğini HMACSHA256 başlatır.

Alanlar

HashSizeInBits	HMAC SHA256 algoritması tarafından bit cinsinden üretilen karma boyutu.
HashSizeInBytes	HMAC SHA256 algoritması tarafından bayt cinsinden üretilen karma boyutu.
HashSizeValue	Hesaplanan karma kodun bit cinsinden boyutunu temsil eder. (Devralındığı yer: HashAlgorithm)
HashValue	Hesaplanan karma kodun değerini temsil eder. (Devralındığı yer: HashAlgorithm)
KeyValue	Karma algoritmada kullanılacak anahtar. (Devralındığı yer: KeyedHashAlgorithm)
State	Karma hesaplamanın durumunu temsil eder. (Devralındığı yer: HashAlgorithm)

Özellikler

BlockSizeValue	Karma değerde kullanılacak blok boyutunu alır veya ayarlar. (Devralındığı yer: HMAC)
CanReuseTransform	Geçerli dönüşümün yeniden kullanılıp kullanılamayacağını belirten bir değer alır. (Devralındığı yer: HashAlgorithm)
CanTransformMultipleBlocks	Türetilmiş bir sınıfta geçersiz kılındığında, birden çok bloğun dönüştürülüp dönüştürülemeyeceğini belirten bir değer alır. (Devralındığı yer: HashAlgorithm)
Hash	Hesaplanan karma kodun değerini alır. (Devralındığı yer: HashAlgorithm)
HashName	Karma için kullanılacak karma algoritmasının adını alır veya ayarlar. (Devralındığı yer: HMAC)
HashSize	Hesaplanan karma kodunun bit cinsinden boyutunu alır. (Devralındığı yer: HashAlgorithm)
InputBlockSize	Türetilmiş bir sınıfta geçersiz kılındığında, giriş bloğu boyutunu alır. (Devralındığı yer: HashAlgorithm)
Key	HMAC hesaplamasında kullanılacak anahtarı alır veya ayarlar.
OutputBlockSize	Türetilmiş bir sınıfta geçersiz kılındığında çıkış bloğu boyutunu alır. (Devralındığı yer: HashAlgorithm)

Yöntemler

Clear()	sınıfı tarafından HashAlgorithm kullanılan tüm kaynakları serbest bırakır. (Devralındığı yer: HashAlgorithm)
ComputeHash(Byte[])	Belirtilen bayt dizisi için karma değeri hesaplar. (Devralındığı yer: HashAlgorithm)
ComputeHash(Byte[], Int32, Int32)	Belirtilen bayt dizisinin belirtilen bölgesi için karma değeri hesaplar. (Devralındığı yer: HashAlgorithm)
ComputeHash(Stream)	Belirtilen Stream nesne için karma değeri hesaplar. (Devralındığı yer: HashAlgorithm)
ComputeHashAsync(Stream, CancellationToken)	Belirtilen Stream nesne için karma değeri zaman uyumsuz olarak hesaplar. (Devralındığı yer: HashAlgorithm)
Dispose()	HashAlgorithm sınıfının geçerli örneği tarafından kullanılan tüm kaynakları serbest bırakır. (Devralındığı yer: HashAlgorithm)
Dispose(Boolean)	HMACSHA256 tarafından kullanılan yönetilmeyen kaynakları serbest bırakır ve yönetilen kaynakları isteğe bağlı olarak serbest bırakır.
Equals(Object)	Belirtilen nesnenin geçerli nesneye eşit olup olmadığını belirler. (Devralındığı yer: Object)
GetHashCode()	Varsayılan karma işlevi işlevi görür. (Devralındığı yer: Object)
GetType()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
HashCore(Byte[], Int32, Int32)	Nesneye yazılan verileri HMAC'yi hesaplamaya yönelik HMAC algoritmasına yönlendirir.
HashCore(ReadOnlySpan<Byte>)	Nesneye yazılan verileri HMAC'yi hesaplamaya yönelik HMAC algoritmasına yönlendirir.
HashData(Byte[], Byte[])	SHA256 algoritmasını kullanarak verilerin HMAC'sini hesaplar.
HashData(Byte[], Stream)	SHA256 algoritmasını kullanarak bir akışın HMAC'sini hesaplar.
HashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)	SHA256 algoritmasını kullanarak verilerin HMAC'sini hesaplar.
HashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Span<Byte>)	SHA256 algoritmasını kullanarak verilerin HMAC'sini hesaplar.
HashData(ReadOnlySpan<Byte>, Stream)	SHA256 algoritmasını kullanarak bir akışın HMAC'sini hesaplar.
HashData(ReadOnlySpan<Byte>, Stream, Span<Byte>)	SHA256 algoritmasını kullanarak bir akışın HMAC'sini hesaplar.
HashDataAsync(Byte[], Stream, CancellationToken)	SHA256 algoritmasını kullanarak bir akışın HMAC'sini zaman uyumsuz olarak hesaplar.
HashDataAsync(ReadOnlyMemory<Byte>, Stream, CancellationToken)	SHA256 algoritmasını kullanarak bir akışın HMAC'sini zaman uyumsuz olarak hesaplar.
HashDataAsync(ReadOnlyMemory<Byte>, Stream, Memory<Byte>, CancellationToken)	SHA256 algoritmasını kullanarak bir akışın HMAC'sini zaman uyumsuz olarak hesaplar.
HashFinal()	Son veriler algoritma tarafından işlendikten sonra HMAC hesaplamasını son haline ekler.
Initialize()	Karma algoritmayı ilk durumuna sıfırlar.
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden dizeyi döndürür. (Devralındığı yer: Object)
TransformBlock(Byte[], Int32, Int32, Byte[], Int32)	Giriş bayt dizisinin belirtilen bölgesi için karma değeri hesaplar ve giriş bayt dizisinin belirtilen bölgesini çıkış bayt dizisinin belirtilen bölgesine kopyalar. (Devralındığı yer: HashAlgorithm)
TransformFinalBlock(Byte[], Int32, Int32)	Belirtilen bayt dizisinin belirtilen bölgesi için karma değeri hesaplar. (Devralındığı yer: HashAlgorithm)
TryComputeHash(ReadOnlySpan<Byte>, Span<Byte>, Int32)	Belirtilen bayt dizisi için karma değeri hesaplamaya çalışır. (Devralındığı yer: HashAlgorithm)
TryHashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Span<Byte>, Int32)	SHA256 algoritmasını kullanarak verilerin HMAC'sini hesaplamaya çalışır.
TryHashFinal(Span<Byte>, Int32)	Son veriler HMAC algoritması tarafından işlendikten sonra HMAC hesaplamasını sonlandırmaya çalışır.

Ayrıca bkz.

• Şifreleme Hizmetleri