opaque_structures.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_OPAQUE_STRUCTURES_H_INCLUDED
#define XMSS_OPAQUE_STRUCTURES_H_INCLUDED
 
#include "types.h"
#include "compat.h"
 
typedef struct XmssSigningContext XmssSigningContext;
 
#define XMSS_SIGNING_CONTEXT_SIZE (4u + 4u + 4u + 4u + 4u * sizeof(void(*)(void)))
 
void xmss_free_signing_context(XmssSigningContext *signing_context);
 
typedef struct XmssInternalCache XmssInternalCache;
 
#define XMSS_CACHE_ENTRY_COUNT(cache_type, cache_level, param_set) \
    ((cache_type) == XMSS_CACHE_NONE ? 0u : \
        ((cache_level) >= XMSS_TREE_DEPTH(param_set) ? 0u : \
            ((cache_type) == XMSS_CACHE_SINGLE_LEVEL ? (1u << (XMSS_TREE_DEPTH(param_set) - (cache_level))) : \
                ((cache_type) == XMSS_CACHE_TOP ? ((1u << ((XMSS_TREE_DEPTH(param_set) - (cache_level)) + 1u)) - 1u) : \
                    0u /* Garbage in, 0 out. */ \
                ) \
            ) \
        ) \
    )
 
#define XMSS_INTERNAL_CACHE_SIZE(cache_type, cache_level, param_set) \
    (4 + 4 + sizeof(XmssValue256) * XMSS_CACHE_ENTRY_COUNT((cache_type), (cache_level), (param_set)))
 
#define XMSS_PUBLIC_KEY_GENERATION_CACHE_SIZE(number_of_partitions) \
    (4 + 4 + sizeof(XmssValue256) * (number_of_partitions))
 
typedef struct XmssKeyContext XmssKeyContext;
 
#define XMSS_PRIVATE_KEY_STATEFUL_PART_SIZE (4u + 4u)
 
#define XMSS_PRIVATE_KEY_STATELESS_PART_SIZE (32u + 32u + 4u + 4u + 32u + sizeof(XmssValue256) + 32u)
 
#define XMSS_KEY_CONTEXT_SIZE(param_set, obfuscation_setting) \
    (4u + 4u + XMSS_SIGNING_CONTEXT_SIZE + XMSS_PRIVATE_KEY_STATELESS_PART_SIZE + \
     2u * XMSS_PRIVATE_KEY_STATEFUL_PART_SIZE + 3 * sizeof(XmssValue256) + sizeof(void*) + 4u + 4u + \
     4u * (1u << XMSS_TREE_DEPTH(param_set)) * ((obfuscation_setting) == XMSS_INDEX_OBFUSCATION_ON ? 1u : 0u))
 
void xmss_free_key_context(XmssKeyContext *key_context);
 
typedef struct XmssKeyGenerationContext XmssKeyGenerationContext;
 
#define XMSS_KEY_GENERATION_CONTEXT_SIZE(generation_partitions) \
    (sizeof(void*) + sizeof(uint32_t) + sizeof(uint32_t) + sizeof(void*) + sizeof(void*) + \
        sizeof(uint32_t) * (generation_partitions))
 
void xmss_free_key_generation_context(XmssKeyGenerationContext *key_generation_context);
 
#endif /* !XMSS_OPAQUE_STRUCTURES_H_INCLUDED */