064b67d073262b526cf3c2f7d3866c2e0164923f
[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 #define OPENSSL_FIPSAPI
55
56 #include <stdio.h>
57 #include <stdlib.h>
58 #include <string.h>
59 #include "cryptlib.h"
60 #include <openssl/cmac.h>
61
62 struct CMAC_CTX_st
63         {
64         /* Cipher context to use */
65         EVP_CIPHER_CTX cctx;
66         /* Keys k1 and k2 */
67         unsigned char k1[EVP_MAX_BLOCK_LENGTH];
68         unsigned char k2[EVP_MAX_BLOCK_LENGTH];
69         /* Temporary block */
70         unsigned char tbl[EVP_MAX_BLOCK_LENGTH];
71         /* Last (possibly partial) block */
72         unsigned char last_block[EVP_MAX_BLOCK_LENGTH];
73         /* Number of bytes in last block: -1 means context not initialised */
74         int nlast_block;
75         };
76
77
78 /* Make temporary keys K1 and K2 */
79
80 static void make_kn(unsigned char *k1, const unsigned char *l, int bl)
81         {
82         int i;
83         unsigned char c = l[0], carry = c>>7, cnext;
84
85         /* Shift block to left, including carry */
86         for (i = 0; i < bl-1; i++, c = cnext)
87                 k1[i] = (c << 1) | ((cnext=l[i+1]) >> 7);
88
89         /* If MSB set fixup with R */
90         k1[i] = (c << 1) ^ ((0-carry)&(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 = M_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         __fips_constseg
145         static const unsigned char zero_iv[EVP_MAX_BLOCK_LENGTH] = {0};
146         /* All zeros means restart */
147         if (!key && !cipher && !impl && keylen == 0)
148                 {
149                 /* Not initialised */
150                 if (ctx->nlast_block == -1)
151                         return 0;
152                 if (!M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, zero_iv))
153                         return 0;
154                 return 1;
155                 }
156         /* Initialiase context */
157         if (cipher && !M_EVP_EncryptInit_ex(&ctx->cctx, cipher, impl, NULL, NULL))
158                 return 0;
159         /* Non-NULL key means initialisation complete */
160         if (key)
161                 {
162                 int bl;
163                 if (!M_EVP_CIPHER_CTX_cipher(&ctx->cctx))
164                         return 0;
165                 if (!EVP_CIPHER_CTX_set_key_length(&ctx->cctx, keylen))
166                         return 0;
167                 if (!M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, key, zero_iv))
168                         return 0;
169                 bl = M_EVP_CIPHER_CTX_block_size(&ctx->cctx);
170                 if (!EVP_Cipher(&ctx->cctx, ctx->tbl, zero_iv, bl))
171                         return 0;
172                 make_kn(ctx->k1, ctx->tbl, bl);
173                 make_kn(ctx->k2, ctx->k1, bl);
174                 OPENSSL_cleanse(ctx->tbl, bl);
175                 /* Reset context again ready for first data block */
176                 if (!M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, zero_iv))
177                         return 0;
178                 /* Zero tbl so resume works */
179                 memset(ctx->tbl, 0, bl);
180                 ctx->nlast_block = 0;
181                 }
182         return 1;
183         }
184
185 int CMAC_Update(CMAC_CTX *ctx, const void *in, size_t dlen)
186         {
187         const unsigned char *data = in;
188         size_t bl;
189         if (ctx->nlast_block == -1)
190                 return 0;
191         if (dlen == 0)
192                 return 1;
193         bl = M_EVP_CIPHER_CTX_block_size(&ctx->cctx);
194         /* Copy into partial block if we need to */
195         if (ctx->nlast_block > 0)
196                 {
197                 size_t nleft;
198                 nleft = bl - ctx->nlast_block;
199                 if (dlen < nleft)
200                         nleft = dlen;
201                 memcpy(ctx->last_block + ctx->nlast_block, data, nleft);
202                 dlen -= nleft;
203                 ctx->nlast_block += nleft;
204                 /* If no more to process return */
205                 if (dlen == 0)
206                         return 1;
207                 data += nleft;
208                 /* Else not final block so encrypt it */
209                 if (!EVP_Cipher(&ctx->cctx, ctx->tbl, ctx->last_block,bl))
210                         return 0;
211                 }
212         /* Encrypt all but one of the complete blocks left */
213         while(dlen > bl)
214                 {
215                 if (!EVP_Cipher(&ctx->cctx, ctx->tbl, data, bl))
216                         return 0;
217                 dlen -= bl;
218                 data += bl;
219                 }
220         /* Copy any data left to last block buffer */
221         memcpy(ctx->last_block, data, dlen);
222         ctx->nlast_block = dlen;
223         return 1;
224
225         }
226
227 int CMAC_Final(CMAC_CTX *ctx, unsigned char *out, size_t *poutlen)
228         {
229         int i, bl, lb;
230         if (ctx->nlast_block == -1)
231                 return 0;
232         bl = M_EVP_CIPHER_CTX_block_size(&ctx->cctx);
233         *poutlen = (size_t)bl;
234         if (!out)
235                 return 1;
236         lb = ctx->nlast_block;
237         /* Is last block complete? */
238         if (lb == bl)
239                 {
240                 for (i = 0; i < bl; i++)
241                         out[i] = ctx->last_block[i] ^ ctx->k1[i];
242                 }
243         else
244                 {
245                 ctx->last_block[lb] = 0x80;
246                 if (bl - lb > 1)
247                         memset(ctx->last_block + lb + 1, 0, bl - lb - 1);
248                 for (i = 0; i < bl; i++)
249                         out[i] = ctx->last_block[i] ^ ctx->k2[i];
250                 }
251         if (!EVP_Cipher(&ctx->cctx, out, out, bl))
252                 {
253                 OPENSSL_cleanse(out, bl);       
254                 return 0;
255                 }
256         return 1;
257         }
258
259 int CMAC_resume(CMAC_CTX *ctx)
260         {
261         if (ctx->nlast_block == -1)
262                 return 0;
263         /* The buffer "tbl" containes the last fully encrypted block
264          * which is the last IV (or all zeroes if no last encrypted block).
265          * The last block has not been modified since CMAC_final().
266          * So reinitliasing using the last decrypted block will allow
267          * CMAC to continue after calling CMAC_Final(). 
268          */
269         return M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, ctx->tbl);
270         }