[thirdparty/openssl.git] / crypto / cmac / cmac.c

/* crypto/cmac/cmac.c */
/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
 * project.
 */
/* ====================================================================
 * Copyright (c) 2010 The OpenSSL Project.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
 *
 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    licensing@OpenSSL.org.
 *
 * 5. Products derived from this software may not be called "OpenSSL"
 *    nor may "OpenSSL" appear in their names without prior written
 *    permission of the OpenSSL Project.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
 *
 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 */

#define OPENSSL_FIPSAPI

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cryptlib.h"
#include <openssl/cmac.h>

struct CMAC_CTX_st
	{
	/* Cipher context to use */
	EVP_CIPHER_CTX cctx;
	/* Keys k1 and k2 */
	unsigned char k1[EVP_MAX_BLOCK_LENGTH];
	unsigned char k2[EVP_MAX_BLOCK_LENGTH];
	/* Temporary block */
	unsigned char tbl[EVP_MAX_BLOCK_LENGTH];
	/* Last (possibly partial) block */
	unsigned char last_block[EVP_MAX_BLOCK_LENGTH];
	/* Number of bytes in last block: -1 means context not initialised */
	int nlast_block;
	};


/* Make temporary keys K1 and K2 */

static void make_kn(unsigned char *k1, const unsigned char *l, int bl)
	{
	int i;
	unsigned char c = l[0], carry = c>>7, cnext;

	/* Shift block to left, including carry */
	for (i = 0; i < bl-1; i++, c = cnext)
		k1[i] = (c << 1) | ((cnext=l[i+1]) >> 7);

	/* If MSB set fixup with R */
	k1[i] = (c << 1) ^ ((0-carry)&(bl==16?0x87:0x1b));
	}

CMAC_CTX *CMAC_CTX_new(void)
	{
	CMAC_CTX *ctx;
	ctx = OPENSSL_malloc(sizeof(CMAC_CTX));
	if (!ctx)
		return NULL;
	EVP_CIPHER_CTX_init(&ctx->cctx);
	ctx->nlast_block = -1;
	return ctx;
	}

void CMAC_CTX_cleanup(CMAC_CTX *ctx)
	{
	EVP_CIPHER_CTX_cleanup(&ctx->cctx);
	OPENSSL_cleanse(ctx->tbl, EVP_MAX_BLOCK_LENGTH);
	OPENSSL_cleanse(ctx->k1, EVP_MAX_BLOCK_LENGTH);
	OPENSSL_cleanse(ctx->k2, EVP_MAX_BLOCK_LENGTH);
	OPENSSL_cleanse(ctx->last_block, EVP_MAX_BLOCK_LENGTH);
	ctx->nlast_block = -1;
	}

EVP_CIPHER_CTX *CMAC_CTX_get0_cipher_ctx(CMAC_CTX *ctx)
	{
	return &ctx->cctx;
	}

void CMAC_CTX_free(CMAC_CTX *ctx)
	{
	CMAC_CTX_cleanup(ctx);
	OPENSSL_free(ctx);
	}

int CMAC_CTX_copy(CMAC_CTX *out, const CMAC_CTX *in)
	{
	int bl;
	if (in->nlast_block == -1)
		return 0;
	if (!EVP_CIPHER_CTX_copy(&out->cctx, &in->cctx))
		return 0;
	bl = M_EVP_CIPHER_CTX_block_size(&in->cctx);
	memcpy(out->k1, in->k1, bl);
	memcpy(out->k2, in->k2, bl);
	memcpy(out->tbl, in->tbl, bl);
	memcpy(out->last_block, in->last_block, bl);
	out->nlast_block = in->nlast_block;
	return 1;
	}

