signing.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_SIGNING_H_INCLUDED
#define XMSS_SIGNING_H_INCLUDED
 
#include "structures.h"
#include "types.h"
 
/* === Library initialization === */
 
XmssError xmss_context_initialize(XmssSigningContext **context, XmssParameterSetOID parameter_set,
    XmssReallocFunction custom_realloc, XmssFreeFunction custom_free, XmssZeroizeFunction zeroize);
 
/* === Key loading === */
 
XmssError xmss_load_private_key(XmssKeyContext **key_context, const XmssPrivateKeyStatelessBlob *private_key,
    const XmssPrivateKeyStatefulBlob *key_usage, const XmssSigningContext *context);
 
XmssError xmss_load_public_key(XmssInternalCache **cache, XmssKeyContext *key_context,
    const XmssPublicKeyInternalBlob *public_key);
 
/* === Key generation === */
 
XmssError xmss_generate_private_key(XmssKeyContext **key_context, XmssPrivateKeyStatelessBlob **private_key,
    XmssPrivateKeyStatefulBlob **key_usage, const XmssBuffer *secure_random,
    XmssIndexObfuscationSetting index_obfuscation_setting, const XmssBuffer *random, const XmssSigningContext *context);
 
XmssError xmss_generate_public_key(XmssKeyGenerationContext **generation_buffer, XmssInternalCache **cache,
    XmssInternalCache **generation_cache, const XmssKeyContext *key_context, XmssCacheType cache_type,
    uint8_t cache_level, uint32_t generation_partitions);
 
XmssError xmss_calculate_public_key_part(XmssKeyGenerationContext *generation_buffer, uint32_t partition_index);
 
XmssError xmss_finish_calculate_public_key(XmssPublicKeyInternalBlob **public_key,
    XmssKeyGenerationContext **generation_buffer, XmssKeyContext *key_context);
 
/* === Signing === */
 
XmssError xmss_request_future_signatures(XmssPrivateKeyStatefulBlob **new_key_usage, XmssKeyContext *key_context,
    uint32_t signature_count);
 
XmssError xmss_sign_message(XmssSignatureBlob **signature, XmssKeyContext *key_context, const XmssBuffer *message);
 
/* === Signature space partitioning === */
 
XmssError xmss_partition_signature_space(XmssPrivateKeyStatefulBlob **new_partition,
    XmssPrivateKeyStatefulBlob **updated_current_partition, XmssKeyContext *key_context, uint32_t new_partition_size);
 
XmssError xmss_merge_signature_space(XmssPrivateKeyStatefulBlob **new_key_usage, XmssKeyContext *key_context,
    const XmssPrivateKeyStatefulBlob *partition_extension);
 
/* === Informationals === */
 
XmssError xmss_get_signature_count(size_t *total_count, size_t *remaining_count, const XmssKeyContext *key_context);
 
XmssError xmss_verify_public_key(const XmssPublicKeyInternalBlob *pub_key,
    const XmssPrivateKeyStatelessBlob *private_key, const XmssKeyContext *key_context);
 
XmssError xmss_verify_private_key_stateless(const XmssPrivateKeyStatelessBlob *private_key,
    const XmssSigningContext *context);
 
XmssError xmss_verify_private_key_stateful(const XmssPrivateKeyStatefulBlob *key_usage,
    const XmssPrivateKeyStatelessBlob *private_key, const XmssKeyContext *key_context,
    const XmssSigningContext *signing_context);
 
XmssError xmss_get_caching_in_public_key(XmssCacheType *cache_type, uint32_t *cache_level,
    const XmssPublicKeyInternalBlob *pub_key);
 
/* === Exportable public key === */
 
XmssError xmss_export_public_key(XmssPublicKey *exported_pub_key, const XmssKeyContext *key_context);
 
XmssError xmss_verify_exported_public_key(const XmssPublicKey *exported_pub_key, const XmssKeyContext *key_context);
 
#endif /* !XMSS_SIGNING_H_INCLUDED */