gmac.h File Reference

GMAC (Galois Message Authentication Code) More...

#include "core/crypto.h"
#include "cipher/cipher_algorithms.h"

Go to the source code of this file.

Data Structures
struct	GmacContext
	GMAC algorithm context. More...

Macros
#define	GMAC_TABLE_W   4
#define	GMAC_TABLE_N   16
#define	GMAC_REVERSE_BITS(n)   reverseInt4(n)
#define	GMAC_PRIVATE_CONTEXT

Functions
error_t	gmacCompute (const CipherAlgo *cipher, const void *key, size_t keyLen, const uint8_t *iv, size_t ivLen, const void *data, size_t dataLen, uint8_t *mac, size_t macLen)
	Compute GMAC using the specified cipher algorithm. More...
error_t	gmacInit (GmacContext *context, const CipherAlgo *cipher, const void *key, size_t keyLen)
	Initialize GMAC calculation. More...
error_t	gmacReset (GmacContext *context, const uint8_t *iv, size_t ivLen)
	Reset GMAC context. More...
void	gmacUpdate (GmacContext *context, const void *data, size_t dataLen)
	Update the GMAC context with a portion of the message being hashed. More...
error_t	gmacFinal (GmacContext *context, uint8_t *mac, size_t macLen)
	Finish the GMAC calculation. More...
void	gmacDeinit (GmacContext *context)
	Release GMAC context. More...
void	gmacMul (GmacContext *context, uint8_t *x)
	Multiplication operation in GF(2^128) More...
void	gmacXorBlock (uint8_t *x, const uint8_t *a, const uint8_t *b, size_t n)
	XOR operation. More...
void	gmacIncCounter (uint8_t *ctr)
	Increment counter block. More...

Detailed Description

GMAC (Galois Message Authentication Code)

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneCRYPTO Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.4

Definition in file gmac.h.

Macro Definition Documentation

GMAC_PRIVATE_CONTEXT

#define GMAC_PRIVATE_CONTEXT

Definition at line 56 of file gmac.h.

GMAC_REVERSE_BITS

#define GMAC_REVERSE_BITS

(

n

)

reverseInt4(n)

Definition at line 48 of file gmac.h.

GMAC_TABLE_N

#define GMAC_TABLE_N   16

Definition at line 47 of file gmac.h.

GMAC_TABLE_W

#define GMAC_TABLE_W   4

Definition at line 40 of file gmac.h.

Function Documentation

gmacCompute()

error_t gmacCompute	(	const CipherAlgo *	cipher,
		const void *	key,
		size_t	keyLen,
		const uint8_t *	iv,
		size_t	ivLen,
		const void *	data,
		size_t	dataLen,
		uint8_t *	mac,
		size_t	macLen
	)

Compute GMAC using the specified cipher algorithm.

Parameters

[in]	cipher	Cipher algorithm used to compute GMAC
[in]	key	Pointer to the secret key
[in]	keyLen	Length of the secret key
[in]	iv	Initialization vector
[in]	ivLen	Length of the initialization vector
[in]	data	Pointer to the input message
[in]	dataLen	Length of the input data
[out]	mac	Calculated MAC value
[in]	macLen	Expected length of the MAC

Returns

Error code

Definition at line 103 of file gmac.c.

gmacDeinit()

void gmacDeinit

(

GmacContext *

context

)

Release GMAC context.

Parameters

[in]

context

Pointer to the GMAC context

Definition at line 451 of file gmac.c.

gmacFinal()

error_t gmacFinal	(	GmacContext *	context,
		uint8_t *	mac,
		size_t	macLen
	)

Finish the GMAC calculation.

Parameters

[in]	context	Pointer to the GMAC context
[out]	mac	Calculated MAC value (optional parameter)
[in]	macLen	Expected length of the MAC

Definition at line 404 of file gmac.c.

gmacIncCounter()

void gmacIncCounter

(

uint8_t *

ctr

)

Increment counter block.

Parameters

[in,out]

ctr

Pointer to the counter block

Definition at line 577 of file gmac.c.

gmacInit()

error_t gmacInit	(	GmacContext *	context,
		const CipherAlgo *	cipher,
		const void *	key,
		size_t	keyLen
	)

Initialize GMAC calculation.

Parameters

[in]	context	Pointer to the GMAC context to initialize
[in]	cipher	Cipher algorithm used to compute GMAC
[in]	key	Pointer to the secret key
[in]	keyLen	Length of the secret key

Returns

Error code

Definition at line 160 of file gmac.c.

gmacMul()

void gmacMul	(	GmacContext *	context,
		uint8_t *	x
	)

Multiplication operation in GF(2^128)

Parameters

[in]	context	Pointer to the GMAC context
[in,out]	x	16-byte block to be multiplied by H

Definition at line 471 of file gmac.c.

gmacReset()

error_t gmacReset	(	GmacContext *	context,
		const uint8_t *	iv,
		size_t	ivLen
	)

Reset GMAC context.

Parameters

[in]	context	Pointer to the GMAC context
[in]	iv	Initialization vector
[in]	ivLen	Length of the initialization vector

Returns

Error code

Definition at line 284 of file gmac.c.

gmacUpdate()

void gmacUpdate	(	GmacContext *	context,
		const void *	data,
		size_t	dataLen
	)

Update the GMAC context with a portion of the message being hashed.

Parameters

[in]	context	Pointer to the GMAC context
[in]	data	Pointer to the input data
[in]	dataLen	Length of the buffer

Definition at line 361 of file gmac.c.

gmacXorBlock()

void gmacXorBlock	(	uint8_t *	x,
		const uint8_t *	a,
		const uint8_t *	b,
		size_t	n
	)

XOR operation.

Parameters

[out]	x	Block resulting from the XOR operation
[in]	a	First block
[in]	b	Second block
[in]	n	Size of the block

Definition at line 560 of file gmac.c.