HMACSHA256 Класс

Ссылка

Определение

Пространство имен:: System.Security.Cryptography

Сборка:: System.Security.Cryptography.Algorithms.dll

Сборка:: System.Security.Cryptography.dll

Сборка:: mscorlib.dll

Сборка:: netstandard.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Вычисляет хэш-код аутентификации сообщения (HMAC) с помощью хэш-функции SHA256.

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

[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public class HMACSHA256 : System.Security.Cryptography.HMAC

public class HMACSHA256 : System.Security.Cryptography.HMAC

[System.Runtime.InteropServices.ComVisible(true)]
public class HMACSHA256 : System.Security.Cryptography.HMAC

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
type HMACSHA256 = class
    inherit HMAC

type HMACSHA256 = class
    inherit HMAC

[<System.Runtime.InteropServices.ComVisible(true)>]
type HMACSHA256 = class
    inherit HMAC

Public Class HMACSHA256
Inherits HMAC

Наследование: Object

HashAlgorithm

KeyedHashAlgorithm

HMAC
HMACSHA256

Атрибуты: UnsupportedOSPlatformAttribute ComVisibleAttribute

Примеры

В следующем примере показано, как подписать файл с помощью HMACSHA256 объекта, а затем проверить файл.

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

HMACSHA256 — это тип хэш-алгоритма, созданного на основе хэш-функции SHA-256 и используемого в качестве кода проверки подлинности сообщения на основе хэша (HMAC). Процесс HMAC смешивает секретный ключ с данными сообщения, хэширует результат с хэш-функцией, снова смешивает хэш-значение с секретным ключом, а затем применяет хэш-функцию во второй раз. Выходной хэш имеет длину 256 бит.

HMAC можно использовать для определения того, было ли отправлено сообщение через небезопасный канал, при условии, что отправитель и получатель совместно используют секретный ключ. Отправитель вычисляет хэш-значение для исходных данных и отправляет исходные данные и хэш-значение в виде одного сообщения. Получатель пересчитывает хэш-значение полученного сообщения и проверяет, соответствует ли вычисляемый HMAC переданный HMAC.

Любое изменение данных или хэш-значения приводит к несоответствию, так как знание секретного ключа требуется для изменения сообщения и воспроизведения правильного хэш-значения. Таким образом, если исходные и вычисляемые хэш-значения совпадают, сообщение проходит проверку подлинности.

HMACSHA256 принимает ключи любого размера и создает хэш-последовательность длиной 256 бит.

Конструкторы

HMACSHA256()	Инициализирует новый экземпляр класса HMACSHA256 созданным случайным образом ключом.
HMACSHA256(Byte[])	Инициализирует новый экземпляр класса HMACSHA256 указанными данными ключа.

Поля

HashSizeInBits	Размер хэша, созданный алгоритмом HMAC SHA256 в битах.
HashSizeInBytes	Размер хэша, созданный алгоритмом HMAC SHA256 в байтах.
HashSizeValue	Представляет размер вычисленного хэш-кода в битах. (Унаследовано от HashAlgorithm)
HashValue	Представляет значение вычисляемого хэш-кода. (Унаследовано от HashAlgorithm)
KeyValue	Ключ, используемый в хэш-алгоритме. (Унаследовано от KeyedHashAlgorithm)
State	Представляет состояние процесса вычисления хэша. (Унаследовано от HashAlgorithm)

Свойства

BlockSizeValue	Получает или задает размер блока, используемый в значении хэша. (Унаследовано от HMAC)
CanReuseTransform	Получает значение, указывающее на возможность повторного использования текущего преобразования. (Унаследовано от HashAlgorithm)
CanTransformMultipleBlocks	Если переопределено в производном классе, возвращает значение, указывающее, возможно ли преобразование нескольких блоков. (Унаследовано от HashAlgorithm)
Hash	Получает значение вычисленного хэш-кода. (Унаследовано от HashAlgorithm)
HashName	Возвращает или задает имя используемого хэш-алгоритма. (Унаследовано от HMAC)
HashSize	Возвращает размер вычисляемого значения HMAC в битах.
HashSize	Получает размер вычисленного хэш-кода в битах. (Унаследовано от HashAlgorithm)
InputBlockSize	При переопределении в производном классе получает размер входного блока. (Унаследовано от HashAlgorithm)
Key	Возвращает или задает ключ, используемый при вычислении HMAC.
Key	Возвращает или задает ключ, используемый при вычислении HMAC. (Унаследовано от HMAC)
OutputBlockSize	При переопределении в производном классе получает размер выходного блока. (Унаследовано от HashAlgorithm)

Методы

Clear()	Освобождает все ресурсы, используемые классом HashAlgorithm. (Унаследовано от HashAlgorithm)
ComputeHash(Byte[])	Вычисляет хэш-значение для заданного массива байтов. (Унаследовано от HashAlgorithm)
ComputeHash(Byte[], Int32, Int32)	Вычисляет хэш-значение для заданной области заданного массива байтов. (Унаследовано от HashAlgorithm)
ComputeHash(Stream)	Вычисляет хэш-значение для заданного объекта Stream. (Унаследовано от HashAlgorithm)
ComputeHashAsync(Stream, CancellationToken)	Асинхронно вычисляет хэш-значение для заданного объекта Stream. (Унаследовано от HashAlgorithm)
Dispose()	Освобождает все ресурсы, используемые текущим экземпляром класса HashAlgorithm. (Унаследовано от HashAlgorithm)
Dispose(Boolean)	Освобождает неуправляемые ресурсы, используемые объектом HMACSHA256, а при необходимости освобождает также управляемые ресурсы.
Dispose(Boolean)	Освобождает неуправляемые ресурсы, используемые объектом HMAC, и, если допускается изменение ключа, опционально освобождает управляемые ресурсы. (Унаследовано от HMAC)
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
HashCore(Byte[], Int32, Int32)	Передает данные из объекта в HMAC-алгоритм для вычисления HMAC.
HashCore(Byte[], Int32, Int32)	Если переопределено в производном классе, передает данные, записанные в объект, в HMAC-алгоритм для вычисления значения HMAC. (Унаследовано от HMAC)
HashCore(ReadOnlySpan<Byte>)	Передает данные из объекта в HMAC-алгоритм для вычисления HMAC.
HashCore(ReadOnlySpan<Byte>)	Передает данные из объекта в HMAC-алгоритм для вычисления HMAC. (Унаследовано от HMAC)
HashData(Byte[], Byte[])	Вычисляет HMAC данных с помощью алгоритма SHA256.
HashData(Byte[], Stream)	Вычисляет HMAC потока с помощью алгоритма SHA256.
HashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)	Вычисляет HMAC данных с помощью алгоритма SHA256.
HashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Span<Byte>)	Вычисляет HMAC данных с помощью алгоритма SHA256.
HashData(ReadOnlySpan<Byte>, Stream)	Вычисляет HMAC потока с помощью алгоритма SHA256.
HashData(ReadOnlySpan<Byte>, Stream, Span<Byte>)	Вычисляет HMAC потока с помощью алгоритма SHA256.
HashDataAsync(Byte[], Stream, CancellationToken)	Асинхронно вычисляет HMAC потока с помощью алгоритма SHA256.
HashDataAsync(ReadOnlyMemory<Byte>, Stream, CancellationToken)	Асинхронно вычисляет HMAC потока с помощью алгоритма SHA256.
HashDataAsync(ReadOnlyMemory<Byte>, Stream, Memory<Byte>, CancellationToken)	Асинхронно вычисляет HMAC потока с помощью алгоритма SHA256.
HashFinal()	Завершает вычисление HMAC после обработки последних данных алгоритмом.
HashFinal()	Если переопределено в производном классе, завершает вычисление HMAC после обработки последних данных алгоритмом. (Унаследовано от HMAC)
Initialize()	Сбрасывает хэш-алгоритм в исходное состояние.
Initialize()	Инициализирует новый экземпляр реализации по умолчанию класса HMAC. (Унаследовано от HMAC)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
TransformBlock(Byte[], Int32, Int32, Byte[], Int32)	Вычисляет хэш-значение для заданной области входного массива байтов и копирует указанную область входного массива байтов в заданную область выходного массива байтов. (Унаследовано от HashAlgorithm)
TransformFinalBlock(Byte[], Int32, Int32)	Вычисляет хэш-значение для заданной области заданного массива байтов. (Унаследовано от HashAlgorithm)
TryComputeHash(ReadOnlySpan<Byte>, Span<Byte>, Int32)	Пытается вычислить хэш-значение для заданного массива байтов. (Унаследовано от HashAlgorithm)
TryHashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Span<Byte>, Int32)	Пытается вычислить HMAC данных с помощью алгоритма SHA256.
TryHashFinal(Span<Byte>, Int32)	Пытается завершить вычисление HMAC после обработки последних данных алгоритмом HMAC.
TryHashFinal(Span<Byte>, Int32)	Пытается завершить вычисление HMAC после обработки последних данных алгоритмом HMAC. (Унаследовано от HMAC)

Явные реализации интерфейса

IDisposable.Dispose()

Освобождает неуправляемые ресурсы, используемые объектом HashAlgorithm, а при необходимости освобождает также управляемые ресурсы.

(Унаследовано от HashAlgorithm)

Применяется к

См. также раздел

службы шифрования