/src/openssl/providers/implementations/include/prov/digestcommon.h

Source
/*
 * Copyright 2019-2026 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#ifndef OSSL_PROVIDERS_DIGESTCOMMON_H
#define OSSL_PROVIDERS_DIGESTCOMMON_H

#include <openssl/core_dispatch.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include "prov/providercommon.h"

/* Internal flags that can be queried */
#define PROV_DIGEST_FLAG_XOF 0x0001
#define PROV_DIGEST_FLAG_ALGID_ABSENT 0x0002

#ifdef __cplusplus
extern "C" {
#endif

#define PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags)               \
    static OSSL_FUNC_digest_get_params_fn name##_get_params;                     \
    static int name##_get_params(OSSL_PARAM params[])                            \
    {                                                                            \
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
    }

#define PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)                      \
    { OSSL_FUNC_DIGEST_GET_PARAMS, (void (*)(void))name##_get_params }, \
    {                                                                   \
        OSSL_FUNC_DIGEST_GETTABLE_PARAMS,                               \
            (void (*)(void))ossl_digest_default_gettable_params         \
    }

#define PROV_FUNC_DIGEST_FINAL(name, dgstsize, fin)                               \
    static OSSL_FUNC_digest_final_fn name##_internal_final;                       \
    static int name##_internal_final(void *ctx, unsigned char *out, size_t *outl, \
        size_t outsz)                                                             \
    {                                                                             \
        if (ossl_prov_is_running() && outsz >= dgstsize && fin(out, ctx)) {       \
            *outl = dgstsize;                                                     \
            return 1;                                                             \
        }                                                                         \
        return 0;                                                                 \
    }

#if defined(FIPS_MODULE)
#include "internal/fips.h"
#include "prov/provider_ctx.h"
#define DIGEST_PROV_CHECK(provctx, name)                  \
    if (!ossl_prov_is_running())                          \
        return NULL;                                      \
    if (!ossl_deferred_self_test(PROV_LIBCTX_OF(provctx), \
            ST_ID_DIGEST_##name))                         \
    return NULL
#else
#define DIGEST_PROV_CHECK(_provctx, _name) \
    if (!ossl_prov_is_running())           \
    return NULL
#endif /* FIPS_MODULE && DIGEST_IS_FIPS */

#define PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(                               \
    name, CTX, blksize, dgstsize, flags, upd, fin)                               \
    static OSSL_FUNC_digest_newctx_fn name##_newctx;                             \
    static OSSL_FUNC_digest_freectx_fn name##_freectx;                           \
    static OSSL_FUNC_digest_dupctx_fn name##_dupctx;                             \
    static void *name##_newctx(void *prov_ctx)                                   \
    {                                                                            \
        DIGEST_PROV_CHECK(prov_ctx, name);                                       \
        return OPENSSL_zalloc(sizeof(CTX));                                      \
    }                                                                            \
    static void name##_freectx(void *vctx)                                       \
    {                                                                            \
        CTX *ctx = (CTX *)vctx;                                                  \
        OPENSSL_clear_free(ctx, sizeof(*ctx));                                   \
    }                                                                            \
    static void *name##_dupctx(void *ctx)                                        \
    {                                                                            \
        CTX *in = (CTX *)ctx;                                                    \
        CTX *ret = ossl_prov_is_running() ? OPENSSL_malloc(sizeof(*ret)) : NULL; \
        if (ret != NULL)                                                         \
            *ret = *in;                                                          \
        return ret;                                                              \
    }                                                                            \
    static void name##_copyctx(void *voutctx, void *vinctx)                      \
    {                                                                            \
        CTX *outctx = (CTX *)voutctx;                                            \
        CTX *inctx = (CTX *)vinctx;                                              \
        *outctx = *inctx;                                                        \
    }                                                                            \
    PROV_FUNC_DIGEST_FINAL(name, dgstsize, fin)                                  \
    PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags)                   \
    const OSSL_DISPATCH ossl_##name##_functions[] = {                            \
        { OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))name##_newctx },              \
        { OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))upd },                        \
        { OSSL_FUNC_DIGEST_FINAL, (void (*)(void))name##_internal_final },       \
        { OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))name##_freectx },            \
        { OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))name##_dupctx },              \
        { OSSL_FUNC_DIGEST_COPYCTX, (void (*)(void))name##_copyctx },            \
        PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)

#define PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END \
    {                                           \
        0, NULL                                 \
    }                                           \
    }                                           \
    ;

#define IMPLEMENT_digest_functions(                                                \
    name, CTX, blksize, dgstsize, flags, init, upd, fin)                           \
    static OSSL_FUNC_digest_init_fn name##_internal_init;                          \
    static int name##_internal_init(void *ctx,                                     \
        ossl_unused const OSSL_PARAM params[])                                     \
    {                                                                              \
        return ossl_prov_is_running() && init(ctx);                                \
    }                                                                              \
    PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(name, CTX, blksize, dgstsize, flags, \
        upd, fin),                                                                 \
        { OSSL_FUNC_DIGEST_INIT, (void (*)(void))name##_internal_init },           \
        PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END

#define IMPLEMENT_digest_functions_with_settable_ctx(                                  \
    name, CTX, blksize, dgstsize, flags, init, upd, fin,                               \
    settable_ctx_params, set_ctx_params)                                               \
    static OSSL_FUNC_digest_init_fn name##_internal_init;                              \
    static int name##_internal_init(void *ctx, const OSSL_PARAM params[])              \
    {                                                                                  \
        return ossl_prov_is_running()                                                  \
            && init(ctx)                                                               \
            && set_ctx_params(ctx, params);                                            \
    }                                                                                  \
    PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(name, CTX, blksize, dgstsize, flags,     \
        upd, fin),                                                                     \
        { OSSL_FUNC_DIGEST_INIT, (void (*)(void))name##_internal_init },               \
        { OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS, (void (*)(void))settable_ctx_params }, \
        { OSSL_FUNC_DIGEST_SET_CTX_PARAMS, (void (*)(void))set_ctx_params },           \
        PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END

#define IMPLEMENT_digest_functions_with_serialize(                                 \
    name, CTX, blksize, dgstsize, flags, init, upd, fin,                           \
    serialize, deserialize)                                                        \
    static OSSL_FUNC_digest_init_fn name##_internal_init;                          \
    static int name##_internal_init(void *ctx, const OSSL_PARAM params[])          \
    {                                                                              \
        return ossl_prov_is_running() && init(ctx);                                \
    }                                                                              \
    PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(name, CTX, blksize, dgstsize, flags, \
        upd, fin),                                                                 \
        { OSSL_FUNC_DIGEST_INIT, (void (*)(void))name##_internal_init },           \
        { OSSL_FUNC_DIGEST_SERIALIZE, (void (*)(void))serialize },                 \
        { OSSL_FUNC_DIGEST_DESERIALIZE, (void (*)(void))deserialize },             \
        PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END

const OSSL_PARAM *ossl_digest_default_gettable_params(void *provctx);
int ossl_digest_default_get_params(OSSL_PARAM params[], size_t blksz,
    size_t paramsz, unsigned long flags);

#ifdef __cplusplus
}
#endif

#endif /* OSSL_PROVIDERS_DIGESTCOMMON_H */

Coverage Report

Created: 2026-07-12 07:21