gmac.h File Reference

GMAC (Galois Message Authentication Code) More...

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.0

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]cipherCipher algorithm used to compute GMAC
[in]keyPointer to the secret key
[in]keyLenLength of the secret key
[in]ivInitialization vector
[in]ivLenLength of the initialization vector
[in]dataPointer to the input message
[in]dataLenLength of the input data
[out]macCalculated MAC value
[in]macLenExpected 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]contextPointer 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]contextPointer to the GMAC context
[out]macCalculated MAC value (optional parameter)
[in]macLenExpected length of the MAC

Definition at line 404 of file gmac.c.

◆ gmacIncCounter()

void gmacIncCounter ( uint8_t *  ctr)

Increment counter block.

Parameters
[in,out]ctrPointer 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]contextPointer to the GMAC context to initialize
[in]cipherCipher algorithm used to compute GMAC
[in]keyPointer to the secret key
[in]keyLenLength 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]contextPointer to the GMAC context
[in,out]x16-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]contextPointer to the GMAC context
[in]ivInitialization vector
[in]ivLenLength 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]contextPointer to the GMAC context
[in]dataPointer to the input data
[in]dataLenLength 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]xBlock resulting from the XOR operation
[in]aFirst block
[in]bSecond block
[in]nSize of the block

Definition at line 560 of file gmac.c.