1 /* crypto/cmac/cmac.c */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2010 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
54 #define OPENSSL_FIPSAPI
60 #include <openssl/cmac.h>
64 /* Cipher context to use */
67 unsigned char k1[EVP_MAX_BLOCK_LENGTH];
68 unsigned char k2[EVP_MAX_BLOCK_LENGTH];
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 */
78 /* Make temporary keys K1 and K2 */
80 static void make_kn(unsigned char *k1, unsigned char *l, int bl)
83 /* Shift block to left, including carry */
84 for (i = 0; i < bl; i++)
87 if (i < bl - 1 && l[i + 1] & 0x80)
90 /* If MSB set fixup with R */
92 k1[bl - 1] ^= bl == 16 ? 0x87 : 0x1b;
95 CMAC_CTX *CMAC_CTX_new(void)
98 ctx = OPENSSL_malloc(sizeof(CMAC_CTX));
101 EVP_CIPHER_CTX_init(&ctx->cctx);
102 ctx->nlast_block = -1;
106 void CMAC_CTX_cleanup(CMAC_CTX *ctx)
108 EVP_CIPHER_CTX_cleanup(&ctx->cctx);
109 OPENSSL_cleanse(ctx->tbl, EVP_MAX_BLOCK_LENGTH);
110 OPENSSL_cleanse(ctx->k1, EVP_MAX_BLOCK_LENGTH);
111 OPENSSL_cleanse(ctx->k2, EVP_MAX_BLOCK_LENGTH);
112 OPENSSL_cleanse(ctx->last_block, EVP_MAX_BLOCK_LENGTH);
113 ctx->nlast_block = -1;
116 EVP_CIPHER_CTX *CMAC_CTX_get0_cipher_ctx(CMAC_CTX *ctx)
121 void CMAC_CTX_free(CMAC_CTX *ctx)
123 CMAC_CTX_cleanup(ctx);
127 int CMAC_CTX_copy(CMAC_CTX *out, const CMAC_CTX *in)
130 if (in->nlast_block == -1)
132 if (!EVP_CIPHER_CTX_copy(&out->cctx, &in->cctx))
134 bl = EVP_CIPHER_CTX_block_size(&in->cctx);
135 memcpy(out->k1, in->k1, bl);
136 memcpy(out->k2, in->k2, bl);
137 memcpy(out->tbl, in->tbl, bl);
138 memcpy(out->last_block, in->last_block, bl);
139 out->nlast_block = in->nlast_block;
143 int CMAC_Init(CMAC_CTX *ctx, const void *key, size_t keylen,
144 const EVP_CIPHER *cipher, ENGINE *impl)
146 static unsigned char zero_iv[EVP_MAX_BLOCK_LENGTH];
147 /* All zeros means restart */
148 if (!key && !cipher && !impl && keylen == 0)
150 /* Not initialised */
151 if (ctx->nlast_block == -1)
153 if (!EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, zero_iv))
157 /* Initialiase context */
158 if (cipher && !EVP_EncryptInit_ex(&ctx->cctx, cipher, impl, NULL, NULL))
160 /* Non-NULL key means initialisation complete */
164 if (!EVP_CIPHER_CTX_cipher(&ctx->cctx))
166 if (!EVP_CIPHER_CTX_set_key_length(&ctx->cctx, keylen))
168 if (!EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, key, zero_iv))
170 bl = EVP_CIPHER_CTX_block_size(&ctx->cctx);
171 if (!EVP_Cipher(&ctx->cctx, ctx->tbl, zero_iv, bl))
173 make_kn(ctx->k1, ctx->tbl, bl);
174 make_kn(ctx->k2, ctx->k1, bl);
175 OPENSSL_cleanse(ctx->tbl, bl);
176 /* Reset context again ready for first data block */
177 if (!EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, zero_iv))
179 /* Zero tbl so resume works */
180 memset(ctx->tbl, 0, bl);
181 ctx->nlast_block = 0;
186 int CMAC_Update(CMAC_CTX *ctx, const void *in, size_t dlen)
188 const unsigned char *data = in;
190 if (ctx->nlast_block == -1)
194 bl = EVP_CIPHER_CTX_block_size(&ctx->cctx);
195 /* Copy into partial block if we need to */
196 if (ctx->nlast_block > 0)
199 nleft = bl - ctx->nlast_block;
202 memcpy(ctx->last_block + ctx->nlast_block, data, nleft);
204 ctx->nlast_block += nleft;
205 /* If no more to process return */
209 /* Else not final block so encrypt it */
210 if (!EVP_Cipher(&ctx->cctx, ctx->tbl, ctx->last_block,bl))
213 /* Encrypt all but one of the complete blocks left */
216 if (!EVP_Cipher(&ctx->cctx, ctx->tbl, data, bl))
221 /* Copy any data left to last block buffer */
222 memcpy(ctx->last_block, data, dlen);
223 ctx->nlast_block = dlen;
228 int CMAC_Final(CMAC_CTX *ctx, unsigned char *out, size_t *poutlen)
231 if (ctx->nlast_block == -1)
233 bl = EVP_CIPHER_CTX_block_size(&ctx->cctx);
234 *poutlen = (size_t)bl;
237 lb = ctx->nlast_block;
238 /* Is last block complete? */
241 for (i = 0; i < bl; i++)
242 out[i] = ctx->last_block[i] ^ ctx->k1[i];
246 ctx->last_block[lb] = 0x80;
248 memset(ctx->last_block + lb + 1, 0, bl - lb - 1);
249 for (i = 0; i < bl; i++)
250 out[i] = ctx->last_block[i] ^ ctx->k2[i];
252 if (!EVP_Cipher(&ctx->cctx, out, out, bl))
254 OPENSSL_cleanse(out, bl);
260 int CMAC_resume(CMAC_CTX *ctx)
262 if (ctx->nlast_block == -1)
264 /* The buffer "tbl" containes the last fully encrypted block
265 * which is the last IV (or all zeroes if no last encrypted block).
266 * The last block has not been modified since CMAC_final().
267 * So reinitliasing using the last decrypted block will allow
268 * CMAC to continue after calling CMAC_Final().
270 return EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, ctx->tbl);