types.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2022 Fox Crypto B.V.
 * SPDX-License-Identifier: MIT
 *
 * SPDX-FileContributor: Thomas Schaap
 */
 
#pragma once
 
#ifndef XMSS_TYPES_H_INCLUDED
#define XMSS_TYPES_H_INCLUDED
 
#include <stddef.h>
#include <stdint.h>
 
#include "compat.h"
 
enum XmssDistantValues
{
    XMSS_DISTANT_VALUE_0 = 0x00,
 
    XMSS_DISTANT_VALUE_1 = 0xD2,
 
    XMSS_DISTANT_VALUE_2 = 0x55,
 
    XMSS_DISTANT_VALUE_3 = 0x87,
 
    XMSS_DISTANT_VALUE_4 = 0x99,
 
    XMSS_DISTANT_VALUE_5 = 0x4B,
 
    XMSS_DISTANT_VALUE_6 = 0xCC,
 
    XMSS_DISTANT_VALUE_7 = 0x1E,
 
    XMSS_DISTANT_VALUE_8 = 0xE1,
 
    XMSS_DISTANT_VALUE_9 = 0x33,
 
    XMSS_DISTANT_VALUE_A = 0xB4,
 
    XMSS_DISTANT_VALUE_B = 0x66,
 
    XMSS_DISTANT_VALUE_C = 0x78,
 
    XMSS_DISTANT_VALUE_D = 0xAA,
 
    XMSS_DISTANT_VALUE_E = 0x2D,
 
    XMSS_DISTANT_VALUE_F = 0xFF,
};
 
typedef enum XmssError
{
    /* NOTE to developers
     * ==================
     *
     * Keep the enumeration-constants synchronized with xmss_error_to_name().
     * Keep the Doxygen descriptions for the enumeration-constants synchronized with xmss_error_to_description().
     */
 
    /* XMSS_DISTANT_VALUE_0 must not be used. */
 
    XMSS_OKAY = XMSS_DISTANT_VALUE_1,
 
    XMSS_ERR_NULL_POINTER = XMSS_DISTANT_VALUE_2,
 
    XMSS_ERR_INVALID_SIGNATURE = XMSS_DISTANT_VALUE_3,
 
    XMSS_ERR_ARGUMENT_MISMATCH = XMSS_DISTANT_VALUE_4,
 
    XMSS_ERR_ALLOC_ERROR = XMSS_DISTANT_VALUE_5,
 
    XMSS_ERR_INVALID_BLOB = XMSS_DISTANT_VALUE_6,
 
    XMSS_ERR_BAD_CONTEXT = XMSS_DISTANT_VALUE_7,
 
    XMSS_ERR_INVALID_ARGUMENT = XMSS_DISTANT_VALUE_8,
 
    XMSS_ERR_PARTITION_DONE = XMSS_DISTANT_VALUE_9,
 
    XMSS_ERR_UNFINISHED_PARTITIONS = XMSS_DISTANT_VALUE_A,
 
    XMSS_ERR_TOO_FEW_SIGNATURES_AVAILABLE = XMSS_DISTANT_VALUE_B,
 
    XMSS_ERR_PARTITIONS_NOT_CONSECUTIVE = XMSS_DISTANT_VALUE_C,
 
    XMSS_ERR_NO_PUBLIC_KEY = XMSS_DISTANT_VALUE_D,
 
    XMSS_ERR_FAULT_DETECTED = XMSS_DISTANT_VALUE_E,
 
    XMSS_UNINITIALIZED = XMSS_DISTANT_VALUE_F
} XmssError;
 
typedef enum XmssParameterSetOID
{
    XMSS_PARAM_SHA2_10_256 = 1,
 
    XMSS_PARAM_SHA2_16_256 = 2,
 
    XMSS_PARAM_SHA2_20_256 = 3,
 
    XMSS_PARAM_SHAKE256_10_256 = 0x10,
 
    XMSS_PARAM_SHAKE256_16_256 = 0x11,
 
    XMSS_PARAM_SHAKE256_20_256 = 0x12,
} XmssParameterSetOID;
 
#define XMSS_TREE_DEPTH(param_set) \
    (((param_set) == XMSS_PARAM_SHA2_10_256 || (param_set) == XMSS_PARAM_SHAKE256_10_256) ? 10u : \
        (((param_set) == XMSS_PARAM_SHA2_16_256 || (param_set) == XMSS_PARAM_SHAKE256_16_256) ? 16u : \
            (((param_set) == XMSS_PARAM_SHA2_20_256 || (param_set) == XMSS_PARAM_SHAKE256_20_256) ? 20u : \
                0u /* Garbage in, 0 out */ \
            ) \
        ) \
    )
 
typedef enum XmssIndexObfuscationSetting
{
    XMSS_INDEX_OBFUSCATION_OFF = XMSS_DISTANT_VALUE_1,
 
    XMSS_INDEX_OBFUSCATION_ON = XMSS_DISTANT_VALUE_2
} XmssIndexObfuscationSetting;
 
typedef enum XmssCacheType
{
    XMSS_CACHE_NONE = XMSS_DISTANT_VALUE_1,
 
    XMSS_CACHE_SINGLE_LEVEL = XMSS_DISTANT_VALUE_2,
    XMSS_CACHE_TOP = XMSS_DISTANT_VALUE_3
} XmssCacheType;
 
typedef struct XmssValue256 {
    uint8_t data[32];
} XmssValue256;
 
#define XMSS_VALUE_256_WORDS 8
 
XMSS_STATIC_ASSERT(XMSS_VALUE_256_WORDS == sizeof(XmssValue256) / sizeof(uint32_t),
    "inconsistent value of XMSS_VALUE_256_WORDS");
 
typedef struct XmssNativeValue256 {
    uint32_t data[XMSS_VALUE_256_WORDS];
} XmssNativeValue256;
 
XMSS_STATIC_ASSERT(sizeof(XmssNativeValue256) == sizeof(XmssValue256),
    "XmssNativeValue256 and XmssValue256 should have equal size");
 
typedef struct XmssBuffer {
    size_t data_size;
    uint8_t *data;
} XmssBuffer;
 
typedef void *(*XmssReallocFunction)(void *ptr, size_t size);
 
typedef void (*XmssFreeFunction)(void *ptr);
 
typedef void (*XmssZeroizeFunction)(void *ptr, size_t size);
 
#endif /* !XMSS_TYPES_H_INCLUDED */