Coverage Report

Created: 2025-12-14 06:48

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/providers/implementations/include/prov/digestcommon.h
Line
Count
Source
1
/*
2
 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the Apache License 2.0 (the "License").  You may not use
5
 * this file except in compliance with the License.  You can obtain a copy
6
 * in the file LICENSE in the source distribution or at
7
 * https://www.openssl.org/source/license.html
8
 */
9
10
#ifndef OSSL_PROVIDERS_DIGESTCOMMON_H
11
#define OSSL_PROVIDERS_DIGESTCOMMON_H
12
13
#include <openssl/core_dispatch.h>
14
#include <openssl/core_names.h>
15
#include <openssl/params.h>
16
#include "prov/providercommon.h"
17
18
/* Internal flags that can be queried */
19
432
#define PROV_DIGEST_FLAG_XOF 0x0001
20
432
#define PROV_DIGEST_FLAG_ALGID_ABSENT 0x0002
21
22
#ifdef __cplusplus
23
extern "C" {
24
#endif
25
26
#define PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags)               \
27
    static OSSL_FUNC_digest_get_params_fn name##_get_params;                     \
28
    static int name##_get_params(OSSL_PARAM params[])                            \
29
400
    {                                                                            \
30
400
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
400
    }
md5_prov.c:md5_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
md5_sha1_prov.c:md5_sha1_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
null_prov.c:nullmd_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
ripemd_prov.c:ripemd160_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha2_prov.c:sha1_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha2_prov.c:sha224_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha2_prov.c:sha256_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha2_prov.c:sha256_192_internal_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha2_prov.c:sha384_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha2_prov.c:sha512_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha2_prov.c:sha512_224_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha2_prov.c:sha512_256_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:sha3_224_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:sha3_256_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:sha3_384_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:sha3_512_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:keccak_224_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:keccak_256_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:keccak_384_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:keccak_512_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:shake_128_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:shake_256_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:keccak_kmac_128_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sha3_prov.c:keccak_kmac_256_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
sm3_prov.c:sm3_get_params
Line
Count
Source
29
16
    {                                                                            \
30
16
        return ossl_digest_default_get_params(params, blksize, dgstsize, flags); \
31
16
    }
32
33
#define PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)                      \
34
    { OSSL_FUNC_DIGEST_GET_PARAMS, (void (*)(void))name##_get_params }, \
35
    {                                                                   \
36
        OSSL_FUNC_DIGEST_GETTABLE_PARAMS,                               \
37
            (void (*)(void))ossl_digest_default_gettable_params         \
38
    }
39
40
#define PROV_FUNC_DIGEST_FINAL(name, dgstsize, fin)                               \
41
    static OSSL_FUNC_digest_final_fn name##_internal_final;                       \
42
    static int name##_internal_final(void *ctx, unsigned char *out, size_t *outl, \
43
        size_t outsz)                                                             \
44
116k
    {                                                                             \
45
116k
        if (ossl_prov_is_running() && outsz >= dgstsize && fin(out, ctx)) {       \
46
116k
            *outl = dgstsize;                                                     \
47
116k
            return 1;                                                             \
48
116k
        }                                                                         \
49
116k
        return 0;                                                                 \
50
116k
    }
Unexecuted instantiation: md5_prov.c:md5_internal_final
Unexecuted instantiation: md5_sha1_prov.c:md5_sha1_internal_final
Unexecuted instantiation: ripemd_prov.c:ripemd160_internal_final
sha2_prov.c:sha1_internal_final
Line
Count
Source
44
13.3k
    {                                                                             \
45
13.3k
        if (ossl_prov_is_running() && outsz >= dgstsize && fin(out, ctx)) {       \
46
13.3k
            *outl = dgstsize;                                                     \
47
13.3k
            return 1;                                                             \
48
13.3k
        }                                                                         \
49
13.3k
        return 0;                                                                 \
50
13.3k
    }
Unexecuted instantiation: sha2_prov.c:sha224_internal_final
sha2_prov.c:sha256_internal_final
Line
Count
Source
44
103k
    {                                                                             \
45
103k
        if (ossl_prov_is_running() && outsz >= dgstsize && fin(out, ctx)) {       \
46
103k
            *outl = dgstsize;                                                     \
47
103k
            return 1;                                                             \
48
103k
        }                                                                         \
49
103k
        return 0;                                                                 \
50
103k
    }
Unexecuted instantiation: sha2_prov.c:sha256_192_internal_internal_final
Unexecuted instantiation: sha2_prov.c:sha384_internal_final
sha2_prov.c:sha512_internal_final
Line
Count
Source
44
16
    {                                                                             \
45
16
        if (ossl_prov_is_running() && outsz >= dgstsize && fin(out, ctx)) {       \
46
16
            *outl = dgstsize;                                                     \
47
16
            return 1;                                                             \
48
16
        }                                                                         \
49
16
        return 0;                                                                 \
50
16
    }
Unexecuted instantiation: sha2_prov.c:sha512_224_internal_final
Unexecuted instantiation: sha2_prov.c:sha512_256_internal_final
Unexecuted instantiation: sm3_prov.c:sm3_internal_final
51
52
#define PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(                               \
53
    name, CTX, blksize, dgstsize, flags, upd, fin)                               \
