HMACSHA256 Clase

Definición

Espacio de nombres:

System.Security.Cryptography

Ensamblado:

System.Security.Cryptography.dll

Source:

HMACSHA256.cs

Calcula un código de autenticación de mensajes basado en hash (HMAC) mediante la función hash SHA256.

C#

public class HMACSHA256 : System.Security.Cryptography.HMAC

Herencia

Object

HashAlgorithm

KeyedHashAlgorithm

HMAC

HMACSHA256

Ejemplos

En el ejemplo siguiente se muestra cómo firmar un archivo mediante el HMACSHA256 objeto y, a continuación, cómo comprobar el archivo.

C#

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

Comentarios

HMACSHA256 es un tipo de algoritmo hash con clave que se construye a partir de la función hash SHA-256 y se usa como código de autenticación de mensajes basado en hash (HMAC). El proceso HMAC mezcla una clave secreta con los datos del mensaje, aplica un algoritmo hash al resultado con la función hash, mezcla ese valor hash con la clave secreta de nuevo y, a continuación, aplica la función hash una segunda vez. El hash de salida tiene una longitud de 256 bits.

Un HMAC se puede usar para determinar si se ha alterado un mensaje enviado a través de un canal no seguro, siempre que el remitente y el receptor compartan una clave secreta. El remitente calcula el valor hash de los datos originales y envía los datos originales y el valor hash como un único mensaje. El receptor recalcula el valor hash en el mensaje recibido y comprueba que el HMAC calculado coincide con el HMAC transmitido.

Cualquier cambio en los datos o en el valor hash da como resultado un error de coincidencia, ya que se requiere el conocimiento de la clave secreta para cambiar el mensaje y reproducir el valor hash correcto. Por lo tanto, si los valores hash originales y calculados coinciden, el mensaje se autentica.

HMACSHA256 acepta claves de cualquier tamaño y genera una secuencia hash de 256 bits de longitud.

Constructores

HMACSHA256()	Inicializa una nueva instancia de la clase HMACSHA256 con una clave generada aleatoriamente.
HMACSHA256(Byte[])	Inicializa una nueva instancia de la clase HMACSHA256 con los datos de clave especificados.

Campos

HashSizeInBits	Tamaño hash generado por el algoritmo HMAC SHA256, en bits.
HashSizeInBytes	Tamaño hash generado por el algoritmo HMAC SHA256, en bytes.
HashSizeValue	Representa el tamaño en bits del código hash calculado. (Heredado de HashAlgorithm)
HashValue	Representa el valor del código hash calculado. (Heredado de HashAlgorithm)
KeyValue	Clave que se va a usar en el algoritmo hash. (Heredado de KeyedHashAlgorithm)
State	Representa el estado del cálculo del valor hash. (Heredado de HashAlgorithm)

Propiedades

BlockSizeValue	Obtiene o establece el tamaño de bloque que se va a usar en el valor hash. (Heredado de HMAC)
CanReuseTransform	Obtiene un valor que indica si la transformación actual puede volver a usarse. (Heredado de HashAlgorithm)
CanTransformMultipleBlocks	Cuando se invalida en una clase derivada, obtiene un valor que indica si se pueden transformar varios bloques. (Heredado de HashAlgorithm)
Hash	Obtiene el valor del código hash calculado. (Heredado de HashAlgorithm)
HashName	Obtiene o establece el nombre del algoritmo hash que se va a utilizar para la operación hash. (Heredado de HMAC)
HashSize	Obtiene el tamaño en bits del código hash calculado. (Heredado de HashAlgorithm)
InputBlockSize	Cuando se invalida en una clase derivada, obtiene el tamaño del bloque de entrada. (Heredado de HashAlgorithm)
Key	Obtiene o establece la clave que se va a usar en el cálculo de HMAC.
OutputBlockSize	Cuando se invalida en una clase derivada, obtiene el tamaño del bloque de salida. (Heredado de HashAlgorithm)

Métodos

Clear()	Libera todos los recursos que utiliza la clase HashAlgorithm. (Heredado de HashAlgorithm)
ComputeHash(Byte[])	Calcula el valor hash para la matriz de bytes especificada. (Heredado de HashAlgorithm)
ComputeHash(Byte[], Int32, Int32)	Calcula el valor hash para la región especificada de la matriz de bytes indicada. (Heredado de HashAlgorithm)
ComputeHash(Stream)	Calcula el valor hash del objeto Stream especificado. (Heredado de HashAlgorithm)
ComputeHashAsync(Stream, CancellationToken)	Calcula de manera asincrónica el valor hash del objeto Stream especificado. (Heredado de HashAlgorithm)
Dispose()	Libera todos los recursos usados por la instancia actual de la clase HashAlgorithm. (Heredado de HashAlgorithm)
Dispose(Boolean)	Libera los recursos no administrados que usa HMACSHA256 y, de forma opcional, libera los recursos administrados.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
HashCore(Byte[], Int32, Int32)	Envía los datos escritos en el objeto al algoritmo HMAC para el cálculo del HMAC.
HashCore(ReadOnlySpan<Byte>)	Envía los datos escritos en el objeto al algoritmo HMAC para el cálculo del HMAC.
HashData(Byte[], Byte[])	Calcula el HMAC de los datos mediante el algoritmo SHA256.
HashData(Byte[], Stream)	Calcula el HMAC de una secuencia mediante el algoritmo SHA256.
HashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)	Calcula el HMAC de los datos mediante el algoritmo SHA256.
HashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Span<Byte>)	Calcula el HMAC de los datos mediante el algoritmo SHA256.
HashData(ReadOnlySpan<Byte>, Stream)	Calcula el HMAC de una secuencia mediante el algoritmo SHA256.
HashData(ReadOnlySpan<Byte>, Stream, Span<Byte>)	Calcula el HMAC de una secuencia mediante el algoritmo SHA256.
HashDataAsync(Byte[], Stream, CancellationToken)	Calcula de forma asincrónica el HMAC de una secuencia mediante el algoritmo SHA256.
HashDataAsync(ReadOnlyMemory<Byte>, Stream, CancellationToken)	Calcula de forma asincrónica el HMAC de una secuencia mediante el algoritmo SHA256.
HashDataAsync(ReadOnlyMemory<Byte>, Stream, Memory<Byte>, CancellationToken)	Calcula de forma asincrónica el HMAC de una secuencia mediante el algoritmo SHA256.
HashFinal()	Finaliza el cálculo de HMAC una vez que el algoritmo procesa los últimos datos.
Initialize()	Restablece el algoritmo hash a su estado inicial.
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)
TransformBlock(Byte[], Int32, Int32, Byte[], Int32)	Calcula el valor hash para la región especificada de la matriz de bytes de entrada y copia la región especificada de la matriz de bytes de entrada resultante en la región indicada de la matriz de bytes de salida. (Heredado de HashAlgorithm)
TransformFinalBlock(Byte[], Int32, Int32)	Calcula el valor hash para la región especificada de la matriz de bytes indicada. (Heredado de HashAlgorithm)
TryComputeHash(ReadOnlySpan<Byte>, Span<Byte>, Int32)	Intenta calcular el valor de hash para la matriz de bytes especificada. (Heredado de HashAlgorithm)
TryHashData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Span<Byte>, Int32)	Intenta calcular el HMAC de los datos mediante el algoritmo SHA256.
TryHashFinal(Span<Byte>, Int32)	Intenta finalizar el cálculo de HMAC una vez que el algoritmo HMAC procesa los últimos datos.

Se aplica a

Consulte también

• servicios criptográficos