int CMAC_Init(CMAC_CTX *ctx, const void *key, size_t keylen, 
			const EVP_CIPHER *cipher, ENGINE *impl)
	{
	__fips_constseg
	static const unsigned char zero_iv[EVP_MAX_BLOCK_LENGTH] = {0};
	/* All zeros means restart */
	if (!key && !cipher && !impl && keylen == 0)
		{
		/* Not initialised */
		if (ctx->nlast_block == -1)
			return 0;
		if (!M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, zero_iv))
			return 0;
		memset(ctx->tbl, 0, M_EVP_CIPHER_CTX_block_size(&ctx->cctx));
		ctx->nlast_block = 0;
		return 1;
		}
	/* Initialiase context */
	if (cipher && !M_EVP_EncryptInit_ex(&ctx->cctx, cipher, impl, NULL, NULL))
		return 0;
	/* Non-NULL key means initialisation complete */
	if (key)
		{
		int bl;
		if (!M_EVP_CIPHER_CTX_cipher(&ctx->cctx))
			return 0;
		if (!EVP_CIPHER_CTX_set_key_length(&ctx->cctx, keylen))
			return 0;
		if (!M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, key, zero_iv))
			return 0;
		bl = M_EVP_CIPHER_CTX_block_size(&ctx->cctx);
		if (!EVP_Cipher(&ctx->cctx, ctx->tbl, zero_iv, bl))
			return 0;
		make_kn(ctx->k1, ctx->tbl, bl);
		make_kn(ctx->k2, ctx->k1, bl);
		OPENSSL_cleanse(ctx->tbl, bl);
		/* Reset context again ready for first data block */
		if (!M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, zero_iv))
			return 0;
		/* Zero tbl so resume works */
		memset(ctx->tbl, 0, bl);
		ctx->nlast_block = 0;
		}
	return 1;
	}

int CMAC_Update(CMAC_CTX *ctx, const void *in, size_t dlen)
	{
	const unsigned char *data = in;
	size_t bl;
	if (ctx->nlast_block == -1)
		return 0;
	if (dlen == 0)
		return 1;
	bl = M_EVP_CIPHER_CTX_block_size(&ctx->cctx);
	/* Copy into partial block if we need to */
	if (ctx->nlast_block > 0)
		{
		size_t nleft;
		nleft = bl - ctx->nlast_block;
		if (dlen < nleft)
			nleft = dlen;
		memcpy(ctx->last_block + ctx->nlast_block, data, nleft);
		dlen -= nleft;
		ctx->nlast_block += nleft;
		/* If no more to process return */
		if (dlen == 0)
			return 1;
		data += nleft;
		/* Else not final block so encrypt it */
		if (!EVP_Cipher(&ctx->cctx, ctx->tbl, ctx->last_block,bl))
			return 0;
		}
	/* Encrypt all but one of the complete blocks left */
	while(dlen > bl)
		{
		if (!EVP_Cipher(&ctx->cctx, ctx->tbl, data, bl))
			return 0;
		dlen -= bl;
		data += bl;
		}
	/* Copy any data left to last block buffer */
	memcpy(ctx->last_block, data, dlen);
	ctx->nlast_block = dlen;
	return 1;

	}

int CMAC_Final(CMAC_CTX *ctx, unsigned char *out, size_t *poutlen)
	{
	int i, bl, lb;
	if (ctx->nlast_block == -1)
		return 0;
	bl = M_EVP_CIPHER_CTX_block_size(&ctx->cctx);
	*poutlen = (size_t)bl;
	if (!out)
		return 1;
	lb = ctx->nlast_block;
	/* Is last block complete? */
	if (lb == bl)
		{
		for (i = 0; i < bl; i++)
			out[i] = ctx->last_block[i] ^ ctx->k1[i];
		}
	else
		{
		ctx->last_block[lb] = 0x80;
		if (bl - lb > 1)
			memset(ctx->last_block + lb + 1, 0, bl - lb - 1);
		for (i = 0; i < bl; i++)
			out[i] = ctx->last_block[i] ^ ctx->k2[i];
		}
	if (!EVP_Cipher(&ctx->cctx, out, out, bl))
		{
		OPENSSL_cleanse(out, bl);	
		return 0;
		}
	return 1;
	}

