128-bit block cipher modes consolidation. As consolidated functions
[openssl.git] / crypto / modes / ctr128.c
1 /* ====================================================================
2  * Copyright (c) 2008 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer. 
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    openssl-core@openssl.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  */
50
51 #include <stddef.h>
52 #include <string.h>
53
54 #ifndef MODES_DEBUG
55 # ifndef NDEBUG
56 #  define NDEBUG
57 # endif
58 #endif
59 #include <assert.h>
60
61 #include "modes.h"
62
63 typedef unsigned int u32;
64 typedef unsigned char u8;
65
66 # define GETU32(pt) (((u32)(pt)[0] << 24) ^ ((u32)(pt)[1] << 16) ^ ((u32)(pt)[2] <<  8) ^ ((u32)(pt)[3]))
67 # define PUTU32(ct, st) { (ct)[0] = (u8)((st) >> 24); (ct)[1] = (u8)((st) >> 16); (ct)[2] = (u8)((st) >>  8); (ct)[3] = (u8)(st); }
68
69 #define STRICT_ALIGNMENT
70 #if defined(__i386) || defined(__i386__) || \
71     defined(__x86_64) || defined(__x86_64__) || \
72     defined(_M_IX86) || defined(_M_AMD64) || defined(_M_X64) || \
73     defined(__s390__) || defined(__s390x__)
74 #  undef STRICT_ALIGNMENT
75 #endif
76
77 /* NOTE: the IV/counter CTR mode is big-endian.  The code itself
78  * is endian-neutral. */
79
80 /* increment counter (128-bit int) by 1 */
81 static void ctr128_inc(unsigned char *counter) {
82         u32 c,n=16;
83
84         do {
85                 n -= 4;
86                 c = GETU32(counter+n);
87                 ++c;    c &= 0xFFFFFFFF;
88                 PUTU32(counter + n, c);
89                 if (c) return;
90         } while (n);
91 }
92
93 #if !defined(OPENSSL_SMALL_FOORPRINT)
94 static void ctr128_inc_aligned(unsigned char *counter) {
95         size_t *data,c,n;
96         const union { long one; char little; } is_endian = {1};
97
98         if (is_endian.little) {
99                 ctr128_inc(counter);
100                 return;
101         }
102
103         data = (size_t *)counter;
104         n = 16/sizeof(size_t);
105         do {
106                 --n;
107                 c = data[n];
108                 ++c;
109                 data[n] = c;
110                 if (c) return;
111         } while (n);
112 }
113 #endif
114
115 /* The input encrypted as though 128bit counter mode is being
116  * used.  The extra state information to record how much of the
117  * 128bit block we have used is contained in *num, and the
118  * encrypted counter is kept in ecount_buf.  Both *num and
119  * ecount_buf must be initialised with zeros before the first
120  * call to CRYPTO_ctr128_encrypt().
121  *
122  * This algorithm assumes that the counter is in the x lower bits
123  * of the IV (ivec), and that the application has full control over
124  * overflow and the rest of the IV.  This implementation takes NO
125  * responsability for checking that the counter doesn't overflow
126  * into the rest of the IV when incremented.
127  */
128 void CRYPTO_ctr128_encrypt(const unsigned char *in, unsigned char *out,
129                         size_t len, const void *key,
130                         unsigned char ivec[16], unsigned char ecount_buf[16],
131                         unsigned int *num, block_f block)
132 {
133         unsigned int n;
134         size_t l=0;
135
136         assert(in && out && key && ecount_buf && num);
137         assert(*num < 16);
138
139         n = *num;
140
141 #if !defined(OPENSSL_SMALL_FOOTPRINT)
142         if (16%sizeof(size_t) == 0) do { /* always true actually */
143                 while (n && len) {
144                         *(out++) = *(in++) ^ ecount_buf[n];
145                         --len;
146                         n = (n+1) % 16;
147                 }
148
149 #if defined(STRICT_ALIGNMENT)
150                 if (((size_t)in|(size_t)out|(size_t)ivec)%sizeof(size_t) != 0)
151                         break;
152 #endif
153                 while (len>=16) {
154                         (*block)(ivec, ecount_buf, key);
155                         ctr128_inc_aligned(ivec);
156                         for (n=0; n<16; n+=sizeof(size_t))
157                                 *(size_t *)(out+n) =
158                                 *(size_t *)(in+n) ^ *(size_t *)(ecount_buf+n);
159                         len -= 16;
160                         out += 16;
161                         in  += 16;
162                 }
163                 n = 0;
164                 if (len) {
165                         (*block)(ivec, ecount_buf, key);
166                         ctr128_inc_aligned(ivec);
167                         while (len--) {
168                                 out[n] = in[n] ^ ecount_buf[n];
169                                 ++n;
170                         }
171                 }
172                 *num = n;
173                 return;
174         } while(0);
175         /* the rest would be commonly eliminated by x86* compiler */
176 #endif
177         while (l<len) {
178                 if (n==0) {
179                         (*block)(ivec, ecount_buf, key);
180                         ctr128_inc(ivec);
181                 }
182                 out[l] = in[l] ^ ecount_buf[n];
183                 ++l;
184                 n = (n+1) % 16;
185         }
186
187         *num=n;
188 }