dh.h File Reference

Diffie-Hellman key exchange. More...

#include "core/crypto.h"
#include "mpi/mpi.h"

Go to the source code of this file.

Data Structures
struct	DhParameters
	Diffie-Hellman parameters. More...
struct	DhContext
	Diffie-Hellman context. More...

Functions
void	dhInit (DhContext *context)
	Initialize Diffie-Hellman context. More...
void	dhFree (DhContext *context)
	Release Diffie-Hellman context. More...
void	dhInitParameters (DhParameters *params)
	Initialize Diffie-Hellman parameters. More...
void	dhFreeParameters (DhParameters *params)
	Release Diffie-Hellman parameters. More...
error_t	dhGenerateKeyPair (DhContext *context, const PrngAlgo *prngAlgo, void *prngContext)
	Diffie-Hellman key pair generation. More...
error_t	dhExportPublicKey (DhContext *context, uint8_t *output, size_t *written, MpiFormat format)
	Export our own public key. More...
error_t	dhImportPeerPublicKey (DhContext *context, const uint8_t *input, size_t length, MpiFormat format)
	Import peer's public key. More...
error_t	dhCheckPublicKey (DhContext *context, const Mpi *publicKey)
	Check Diffie-Hellman public value. More...
error_t	dhComputeSharedSecret (DhContext *context, uint8_t *output, size_t outputSize, size_t *outputLen)
	Compute Diffie-Hellman shared secret. More...

Detailed Description

Diffie-Hellman key exchange.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2025 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.5.4

Definition in file dh.h.

Function Documentation

dhCheckPublicKey()

error_t dhCheckPublicKey	(	DhContext *	context,
		const Mpi *	publicKey
	)

Check Diffie-Hellman public value.

Parameters

[in]	context	Pointer to the Diffie-Hellman context
[in]	publicKey	Public value to be checked

Returns

Error code

Definition at line 245 of file dh.c.

dhComputeSharedSecret()

error_t dhComputeSharedSecret	(	DhContext *	context,
		uint8_t *	output,
		size_t	outputSize,
		size_t *	outputLen
	)

Compute Diffie-Hellman shared secret.

Parameters

[in]	context	Pointer to the Diffie-Hellman context
[out]	output	Buffer where to store the shared secret
[in]	outputSize	Size of the buffer in bytes
[out]	outputLen	Length of the resulting shared secret

Returns

Error code

Definition at line 289 of file dh.c.

dhExportPublicKey()

error_t dhExportPublicKey	(	DhContext *	context,
		uint8_t *	output,
		size_t *	written,
		MpiFormat	format
	)

Export our own public key.

Parameters

[in]	context	Pointer to the Diffie-Hellman context
[out]	output	Pointer to the octet string
[out]	written	Length of the octet string, in bytes
[in]	format	Output format

Returns

Error code

Definition at line 185 of file dh.c.

dhFree()

void dhFree

(

DhContext *

context

)

Release Diffie-Hellman context.

Parameters

[in]

context

Pointer to the Diffie-Hellman context

Definition at line 71 of file dh.c.

dhFreeParameters()

void dhFreeParameters

(

DhParameters *

params

)

Release Diffie-Hellman parameters.

Parameters

[in]

params

Pointer to the Diffie-Hellman parameters

Definition at line 102 of file dh.c.

dhGenerateKeyPair()

error_t dhGenerateKeyPair	(	DhContext *	context,
		const PrngAlgo *	prngAlgo,
		void *	prngContext
	)

Diffie-Hellman key pair generation.

Parameters

[in]	context	Pointer to the Diffie-Hellman context
[in]	prngAlgo	PRNG algorithm
[in]	prngContext	Pointer to the PRNG context

Returns

Error code

Definition at line 119 of file dh.c.

dhImportPeerPublicKey()

error_t dhImportPeerPublicKey	(	DhContext *	context,
		const uint8_t *	input,
		size_t	length,
		MpiFormat	format
	)

Import peer's public key.

Parameters

[in]	context	Pointer to the Diffie-Hellman context
[in]	input	Pointer to the octet string
[in]	length	Length of the octet string, in bytes
[in]	format	Input format

Returns

Error code

Definition at line 218 of file dh.c.

dhInit()

void dhInit

(

DhContext *

context

)

Initialize Diffie-Hellman context.

Parameters

[in]

context

Pointer to the Diffie-Hellman context

Definition at line 54 of file dh.c.

dhInitParameters()

void dhInitParameters

(

DhParameters *

params

)

Initialize Diffie-Hellman parameters.

Parameters

[in]

params

Pointer to the Diffie-Hellman parameters

Definition at line 88 of file dh.c.