tls_key_material.h
Go to the documentation of this file.
1 /**
2  * @file tls_key_material.h
3  * @brief Key material generation
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 CycloneSSL 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.0
29  **/
30 
31 #ifndef _TLS_KEY_MATERIAL_H
32 #define _TLS_KEY_MATERIAL_H
33 
34 //Dependencies
35 #include "tls.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //TLS related functions
47 error_t tlsGenerateKeyBlock(TlsContext *context, size_t keyBlockLen);
48 
49 error_t tlsExportKeyingMaterial(TlsContext *context, const char_t *label,
50  bool_t useContextValue, const uint8_t *contextValue,
51  size_t contextValueLen, uint8_t *output, size_t outputLen);
52 
53 error_t tlsPrf(const uint8_t *secret, size_t secretLen, const char_t *label,
54  const uint8_t *seed, size_t seedLen, uint8_t *output, size_t outputLen);
55 
56 error_t tls12Prf(const HashAlgo *hash, const uint8_t *secret, size_t secretLen,
57  const char_t *label, const uint8_t *seed, size_t seedLen, uint8_t *output,
58  size_t outputLen);
59 
60 void tlsDumpSecret(TlsContext *context, const char_t *label,
61  const uint8_t *secret, size_t secretLen);
62 
63 //C++ guard
64 #ifdef __cplusplus
65 }
66 #endif
67 
68 #endif
char char_t
Definition: compiler_port.h:48
int bool_t
Definition: compiler_port.h:53
error_t
Error codes.
Definition: error.h:43
Common interface for hash algorithms.
Definition: crypto.h:1014
TLS (Transport Layer Security)
uint8_t secret[TLS_MASTER_SECRET_SIZE]
Master secret.
Definition: tls.h:1867
#define TlsContext
Definition: tls.h:36
error_t tlsGenerateExtendedMasterSecret(TlsContext *context)
Extended master secret computation.
error_t tlsGenerateMasterSecret(TlsContext *context)
Master secret computation.
error_t tls12Prf(const HashAlgo *hash, const uint8_t *secret, size_t secretLen, const char_t *label, const uint8_t *seed, size_t seedLen, uint8_t *output, size_t outputLen)
Pseudorandom function (TLS 1.2)
void tlsDumpSecret(TlsContext *context, const char_t *label, const uint8_t *secret, size_t secretLen)
Dump secret key (for debugging purpose only)
error_t tlsGenerateSessionKeys(TlsContext *context)
Generate session keys.
error_t tlsGenerateKeyBlock(TlsContext *context, size_t keyBlockLen)
Key expansion function.
error_t tlsPrf(const uint8_t *secret, size_t secretLen, const char_t *label, const uint8_t *seed, size_t seedLen, uint8_t *output, size_t outputLen)
Pseudorandom function (TLS 1.0 and 1.1)
error_t tlsGeneratePskPremasterSecret(TlsContext *context)
Premaster secret generation (for PSK cipher suites)
error_t tlsExportKeyingMaterial(TlsContext *context, const char_t *label, bool_t useContextValue, const uint8_t *contextValue, size_t contextValueLen, uint8_t *output, size_t outputLen)
Export keying material per RFC 5705 standard.