verify_runtime.h File Reference

CycloneBOOT runtime (verify-before-boot) image verification. More...

#include "modules/image/image.h"
#include "modules/memory/memory.h"
#include "core/verify.h"
#include "pkc/rsa.h"
#include "pkix/pem_key_import.h"
#include "ecc/ec.h"
#include "ecc/ecdsa.h"

Go to the source code of this file.

Macros
#define	VERIFY_RUNTIME_RSA_SUPPORT   DISABLED
#define	VERIFY_RUNTIME_ECDSA_SUPPORT   DISABLED

Functions
cboot_error_t	verifyRuntimeImageSignature (const Slot *slot, uint32_t entryOffset, const char_t *signKey, size_t signKeyLen, const HashAlgo *hashAlgo, VerifySignAlgo signAlgo)
	Verify the runtime signature of an image.
cboot_error_t	verifyRuntimeImageIntegrity (const Slot *slot, uint32_t entryOffset, const HashAlgo *hashAlgo)
	Verify the runtime integrity digest embedded in an image.

Detailed Description

CycloneBOOT runtime (verify-before-boot) image verification.

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

Function Documentation

verifyRuntimeImageIntegrity()

cboot_error_t verifyRuntimeImageIntegrity	(	const Slot *	slot,
		uint32_t	entryOffset,
		const HashAlgo *	hashAlgo
	)

Verify the runtime integrity digest embedded in an image.

Parameters

[in]	slot	Slot holding the image
[in]	entryOffset	Offset from the slot start where execution begins
[in]	hashAlgo	Hash algorithm of the embedded digest

Returns

Error code (CBOOT_NO_ERROR on a matching digest)

verifyRuntimeImageSignature()

cboot_error_t verifyRuntimeImageSignature	(	const Slot *	slot,
		uint32_t	entryOffset,
		const char_t *	signKey,
		size_t	signKeyLen,
		const HashAlgo *	hashAlgo,
		VerifySignAlgo	signAlgo
	)

Verify the runtime signature of an image.

Parameters

[in]	slot	Slot containing the resident image to authenticate.
[in]	entryOffset	Offset from the slot start where execution begins.
[in]	signKey	PEM-encoded public key used to verify the signature.
[in]	signKeyLen	Length of the PEM public key.
[in]	hashAlgo	Hash algorithm used over the firmware body.
[in]	signAlgo	Signature algorithm (VERIFY_SIGN_RSA or VERIFY_SIGN_ECDSA); must match the algorithm selected at build time via BOOT_RUNTIME_SIGNATURE_RSA / BOOT_RUNTIME_SIGNATURE_ECDSA, else CBOOT_ERROR_UNSUPPORTED_SIGNATURE_ALGO.

Returns

Error code (CBOOT_NO_ERROR on a valid signature).

Parameters

[in]	slot	Slot containing the resident image to authenticate
[in]	entryOffset	Offset from the slot start where execution begins
[in]	signKey	PEM-encoded public key used to verify the signature
[in]	signKeyLen	Length of the PEM public key
[in]	hashAlgo	Hash algorithm used over the firmware body
[in]	signAlgo	Signature algorithm (VERIFY_SIGN_RSA or VERIFY_SIGN_ECDSA)

Returns

Error code (CBOOT_NO_ERROR on a valid signature)