int CMAC_resume(CMAC_CTX *ctx)
	{
	if (ctx->nlast_block == -1)
		return 0;
	/* The buffer "tbl" containes the last fully encrypted block
	 * which is the last IV (or all zeroes if no last encrypted block).
	 * The last block has not been modified since CMAC_final().
	 * So reinitliasing using the last decrypted block will allow
	 * CMAC to continue after calling CMAC_Final(). 
	 */
	return M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, ctx->tbl);
	}
Commit	Line	Data
8c968e03 DSH	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
399aa6b5 RL	54	#define OPENSSL_FIPSAPI
399aa6b5 RL	55
8c968e03 DSH	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
03cf7e78	80	static void make_kn(unsigned char k1, const unsigned char l, int bl)
8c968e03 DSH	81	{
8c968e03 DSH	82	int i;
03cf7e78 AP	83	unsigned char c = l[0], carry = c>>7, cnext;
03cf7e78 AP	84
8c968e03	85	/* Shift block to left, including carry */
03cf7e78 AP	86	for (i = 0; i < bl-1; i++, c = cnext)
	87	k1[i] = (c << 1) \| ((cnext=l[i+1]) >> 7);
	88
8c968e03	89	/* If MSB set fixup with R */
03cf7e78	90	k1[i] = (c << 1) ^ ((0-carry)&(bl==16?0x87:0x1b));
8c968e03 DSH	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
c8ef656d DSH	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;
399aa6b5	132	bl = M_EVP_CIPHER_CTX_block_size(&in->cctx);
c8ef656d DSH	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
8c968e03 DSH	141	int CMAC_Init(CMAC_CTX ctx, const void key, size_t keylen,
	142	const EVP_CIPHER cipher, ENGINE impl)
	143	{
03cf7e78 AP	144	__fips_constseg
03cf7e78 AP	145	static const unsigned char zero_iv[EVP_MAX_BLOCK_LENGTH] = {0};
8c968e03 DSH	146	/* All zeros means restart */
	147	if (!key && !cipher && !impl && keylen == 0)
	148	{
	149	/* Not initialised */
c8ef656d	150	if (ctx->nlast_block == -1)
8c968e03	151	return 0;
399aa6b5	152	if (!M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, zero_iv))
8c968e03	153	return 0;
80eb4351	154	memset(ctx->tbl, 0, M_EVP_CIPHER_CTX_block_size(&ctx->cctx));
bbe0c8c5	155	ctx->nlast_block = 0;
c8ef656d	156	return 1;
8c968e03 DSH	157	}
8c968e03 DSH	158	/* Initialiase context */
399aa6b5	159	if (cipher && !M_EVP_EncryptInit_ex(&ctx->cctx, cipher, impl, NULL, NULL))
8c968e03 DSH	160	return 0;
	161	/* Non-NULL key means initialisation complete */
	162	if (key)
	163	{
	164	int bl;
399aa6b5	165	if (!M_EVP_CIPHER_CTX_cipher(&ctx->cctx))
8c968e03 DSH	166	return 0;
	167	if (!EVP_CIPHER_CTX_set_key_length(&ctx->cctx, keylen))
	168	return 0;
399aa6b5	169	if (!M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, key, zero_iv))
8c968e03	170	return 0;
399aa6b5	171	bl = M_EVP_CIPHER_CTX_block_size(&ctx->cctx);
8c968e03 DSH	172	if (!EVP_Cipher(&ctx->cctx, ctx->tbl, zero_iv, bl))
	173	return 0;
	174	make_kn(ctx->k1, ctx->tbl, bl);
	175	make_kn(ctx->k2, ctx->k1, bl);
	176	OPENSSL_cleanse(ctx->tbl, bl);
	177	/* Reset context again ready for first data block */
399aa6b5	178	if (!M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, zero_iv))
8c968e03	179	return 0;
c8ef656d DSH	180	/* Zero tbl so resume works */
c8ef656d DSH	181	memset(ctx->tbl, 0, bl);
8c968e03 DSH	182	ctx->nlast_block = 0;
	183	}
	184	return 1;
	185	}
	186
	187	int CMAC_Update(CMAC_CTX ctx, const void in, size_t dlen)
	188	{
	189	const unsigned char *data = in;
	190	size_t bl;
	191	if (ctx->nlast_block == -1)
	192	return 0;
	193	if (dlen == 0)
	194	return 1;
399aa6b5	195	bl = M_EVP_CIPHER_CTX_block_size(&ctx->cctx);
8c968e03 DSH	196	/* Copy into partial block if we need to */
	197	if (ctx->nlast_block > 0)
	198	{
	199	size_t nleft;
	200	nleft = bl - ctx->nlast_block;
	201	if (dlen < nleft)
	202	nleft = dlen;
	203	memcpy(ctx->last_block + ctx->nlast_block, data, nleft);
	204	dlen -= nleft;
	205	ctx->nlast_block += nleft;
	206	/* If no more to process return */
	207	if (dlen == 0)
	208	return 1;
	209	data += nleft;
	210	/* Else not final block so encrypt it */
	211	if (!EVP_Cipher(&ctx->cctx, ctx->tbl, ctx->last_block,bl))
	212	return 0;
	213	}
	214	/* Encrypt all but one of the complete blocks left */
	215	while(dlen > bl)
	216	{
	217	if (!EVP_Cipher(&ctx->cctx, ctx->tbl, data, bl))
	218	return 0;
	219	dlen -= bl;
	220	data += bl;
	221	}
	222	/* Copy any data left to last block buffer */
	223	memcpy(ctx->last_block, data, dlen);
	224	ctx->nlast_block = dlen;
	225	return 1;
	226
	227	}
	228
