hmac.h File Reference

HMAC (Keyed-Hashing for Message Authentication) More...

#include "core/crypto.h"
#include "hash/hash_algorithms.h"

Go to the source code of this file.

Data Structures

struct  HmacContext
 HMAC algorithm context. More...
 

Macros

#define HMAC_PRIVATE_CONTEXT
 
#define HMAC_IPAD   0x36
 
#define HMAC_OPAD   0x5C
 

Functions

error_t hmacCompute (const HashAlgo *hash, const void *key, size_t keyLen, const void *data, size_t dataLen, uint8_t *digest)
 Compute HMAC using the specified hash function. More...
 
error_t hmacInit (HmacContext *context, const HashAlgo *hash, const void *key, size_t keyLen)
 Initialize HMAC calculation. More...
 
void hmacUpdate (HmacContext *context, const void *data, size_t length)
 Update the HMAC context with a portion of the message being hashed. More...
 
void hmacFinal (HmacContext *context, uint8_t *digest)
 Finish the HMAC calculation. More...
 
void hmacFinalRaw (HmacContext *context, uint8_t *digest)
 Finish the HMAC calculation (no padding added) More...
 
void hmacDeinit (HmacContext *context)
 Release HMAC context. More...
 

Variables

const uint8_t HMAC_WITH_MD5_OID [8]
 
const uint8_t HMAC_WITH_TIGER_OID [8]
 
const uint8_t HMAC_WITH_RIPEMD160_OID [8]
 
const uint8_t HMAC_WITH_SHA1_OID [8]
 
const uint8_t HMAC_WITH_SHA224_OID [8]
 
const uint8_t HMAC_WITH_SHA256_OID [8]
 
const uint8_t HMAC_WITH_SHA384_OID [8]
 
const uint8_t HMAC_WITH_SHA512_OID [8]
 
const uint8_t HMAC_WITH_SHA512_224_OID [8]
 
const uint8_t HMAC_WITH_SHA512_256_OID [8]
 
const uint8_t HMAC_WITH_SHA3_224_OID [9]
 
const uint8_t HMAC_WITH_SHA3_256_OID [9]
 
const uint8_t HMAC_WITH_SHA3_384_OID [9]
 
const uint8_t HMAC_WITH_SHA3_512_OID [9]
 
const uint8_t HMAC_WITH_SM3_OID [10]
 

Detailed Description

HMAC (Keyed-Hashing for Message Authentication)

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 hmac.h.

Macro Definition Documentation

◆ HMAC_IPAD

#define HMAC_IPAD   0x36

Definition at line 44 of file hmac.h.

◆ HMAC_OPAD

#define HMAC_OPAD   0x5C

Definition at line 46 of file hmac.h.

◆ HMAC_PRIVATE_CONTEXT

#define HMAC_PRIVATE_CONTEXT

Definition at line 40 of file hmac.h.

Function Documentation

◆ hmacCompute()

error_t hmacCompute ( const HashAlgo hash,
const void *  key,
size_t  keyLen,
const void *  data,
size_t  dataLen,
uint8_t *  digest 
)

Compute HMAC using the specified hash function.

Parameters
[in]hashHash algorithm used to compute HMAC
[in]keyKey to use in the hash algorithm
[in]keyLenLength of the key
[in]dataThe input data for which to compute the hash code
[in]dataLenLength of the input data
[out]digestThe computed HMAC value
Returns
Error code

Definition at line 91 of file hmac.c.

◆ hmacDeinit()

void hmacDeinit ( HmacContext context)

Release HMAC context.

Parameters
[in]contextPointer to the HMAC context

Definition at line 256 of file hmac.c.

◆ hmacFinal()

void hmacFinal ( HmacContext context,
uint8_t *  digest 
)

Finish the HMAC calculation.

Parameters
[in]contextPointer to the HMAC context
[out]digestCalculated HMAC value (optional parameter)

Definition at line 218 of file hmac.c.

◆ hmacFinalRaw()

void hmacFinalRaw ( HmacContext context,
uint8_t *  digest 
)

Finish the HMAC calculation (no padding added)

Parameters
[in]contextPointer to the HMAC context
[out]digestCalculated HMAC value (optional parameter)

Definition at line 273 of file hmac.c.

◆ hmacInit()

error_t hmacInit ( HmacContext context,
const HashAlgo hash,
const void *  key,
size_t  keyLen 
)

Initialize HMAC calculation.

Parameters
[in]contextPointer to the HMAC context to initialize
[in]hashHash algorithm used to compute HMAC
[in]keyKey to use in the hash algorithm
[in]keyLenLength of the key
Returns
Error code

Definition at line 140 of file hmac.c.

◆ hmacUpdate()

void hmacUpdate ( HmacContext context,
const void *  data,
size_t  length 
)

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

Parameters
[in]contextPointer to the HMAC context
[in]dataPointer to the buffer being hashed
[in]lengthLength of the buffer

Definition at line 201 of file hmac.c.

Variable Documentation

◆ HMAC_WITH_MD5_OID

const uint8_t HMAC_WITH_MD5_OID[8]
extern

Definition at line 49 of file hmac.c.

◆ HMAC_WITH_RIPEMD160_OID

const uint8_t HMAC_WITH_RIPEMD160_OID[8]
extern

Definition at line 53 of file hmac.c.

◆ HMAC_WITH_SHA1_OID

const uint8_t HMAC_WITH_SHA1_OID[8]
extern

Definition at line 55 of file hmac.c.

◆ HMAC_WITH_SHA224_OID

const uint8_t HMAC_WITH_SHA224_OID[8]
extern

Definition at line 57 of file hmac.c.

◆ HMAC_WITH_SHA256_OID

const uint8_t HMAC_WITH_SHA256_OID[8]
extern

Definition at line 59 of file hmac.c.

◆ HMAC_WITH_SHA384_OID

const uint8_t HMAC_WITH_SHA384_OID[8]
extern

Definition at line 61 of file hmac.c.

◆ HMAC_WITH_SHA3_224_OID

const uint8_t HMAC_WITH_SHA3_224_OID[9]
extern

Definition at line 69 of file hmac.c.

◆ HMAC_WITH_SHA3_256_OID

const uint8_t HMAC_WITH_SHA3_256_OID[9]
extern

Definition at line 71 of file hmac.c.

◆ HMAC_WITH_SHA3_384_OID

const uint8_t HMAC_WITH_SHA3_384_OID[9]
extern

Definition at line 73 of file hmac.c.

◆ HMAC_WITH_SHA3_512_OID

const uint8_t HMAC_WITH_SHA3_512_OID[9]
extern

Definition at line 75 of file hmac.c.

◆ HMAC_WITH_SHA512_224_OID

const uint8_t HMAC_WITH_SHA512_224_OID[8]
extern

Definition at line 65 of file hmac.c.

◆ HMAC_WITH_SHA512_256_OID

const uint8_t HMAC_WITH_SHA512_256_OID[8]
extern

Definition at line 67 of file hmac.c.

◆ HMAC_WITH_SHA512_OID

const uint8_t HMAC_WITH_SHA512_OID[8]
extern

Definition at line 63 of file hmac.c.

◆ HMAC_WITH_SM3_OID

const uint8_t HMAC_WITH_SM3_OID[10]
extern

Definition at line 77 of file hmac.c.

◆ HMAC_WITH_TIGER_OID

const uint8_t HMAC_WITH_TIGER_OID[8]
extern

Definition at line 51 of file hmac.c.