File: qat_prov_sha2.c

package info (click to toggle)
qatengine 2.0.0-8
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,264 kB
  • sloc: ansic: 88,285; sh: 475; makefile: 245
file content (269 lines) | stat: -rw-r--r-- 11,648 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
/* ====================================================================
 *
 *
 *   BSD LICENSE
 *
 *   Copyright(c) 2023-2025 Intel Corporation.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS 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 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * ====================================================================
 */

/*****************************************************************************
 * @file qat_prov_sha2.c
 *
 * This file provides an implementation to qatprovider SHA2 operations
 *
 *****************************************************************************/
#if defined(ENABLE_QAT_FIPS) && defined(ENABLE_QAT_SW_SHA2)

# include <openssl/core_names.h>
# include <openssl/crypto.h>
# include <openssl/evp.h>
# include <openssl/params.h>
# include <openssl/err.h>
# include <openssl/proverr.h>

# include "qat_sw_sha2.h"
# include "qat_provider.h"
# include "qat_utils.h"
# include "qat_evp.h"
# include "e_qat.h"

/*
 * Forward declaration of any unique methods implemented here. This is not strictly
 * necessary for the compiler, but provides an assurance that the signatures
 * of the functions in the dispatch table are correct.
 */
static OSSL_FUNC_digest_init_fn qat_sha2_init;
static OSSL_FUNC_digest_update_fn qat_sha2_update;
static OSSL_FUNC_digest_final_fn qat_sha2_final;

static int qat_sha2_init(void *vctx, ossl_unused const OSSL_PARAM params[])
{
    QAT_SHA2_CTX *ctx = (QAT_SHA2_CTX *) vctx;

    if (!qat_prov_is_running())
        return 0;
    /* The newctx() handles most of the ctx fixed setup. */
    memset(ctx->h, 0, sizeof(ctx->h));
    if (!mb_qat_SHA2_init(ctx)) {
        WARN("QAT sha2 ctx init failed!\n");
        return 0;
    }
    return 1;
}

static int qat_sha2_update(void *vctx, const unsigned char *inp, size_t len)
{
# ifdef ENABLE_QAT_FIPS
    qat_fips_service_indicator = 1;
# endif
    QAT_SHA2_CTX *ctx = (QAT_SHA2_CTX *) vctx;

    if (!qat_prov_is_running())
        return 0;

    return mb_qat_SHA2_update(ctx, inp, len);

# ifdef ENABLE_QAT_FIPS
    qat_fips_service_indicator = 0;
# endif
}

static int qat_sha2_final(void *vctx, unsigned char *out, size_t *outl,
                          size_t outsz)
{
# ifdef ENABLE_QAT_FIPS
    qat_fips_service_indicator = 1;
# endif
    int ret = 1;
    QAT_SHA2_CTX *ctx = (QAT_SHA2_CTX *) vctx;

    if (!qat_prov_is_running())
        return 0;

    *outl = ctx->md_size;
    if (outsz > 0) {
        ret = mb_qat_SHA2_final(ctx, out);
    }
# ifdef ENABLE_QAT_FIPS
    qat_fips_service_indicator = 0;
# endif
    return ret;
}

static const OSSL_PARAM qat_sha2_default_known_gettable_params[] = {
    OSSL_PARAM_size_t(OSSL_DIGEST_PARAM_BLOCK_SIZE, NULL),
    OSSL_PARAM_size_t(OSSL_DIGEST_PARAM_SIZE, NULL),
    OSSL_PARAM_int(OSSL_DIGEST_PARAM_XOF, NULL),
    OSSL_PARAM_int(OSSL_DIGEST_PARAM_ALGID_ABSENT, NULL),
    OSSL_PARAM_END
};

const OSSL_PARAM *qat_sha2_default_gettable_params(void *provctx)
{
    return qat_sha2_default_known_gettable_params;
}

