add cvsignore
[openssl.git] / crypto / cmac / cmac.c
1 /* crypto/cmac/cmac.c */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project.
4  */
5 /* ====================================================================
6  * Copyright (c) 2010 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  */
53
54 #include <stdio.h>
55 #include <stdlib.h>
56 #include <string.h>
57 #include "cryptlib.h"
58 #include <openssl/cmac.h>
59
60 struct CMAC_CTX_st
61         {
62         /* Cipher context to use */
63         EVP_CIPHER_CTX cctx;
64         /* Keys k1 and k2 */
65         unsigned char k1[EVP_MAX_BLOCK_LENGTH];
66         unsigned char k2[EVP_MAX_BLOCK_LENGTH];
67         /* Temporary block */
68         unsigned char tbl[EVP_MAX_BLOCK_LENGTH];
69         /* Last (possibly partial) block */
70         unsigned char last_block[EVP_MAX_BLOCK_LENGTH];
71         /* Number of bytes in last block: -1 means context not initialised */
72         int nlast_block;
73         };
74
75
76 /* Make temporary keys K1 and K2 */
77
78 static void make_kn(unsigned char *k1, unsigned char *l, int bl)
79         {
80         int i;
81         /* Shift block to left, including carry */
82         for (i = 0; i < bl; i++)
83                 {
84                 k1[i] = l[i] << 1;
85                 if (i < bl - 1 && l[i + 1] & 0x80)
86                         k1[i] |= 1;
87                 }
88         /* If MSB set fixup with R */
89         if (l[0] & 0x80)
90                 k1[bl - 1] ^= bl == 16 ? 0x87 : 0x1b;
91         }
92
93 CMAC_CTX *CMAC_CTX_new(void)
94         {
95         CMAC_CTX *ctx;
96         ctx = OPENSSL_malloc(sizeof(CMAC_CTX));
97         if (!ctx)
98                 return NULL;
99         EVP_CIPHER_CTX_init(&ctx->cctx);
100         ctx->nlast_block = -1;
101         return ctx;
102         }
103
104 void CMAC_CTX_cleanup(CMAC_CTX *ctx)
105         {
106         EVP_CIPHER_CTX_cleanup(&ctx->cctx);
107         OPENSSL_cleanse(ctx->tbl, EVP_MAX_BLOCK_LENGTH);
108         OPENSSL_cleanse(ctx->k1, EVP_MAX_BLOCK_LENGTH);
109         OPENSSL_cleanse(ctx->k2, EVP_MAX_BLOCK_LENGTH);
110         OPENSSL_cleanse(ctx->last_block, EVP_MAX_BLOCK_LENGTH);
111         ctx->nlast_block = -1;
112         }
113
114 EVP_CIPHER_CTX *CMAC_CTX_get0_cipher_ctx(CMAC_CTX *ctx)
115         {
116         return &ctx->cctx;
117         }
118
119 void CMAC_CTX_free(CMAC_CTX *ctx)
120         {
121         CMAC_CTX_cleanup(ctx);
122         OPENSSL_free(ctx);
123         }
124
125 int CMAC_CTX_copy(CMAC_CTX *out, const CMAC_CTX *in)
126         {
127         int bl;
128         if (in->nlast_block == -1)
129                 return 0;
130         if (!EVP_CIPHER_CTX_copy(&out->cctx, &in->cctx))
131                 return 0;
132         bl = EVP_CIPHER_CTX_block_size(&in->cctx);
133         memcpy(out->k1, in->k1, bl);
134         memcpy(out->k2, in->k2, bl);
135         memcpy(out->tbl, in->tbl, bl);
136         memcpy(out->last_block, in->last_block, bl);
137         out->nlast_block = in->nlast_block;
138         return 1;
139         }
140
141 int CMAC_Init(CMAC_CTX *ctx, const void *key, size_t keylen, 
142                         const EVP_CIPHER *cipher, ENGINE *impl)
143         {
144         static unsigned char zero_iv[EVP_MAX_BLOCK_LENGTH];
145         /* All zeros means restart */
146         if (!key && !cipher && !impl && keylen == 0)
147                 {
148                 /* Not initialised */
149                 if (ctx->nlast_block == -1)
150                         return 0;
151                 if (!EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, zero_iv))
152                         return 0;
153                 return 1;
154                 }
155         /* Initialiase context */
156         if (cipher && !EVP_EncryptInit_ex(&ctx->cctx, cipher, impl, NULL, NULL))
157                 return 0;
158         /* Non-NULL key means initialisation complete */
159         if (key)
160                 {
161                 int bl;
162                 if (!EVP_CIPHER_CTX_cipher(&ctx->cctx))
163                         return 0;
164                 if (!EVP_CIPHER_CTX_set_key_length(&ctx->cctx, keylen))
165                         return 0;
166                 if (!EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, key, zero_iv))
167                         return 0;
168                 bl = EVP_CIPHER_CTX_block_size(&ctx->cctx);
169                 if (!EVP_Cipher(&ctx->cctx, ctx->tbl, zero_iv, bl))
170                         return 0;
171                 make_kn(ctx->k1, ctx->tbl, bl);
172                 make_kn(ctx->k2, ctx->k1, bl);
173                 OPENSSL_cleanse(ctx->tbl, bl);
174                 /* Reset context again ready for first data block */
175                 if (!EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, zero_iv))
176                         return 0;
177                 /* Zero tbl so resume works */
178                 memset(ctx->tbl, 0, bl);
179                 ctx->nlast_block = 0;
180                 }
181         return 1;
182         }
183
184 int CMAC_Update(CMAC_CTX *ctx, const void *in, size_t dlen)
185         {
186         const unsigned char *data = in;
187         size_t bl;
188         if (ctx->nlast_block == -1)
189                 return 0;
190         if (dlen == 0)
191                 return 1;
192         bl = EVP_CIPHER_CTX_block_size(&ctx->cctx);
193         /* Copy into partial block if we need to */
194         if (ctx->nlast_block > 0)
195                 {
196                 size_t nleft;
197                 nleft = bl - ctx->nlast_block;
198                 if (dlen < nleft)
199                         nleft = dlen;
200                 memcpy(ctx->last_block + ctx->nlast_block, data, nleft);
201                 dlen -= nleft;
202                 ctx->nlast_block += nleft;
203                 /* If no more to process return */
204                 if (dlen == 0)
205                         return 1;
206                 data += nleft;
207                 /* Else not final block so encrypt it */
208                 if (!EVP_Cipher(&ctx->cctx, ctx->tbl, ctx->last_block,bl))
209                         return 0;
210                 }
211         /* Encrypt all but one of the complete blocks left */
212         while(dlen > bl)
213                 {
214                 if (!EVP_Cipher(&ctx->cctx, ctx->tbl, data, bl))
215                         return 0;
216                 dlen -= bl;
217                 data += bl;
218                 }
219         /* Copy any data left to last block buffer */
220         memcpy(ctx->last_block, data, dlen);
221         ctx->nlast_block = dlen;
222         return 1;
223
224         }
225
226 int CMAC_Final(CMAC_CTX *ctx, unsigned char *out, size_t *poutlen)
227         {
228         int i, bl, lb;
229         if (ctx->nlast_block == -1)
230                 return 0;
231         bl = EVP_CIPHER_CTX_block_size(&ctx->cctx);
232         *poutlen = (size_t)bl;
233         if (!out)
234                 return 1;
235         lb = ctx->nlast_block;
236         /* Is last block complete? */
237         if (lb == bl)
238                 {
239                 for (i = 0; i < bl; i++)
240                         out[i] = ctx->last_block[i] ^ ctx->k1[i];
241                 }
242         else
243                 {
244                 ctx->last_block[lb] = 0x80;
245                 if (bl - lb > 1)
246                         memset(ctx->last_block + lb + 1, 0, bl - lb - 1);
247                 for (i = 0; i < bl; i++)
248                         out[i] = ctx->last_block[i] ^ ctx->k2[i];
249                 }
250         if (!EVP_Cipher(&ctx->cctx, out, out, bl))
251                 {
252                 OPENSSL_cleanse(out, bl);       
253                 return 0;
254                 }
255         return 1;
256         }
257
258 int CMAC_resume(CMAC_CTX *ctx)
259         {
260         if (ctx->nlast_block == -1)
261                 return 0;
262         /* The buffer "tbl" containes the last fully encrypted block
263          * which is the last IV (or all zeroes if no last encrypted block).
264          * The last block has not been modified since CMAC_final().
265          * So reinitliasing using the last decrypted block will allow
266          * CMAC to continue after calling CMAC_Final(). 
267          */
268         return EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, ctx->tbl);
269         }