key_provider.h File Reference

CycloneBOOT cipher key provider callback. More...

#include "os_port.h"
#include "core/cboot_error.h"
#include "boot_config.h"

Go to the source code of this file.

Macros
#define	KEY_PROVIDER_SUPPORT   DISABLED
#define	KEY_PROVIDER_MAX_KEY_SIZE   32

Typedefs
typedef cboot_error_t(*	KeyProviderCallback) (uint8_t *key, size_t *keyLen)
	Cipher key provider callback function.

Functions
cboot_error_t	keyProviderRegisterCallback (KeyProviderCallback callback)
	Register cipher key provider callback function.
cboot_error_t	keyProviderGetKey (uint8_t *key, size_t *keyLen)
	Retrieve the cipher key from the registered provider.

Variables
KeyProviderCallback	keyProviderCallback

Detailed Description

CycloneBOOT cipher key provider callback.

License

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

Copyright (C) 2021-2026 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneBOOT 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.6.6

Typedef Documentation

KeyProviderCallback

typedef cboot_error_t(* KeyProviderCallback) (uint8_t *key, size_t *keyLen)

Cipher key provider callback function.

The callback fills key with the cipher key and writes its length to keyLen. On entry, *keyLen holds the size of the key buffer (KEY_PROVIDER_MAX_KEY_SIZE); the callback must not write more than that.

Parameters

[out]	key	Buffer that receives the cipher key
[in,out]	keyLen	On entry the buffer size, on exit the key length

Returns

Error code

Function Documentation

keyProviderGetKey()

cboot_error_t keyProviderGetKey	(	uint8_t *	key,
		size_t *	keyLen
	)

Retrieve the cipher key from the registered provider.

Parameters

[out]	key	Buffer (KEY_PROVIDER_MAX_KEY_SIZE bytes) that receives the key
[out]	keyLen	Length of the retrieved key

Returns

Error code

keyProviderRegisterCallback()

cboot_error_t keyProviderRegisterCallback

(

KeyProviderCallback

callback

)

Register cipher key provider callback function.

The callback is invoked by a CycloneBOOT consumer (IAP update library or second-stage bootloader) to obtain the cipher key at run time, instead of having the key statically configured. This lets the key live in a secure element (e.g. STSAFE) and never sit in flash.

Parameters

[in]

callback

Cipher key provider callback function

Returns

Error code