lc_xdrbg.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022 - 2025, Stephan Mueller <smueller@chronox.de>
 *
 * License: see LICENSE file in root directory
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
 * WHICH ARE HEREBY DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
 
#ifndef LC_XDRBG_DRNG_H
#define LC_XDRBG_DRNG_H
 
#if defined __has_include
#if __has_include("lc_ascon_hash.h")
#include "lc_ascon_hash.h"
#define LC_XDRBG_ASCON_ENABLED
#endif
#if __has_include("lc_sha3.h")
#include "lc_sha3.h"
#define LC_XDRBG_SHAKE_ENABLED
#endif
#else
#error "Compiler misses __has_include"
#endif
 
#include "lc_rng.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define LC_XDRBG_DRNG_INITIALLY_SEEDED 0x8
#define LC_XDRBG_DRNG_KEYSIZE_MASK 0x7
 
enum lc_xdrbg_status_keysize {
        lc_xdrbg_keysize_undefined,
        lc_xdrbg_keysize_xdrbg128,
        lc_xdrbg_keysize_xdrbg256,
        lc_xdrbg_keysize_xdrbg512
};
 
struct lc_xdrbg_drng_state {
        uint16_t chunksize;
        uint8_t status;
        /*
         * NOTE: keep the lc_hash pointer before the v variable, because
         * lc_hash is aligned to 8 bytes and has a size of 8 bytes. This ensures
         * that v is aligned to 8 bytes as well.
         */
        const struct lc_hash *xof;
        uint8_t v[];
};
 
/* Helper, do not call directly */
#define LC_XDRBG_DRNG_CTX_ON_STACK(name, ctxsize)                              \
        _Pragma("GCC diagnostic push") _Pragma(                                \
                "GCC diagnostic ignored \"-Wdeclaration-after-statement\"")    \
                LC_ALIGNED_BUFFER(name##_ctx_buf, ctxsize,                     \
                                  LC_HASH_COMMON_ALIGNMENT);                   \
        struct lc_rng_ctx *name = (struct lc_rng_ctx *)name##_ctx_buf;         \
        _Pragma("GCC diagnostic pop")
 
/***************************** SHAKE-based XDRBG ******************************/
 
#ifdef LC_XDRBG_SHAKE_ENABLED

extern const struct lc_rng *lc_xdrbg256_drng;
extern const struct lc_rng *lc_xdrbg512_drng;
 
#define LC_XDRBG256_DRNG_KEYSIZE 64
/*
 * For streamlining the access requests, the max chunk size plus the key size
 * should be a full multiple of the SHAKE rate. As the key size is not
 * exactly the rate size, the chunk size needs to consider it
 */
#define LC_XDRBG256_DRNG_MAX_CHUNK                                             \
        (LC_SHAKE_256_SIZE_BLOCK * 3 - LC_XDRBG256_DRNG_KEYSIZE)
#define LC_XDRBG256_DRNG_STATE_SIZE                                            \
        (sizeof(struct lc_xdrbg_drng_state) + LC_XDRBG256_DRNG_KEYSIZE)
#define LC_XDRBG256_DRNG_CTX_SIZE                                              \
        (sizeof(struct lc_rng) + LC_XDRBG256_DRNG_STATE_SIZE)
 
#define LC_XDRBG256_RNG_CTX(name)                                              \
        LC_RNG_CTX(name, lc_xdrbg256_drng);                                    \
        struct lc_xdrbg_drng_state *__name = name->rng_state;                  \
        __name->status = lc_xdrbg_keysize_xdrbg256;                            \
        __name->xof = lc_shake256;                                             \
        __name->chunksize = LC_XDRBG256_DRNG_MAX_CHUNK;                        \
        lc_xdrbg256_drng->zero(name->rng_state);

#define LC_XDRBG256_DRNG_CTX_ON_STACK(name)                                    \
        LC_XDRBG_DRNG_CTX_ON_STACK(name, LC_XDRBG256_DRNG_CTX_SIZE);           \
        LC_XDRBG256_RNG_CTX(name)

int lc_xdrbg256_drng_alloc(struct lc_rng_ctx **state);