54
    static OSSL_FUNC_digest_newctx_fn name##_newctx;                             \
55
    static OSSL_FUNC_digest_freectx_fn name##_freectx;                           \
56
    static OSSL_FUNC_digest_dupctx_fn name##_dupctx;                             \
57
    static void *name##_newctx(void *prov_ctx)                                   \
58
116k
    {                                                                            \
59
116k
        CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) : NULL; \
60
116k
        return ctx;                                                              \
61
116k
    }                                                                            \
62
    static void name##_freectx(void *vctx)                                       \
63
116k
    {                                                                            \
64
116k
        CTX *ctx = (CTX *)vctx;                                                  \
65
116k
        OPENSSL_clear_free(ctx, sizeof(*ctx));                                   \
66
116k
    }                                                                            \
Unexecuted instantiation: md5_prov.c:md5_freectx
Unexecuted instantiation: md5_sha1_prov.c:md5_sha1_freectx
Unexecuted instantiation: null_prov.c:nullmd_freectx
Unexecuted instantiation: ripemd_prov.c:ripemd160_freectx
sha2_prov.c:sha1_freectx
Line
Count
Source
63
13.3k
    {                                                                            \
64
13.3k
        CTX *ctx = (CTX *)vctx;                                                  \
65
13.3k
        OPENSSL_clear_free(ctx, sizeof(*ctx));                                   \
66
13.3k
    }                                                                            \
Unexecuted instantiation: sha2_prov.c:sha224_freectx
sha2_prov.c:sha256_freectx
Line
Count
Source
63
103k
    {                                                                            \
64
103k
        CTX *ctx = (CTX *)vctx;                                                  \
65
103k
        OPENSSL_clear_free(ctx, sizeof(*ctx));                                   \
66
103k
    }                                                                            \
Unexecuted instantiation: sha2_prov.c:sha256_192_internal_freectx
Unexecuted instantiation: sha2_prov.c:sha384_freectx
sha2_prov.c:sha512_freectx
Line
Count
Source
63
16
    {                                                                            \
64
16
        CTX *ctx = (CTX *)vctx;                                                  \
65
16
        OPENSSL_clear_free(ctx, sizeof(*ctx));                                   \
66
16
    }                                                                            \
Unexecuted instantiation: sha2_prov.c:sha512_224_freectx
Unexecuted instantiation: sha2_prov.c:sha512_256_freectx
Unexecuted instantiation: sm3_prov.c:sm3_freectx
67
    static void *name##_dupctx(void *ctx)                                        \
68
0
    {                                                                            \
69
0
        CTX *in = (CTX *)ctx;                                                    \
70
0
        CTX *ret = ossl_prov_is_running() ? OPENSSL_malloc(sizeof(*ret)) : NULL; \
71
0
        if (ret != NULL)                                                         \
72
0
            *ret = *in;                                                          \
73
0
        return ret;                                                              \
74
0
    }                                                                            \
75
    static void name##_copyctx(void *voutctx, void *vinctx)                      \
76
0
    {                                                                            \
77
0
        CTX *outctx = (CTX *)voutctx;                                            \
78
0
        CTX *inctx = (CTX *)vinctx;                                              \
79
0
        *outctx = *inctx;                                                        \
80
0
    }                                                                            \
Unexecuted instantiation: md5_prov.c:md5_copyctx
Unexecuted instantiation: md5_sha1_prov.c:md5_sha1_copyctx
Unexecuted instantiation: null_prov.c:nullmd_copyctx
Unexecuted instantiation: ripemd_prov.c:ripemd160_copyctx
Unexecuted instantiation: sha2_prov.c:sha1_copyctx
Unexecuted instantiation: sha2_prov.c:sha224_copyctx
Unexecuted instantiation: sha2_prov.c:sha256_copyctx
Unexecuted instantiation: sha2_prov.c:sha256_192_internal_copyctx
Unexecuted instantiation: sha2_prov.c:sha384_copyctx
Unexecuted instantiation: sha2_prov.c:sha512_copyctx
Unexecuted instantiation: sha2_prov.c:sha512_224_copyctx
Unexecuted instantiation: sha2_prov.c:sha512_256_copyctx
Unexecuted instantiation: sm3_prov.c:sm3_copyctx
81
    PROV_FUNC_DIGEST_FINAL(name, dgstsize, fin)                                  \
82
    PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags)                   \
83
    const OSSL_DISPATCH ossl_##name##_functions[] = {                            \
84
        { OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))name##_newctx },              \
85
        { OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))upd },                        \
86
        { OSSL_FUNC_DIGEST_FINAL, (void (*)(void))name##_internal_final },       \
87
        { OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))name##_freectx },            \
88
        { OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))name##_dupctx },              \
