ike_kdf.h
Go to the documentation of this file.
1 /**
2  * @file ike_kdf.h
3  * @brief IKEv2 key derivation functions
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2026 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.6.6
29  **/
30 
31 #ifndef _IKE_KDF_H
32 #define _IKE_KDF_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "mac/mac_algorithms.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 
44 /**
45  * @brief IKE PRF algorithm context
46  **/
47 
48 typedef struct
49 {
52  size_t outputLen;
54 
55 
56 //IKE KDF related functions
57 error_t ikePrf(MacAlgo macAlgo, const HashAlgo *hashAlgo,
58  const CipherAlgo *cipherAlgo, const uint8_t *key, size_t keyLen,
59  const uint8_t *data, size_t dataLen, uint8_t *output);
60 
61 error_t ikePrfEx(MacAlgo macAlgo, const HashAlgo *hashAlgo,
62  const CipherAlgo *cipherAlgo, const uint8_t *key, size_t keyLen,
63  const DataFrag *dataFrags, uint_t dataNumFrags, uint8_t *output);
64 
65 error_t ikePrfPlus(MacAlgo macAlgo, const HashAlgo *hashAlgo,
66  const CipherAlgo *cipherAlgo, const uint8_t *key, size_t keyLen,
67  const uint8_t *data, size_t dataLen, uint8_t *output,
68  size_t outputLen);
69 
70 error_t ikePrfPlusEx(MacAlgo macAlgo, const HashAlgo *hashAlgo,
71  const CipherAlgo *cipherAlgo, const uint8_t *key, size_t keyLen,
72  const DataFrag *dataFrags, uint_t dataNumFrags, uint8_t *output,
73  size_t outputLen);
74 
75 error_t ikePrfInit(IkePrfContext *context, MacAlgo macAlgo,
76  const HashAlgo *hashAlgo, const CipherAlgo *cipherAlgo, const uint8_t *key,
77  size_t keyLen);
78 
79 void ikePrfUpdate(IkePrfContext *context, const uint8_t *data, size_t dataLen);
80 error_t ikePrfFinal(IkePrfContext *context, uint8_t *output, size_t outputLen);
81 
82 //C++ guard
83 #ifdef __cplusplus
84 }
85 #endif
86 
87 #endif
void ikePrfUpdate(IkePrfContext *context, const uint8_t *data, size_t dataLen)
Update PRF calculation.
Definition: ike_kdf.c:492
size_t outputLen
Definition: ike_kdf.h:52
IKE PRF algorithm context.
Definition: ike_kdf.h:49
MacAlgo macAlgo
Definition: ike_kdf.h:50
uint8_t data[]
Definition: ethernet.h:224
error_t ikePrfInit(IkePrfContext *context, MacAlgo macAlgo, const HashAlgo *hashAlgo, const CipherAlgo *cipherAlgo, const uint8_t *key, size_t keyLen)
Initialize PRF calculation.
Definition: ike_kdf.c:315
MacContext macContext
Definition: ike_kdf.h:51
error_t
Error codes.
Definition: error.h:43
Data fragment descriptor.
Definition: crypto.h:1164
error_t ikePrfPlusEx(MacAlgo macAlgo, const HashAlgo *hashAlgo, const CipherAlgo *cipherAlgo, const uint8_t *key, size_t keyLen, const DataFrag *dataFrags, uint_t dataNumFrags, uint8_t *output, size_t outputLen)
Function that outputs a pseudorandom stream (prf+ function)
Definition: ike_kdf.c:191
error_t ikePrfEx(MacAlgo macAlgo, const HashAlgo *hashAlgo, const CipherAlgo *cipherAlgo, const uint8_t *key, size_t keyLen, const DataFrag *dataFrags, uint_t dataNumFrags, uint8_t *output)
Pseudorandom function (prf function)
Definition: ike_kdf.c:92
General definitions for cryptographic algorithms.
uint32_t dataLen
Definition: sftp_common.h:229
Common interface for encryption algorithms.
Definition: crypto.h:1285
Collection of MAC algorithms.
Common interface for hash algorithms.
Definition: crypto.h:1243
error_t ikePrfFinal(IkePrfContext *context, uint8_t *output, size_t outputLen)
Finalize PRF calculation.
Definition: ike_kdf.c:546
unsigned int uint_t
Definition: compiler_port.h:57
MacAlgo
MAC algorithms.
Generic MAC algorithm context.
error_t ikePrf(MacAlgo macAlgo, const HashAlgo *hashAlgo, const CipherAlgo *cipherAlgo, const uint8_t *key, size_t keyLen, const uint8_t *data, size_t dataLen, uint8_t *output)
Pseudorandom function (prf function)
Definition: ike_kdf.c:55
error_t ikePrfPlus(MacAlgo macAlgo, const HashAlgo *hashAlgo, const CipherAlgo *cipherAlgo, const uint8_t *key, size_t keyLen, const uint8_t *data, size_t dataLen, uint8_t *output, size_t outputLen)
Function that outputs a pseudorandom stream (prf+ function)
Definition: ike_kdf.c:152