static int qat_sha2_default_get_params(OSSL_PARAM params[], size_t blksz,
                                       size_t paramsz, unsigned long flags)
{
    OSSL_PARAM *p = NULL;

    p = OSSL_PARAM_locate(params, OSSL_DIGEST_PARAM_BLOCK_SIZE);
    if (p != NULL && !OSSL_PARAM_set_size_t(p, blksz)) {
        QATerr(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
        return 0;
    }
    p = OSSL_PARAM_locate(params, OSSL_DIGEST_PARAM_SIZE);
    if (p != NULL && !OSSL_PARAM_set_size_t(p, paramsz)) {
        QATerr(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
        return 0;
    }
    p = OSSL_PARAM_locate(params, OSSL_DIGEST_PARAM_XOF);
    if (p != NULL
        && !OSSL_PARAM_set_int(p, (flags & PROV_DIGEST_FLAG_XOF) != 0)) {
        QATerr(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
        return 0;
    }
    p = OSSL_PARAM_locate(params, OSSL_DIGEST_PARAM_ALGID_ABSENT);
    if (p != NULL
        && !OSSL_PARAM_set_int(p,
                               (flags & PROV_DIGEST_FLAG_ALGID_ABSENT) != 0)) {
        QATerr(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
        return 0;
    }
    return 1;
}

static void set_ctx_md_type(QAT_SHA2_CTX *ctx, int bitlen)
{
    switch (bitlen) {
    case 224:
        ctx->md_type = NID_sha224;
        break;
    case 256:
        ctx->md_type = NID_sha256;
        break;
    case 384:
        ctx->md_type = NID_sha384;
        break;
    case 512:
        ctx->md_type = NID_sha512;
        break;
    }
}

# define PROV_DISPATCH_FUNC_SHA2_GET_PARAMS(name)                                \
{ OSSL_FUNC_DIGEST_GET_PARAMS, (void (*)(void))qat_##name##_get_params },        \
{ OSSL_FUNC_DIGEST_GETTABLE_PARAMS,                                              \
  (void (*)(void))qat_sha2_default_gettable_params }

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

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

# define PROV_DISPATCH_FUNC_DIGEST_FREE_DUP(name, blksize)                       \
static void qat_##name##_freectx(void *vctx)                                     \
{                                                                                \
    QAT_SHA2_CTX *ctx = (QAT_SHA2_CTX *)vctx;                                    \
                                                                                 \
    mb_qat_sha2_cleanup(ctx);                                                    \
                                                                                 \
}                                                                                \
static void *qat_##name##_dupctx(void *ctx)                                      \
{                                                                                \
    QAT_SHA2_CTX *in = (QAT_SHA2_CTX *)ctx;                                      \
    QAT_SHA2_CTX *ret = qat_prov_is_running() ?                                  \
                                OPENSSL_malloc(sizeof(*ret))                     \
                                : NULL;                                          \
    if (ret != NULL)                                                             \
        *ret = *in;                                                              \
    return ret;                                                                  \
}

# define PROV_FUNC_SHA2_COMMON(name, bitlen, blksize, dgstsize, flags)           \
PROV_FUNC_SHA2_GET_PARAM(name, blksize, dgstsize, flags)                         \
PROV_DISPATCH_FUNC_DIGEST_FREE_DUP(name, blksize)                               \
const OSSL_DISPATCH qat_##name##_functions[] = {                                 \
    { OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))qat_##name##_newctx },            \
    { OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))qat_sha2_update },                \
    { OSSL_FUNC_DIGEST_FINAL, (void (*)(void))qat_sha2_final },                  \
    { OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))qat_##name##_freectx },          \
    { OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))qat_##name##_dupctx },            \
    PROV_DISPATCH_FUNC_SHA2_GET_PARAMS(name)

# define PROV_FUNC_SHA2(name, bitlen, blksize, dgstsize, flags)                  \
    PROV_FUNC_SHA2_COMMON(name, bitlen, blksize, dgstsize, flags),               \
    { OSSL_FUNC_DIGEST_INIT, (void (*)(void))qat_sha2_init },                    \
    PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END

# define SHA2_NEW_CTX(name, bitlen, blksize, dgstsize, pad_val, sha_name)        \
static OSSL_FUNC_digest_newctx_fn qat_##name##_newctx;                           \
static void *qat_##name##_newctx(void *provctx)                                  \
{                                                                                \
    QAT_SHA2_CTX *ctx = qat_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx))     \
                                                : NULL;                          \
                                                                                 \
    if (ctx == NULL)                                                             \
        return NULL;                                                             \
                                                                                 \
    set_ctx_md_type(ctx, bitlen);                                                \
    ctx->block_size = blksize;                                                   \
    ctx->md_size = dgstsize;                                                     \
    return ctx;                                                                  \
}                                                                                \

# define QAT_PROVIDER_SHA2_IMPLEMENTION(bitlen, blksize, dgstsize, flags,        \
          sha_name)                                                              \
SHA2_NEW_CTX(sha##bitlen, bitlen, blksize, dgstsize, '\x06', sha_name)           \
PROV_FUNC_SHA2(sha##bitlen, bitlen, blksize, dgstsize, flags)

/* qat_sha224_functions */
QAT_PROVIDER_SHA2_IMPLEMENTION(224, QAT_SHA256_CBLOCK,
                               QAT_SHA224_DIGEST_LENGTH, SHA2_FLAGS, "SHA-224")
/* qat_sha256_functions */
    QAT_PROVIDER_SHA2_IMPLEMENTION(256, QAT_SHA256_CBLOCK,
                               QAT_SHA256_DIGEST_LENGTH, SHA2_FLAGS, "SHA2-256")
/* qat_sha384_functions */
    QAT_PROVIDER_SHA2_IMPLEMENTION(384, QAT_SHA512_CBLOCK,
                               QAT_SHA384_DIGEST_LENGTH, SHA2_FLAGS, "SHA-384")
/* qat_sha512_functions */
    QAT_PROVIDER_SHA2_IMPLEMENTION(512, QAT_SHA512_CBLOCK,
                               QAT_SHA512_DIGEST_LENGTH, SHA2_FLAGS, "SHA-512")
#endif                          /* ENABLE_QAT_FIPS && ENABLE_QAT_SW_SHA2 */