#define LC_XDRBG512_DRNG_KEYSIZE 128
/*
 * For streamlining the access requests, the max chunk size plus the key size
 * should be a full multiple of the SHAKE rate. As the key size is not
 * exactly the rate size, the chunk size needs to consider it. As the rate is
 * 576 bits and the keysize is 1024 bits, use 6 rate size blocks as the actual
 * returned data size is 576 * 6 - 1024 == 2432 which is in the vicinity
 * defined for XDRBG256. The XDRBG allows a slightly different maximum chunk
 * size if you have an argument for it.
 */
#define LC_XDRBG512_DRNG_MAX_CHUNK                                             \
        (LC_SHAKE_512_SIZE_BLOCK * 6 - LC_XDRBG512_DRNG_KEYSIZE)
#define LC_XDRBG512_DRNG_STATE_SIZE                                            \
        (sizeof(struct lc_xdrbg_drng_state) + LC_XDRBG512_DRNG_KEYSIZE)
#define LC_XDRBG512_DRNG_CTX_SIZE                                              \
        (sizeof(struct lc_rng) + LC_XDRBG512_DRNG_STATE_SIZE)
 
#define LC_XDRBG512_RNG_CTX(name)                                              \
        LC_RNG_CTX(name, lc_xdrbg512_drng);                                    \
        struct lc_xdrbg_drng_state *__name = name->rng_state;                  \
        __name->status = lc_xdrbg_keysize_xdrbg512;                            \
        __name->xof = lc_shake512;                                             \
        __name->chunksize = LC_XDRBG512_DRNG_MAX_CHUNK;                        \
        lc_xdrbg512_drng->zero(name->rng_state);

#define LC_XDRBG512_DRNG_CTX_ON_STACK(name)                                    \
        LC_XDRBG_DRNG_CTX_ON_STACK(name, LC_XDRBG512_DRNG_CTX_SIZE);           \
        LC_XDRBG512_RNG_CTX(name)

int lc_xdrbg512_drng_alloc(struct lc_rng_ctx **state);
 
#endif /* LC_XDRBG_SHAKE_ENABLED */
 
/***************************** Ascon-based XDRBG ******************************/
 
#ifdef LC_XDRBG_ASCON_ENABLED

extern const struct lc_rng *lc_xdrbg128_drng;
 
#define LC_XDRBG128_DRNG_KEYSIZE 32
 
/*
 * For streamlining the access requests, the max chunk size plus the key size
 * should be a full multiple of the Ascon rate. As the key size is already
 * exactly the rate size, the chunk size does not need to consider it.
 */
#define LC_XDRBG128_DRNG_MAX_CHUNK (LC_ASCON_HASH_RATE * 32)
#define LC_XDRBG128_DRNG_STATE_SIZE                                            \
        (sizeof(struct lc_xdrbg_drng_state) + LC_XDRBG128_DRNG_KEYSIZE)
#define LC_XDRBG128_DRNG_CTX_SIZE                                              \
        (sizeof(struct lc_rng) + LC_XDRBG128_DRNG_STATE_SIZE)
 
#define LC_XDRBG128_RNG_CTX(name)                                              \
        LC_RNG_CTX(name, lc_xdrbg128_drng);                                    \
        struct lc_xdrbg_drng_state *__name = name->rng_state;                  \
        __name->status = lc_xdrbg_keysize_xdrbg128;                            \
        __name->xof = lc_ascon_xof;                                            \
        __name->chunksize = LC_XDRBG128_DRNG_MAX_CHUNK;                        \
        lc_xdrbg128_drng->zero(name->rng_state);

#define LC_XDRBG128_DRNG_CTX_ON_STACK(name)                                    \
        LC_XDRBG_DRNG_CTX_ON_STACK(name, LC_XDRBG128_DRNG_CTX_SIZE);           \
        LC_XDRBG128_RNG_CTX(name)

int lc_xdrbg128_drng_alloc(struct lc_rng_ctx **state);
 
#endif /* LC_XDRBG_ASCON_ENABLED */
 
#ifdef __cplusplus
}
#endif
 
#endif /* LC_XDRBG_DRNG_H */