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 * ====================================================================
58 #include <openssl/cmac.h>
61 #include <openssl/fips.h>
66 /* Cipher context to use */
69 unsigned char k1
[EVP_MAX_BLOCK_LENGTH
];
70 unsigned char k2
[EVP_MAX_BLOCK_LENGTH
];
72 unsigned char tbl
[EVP_MAX_BLOCK_LENGTH
];
73 /* Last (possibly partial) block */
74 unsigned char last_block
[EVP_MAX_BLOCK_LENGTH
];
75 /* Number of bytes in last block: -1 means context not initialised */
80 /* Make temporary keys K1 and K2 */
82 static void make_kn(unsigned char *k1
, unsigned char *l
, int bl
)
85 /* Shift block to left, including carry */
86 for (i
= 0; i
< bl
; i
++)
89 if (i
< bl
- 1 && l
[i
+ 1] & 0x80)
92 /* If MSB set fixup with R */
94 k1
[bl
- 1] ^= bl
== 16 ? 0x87 : 0x1b;
97 CMAC_CTX
*CMAC_CTX_new(void)
100 ctx
= OPENSSL_malloc(sizeof(CMAC_CTX
));
103 EVP_CIPHER_CTX_init(&ctx
->cctx
);
104 ctx
->nlast_block
= -1;
108 void CMAC_CTX_cleanup(CMAC_CTX
*ctx
)
111 if (FIPS_mode() && !ctx
->cctx
.engine
)
113 FIPS_cmac_ctx_cleanup(ctx
);
117 EVP_CIPHER_CTX_cleanup(&ctx
->cctx
);
118 OPENSSL_cleanse(ctx
->tbl
, EVP_MAX_BLOCK_LENGTH
);
119 OPENSSL_cleanse(ctx
->k1
, EVP_MAX_BLOCK_LENGTH
);
120 OPENSSL_cleanse(ctx
->k2
, EVP_MAX_BLOCK_LENGTH
);
121 OPENSSL_cleanse(ctx
->last_block
, EVP_MAX_BLOCK_LENGTH
);
122 ctx
->nlast_block
= -1;
125 EVP_CIPHER_CTX
*CMAC_CTX_get0_cipher_ctx(CMAC_CTX
*ctx
)
130 void CMAC_CTX_free(CMAC_CTX
*ctx
)
132 CMAC_CTX_cleanup(ctx
);
136 int CMAC_CTX_copy(CMAC_CTX
*out
, const CMAC_CTX
*in
)
139 if (in
->nlast_block
== -1)
141 if (!EVP_CIPHER_CTX_copy(&out
->cctx
, &in
->cctx
))
143 bl
= EVP_CIPHER_CTX_block_size(&in
->cctx
);
144 memcpy(out
->k1
, in
->k1
, bl
);
145 memcpy(out
->k2
, in
->k2
, bl
);
146 memcpy(out
->tbl
, in
->tbl
, bl
);
147 memcpy(out
->last_block
, in
->last_block
, bl
);
148 out
->nlast_block
= in
->nlast_block
;
152 int CMAC_Init(CMAC_CTX
*ctx
, const void *key
, size_t keylen
,
153 const EVP_CIPHER
*cipher
, ENGINE
*impl
)
155 static unsigned char zero_iv
[EVP_MAX_BLOCK_LENGTH
];
159 /* If we have an ENGINE need to allow non FIPS */
160 if ((impl
|| ctx
->cctx
.engine
)
161 && !(ctx
->cctx
.flags
& EVP_CIPH_FLAG_NON_FIPS_ALLOW
))
164 EVPerr(EVP_F_CMAC_INIT
, EVP_R_DISABLED_FOR_FIPS
);
167 /* Other algorithm blocking will be done in FIPS_cmac_init,
168 * via FIPS_cipherinit().
170 if (!impl
&& !ctx
->cctx
.engine
)
171 return FIPS_cmac_init(ctx
, key
, keylen
, cipher
, NULL
);
174 /* All zeros means restart */
175 if (!key
&& !cipher
&& !impl
&& keylen
== 0)
177 /* Not initialised */
178 if (ctx
->nlast_block
== -1)
180 if (!EVP_EncryptInit_ex(&ctx
->cctx
, NULL
, NULL
, NULL
, zero_iv
))
182 memset(ctx
->tbl
, 0, EVP_CIPHER_CTX_block_size(&ctx
->cctx
));
183 ctx
->nlast_block
= 0;
186 /* Initialiase context */
187 if (cipher
&& !EVP_EncryptInit_ex(&ctx
->cctx
, cipher
, impl
, NULL
, NULL
))
189 /* Non-NULL key means initialisation complete */
193 if (!EVP_CIPHER_CTX_cipher(&ctx
->cctx
))
195 if (!EVP_CIPHER_CTX_set_key_length(&ctx
->cctx
, keylen
))
197 if (!EVP_EncryptInit_ex(&ctx
->cctx
, NULL
, NULL
, key
, zero_iv
))
199 bl
= EVP_CIPHER_CTX_block_size(&ctx
->cctx
);
200 if (!EVP_Cipher(&ctx
->cctx
, ctx
->tbl
, zero_iv
, bl
))
202 make_kn(ctx
->k1
, ctx
->tbl
, bl
);
203 make_kn(ctx
->k2
, ctx
->k1
, bl
);
204 OPENSSL_cleanse(ctx
->tbl
, bl
);
205 /* Reset context again ready for first data block */
206 if (!EVP_EncryptInit_ex(&ctx
->cctx
, NULL
, NULL
, NULL
, zero_iv
))
208 /* Zero tbl so resume works */
209 memset(ctx
->tbl
, 0, bl
);
210 ctx
->nlast_block
= 0;
215 int CMAC_Update(CMAC_CTX
*ctx
, const void *in
, size_t dlen
)
217 const unsigned char *data
= in
;
220 if (FIPS_mode() && !ctx
->cctx
.engine
)
221 return FIPS_cmac_update(ctx
, in
, dlen
);
223 if (ctx
->nlast_block
== -1)
227 bl
= EVP_CIPHER_CTX_block_size(&ctx
->cctx
);
228 /* Copy into partial block if we need to */
229 if (ctx
->nlast_block
> 0)
232 nleft
= bl
- ctx
->nlast_block
;
235 memcpy(ctx
->last_block
+ ctx
->nlast_block
, data
, nleft
);
237 ctx
->nlast_block
+= nleft
;
238 /* If no more to process return */
242 /* Else not final block so encrypt it */
243 if (!EVP_Cipher(&ctx
->cctx
, ctx
->tbl
, ctx
->last_block
,bl
))
246 /* Encrypt all but one of the complete blocks left */
249 if (!EVP_Cipher(&ctx
->cctx
, ctx
->tbl
, data
, bl
))
254 /* Copy any data left to last block buffer */
255 memcpy(ctx
->last_block
, data
, dlen
);
256 ctx
->nlast_block
= dlen
;
261 int CMAC_Final(CMAC_CTX
*ctx
, unsigned char *out
, size_t *poutlen
)
265 if (FIPS_mode() && !ctx
->cctx
.engine
)
266 return FIPS_cmac_final(ctx
, out
, poutlen
);
268 if (ctx
->nlast_block
== -1)
270 bl
= EVP_CIPHER_CTX_block_size(&ctx
->cctx
);
271 *poutlen
= (size_t)bl
;
274 lb
= ctx
->nlast_block
;
275 /* Is last block complete? */
278 for (i
= 0; i
< bl
; i
++)
279 out
[i
] = ctx
->last_block
[i
] ^ ctx
->k1
[i
];
283 ctx
->last_block
[lb
] = 0x80;
285 memset(ctx
->last_block
+ lb
+ 1, 0, bl
- lb
- 1);
286 for (i
= 0; i
< bl
; i
++)
287 out
[i
] = ctx
->last_block
[i
] ^ ctx
->k2
[i
];
289 if (!EVP_Cipher(&ctx
->cctx
, out
, out
, bl
))
291 OPENSSL_cleanse(out
, bl
);
297 int CMAC_resume(CMAC_CTX
*ctx
)
299 if (ctx
->nlast_block
== -1)
301 /* The buffer "tbl" containes the last fully encrypted block
302 * which is the last IV (or all zeroes if no last encrypted block).
303 * The last block has not been modified since CMAC_final().
304 * So reinitliasing using the last decrypted block will allow
305 * CMAC to continue after calling CMAC_Final().
307 return EVP_EncryptInit_ex(&ctx
->cctx
, NULL
, NULL
, NULL
, ctx
->tbl
);