crypto/modes/wrap128.c

   1 /* crypto/modes/wrap128.c */
   2 /*
   3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
   4  * project. Mode with padding contributed by Petr Spacek
   5  * (pspacek@redhat.com).
   6  */
   7 /* ====================================================================
   8  * Copyright (c) 2013 The OpenSSL Project.  All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  *
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  *
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in
  19  *    the documentation and/or other materials provided with the
  20  *    distribution.
  21  *
  22  * 3. All advertising materials mentioning features or use of this
  23  *    software must display the following acknowledgment:
  24  *    "This product includes software developed by the OpenSSL Project
  25  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  26  *
  27  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  28  *    endorse or promote products derived from this software without
  29  *    prior written permission. For written permission, please contact
  30  *    licensing@OpenSSL.org.
  31  *
  32  * 5. Products derived from this software may not be called "OpenSSL"
  33  *    nor may "OpenSSL" appear in their names without prior written
  34  *    permission of the OpenSSL Project.
  35  *
  36  * 6. Redistributions of any form whatsoever must retain the following
  37  *    acknowledgment:
  38  *    "This product includes software developed by the OpenSSL Project
  39  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  42  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  44  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  47  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  48  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  50  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  51  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  52  * OF THE POSSIBILITY OF SUCH DAMAGE.
  53  * ====================================================================
  54  */
  55
  56 /**  Beware!
  57  *
  58  *  Following wrapping modes were designed for AES but this implementation
  59  *  allows you to use them for any 128 bit block cipher.
  60  */
  61
  62 #include "cryptlib.h"
  63 #include <openssl/modes.h>
  64
  65 /** RFC 3394 section 2.2.3.1 Default Initial Value */
  66 static const unsigned char default_iv[] = {
  67     0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6,
  68 };
  69
  70 /** RFC 5649 section 3 Alternative Initial Value 32-bit constant */
  71 static const unsigned char default_aiv[] = {
  72     0xA6, 0x59, 0x59, 0xA6
  73 };
  74
  75 /** Input size limit: lower than maximum of standards but far larger than
  76  *  anything that will be used in practice.
  77  */
  78 #define CRYPTO128_WRAP_MAX (1UL << 31)
  79
  80 /** Wrapping according to RFC 3394 section 2.2.1.
  81  *
  82  *  @param[in]  key    Key value.
  83  *  @param[in]  iv     IV value. Length = 8 bytes. NULL = use default_iv.
  84  *  @param[in]  in     Plain text as n 64-bit blocks, n >= 2.
  85  *  @param[in]  inlen  Length of in.
  86  *  @param[out] out    Cipher text. Minimal buffer length = (inlen + 8) bytes.
  87  *                     Input and output buffers can overlap if block function
  88  *                     supports that.
  89  *  @param[in]  block  Block processing function.
  90  *  @return            0 if inlen does not consist of n 64-bit blocks, n >= 2.
  91  *                     or if inlen > CRYPTO128_WRAP_MAX.
  92  *                     Output length if wrapping succeeded.
  93  */
  94 size_t CRYPTO_128_wrap(void *key, const unsigned char *iv,
  95                        unsigned char *out,
  96                        const unsigned char *in, size_t inlen,
  97                        block128_f block)
  98 {
  99     unsigned char *A, B[16], *R;
 100     size_t i, j, t;
 101     if ((inlen & 0x7) || (inlen < 16) || (inlen > CRYPTO128_WRAP_MAX))
 102         return 0;
 103     A = B;
 104     t = 1;
 105     memmove(out + 8, in, inlen);
 106     if (!iv)
 107         iv = default_iv;
 108
 109     memcpy(A, iv, 8);
 110
 111     for (j = 0; j < 6; j++) {
 112         R = out + 8;
 113         for (i = 0; i < inlen; i += 8, t++, R += 8) {
 114             memcpy(B + 8, R, 8);
 115             block(B, B, key);
 116             A[7] ^= (unsigned char)(t & 0xff);
 117             if (t > 0xff) {
 118                 A[6] ^= (unsigned char)((t >> 8) & 0xff);
 119                 A[5] ^= (unsigned char)((t >> 16) & 0xff);
 120                 A[4] ^= (unsigned char)((t >> 24) & 0xff);
 121             }
 122             memcpy(R, B + 8, 8);
 123         }
 124     }
 125     memcpy(out, A, 8);
 126     return inlen + 8;
 127 }
 128
 129 /** Unwrapping according to RFC 3394 section 2.2.2 steps 1-2.
 130  *  IV check (step 3) is responsibility of the caller.
 131  *
 132  *  @param[in]  key    Key value.
 133  *  @param[out] iv     Unchecked IV value. Minimal buffer length = 8 bytes.
 134  *  @param[out] out    Plain text without IV.
 135  *                     Minimal buffer length = (inlen - 8) bytes.
 136  *                     Input and output buffers can overlap if block function
 137  *                     supports that.
 138  *  @param[in]  in     Ciphertext text as n 64-bit blocks
 139  *  @param[in]  inlen  Length of in.
 140  *  @param[in]  block  Block processing function.
 141  *  @return            0 if inlen is out of range [24, CRYPTO128_WRAP_MAX]
 142  *                     or if inlen is not multiply of 8.
 143  *                     Output length otherwise.
 144  */
 145 static size_t crypto_128_unwrap_raw(void *key, unsigned char *iv,
 146                                     unsigned char *out,
 147                                     const unsigned char *in, size_t inlen,
 148                                     block128_f block)
 149 {
 150     unsigned char *A, B[16], *R;
 151     size_t i, j, t;
 152     inlen -= 8;
 153     if ((inlen & 0x7) || (inlen < 16) || (inlen > CRYPTO128_WRAP_MAX))
 154         return 0;
 155     A = B;
 156     t = 6 * (inlen >> 3);
 157     memcpy(A, in, 8);
 158     memmove(out, in + 8, inlen);
 159     for (j = 0; j < 6; j++) {
 160         R = out + inlen - 8;
 161         for (i = 0; i < inlen; i += 8, t--, R -= 8) {
 162             A[7] ^= (unsigned char)(t & 0xff);
 163             if (t > 0xff) {
 164                 A[6] ^= (unsigned char)((t >> 8) & 0xff);
 165                 A[5] ^= (unsigned char)((t >> 16) & 0xff);
 166                 A[4] ^= (unsigned char)((t >> 24) & 0xff);
 167             }
 168             memcpy(B + 8, R, 8);
 169             block(B, B, key);
 170             memcpy(R, B + 8, 8);
 171         }
 172     }
 173     memcpy(iv, A, 8);
 174     return inlen;
 175 }
 176
 177 /** Unwrapping according to RFC 3394 section 2.2.2 including IV check.
 178  *  First block of plain text have to match supplied IV otherwise an error is
 179  *  returned.
 180  *
 181  *  @param[in]  key    Key value.
 182  *  @param[out] iv     Unchecked IV value. Minimal buffer length = 8 bytes.
 183  *  @param[out] out    Plain text without IV.
 184  *                     Minimal buffer length = (inlen - 8) bytes.
 185  *                     Input and output buffers can overlap if block function
 186  *                     supports that.
 187  *  @param[in]  in     Ciphertext text as n 64-bit blocks
 188  *  @param[in]  inlen  Length of in.
 189  *  @param[in]  block  Block processing function.
 190  *  @return            0 if inlen is out of range [24, CRYPTO128_WRAP_MAX]
 191  *                     or if inlen is not multiply of 8
 192  *                     or if IV doesn't match expected value.
 193  *                     Output length otherwise.
 194  */
 195 size_t CRYPTO_128_unwrap(void *key, const unsigned char *iv,
 196                          unsigned char *out, const unsigned char *in,
 197                          size_t inlen, block128_f block)
 198 {
 199     size_t ret;
 200     unsigned char got_iv[8];
 201
 202     ret = crypto_128_unwrap_raw(key, got_iv, out, in, inlen, block);
 203     if (ret != inlen)
 204         return ret;
 205
 206     if (!iv)
 207         iv = default_iv;
 208     if (CRYPTO_memcmp(out, iv, 8)) {
 209         OPENSSL_cleanse(out, inlen);
 210         return 0;
 211     }
 212     return inlen;
 213 }
 214
 215 /** Wrapping according to RFC 5649 section 4.1.
 216  *
 217  *  @param[in]  key    Key value.
 218  *  @param[in]  icv    (Non-standard) IV, 4 bytes. NULL = use default_aiv.
 219  *  @param[out] out    Cipher text. Minimal buffer length = (inlen + 15) bytes.
 220  *                     Input and output buffers can overlap if block function
 221  *                     supports that.
 222  *  @param[in]  in     Plain text as n 64-bit blocks, n >= 2.
 223  *  @param[in]  inlen  Length of in.
 224  *  @param[in]  block  Block processing function.
 225  *  @return            0 if inlen is out of range [1, CRYPTO128_WRAP_MAX].
 226  *                     Output length if wrapping succeeded.
 227  */
 228 size_t CRYPTO_128_wrap_pad(void *key, const unsigned char *icv,
 229                            unsigned char *out,
 230                            const unsigned char *in, size_t inlen,
 231                            block128_f block)
 232 {
 233     /* n: number of 64-bit blocks in the padded key data
 234      *
 235      * If length of plain text is not a multiple of 8, pad the plain text octet
 236      * string on the right with octets of zeros, where final length is the
 237      * smallest multiple of 8 that is greater than length of plain text.
 238      * If length of plain text is a multiple of 8, then there is no padding. */
 239     const size_t blocks_padded = (inlen + 7) / 8; /* CEILING(m/8) */
 240     const size_t padded_len = blocks_padded * 8;
 241     const size_t padding_len = padded_len - inlen;
 242     /* RFC 5649 section 3: Alternative Initial Value */
 243     unsigned char aiv[8];
 244     int ret;
 245
 246     /* Section 1: use 32-bit fixed field for plaintext octet length */
 247     if (inlen == 0 || inlen >= CRYPTO128_WRAP_MAX)
 248         return 0;
 249
 250     /* Section 3: Alternative Initial Value */
 251     if (!icv)
 252         memcpy(aiv, default_aiv, 4);
 253     else
 254         memcpy(aiv, icv, 4);    /* Standard doesn't mention this. */
 255
 256     aiv[4] = (inlen >> 24) & 0xFF;
 257     aiv[5] = (inlen >> 16) & 0xFF;
 258     aiv[6] = (inlen >> 8) & 0xFF;
 259     aiv[7] = inlen & 0xFF;
 260
 261     if (padded_len == 8) {
 262         /*
 263          * Section 4.1 - special case in step 2: If the padded plaintext
 264          * contains exactly eight octets, then prepend the AIV and encrypt
 265          * the resulting 128-bit block using AES in ECB mode.
 266          */
 267         memmove(out + 8, in, inlen);
 268         memcpy(out, aiv, 8);
 269         memset(out + 8 + inlen, 0, padding_len);
 270         block(out, out, key);
 271         ret = 16;               /* AIV + padded input */
 272     } else {
 273         memmove(out, in, inlen);
 274         memset(out + inlen, 0, padding_len); /* Section 4.1 step 1 */
 275         ret = CRYPTO_128_wrap(key, aiv, out, out, padded_len, block);
 276     }
 277
 278     return ret;
 279 }
 280
 281 /** Unwrapping according to RFC 5649 section 4.2.
 282  *
 283  *  @param[in]  key    Key value.
 284  *  @param[in]  icv    (Non-standard) IV, 4 bytes. NULL = use default_aiv.
 285  *  @param[out] out    Plain text. Minimal buffer length = inlen bytes.
 286  *                     Input and output buffers can overlap if block function
 287  *                     supports that.
 288  *  @param[in]  in     Ciphertext text as n 64-bit blocks
 289  *  @param[in]  inlen  Length of in.
 290  *  @param[in]  block  Block processing function.
 291  *  @return            0 if inlen is out of range [16, CRYPTO128_WRAP_MAX],
 292  *                     or if inlen is not multiply of 8
 293  *                     or if IV and message length indicator doesn't match.
 294  *                     Output length if unwrapping succeeded and IV matches.
 295  */
 296 size_t CRYPTO_128_unwrap_pad(void *key, const unsigned char *icv,
 297                              unsigned char *out,
 298                              const unsigned char *in, size_t inlen,
 299                              block128_f block)
 300 {
 301     /* n: number of 64-bit blocks in the padded key data */
 302     size_t n = inlen / 8 - 1;
 303     size_t padded_len;
 304     size_t padding_len;
 305     size_t ptext_len;
 306     /* RFC 5649 section 3: Alternative Initial Value */
 307     unsigned char aiv[8];
 308     static unsigned char zeros[8] = { 0x0 };
 309     size_t ret;
 310
 311     /* Section 4.2: Cipher text length has to be (n+1) 64-bit blocks. */
 312     if ((inlen & 0x7) != 0 || inlen < 16 || inlen >= CRYPTO128_WRAP_MAX)
 313         return 0;
 314
 315     memmove(out, in, inlen);
 316     if (inlen == 16) {
 317         /*
 318          * Section 4.2 - special case in step 1: When n=1, the ciphertext
 319          * contains exactly two 64-bit blocks and they are decrypted as a
 320          * single AES block using AES in ECB mode: AIV | P[1] = DEC(K, C[0] |
 321          * C[1])
 322          */
 323         block(out, out, key);
 324         memcpy(aiv, out, 8);
 325         /* Remove AIV */
 326         memmove(out, out + 8, 8);
 327         padded_len = 8;
 328     } else {
 329         padded_len = inlen - 8;
 330         ret = crypto_128_unwrap_raw(key, aiv, out, out, inlen, block);
 331         if (padded_len != ret) {
 332             OPENSSL_cleanse(out, inlen);
 333             return 0;
 334         }
 335     }
 336
 337     /*
 338      * Section 3: AIV checks: Check that MSB(32,A) = A65959A6. Optionally a
 339      * user-supplied value can be used (even if standard doesn't mention
 340      * this).
 341      */
 342     if ((!icv && CRYPTO_memcmp(aiv, default_aiv, 4))
 343         || (icv && CRYPTO_memcmp(aiv, icv, 4))) {
 344         OPENSSL_cleanse(out, inlen);
 345         return 0;
 346     }
 347
 348     /*
 349      * Check that 8*(n-1) < LSB(32,AIV) <= 8*n. If so, let ptext_len =
 350      * LSB(32,AIV).
 351      */
 352
 353     ptext_len = (aiv[4] << 24) | (aiv[5] << 16) | (aiv[6] << 8) | aiv[7];
 354     if (8 * (n - 1) >= ptext_len || ptext_len > 8 * n) {
 355         OPENSSL_cleanse(out, inlen);
 356         return 0;
 357     }
 358
 359     /*
 360      * Check that the rightmost padding_len octets of the output data are
 361      * zero.
 362      */
 363     padding_len = padded_len - ptext_len;
 364     if (CRYPTO_memcmp(out + ptext_len, zeros, padding_len) != 0) {
 365         OPENSSL_cleanse(out, inlen);
 366         return 0;
 367     }
 368
 369     /* Section 4.2 step 3: Remove padding */
 370     return ptext_len;
 371 }