Vulnerabilidades de temporalización con descifrado simétrico en modo CBC al usar el relleno
Microsoft ya no considera seguro descifrar los datos cifrados con el modo de cifrado simétrico Encadenamiento de bloques de cifrado (CBC) cuando se ha aplicado relleno verificable sin garantizar primero la integridad del texto cifrado, excepto en circunstancias muy específicas. Esta decisión se basa en la investigación criptográfica conocida actualmente.
Introducción
Un ataque de oráculo de relleno es un tipo de ataque contra datos cifrados que permite al atacante descifrar el contenido de los datos sin conocer la clave.
Un oráculo hace referencia a una "indicación" que brinda a un atacante información sobre si la acción que ejecuta es correcta o no. Imagine que está jugando un juego de mesa o de cartas con un niño: la cara se le ilumina con una gran sonrisa cuando cree que está a punto de hacer un buen movimiento. Eso es un oráculo. Usted, como oponente, puede usar este oráculo para planear su próximo movimiento según corresponda.
El relleno es un término criptográfico específico. Algunos cifrados, que son los algoritmos que se usan para cifrar los datos, funcionan en bloques de datos en los que cada bloque tiene un tamaño fijo. Si los datos que quiere cifrar no tienen el tamaño adecuado para rellenar los bloques, los datos se rellenan hasta que lo hacen. Muchas formas de relleno requieren que este siempre esté presente, incluso si la entrada original tenía el tamaño correcto. Esto permite que el relleno siempre se quite de manera segura tras el descifrado.
Al combinar ambos elementos, una implementación de software con un oráculo de relleno revela si los datos descifrados tienen un relleno válido. El oráculo podría ser algo tan sencillo como devolver un valor que dice "Relleno no válido", o bien algo más complicado como tomar un tiempo considerablemente diferente para procesar un bloque válido en lugar de uno no válido.
Los cifrados basados en bloques tienen otra propiedad, denominada "modo", que determina la relación de los datos del primer bloque con los datos del segundo bloque, y así sucesivamente. Uno de los modos más usados es CBC. CBC presenta un bloque aleatorio inicial, conocido como "vector de inicialización" (IV), y combina el bloque anterior con el resultado del cifrado estático a fin de que cifrar el mismo mensaje con la misma clave no siempre genere la misma salida cifrada.
Un atacante puede usar un oráculo de relleno, en combinación con la manera de estructurar los datos de CBC, para enviar mensajes ligeramente modificados al código que expone el oráculo y seguir enviando datos hasta que el oráculo indique que son correctos. Desde esta respuesta, el atacante puede descifrar el mensaje byte a byte.
Las redes informáticas modernas son de una calidad tan alta que un atacante puede detectar diferencias muy pequeñas (menos de 0,1 ms) en el tiempo de ejecución en sistemas remotos. Las aplicaciones que suponen que un descifrado correcto solo puede ocurrir cuando no se alteran los datos pueden resultar vulnerables a ataques desde herramientas que están diseñadas para observar diferencias en el descifrado correcto e incorrecto. Si bien esta diferencia de temporalización puede ser más significativa en algunos lenguajes o bibliotecas que en otros, ahora se cree que se trata de una amenaza práctica para todos los lenguajes y las bibliotecas cuando se tiene en cuenta la respuesta de la aplicación ante el error.
Este tipo de ataque se basa en la capacidad de cambiar los datos cifrados y probar el resultado con el oráculo. La única manera de mitigar completamente el ataque es detectar los cambios en los datos cifrados y rechazar que se hagan acciones en ellos. La manera estándar de hacerlo es crear una firma para los datos y validarla antes de realizar cualquier operación. La firma debe ser verificable y el atacante no debe poder crearla; de lo contrario, podría modificar los datos cifrados y calcular una firma nueva en función de esos datos cambiados. Un tipo común de firma adecuada se conoce como "código de autenticación de mensajes hash con clave" (HMAC). Un HMAC difiere de una suma de comprobación en que requiere una clave secreta, que solo conoce la persona que genera el HMAC y la persona que la valida. Si no se tiene esta clave, no se puede generar un HMAC correcto. Cuando reciba los datos, puede tomar los datos cifrados, calcular de manera independiente el HMAC con la clave secreta que comparten usted y el emisor y, luego, comparar el HMAC que este envía respecto del que usted calculó. Esta comparación debe ser de tiempo constante; de lo contrario, habrá agregado otro oráculo detectable, permitiendo así un tipo de ataque distinto.
En resumen, para usar de manera segura los cifrados de bloques de CBC rellenados, debe combinarlos con un HMAC (u otra comprobación de integridad de datos) que se valide mediante una comparación de tiempo constante antes de intentar descifrar los datos. Dado que todos los mensajes modificados tardan el mismo tiempo en generar una respuesta, el ataque se evita.
Quién es vulnerable
Esta vulnerabilidad se aplica a las aplicaciones administradas y nativas que hacen su propio cifrado y descifrado. Estas incluyen, por ejemplo:
- Una aplicación que cifra una cookie para descifrarla posteriormente en el servidor.
- Una aplicación de base de datos que proporciona la posibilidad de que los usuarios inserten datos en una tabla cuyas columnas se descifran posteriormente.
- Una aplicación de transferencia de datos que se basa en el cifrado mediante una clave compartida para proteger los datos en tránsito.
- Una aplicación que cifra y descifra mensajes "dentro" del túnel TLS.
Tenga en cuenta que es posible que el uso de TLS por sí solo no lo proteja en estos escenarios.
Una aplicación vulnerable:
- Descifra los datos mediante el modo de cifrado CBC con un modo de relleno verificable, como PKCS#7 o ANSI X.923.
- Lleva a cabo el descifrado sin haber hecho una comprobación de integridad de datos (a través de una MAC o una firma digital asimétrica).
Esto también se aplica a las aplicaciones basadas en abstracciones sobre estos elementos primitivos, como la estructura EnvelopedData de sintaxis de mensajes criptográficos (PKCS#7/CMS).
Áreas de interés relacionadas
La investigación ha hecho que Microsoft se preocupe más por los mensajes de CBC que se rellenan con relleno equivalente al estándar ISO 10126 cuando el mensaje tiene una estructura de pie de página conocida o predecible. Por ejemplo, el contenido preparado en virtud de las reglas de la recomendación sobre procesamiento y sintaxis de firma de XML de W3C (xmlenc, EncryptedXml). Si bien la guía de W3C para firmar mensajes y luego cifrarlos se consideraba adecuada en ese momento, Microsoft ahora recomienda siempre cifrar y luego firmar.
Los desarrolladores de aplicaciones siempre deben tener en cuenta la comprobación de la aplicabilidad de una clave de firma asimétrica, ya que no hay ninguna relación de confianza inherente entre una clave asimétrica y un mensaje arbitrario.
Detalles
Históricamente, ha habido consenso de la importancia de cifrar y autenticar los datos importantes a través de medios como las firmas RSA o HMAC. Sin embargo, las guías han sido menos claras con respecto a cómo secuenciar las operaciones de cifrado y autenticación. Debido a la vulnerabilidad que se detalla en este artículo, la guía de Microsoft ahora indica usar siempre el paradigma de cifrar y luego firmar. Es decir, primero debe cifrar los datos con una clave simétrica y, a continuación, calcular una MAC o una firma asimétrica sobre el texto cifrado (datos cifrados). Cuando quiera descifrar datos, haga la secuencia al revés. En primer lugar, confirme la MAC o la firma del texto cifrado y, luego, descifre los datos.
Se sabe que ha existido una clase de vulnerabilidades conocidas como "ataques de oráculo de relleno" durante más de 10 años. Estas vulnerabilidades permiten que un atacante descifre los datos cifrados mediante algoritmos de bloques simétricos, como AES y 3DES, con no más de 4096 intentos por bloque de datos. Estas vulnerabilidades aprovechan el hecho de que los cifrados de bloques se usan con más frecuencia con datos de relleno verificables al final. Se descubrió que si un atacante puede alterar el texto cifrado y averiguar si esta alteración generó un error en el formato del relleno al final, significa que puede descifrar los datos.
Inicialmente, los ataques prácticos se basaban en los servicios que devolvían códigos de error diferentes en función de si el relleno era válido, como la vulnerabilidad MS10-070 de ASP.NET. Sin embargo, Microsoft ahora considera que es práctico llevar a cabo ataques similares usando solo las diferencias de temporalización entre el procesamiento de relleno válido y no válido.
Siempre que el esquema de cifrado emplee una firma y que la comprobación de la firma se haga con un tiempo de ejecución fijo para una longitud de datos determinada (más allá del contenido), la integridad de los datos se puede comprobar sin emitir ninguna información a un atacante a través de un canal lateral. Debido a que la comprobación de integridad rechaza los mensajes alterados, se mitiga la amenaza relacionada con los ataques de oráculo de relleno.
Guía
En primer lugar, Microsoft recomienda que los datos con necesidades de confidencialidad se transmitan a través del protocolo Seguridad de la capa de transporte (TLS), el sucesor del protocolo Capa de sockets seguros (SSL).
A continuación, analice la aplicación para:
- Comprender exactamente qué cifrado realiza y qué cifrado proporcionan las plataformas y las API que usa.
- Tener certeza de que cada uso en cada capa de un algoritmo de cifrado de bloques simétrico, como AES y 3DES, en modo CBC incorpora el uso de una comprobación de integridad de datos con clave secreta (una firma asimétrica, un HMAC, o bien para cambiar el modo de cifrado a un modo de cifrado autenticado (AE), como GCM o CCM).
En función de la investigación actual, suele creerse que, cuando los pasos de autenticación y cifrado se completan de manera independiente para los modos de cifrado que no son AE, la mejor opción general es autenticar el texto cifrado (cifrar y luego firmar). Sin embargo, no hay una respuesta correcta única para la criptografía y esta generalización no es tan buena como los consejos dirigidos de un profesional de la criptografía.
En el caso de las aplicaciones que no pueden cambiar el formato de la mensajería, pero realizan un descifrado CBC sin autenticación, se recomienda que intenten incorporar mitigaciones como las siguientes:
- Descifrar sin permitir que el descifrador compruebe o quite el relleno:
- De todos modos, todo relleno aplicado se debe quitar u omitir, ya que la carga se moverá a la aplicación.
- La ventaja es que la comprobación y eliminación del relleno se puede incorporar a otra lógica de comprobación de los datos de aplicación. Si la comprobación del relleno y de los datos se pueden realizar en un tiempo constante, se reduce la amenaza.
- Debido a que la interpretación del relleno cambia la longitud percibida del mensaje, es posible que todavía se emita información de temporalización desde este enfoque.
- Cambiar el modo de relleno de descifrado a ISO10126:
- El relleno de descifrado ISO10126 es compatible tanto con el relleno de cifrado PKCS7 como con ANSIX923.
- Cambiar el modo reduce el conocimiento del oráculo de relleno a 1 byte en lugar de todo el bloque. Sin embargo, si el contenido tiene un pie de página conocido (como un elemento XML de cierre), los ataques relacionados pueden seguir atacando al resto del mensaje.
- Esto tampoco evita que se recupere texto sin formato en situaciones en las que el atacante puede convertir varias veces ese mismo texto sin formato en texto cifrado con una compensación de mensaje diferente.
- Controlar la evaluación de una llamada de descifrado para atenuar la señal de temporalización:
- El cálculo del tiempo de espera debe tener un mínimo que supere la cantidad máxima de tiempo que tardaría el descifrado de cualquier segmento de datos que contenga relleno.
- Los cálculos de tiempo se deben hacer según la guía que aparece en el artículo sobre la adquisición de marcas de tiempo de alta resolución, no mediante el uso de Environment.TickCount (sujeto a reversión o desbordamiento) ni restando dos marcas de tiempo del sistema (sujeto a errores de ajuste de NTP).
- Los cálculos de tiempo deben incluir la operación de descifrado, incluidas todas las excepciones posibles en aplicaciones administradas o de C++, no solo el relleno al final.
- Si se determinó el éxito o el error, la puerta de control de temporalización debe devolver un error al expirar.
- Los servicios que realizan descifrado sin autenticación deben tener implementada la supervisión para detectar que se produjo una inundación de mensajes "no válidos".
- Tenga en cuenta que esta señal lleva tanto falsos positivos (datos dañados legítimamente) como falsos negativos (que propagan el ataque durante un tiempo suficiente como para evadir la detección).
Búsqueda de código vulnerable: aplicaciones nativas
En el caso de los programas creados con la biblioteca Cryptography: Next Generation (CNG) de Windows:
- La llamada de descifrado es a BCryptDecrypt, especificando la marca
BCRYPT_BLOCK_PADDING. - El identificador de clave se inicializó mediante una llamada a BCryptSetProperty con BCRYPT_CHAINING_MODE establecido en
BCRYPT_CHAIN_MODE_CBC.- Dado que
BCRYPT_CHAIN_MODE_CBCes el valor predeterminado, es posible que el código afectado no haya asignado ningún valor paraBCRYPT_CHAINING_MODE.
- Dado que
En el caso de los programas creados con Windows Cryptography API:
- La llamada de descifrado es a CryptDecrypt con
Final=TRUE. - El identificador de clave se inicializó mediante una llamada a CryptSetKeyParam con KP_MODE establecido en
CRYPT_MODE_CBC.- Dado que
CRYPT_MODE_CBCes el valor predeterminado, es posible que el código afectado no haya asignado ningún valor paraKP_MODE.
- Dado que
Búsqueda de código vulnerable: aplicaciones administradas
- La llamada de descifrado es a los métodos CreateDecryptor() o CreateDecryptor(Byte[], Byte[]) en System.Security.Cryptography.SymmetricAlgorithm.
- Esto incluye los tipos derivados siguientes dentro de .NET, pero también puede incluir tipos de terceros:
- La propiedad SymmetricAlgorithm.Padding se estableció en PaddingMode.PKCS7, PaddingMode.ANSIX923 o PaddingMode.ISO10126.
- Dado que PaddingMode.PKCS7 es el valor predeterminado, es posible que el código afectado nunca haya asignado la propiedad SymmetricAlgorithm.Padding.
- La propiedad SymmetricAlgorithm.Mode se estableció en CipherMode.CBC.
- Dado que CipherMode.CBC es el valor predeterminado, es posible que el código afectado nunca haya asignado la propiedad SymmetricAlgorithm.Mode.
Búsqueda de código vulnerable: sintaxis de mensajes criptográficos
Un mensaje EnvelopedData de CMS sin autenticación cuyo contenido cifrado usa el modo CBC de AES (2.16.840.1.101.3.4.1.2, 2.16.840.1.101.3.4.1.22, 2.16.840.1.101.3.4.1.42), DES (1.3.14.3.2.7), 3DES (1.2.840.113549.3.7) o RC2 (1.2.840.113549.3.2) es vulnerable, así como los mensajes que utilizan cualquier otro algoritmo de cifrado de bloques en modo CBC.
Si bien los cifrados de secuencias no son susceptibles a esta vulnerabilidad específica, Microsoft recomienda autenticar siempre los datos al inspeccionar el valor ContentEncryptionAlgorithm.
En el caso de las aplicaciones administradas, un blob EnvelopedData de CMS se puede detectar como cualquier valor que se pasa a System.Security.Cryptography.Pkcs.EnvelopedCms.Decode(Byte[]).
En el caso de las aplicaciones nativas, un blob EnvelopedData de CMS se puede detectar como cualquier valor que se proporciona a un identificador de CMS a través de CryptMsgUpdate, cuyo CMSG_TYPE_PARAM resultante es CMSG_ENVELOPED. Además, el identificador de CMS recibe posteriormente una instrucción CMSG_CTRL_DECRYPT mediante CryptMsgControl.
Ejemplo de código vulnerable: administrado
Este método lee una cookie y la descifra, y no hay ninguna comprobación de integridad de datos visible. Por lo tanto, el contenido de una cookie que este método lee puede sufrir un ataque del usuario que lo recibió o de cualquier atacante que haya obtenido el valor cifrado de la cookie.
private byte[] DecryptCookie(string cookieName)
{
HttpCookie cookie = Request.Cookies[cookieName];
if (cookie == null)
{
return null;
}
using (ICryptoTransform decryptor = _aes.CreateDecryptor())
using (MemoryStream memoryStream = new MemoryStream())
using (CryptoStream cryptoStream =
new CryptoStream(memoryStream, decryptor, CryptoStreamMode.Write))
{
byte[] readCookie = Convert.FromBase64String(cookie.Value);
cryptoStream.Write(readCookie, 0, readCookie.Length);
cryptoStream.FlushFinalBlock();
return memoryStream.ToArray();
}
}
Código de ejemplo según los procedimientos recomendados: administrado
En el código de ejemplo siguiente, se usa un formato de mensaje no estándar de
cipher_algorithm_id || hmac_algorithm_id || hmac_tag || iv || ciphertext
en el que los identificadores de algoritmo cipher_algorithm_id y hmac_algorithm_id son representaciones de la aplicación local (no estándar) de esos algoritmos. Estos identificadores pueden tener sentido en otras partes del protocolo de mensajería existente y no como secuencias de bytes concatenadas vacías.
En este ejemplo, también se usa una clave maestra única para derivar una clave de cifrado y una clave HMAC. Esto se proporciona como una oportunidad para convertir una aplicación con clave única en una aplicación con clave doble y para recomendar mantener las dos claves como valores diferentes. Además, garantiza que la clave HMAC y la clave de cifrado no salgan de la sincronización.
Este ejemplo no acepta una clase Stream para cifrado ni descifrado. El formato de datos actual dificulta el cifrado de un solo paso, porque el valor hmac_tag antecede al texto cifrado. Sin embargo, se eligió este formato porque mantiene todos los elementos de tamaño fijo al principio a fin de simplificar el analizador. Este formato de datos permite el descifrado de un solo paso, aunque se recomienda que un implementador llame a GetHashAndReset y compruebe el resultado antes de llamar a TransformFinalBlock. Si el cifrado de streaming es importante, es posible que se requiera un modo AE distinto.
// ==++==
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
// Shared under the terms of the Microsoft Public License,
// https://opensource.org/licenses/MS-PL
//
// ==--==
using System;
using System.Diagnostics;
using System.IO;
using System.Runtime.CompilerServices;
using System.Security.Cryptography;
namespace Microsoft.Examples.Cryptography
{
public enum AeCipher : byte
{
Unknown,
Aes256CbcPkcs7,
}
public enum AeMac : byte
{
Unknown,
HMACSHA256,
HMACSHA384,
}
/// <summary>
/// Provides extension methods to make HashAlgorithm look like .NET Core's
/// IncrementalHash
/// </summary>
internal static class IncrementalHashExtensions
{
public static void AppendData(this HashAlgorithm hash, byte[] data)
{
hash.TransformBlock(data, 0, data.Length, null, 0);
}
public static void AppendData(
this HashAlgorithm hash,
byte[] data,
int offset,
int length)
{
hash.TransformBlock(data, offset, length, null, 0);
}
public static byte[] GetHashAndReset(this HashAlgorithm hash)
{
hash.TransformFinalBlock(Array.Empty<byte>(), 0, 0);
return hash.Hash;
}
}
public static partial class AuthenticatedEncryption
{
/// <summary>
/// Use <paramref name="masterKey"/> to derive two keys (one cipher, one HMAC)
/// to provide authenticated encryption for <paramref name="message"/>.
/// </summary>
/// <param name="masterKey">The master key from which other keys derive.</param>
/// <param name="message">The message to encrypt</param>
/// <returns>
/// A concatenation of
/// [cipher algorithm+chainmode+padding][mac algorithm][authtag][IV][ciphertext],
/// suitable to be passed to <see cref="Decrypt"/>.
/// </returns>
/// <remarks>
/// <paramref name="masterKey"/> should be a 128-bit (or bigger) value generated
/// by a secure random number generator, such as the one returned from
/// <see cref="RandomNumberGenerator.Create()"/>.
/// This implementation chooses to block deficient inputs by length, but does not
/// make any attempt at discerning the randomness of the key.
///
/// If the master key is being input by a prompt (like a password/passphrase)
/// then it should be properly turned into keying material via a Key Derivation
/// Function like PBKDF2, represented by Rfc2898DeriveBytes. A 'password' should
/// never be simply turned to bytes via an Encoding class and used as a key.
/// </remarks>
public static byte[] Encrypt(byte[] masterKey, byte[] message)
{
if (masterKey == null)
throw new ArgumentNullException(nameof(masterKey));
if (masterKey.Length < 16)
throw new ArgumentOutOfRangeException(
nameof(masterKey),
"Master Key must be at least 128 bits (16 bytes)");
if (message == null)
throw new ArgumentNullException(nameof(message));
// First, choose an encryption scheme.
AeCipher aeCipher = AeCipher.Aes256CbcPkcs7;
// Second, choose an authentication (message integrity) scheme.
//
// In this example we use the master key length to change from HMACSHA256 to
// HMACSHA384, but that is completely arbitrary. This mostly represents a
// "cryptographic needs change over time" scenario.
AeMac aeMac = masterKey.Length < 48 ? AeMac.HMACSHA256 : AeMac.HMACSHA384;
// It's good to be able to identify what choices were made when a message was
// encrypted, so that the message can later be decrypted. This allows for
// future versions to add support for new encryption schemes, but still be
// able to read old data. A practice known as "cryptographic agility".
//
// This is similar in practice to PKCS#7 messaging, but this uses a
// private-scoped byte rather than a public-scoped Object IDentifier (OID).
// Please note that the scheme in this example adheres to no particular
// standard, and is unlikely to survive to a more complete implementation in
// the .NET Framework.
//
// You may be well-served by prepending a version number byte to this
// message, but may want to avoid the value 0x30 (the leading byte value for
// DER-encoded structures such as X.509 certificates and PKCS#7 messages).
byte[] algorithmChoices = { (byte)aeCipher, (byte)aeMac };
byte[] iv;
byte[] cipherText;
byte[] tag;
// Using our algorithm choices, open an HMAC (as an authentication tag
// generator) and a SymmetricAlgorithm which use different keys each derived
// from the same master key.
//
// A custom implementation may very well have distinctly managed secret keys
// for the MAC and cipher, this example merely demonstrates the master to
// derived key methodology to encourage key separation from the MAC and
// cipher keys.
using (HMAC tagGenerator = GetMac(aeMac, masterKey))
{
using (SymmetricAlgorithm cipher = GetCipher(aeCipher, masterKey))
using (ICryptoTransform encryptor = cipher.CreateEncryptor())
{
// Since no IV was provided, a random one has been generated
// during the call to CreateEncryptor.
//
// But note that it only does the auto-generation once. If the cipher
// object were used again, a call to GenerateIV would have been
// required.
iv = cipher.IV;
cipherText = Transform(encryptor, message, 0, message.Length);
}
// The IV and ciphertext both need to be included in the MAC to prevent
// tampering.
//
// By including the algorithm identifiers, we have technically moved from
// simple Authenticated Encryption (AE) to Authenticated Encryption with
// Additional Data (AEAD). By including the algorithm identifiers in the
// MAC, it becomes harder for an attacker to change them as an attempt to
// perform a downgrade attack.
//
// If you've added a data format version field, it can also be included
// in the MAC to further inhibit an attacker's options for confusing the
// data processor into believing the tampered message is valid.
tagGenerator.AppendData(algorithmChoices);
tagGenerator.AppendData(iv);
tagGenerator.AppendData(cipherText);
tag = tagGenerator.GetHashAndReset();
}
// Build the final result as the concatenation of everything except the keys.
int totalLength =
algorithmChoices.Length +
tag.Length +
iv.Length +
cipherText.Length;
byte[] output = new byte[totalLength];
int outputOffset = 0;
Append(algorithmChoices, output, ref outputOffset);
Append(tag, output, ref outputOffset);
Append(iv, output, ref outputOffset);
Append(cipherText, output, ref outputOffset);
Debug.Assert(outputOffset == output.Length);
return output;
}
/// <summary>
/// Reads a message produced by <see cref="Encrypt"/> after verifying it hasn't
/// been tampered with.
/// </summary>
/// <param name="masterKey">The master key from which other keys derive.</param>
/// <param name="cipherText">
/// The output of <see cref="Encrypt"/>: a concatenation of a cipher ID, mac ID,
/// authTag, IV, and cipherText.
/// </param>
/// <returns>The decrypted content.</returns>
/// <exception cref="ArgumentNullException">
/// <paramref name="masterKey"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentNullException">
/// <paramref name="cipherText"/> is <c>null</c>.
/// </exception>
/// <exception cref="CryptographicException">
/// <paramref name="cipherText"/> identifies unknown algorithms, is not long
/// enough, fails a data integrity check, or fails to decrypt.
/// </exception>
/// <remarks>
/// <paramref name="masterKey"/> should be a 128-bit (or larger) value
/// generated by a secure random number generator, such as the one returned from
/// <see cref="RandomNumberGenerator.Create()"/>. This implementation chooses to
/// block deficient inputs by length, but doesn't make any attempt at
/// discerning the randomness of the key.
///
/// If the master key is being input by a prompt (like a password/passphrase),
/// then it should be properly turned into keying material via a Key Derivation
/// Function like PBKDF2, represented by Rfc2898DeriveBytes. A 'password' should
/// never be simply turned to bytes via an Encoding class and used as a key.
/// </remarks>
public static byte[] Decrypt(byte[] masterKey, byte[] cipherText)
{
// This example continues the .NET practice of throwing exceptions for
// failures. If you consider message tampering to be normal (and thus
// "not exceptional") behavior, you may like the signature
// bool Decrypt(byte[] messageKey, byte[] cipherText, out byte[] message)
// better.
if (masterKey == null)
throw new ArgumentNullException(nameof(masterKey));
if (masterKey.Length < 16)
throw new ArgumentOutOfRangeException(
nameof(masterKey),
"Master Key must be at least 128 bits (16 bytes)");
if (cipherText == null)
throw new ArgumentNullException(nameof(cipherText));
// The format of this message is assumed to be public, so there's no harm in
// saying ahead of time that the message makes no sense.
if (cipherText.Length < 2)
{
throw new CryptographicException();
}
// Use the message algorithm headers to determine what cipher algorithm and
// MAC algorithm are going to be used. Since the same Key Derivation
// Functions (KDFs) are being used in Decrypt as Encrypt, the keys are also
// the same.
AeCipher aeCipher = (AeCipher)cipherText[0];
AeMac aeMac = (AeMac)cipherText[1];
using (SymmetricAlgorithm cipher = GetCipher(aeCipher, masterKey))
using (HMAC tagGenerator = GetMac(aeMac, masterKey))
{
int blockSizeInBytes = cipher.BlockSize / 8;
int tagSizeInBytes = tagGenerator.HashSize / 8;
int headerSizeInBytes = 2;
int tagOffset = headerSizeInBytes;
int ivOffset = tagOffset + tagSizeInBytes;
int cipherTextOffset = ivOffset + blockSizeInBytes;
int cipherTextLength = cipherText.Length - cipherTextOffset;
int minLen = cipherTextOffset + blockSizeInBytes;
// Again, the minimum length is still assumed to be public knowledge,
// nothing has leaked out yet. The minimum length couldn't just be calculated
// without reading the header.
if (cipherText.Length < minLen)
{
throw new CryptographicException();
}
// It's very important that the MAC be calculated and verified before
// proceeding to decrypt the ciphertext, as this prevents any sort of
// information leaking out to an attacker.
//
// Don't include the tag in the calculation, though.
// First, everything before the tag (the cipher and MAC algorithm ids)
tagGenerator.AppendData(cipherText, 0, tagOffset);
// Skip the data before the tag and the tag, then read everything that
// remains.
tagGenerator.AppendData(
cipherText,
tagOffset + tagSizeInBytes,
cipherText.Length - tagSizeInBytes - tagOffset);
byte[] generatedTag = tagGenerator.GetHashAndReset();
// The time it took to get to this point has so far been a function only
// of the length of the data, or of non-encrypted values (e.g. it could
// take longer to prepare the *key* for the HMACSHA384 MAC than the
// HMACSHA256 MAC, but the algorithm choice wasn't a secret).
//
// If the verification of the authentication tag aborts as soon as a
// difference is found in the byte arrays then your program may be
// acting as a timing oracle which helps an attacker to brute-force the
// right answer for the MAC. So, it's very important that every possible
// "no" (2^256-1 of them for HMACSHA256) be evaluated in as close to the
// same amount of time as possible. For this, we call CryptographicEquals
if (!CryptographicEquals(
generatedTag,
0,
cipherText,
tagOffset,
tagSizeInBytes))
{
// Assuming every tampered message (of the same length) took the same
// amount of time to process, we can now safely say
// "this data makes no sense" without giving anything away.
throw new CryptographicException();
}
// Restore the IV into the symmetricAlgorithm instance.
byte[] iv = new byte[blockSizeInBytes];
Buffer.BlockCopy(cipherText, ivOffset, iv, 0, iv.Length);
cipher.IV = iv;
using (ICryptoTransform decryptor = cipher.CreateDecryptor())
{
return Transform(
decryptor,
cipherText,
cipherTextOffset,
cipherTextLength);
}
}
}
private static byte[] Transform(
ICryptoTransform transform,
byte[] input,
int inputOffset,
int inputLength)
{
// Many of the implementations of ICryptoTransform report true for
// CanTransformMultipleBlocks, and when the entire message is available in
// one shot this saves on the allocation of the CryptoStream and the
// intermediate structures it needs to properly chunk the message into blocks
// (since the underlying stream won't always return the number of bytes
// needed).
if (transform.CanTransformMultipleBlocks)
{
return transform.TransformFinalBlock(input, inputOffset, inputLength);
}
// If our transform couldn't do multiple blocks at once, let CryptoStream
// handle the chunking.
using (MemoryStream messageStream = new MemoryStream())
using (CryptoStream cryptoStream =
new CryptoStream(messageStream, transform, CryptoStreamMode.Write))
{
cryptoStream.Write(input, inputOffset, inputLength);
cryptoStream.FlushFinalBlock();
return messageStream.ToArray();
}
}
/// <summary>
/// Open a properly configured <see cref="SymmetricAlgorithm"/> conforming to the
/// scheme identified by <paramref name="aeCipher"/>.
/// </summary>
/// <param name="aeCipher">The cipher mode to open.</param>
/// <param name="masterKey">The master key from which other keys derive.</param>
/// <returns>
/// A SymmetricAlgorithm object with the right key, cipher mode, and padding
/// mode; or <c>null</c> on unknown algorithms.
/// </returns>
private static SymmetricAlgorithm GetCipher(AeCipher aeCipher, byte[] masterKey)
{
SymmetricAlgorithm symmetricAlgorithm;
switch (aeCipher)
{
case AeCipher.Aes256CbcPkcs7:
symmetricAlgorithm = Aes.Create();
// While 256-bit, CBC, and PKCS7 are all the default values for these
// properties, being explicit helps comprehension more than it hurts
// performance.
symmetricAlgorithm.KeySize = 256;
symmetricAlgorithm.Mode = CipherMode.CBC;
symmetricAlgorithm.Padding = PaddingMode.PKCS7;
break;
default:
// An algorithm we don't understand
throw new CryptographicException();
}
// Instead of using the master key directly, derive a key for our chosen
// HMAC algorithm based upon the master key.
//
// Since none of the symmetric encryption algorithms currently in .NET
// support key sizes greater than 256-bit, we can use HMACSHA256 with
// NIST SP 800-108 5.1 (Counter Mode KDF) to derive a value that is
// no smaller than the key size, then Array.Resize to trim it down as
// needed.
using (HMAC hmac = new HMACSHA256(masterKey))
{
// i=1, Label=ASCII(cipher)
byte[] cipherKey = hmac.ComputeHash(
new byte[] { 1, 99, 105, 112, 104, 101, 114 });
// Resize the array to the desired keysize. KeySize is in bits,
// and Array.Resize wants the length in bytes.
Array.Resize(ref cipherKey, symmetricAlgorithm.KeySize / 8);
symmetricAlgorithm.Key = cipherKey;
}
return symmetricAlgorithm;
}
/// <summary>
/// Open a properly configured <see cref="HMAC"/> conforming to the scheme
/// identified by <paramref name="aeMac"/>.
/// </summary>
/// <param name="aeMac">The message authentication mode to open.</param>
/// <param name="masterKey">The master key from which other keys derive.</param>
/// <returns>
/// An HMAC object with the proper key, or <c>null</c> on unknown algorithms.
/// </returns>
private static HMAC GetMac(AeMac aeMac, byte[] masterKey)
{
HMAC hmac;
switch (aeMac)
{
case AeMac.HMACSHA256:
hmac = new HMACSHA256();
break;
case AeMac.HMACSHA384:
hmac = new HMACSHA384();
break;
default:
// An algorithm we don't understand
throw new CryptographicException();
}
// Instead of using the master key directly, derive a key for our chosen
// HMAC algorithm based upon the master key.
// Since the output size of the HMAC is the same as the ideal key size for
// the HMAC, we can use the master key over a fixed input once to perform
// NIST SP 800-108 5.1 (Counter Mode KDF):
hmac.Key = masterKey;
// i=1, Context=ASCII(MAC)
byte[] newKey = hmac.ComputeHash(new byte[] { 1, 77, 65, 67 });
hmac.Key = newKey;
return hmac;
}
// A simple helper method to ensure that the offset (writePos) always moves
// forward with new data.
private static void Append(byte[] newData, byte[] combinedData, ref int writePos)
{
Buffer.BlockCopy(newData, 0, combinedData, writePos, newData.Length);
writePos += newData.Length;
}
/// <summary>
/// Compare the contents of two arrays in an amount of time which is only
/// dependent on <paramref name="length"/>.
/// </summary>
/// <param name="a">An array to compare to <paramref name="b"/>.</param>
/// <param name="aOffset">
/// The starting position within <paramref name="a"/> for comparison.
/// </param>
/// <param name="b">An array to compare to <paramref name="a"/>.</param>
/// <param name="bOffset">
/// The starting position within <paramref name="b"/> for comparison.
/// </param>
/// <param name="length">
/// The number of bytes to compare between <paramref name="a"/> and
/// <paramref name="b"/>.</param>
/// <returns>
/// <c>true</c> if both <paramref name="a"/> and <paramref name="b"/> have
/// sufficient length for the comparison and all of the applicable values are the
/// same in both arrays; <c>false</c> otherwise.
/// </returns>
/// <remarks>
/// An "insufficient data" <c>false</c> response can happen early, but otherwise
/// a <c>true</c> or <c>false</c> response take the same amount of time.
/// </remarks>
[MethodImpl(MethodImplOptions.NoInlining | MethodImplOptions.NoOptimization)]
private static bool CryptographicEquals(
byte[] a,
int aOffset,
byte[] b,
int bOffset,
int length)
{
Debug.Assert(a != null);
Debug.Assert(b != null);
Debug.Assert(length >= 0);
int result = 0;
if (a.Length - aOffset < length || b.Length - bOffset < length)
{
return false;
}
unchecked
{
for (int i = 0; i < length; i++)
{
// Bitwise-OR of subtraction has been found to have the most
// stable execution time.
//
// This cannot overflow because bytes are 1 byte in length, and
// result is 4 bytes.
// The OR propagates all set bytes, so the differences are only
// present in the lowest byte.
result = result | (a[i + aOffset] - b[i + bOffset]);
}
}
return result == 0;
}
}
}
