hkdf.h
Go to the documentation of this file.
1 /**
2  * @file hkdf.h
3  * @brief HKDF (HMAC-based Key Derivation Function)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.4
29  **/
30 
31 #ifndef _HKDF_H
32 #define _HKDF_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //HKDF related functions
43 error_t hkdf(const HashAlgo *hash, const uint8_t *ikm, size_t ikmLen,
44  const uint8_t *salt, size_t saltLen, const uint8_t *info, size_t infoLen,
45  uint8_t *okm, size_t okmLen);
46 
47 error_t hkdfExtract(const HashAlgo *hash, const uint8_t *ikm, size_t ikmLen,
48  const uint8_t *salt, size_t saltLen, uint8_t *prk);
49 
50 error_t hkdfExpand(const HashAlgo *hash, const uint8_t *prk, size_t prkLen,
51  const uint8_t *info, size_t infoLen, uint8_t *okm, size_t okmLen);
52 
53 //C++ guard
54 #ifdef __cplusplus
55 }
56 #endif
57 
58 #endif
hkdfExpand
error_t hkdfExpand(const HashAlgo *hash, const uint8_t *prk, size_t prkLen, const uint8_t *info, size_t infoLen, uint8_t *okm, size_t okmLen)
HKDF expand step.
Definition: hkdf.c:158
error_t
error_t
Error codes.
Definition: error.h:43
crypto.h
General definitions for cryptographic algorithms.
HashAlgo
Common interface for hash algorithms.
Definition: crypto.h:1046
hkdf
error_t hkdf(const HashAlgo *hash, const uint8_t *ikm, size_t ikmLen, const uint8_t *salt, size_t saltLen, const uint8_t *info, size_t infoLen, uint8_t *okm, size_t okmLen)
HKDF key derivation function.
Definition: hkdf.c:63
hkdfExtract
error_t hkdfExtract(const HashAlgo *hash, const uint8_t *ikm, size_t ikmLen, const uint8_t *salt, size_t saltLen, uint8_t *prk)
HKDF extract step.
Definition: hkdf.c:97