version.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024 Fox Crypto B.V.
 * SPDX-License-Identifier: MIT
 *
 * SPDX-FileContributor: Frans van Dorsselaer
 */
 
#pragma once
 
#ifndef XMSS_VERSION_H_INCLUDED
#define XMSS_VERSION_H_INCLUDED
 
#include "xmss_config.h"
 
#include <stdint.h>
 
#include "compat.h"
 
XMSS_STATIC_ASSERT(XMSS_LIBRARY_VERSION_MAJOR >= 1 && XMSS_LIBRARY_VERSION_MAJOR <= 255,
    "XMSS_LIBRARY_VERSION inconsistent");
XMSS_STATIC_ASSERT(XMSS_LIBRARY_VERSION_MINOR >= 0 && XMSS_LIBRARY_VERSION_MINOR <= 255,
    "XMSS_LIBRARY_VERSION inconsistent");
XMSS_STATIC_ASSERT(XMSS_LIBRARY_VERSION_PATCH >= 0 && XMSS_LIBRARY_VERSION_PATCH <= 255,
    "XMSS_LIBRARY_VERSION inconsistent");
 
#define XMSS_LIBRARY_VERSION_CONSTRUCT(major, minor, patch) \
    ((((uint32_t)(uint8_t)(major)) << 16) \
    | (((uint32_t)(uint8_t)(minor)) << 8) \
    | ((uint32_t)(uint8_t)(patch)))
 
#define XMSS_LIBRARY_VERSION (XMSS_LIBRARY_VERSION_CONSTRUCT(XMSS_LIBRARY_VERSION_MAJOR, XMSS_LIBRARY_VERSION_MINOR, \
    XMSS_LIBRARY_VERSION_PATCH))
 
#define XMSS_LIBRARY_GET_VERSION_MAJOR(version) ((uint8_t)((((uint32_t)(version)) >> 16) & UINT8_MAX))
 
#define XMSS_LIBRARY_GET_VERSION_MINOR(version) ((uint8_t)((((uint32_t)(version)) >> 8) & UINT8_MAX))
 
#define XMSS_LIBRARY_GET_VERSION_PATCH(version) ((uint8_t)(((uint32_t)(version)) & UINT8_MAX))
 
XMSS_STATIC_ASSERT(XMSS_LIBRARY_GET_VERSION_MAJOR(XMSS_LIBRARY_VERSION) == XMSS_LIBRARY_VERSION_MAJOR,
    "XMSS_LIBRARY_VERSION inconsistent");
XMSS_STATIC_ASSERT(XMSS_LIBRARY_GET_VERSION_MINOR(XMSS_LIBRARY_VERSION) == XMSS_LIBRARY_VERSION_MINOR,
    "XMSS_LIBRARY_VERSION inconsistent");
XMSS_STATIC_ASSERT(XMSS_LIBRARY_GET_VERSION_PATCH(XMSS_LIBRARY_VERSION) == XMSS_LIBRARY_VERSION_PATCH,
    "XMSS_LIBRARY_VERSION inconsistent");
 
uint32_t xmss_library_get_version(void);
 
#endif /* !XMSS_VERSION_H_INCLUDED */