89
        { OSSL_FUNC_DIGEST_COPYCTX, (void (*)(void))name##_copyctx },            \
90
        PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)
91
92
#define PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END \
93
    {                                           \
94
        0, NULL                                 \
95
    }                                           \
96
    }                                           \
97
    ;
98
99
#define IMPLEMENT_digest_functions(                                                \
100
    name, CTX, blksize, dgstsize, flags, init, upd, fin)                           \
101
    static OSSL_FUNC_digest_init_fn name##_internal_init;                          \
102
    static int name##_internal_init(void *ctx,                                     \
103
        ossl_unused const OSSL_PARAM params[])                                     \
104
0
    {                                                                              \
105
0
        return ossl_prov_is_running() && init(ctx);                                \
106
0
    }                                                                              \
Unexecuted instantiation: md5_prov.c:md5_internal_init
Unexecuted instantiation: null_prov.c:nullmd_internal_init
Unexecuted instantiation: ripemd_prov.c:ripemd160_internal_init
Unexecuted instantiation: sm3_prov.c:sm3_internal_init
107
    PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(name, CTX, blksize, dgstsize, flags, \
108
        upd, fin),                                                                 \
109
        { OSSL_FUNC_DIGEST_INIT, (void (*)(void))name##_internal_init },           \
110
        PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
111
112
#define IMPLEMENT_digest_functions_with_settable_ctx(                                  \
113
    name, CTX, blksize, dgstsize, flags, init, upd, fin,                               \
114
    settable_ctx_params, set_ctx_params)                                               \
115
    static OSSL_FUNC_digest_init_fn name##_internal_init;                              \
116
    static int name##_internal_init(void *ctx, const OSSL_PARAM params[])              \
117
13.3k
    {                                                                                  \
118
13.3k
        return ossl_prov_is_running()                                                  \
119
13.3k
            && init(ctx)                                                               \
120
13.3k
            && set_ctx_params(ctx, params);                                            \
121
13.3k
    }                                                                                  \
Unexecuted instantiation: md5_sha1_prov.c:md5_sha1_internal_init
sha2_prov.c:sha1_internal_init
Line
Count
Source
117
13.3k
    {                                                                                  \
118
13.3k
        return ossl_prov_is_running()                                                  \
119
13.3k
            && init(ctx)                                                               \
120
13.3k
            && set_ctx_params(ctx, params);                                            \
121
13.3k
    }                                                                                  \
122
    PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(name, CTX, blksize, dgstsize, flags,     \
123
        upd, fin),                                                                     \
124
        { OSSL_FUNC_DIGEST_INIT, (void (*)(void))name##_internal_init },               \
125
        { OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS, (void (*)(void))settable_ctx_params }, \
126
        { OSSL_FUNC_DIGEST_SET_CTX_PARAMS, (void (*)(void))set_ctx_params },           \
127
        PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
128
129
#define IMPLEMENT_digest_functions_with_serialize(                                 \
130
    name, CTX, blksize, dgstsize, flags, init, upd, fin,                           \
131
    serialize, deserialize)                                                        \
132
    static OSSL_FUNC_digest_init_fn name##_internal_init;                          \
133
    static int name##_internal_init(void *ctx, const OSSL_PARAM params[])          \
134
103k
    {                                                                              \
135
103k
        return ossl_prov_is_running() && init(ctx);                                \
136
103k
    }                                                                              \
Unexecuted instantiation: sha2_prov.c:sha224_internal_init
sha2_prov.c:sha256_internal_init
Line
Count
Source
134
103k
    {                                                                              \
135
103k
        return ossl_prov_is_running() && init(ctx);                                \
136
103k
    }                                                                              \
Unexecuted instantiation: sha2_prov.c:sha256_192_internal_internal_init
Unexecuted instantiation: sha2_prov.c:sha384_internal_init
sha2_prov.c:sha512_internal_init
Line
Count
Source
134
16
    {                                                                              \
135
16
        return ossl_prov_is_running() && init(ctx);                                \
136
16
    }                                                                              \
Unexecuted instantiation: sha2_prov.c:sha512_224_internal_init
Unexecuted instantiation: sha2_prov.c:sha512_256_internal_init
137
    PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(name, CTX, blksize, dgstsize, flags, \
138
        upd, fin),                                                                 \
139
        { OSSL_FUNC_DIGEST_INIT, (void (*)(void))name##_internal_init },           \
140
        { OSSL_FUNC_DIGEST_SERIALIZE, (void (*)(void))serialize },                 \
141
        { OSSL_FUNC_DIGEST_DESERIALIZE, (void (*)(void))deserialize },             \
142
        PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
143
144
const OSSL_PARAM *ossl_digest_default_gettable_params(void *provctx);
145
int ossl_digest_default_get_params(OSSL_PARAM params[], size_t blksz,
146
    size_t paramsz, unsigned long flags);
147
148
#ifdef __cplusplus
149
}
150
#endif
151
152
#endif /* OSSL_PROVIDERS_DIGESTCOMMON_H */