c8ef656d	229	int CMAC_Final(CMAC_CTX ctx, unsigned char out, size_t *poutlen)
8c968e03 DSH	230	{
	231	int i, bl, lb;
	232	if (ctx->nlast_block == -1)
	233	return 0;
399aa6b5	234	bl = M_EVP_CIPHER_CTX_block_size(&ctx->cctx);
c8ef656d DSH	235	*poutlen = (size_t)bl;
	236	if (!out)
	237	return 1;
8c968e03 DSH	238	lb = ctx->nlast_block;
	239	/* Is last block complete? */
	240	if (lb == bl)
	241	{
	242	for (i = 0; i < bl; i++)
c8ef656d	243	out[i] = ctx->last_block[i] ^ ctx->k1[i];
8c968e03 DSH	244	}
	245	else
	246	{
	247	ctx->last_block[lb] = 0x80;
	248	if (bl - lb > 1)
	249	memset(ctx->last_block + lb + 1, 0, bl - lb - 1);
	250	for (i = 0; i < bl; i++)
c8ef656d	251	out[i] = ctx->last_block[i] ^ ctx->k2[i];
8c968e03	252	}
c8ef656d DSH	253	if (!EVP_Cipher(&ctx->cctx, out, out, bl))
	254	{
	255	OPENSSL_cleanse(out, bl);
	256	return 0;
	257	}
	258	return 1;
	259	}
	260
	261	int CMAC_resume(CMAC_CTX *ctx)
	262	{
	263	if (ctx->nlast_block == -1)
8c968e03	264	return 0;
c8ef656d DSH	265	/* The buffer "tbl" containes the last fully encrypted block
	266	* which is the last IV (or all zeroes if no last encrypted block).
	267	* The last block has not been modified since CMAC_final().
	268	* So reinitliasing using the last decrypted block will allow
	269	* CMAC to continue after calling CMAC_Final().
	270	*/
399aa6b5	271	return M_EVP_EncryptInit_ex(&ctx->cctx, NULL, NULL, NULL, ctx->tbl);
8c968e03	272	}