Coverage Report

Created: 2023-09-25 06:41

/src/openssl/crypto/evp/ctrl_params_translate.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2021-2023 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
/*
11
 * Some ctrls depend on deprecated functionality.  We trust that this is
12
 * functionality that remains internally even when 'no-deprecated' is
13
 * configured.  When we drop #legacy EVP_PKEYs, this source should be
14
 * possible to drop as well.
15
 */
16
#include "internal/deprecated.h"
17
18
#include <string.h>
19
20
/* The following includes get us all the EVP_PKEY_CTRL macros */
21
#include <openssl/dh.h>
22
#include <openssl/dsa.h>
23
#include <openssl/ec.h>
24
#include <openssl/rsa.h>
25
#include <openssl/kdf.h>
26
27
/* This include gets us all the OSSL_PARAM key string macros */
28
#include <openssl/core_names.h>
29
30
#include <openssl/err.h>
31
#include <openssl/evperr.h>
32
#include <openssl/params.h>
33
#include "internal/nelem.h"
34
#include "internal/cryptlib.h"
35
#include "internal/ffc.h"
36
#include "crypto/evp.h"
37
#include "crypto/dh.h"
38
#include "crypto/ec.h"
39
40
struct translation_ctx_st;       /* Forwarding */
41
struct translation_st;           /* Forwarding */
42
43
/*
44
 * The fixup_args functions are called with the following parameters:
45
 *
46
 * |state|              The state we're called in, explained further at the
47
 *                      end of this comment.
48
 * |translation|        The translation item, to be pilfered for data as
49
 *                      necessary.
50
 * |ctx|                The translation context, which contains copies of
51
 *                      the following arguments, applicable according to
52
 *                      the caller.  All of the attributes in this context
53
 *                      may be freely modified by the fixup_args function.
54
 *                      For cleanup, call cleanup_translation_ctx().
55
 *
56
 * The |state| tells the fixup_args function something about the caller and
57
 * what they may expect:
58
 *
59
 * PKEY                         The fixup_args function has been called
60
 *                              from an EVP_PKEY payload getter / setter,
61
 *                              and is fully responsible for getting or
62
 *                              setting the requested data.  With this
63
 *                              state, the fixup_args function is expected
64
 *                              to use or modify |*params|, depending on
65
 *                              |action_type|.
66
 *
67
 * PRE_CTRL_TO_PARAMS           The fixup_args function has been called
68
 * POST_CTRL_TO_PARAMS          from EVP_PKEY_CTX_ctrl(), to help with
69
 *                              translating the ctrl data to an OSSL_PARAM
70
 *                              element or back.  The calling sequence is
71
 *                              as follows:
72
 *
73
 *                              1. fixup_args(PRE_CTRL_TO_PARAMS, ...)
74
 *                              2. EVP_PKEY_CTX_set_params() or
75
 *                                 EVP_PKEY_CTX_get_params()
76
 *                              3. fixup_args(POST_CTRL_TO_PARAMS, ...)
77
 *
78
 *                              With the PRE_CTRL_TO_PARAMS state, the
79
 *                              fixup_args function is expected to modify
80
 *                              the passed |*params| in whatever way
81
 *                              necessary, when |action_type == SET|.
82
 *                              With the POST_CTRL_TO_PARAMS state, the
83
 *                              fixup_args function is expected to modify
84
 *                              the passed |p2| in whatever way necessary,
85
 *                              when |action_type == GET|.
86
 *
87
 *                              The return value from the fixup_args call
88
 *                              with the POST_CTRL_TO_PARAMS state becomes
89
 *                              the return value back to EVP_PKEY_CTX_ctrl().
90
 *
91
 * CLEANUP_CTRL_TO_PARAMS       The cleanup_args functions has been called
92
 *                              from EVP_PKEY_CTX_ctrl(), to clean up what
93
 *                              the fixup_args function has done, if needed.
94
 *
95
 *
96
 * PRE_CTRL_STR_TO_PARAMS       The fixup_args function has been called
97
 * POST_CTRL_STR_TO_PARAMS      from EVP_PKEY_CTX_ctrl_str(), to help with
98
 *                              translating the ctrl_str data to an
99
 *                              OSSL_PARAM element or back.  The calling
100
 *                              sequence is as follows:
101
 *
102
 *                              1. fixup_args(PRE_CTRL_STR_TO_PARAMS, ...)
103
 *                              2. EVP_PKEY_CTX_set_params() or
104
 *                                 EVP_PKEY_CTX_get_params()
105
 *                              3. fixup_args(POST_CTRL_STR_TO_PARAMS, ...)
106
 *
107
 *                              With the PRE_CTRL_STR_TO_PARAMS state,
108
 *                              the fixup_args function is expected to
109
 *                              modify the passed |*params| in whatever
110
 *                              way necessary, when |action_type == SET|.
111
 *                              With the POST_CTRL_STR_TO_PARAMS state,
112
 *                              the fixup_args function is only expected
113
 *                              to return a value.
114
 *
115
 * CLEANUP_CTRL_STR_TO_PARAMS   The cleanup_args functions has been called
116
 *                              from EVP_PKEY_CTX_ctrl_str(), to clean up
117
 *                              what the fixup_args function has done, if
118
 *                              needed.
119
 *
120
 * PRE_PARAMS_TO_CTRL           The fixup_args function has been called
121
 * POST_PARAMS_TO_CTRL          from EVP_PKEY_CTX_get_params() or
122
 *                              EVP_PKEY_CTX_set_params(), to help with
123
 *                              translating the OSSL_PARAM data to the
124
 *                              corresponding EVP_PKEY_CTX_ctrl() arguments
125
 *                              or the other way around.  The calling
126
 *                              sequence is as follows:
127
 *
128
 *                              1. fixup_args(PRE_PARAMS_TO_CTRL, ...)
129
 *                              2. EVP_PKEY_CTX_ctrl()
130
 *                              3. fixup_args(POST_PARAMS_TO_CTRL, ...)
131
 *
132
 *                              With the PRE_PARAMS_TO_CTRL state, the
133
 *                              fixup_args function is expected to modify
134
 *                              the passed |p1| and |p2| in whatever way
135
 *                              necessary, when |action_type == SET|.
136
 *                              With the POST_PARAMS_TO_CTRL state, the
137
 *                              fixup_args function is expected to
138
 *                              modify the passed |*params| in whatever
139
 *                              way necessary, when |action_type == GET|.
140
 *
141
 * CLEANUP_PARAMS_TO_CTRL       The cleanup_args functions has been called
142
 *                              from EVP_PKEY_CTX_get_params() or
143
 *                              EVP_PKEY_CTX_set_params(), to clean up what
144
 *                              the fixup_args function has done, if needed.
145
 */
146
enum state {
147
    PKEY,
148
    PRE_CTRL_TO_PARAMS, POST_CTRL_TO_PARAMS, CLEANUP_CTRL_TO_PARAMS,
149
    PRE_CTRL_STR_TO_PARAMS, POST_CTRL_STR_TO_PARAMS, CLEANUP_CTRL_STR_TO_PARAMS,
150
    PRE_PARAMS_TO_CTRL, POST_PARAMS_TO_CTRL, CLEANUP_PARAMS_TO_CTRL
151
};
152
enum action {
153
    NONE = 0, GET = 1, SET = 2
154
};
155
typedef int fixup_args_fn(enum state state,
156
                          const struct translation_st *translation,
157
                          struct translation_ctx_st *ctx);
158
typedef int cleanup_args_fn(enum state state,
159
                            const struct translation_st *translation,
160
                            struct translation_ctx_st *ctx);
161
162
struct translation_ctx_st {
163
    /*
164
     * The EVP_PKEY_CTX, for calls on that structure, to be pilfered for data
165
     * as necessary.
166
     */
167
    EVP_PKEY_CTX *pctx;
168
    /*
169
     * The action type (GET or SET).  This may be 0 in some cases, and should
170
     * be modified by the fixup_args function in the PRE states.  It should
171
     * otherwise remain untouched once set.
172
     */
173
    enum action action_type;
174
    /*
175
     * For ctrl to params translation, the actual ctrl command number used.
176
     * For params to ctrl translation, 0.
177
     */
178
    int ctrl_cmd;
179
    /*
180
     * For ctrl_str to params translation, the actual ctrl command string
181
     * used.  In this case, the (string) value is always passed as |p2|.
182
     * For params to ctrl translation, this is NULL.  Along with it is also
183
     * and indicator whether it matched |ctrl_str| or |ctrl_hexstr| in the
184
     * translation item.
185
     */
186
    const char *ctrl_str;
187
    int ishex;
188
    /* the ctrl-style int argument. */
189
    int p1;
190
    /* the ctrl-style void* argument. */
191
    void *p2;
192
    /* a size, for passing back the |p2| size where applicable */
193
    size_t sz;
194
    /* pointer to the OSSL_PARAM-style params array. */
195
    OSSL_PARAM *params;
196
197
    /*-
198
     * The following are used entirely internally by the fixup_args functions
199
     * and should not be touched by the callers, at all.
200
     */
201
202
    /*
203
     * Copy of the ctrl-style void* argument, if the fixup_args function
204
     * needs to manipulate |p2| but wants to remember original.
205
     */
206
    void *orig_p2;
207
    /* Diverse types of storage for the needy. */
208
    char name_buf[OSSL_MAX_NAME_SIZE];
209
    void *allocated_buf;
210
    void *bufp;
211
    size_t buflen;
212
};
213
214
struct translation_st {
215
    /*-
216
     * What this table item does.
217
     *
218
     * If the item has this set to 0, it means that both GET and SET are
219
     * supported, and |fixup_args| will determine which it is.  This is to
220
     * support translations of ctrls where the action type depends on the
221
     * value of |p1| or |p2| (ctrls are really bi-directional, but are
222
     * seldom used that way).
223
     *
224
     * This can be also used in the lookup template when it looks up by
225
     * OSSL_PARAM key, to indicate if a setter or a getter called.
226
     */
227
    enum action action_type;
228
229
    /*-
230
     * Conditions, for params->ctrl translations.
231
     *
232
     * In table item, |keytype1| and |keytype2| can be set to -1 to indicate
233
     * that this item supports all key types (or rather, that |fixup_args|
234
     * will check and return an error if it's not supported).
235
     * Any of these may be set to 0 to indicate that they are unset.
236
     */
237
    int keytype1;    /* The EVP_PKEY_XXX type, i.e. NIDs. #legacy */
238
    int keytype2;    /* Another EVP_PKEY_XXX type, used for aliases */
239
    int optype;      /* The operation type */
240
241
    /*
242
     * Lookup and translation attributes
243
     *
244
     * |ctrl_num|, |ctrl_str|, |ctrl_hexstr| and |param_key| are lookup
245
     * attributes.
246
     *
247
     * |ctrl_num| may be 0 or that |param_key| may be NULL in the table item,
248
     * but not at the same time.  If they are, they are simply not used for
249
     * lookup.
250
     * When |ctrl_num| == 0, no ctrl will be called.  Likewise, when
251
     * |param_key| == NULL, no OSSL_PARAM setter/getter will be called.
252
     * In that case the treatment of the translation item relies entirely on
253
     * |fixup_args|, which is then assumed to have side effects.
254
     *
255
     * As a special case, it's possible to set |ctrl_hexstr| and assign NULL
256
     * to |ctrl_str|.  That will signal to default_fixup_args() that the
257
     * value must always be interpreted as hex.
258
     */
259
    int ctrl_num;            /* EVP_PKEY_CTRL_xxx */
260
    const char *ctrl_str;    /* The corresponding ctrl string */
261
    const char *ctrl_hexstr; /* The alternative "hex{str}" ctrl string */
262
    const char *param_key;   /* The corresponding OSSL_PARAM key */
263
    /*
264
     * The appropriate OSSL_PARAM data type.  This may be 0 to indicate that
265
     * this OSSL_PARAM may have more than one data type, depending on input
266
     * material.  In this case, |fixup_args| is expected to check and handle
267
     * it.
268
     */
269
    unsigned int param_data_type;
270
271
    /*
272
     * Fixer functions
273
     *
274
     * |fixup_args| is always called before (for SET) or after (for GET)
275
     * the actual ctrl / OSSL_PARAM function.
276
     */
277
    fixup_args_fn *fixup_args;
278
};
279
280
/*-
281
 * Fixer function implementations
282
 * ==============================
283
 */
284
285
/*
286
 * default_check isn't a fixer per se, but rather a helper function to
287
 * perform certain standard checks.
288
 */
289
static int default_check(enum state state,
290
                         const struct translation_st *translation,
291
                         const struct translation_ctx_st *ctx)
292
0
{
293
0
    switch (state) {
294
0
    default:
295
0
        break;
296
0
    case PRE_CTRL_TO_PARAMS:
297
0
        if (!ossl_assert(translation != NULL)) {
298
0
            ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
299
0
            return -2;
300
0
        }
301
0
        if (!ossl_assert(translation->param_key != 0)
302
0
            || !ossl_assert(translation->param_data_type != 0)) {
303
0
            ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
304
0
            return -1;
305
0
        }
306
0
        break;
307
0
    case PRE_CTRL_STR_TO_PARAMS:
308
        /*
309
         * For ctrl_str to params translation, we allow direct use of
310
         * OSSL_PARAM keys as ctrl_str keys.  Therefore, it's possible that
311
         * we end up with |translation == NULL|, which is fine.  The fixup
312
         * function will have to deal with it carefully.
313
         */
314
0
        if (translation != NULL) {
315
0
            if (!ossl_assert(translation->action_type != GET)) {
316
0
                ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
317
0
                return -2;
318
0
            }
319
0
            if (!ossl_assert(translation->param_key != NULL)
320
0
                || !ossl_assert(translation->param_data_type != 0)) {
321
0
                ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
322
0
                return 0;
323
0
            }
324
0
        }
325
0
        break;
326
0
    case PRE_PARAMS_TO_CTRL:
327
0
    case POST_PARAMS_TO_CTRL:
328
0
        if (!ossl_assert(translation != NULL)) {
329
0
            ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
330
0
            return -2;
331
0
        }
332
0
        if (!ossl_assert(translation->ctrl_num != 0)
333
0
            || !ossl_assert(translation->param_data_type != 0)) {
334
0
            ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
335
0
            return -1;
336
0
        }
337
0
    }
338
339
    /* Nothing else to check */
340
0
    return 1;
341
0
}
342
343
/*-
344
 * default_fixup_args fixes up all sorts of arguments, governed by the
345
 * diverse attributes in the translation item.  It covers all "standard"
346
 * base ctrl functionality, meaning it can handle basic conversion of
347
 * data between p1+p2 (SET) or return value+p2 (GET) as long as the values
348
 * don't have extra semantics (such as NIDs, OIDs, that sort of stuff).
349
 * Extra semantics must be handled via specific fixup_args functions.
350
 *
351
 * The following states and action type combinations have standard handling
352
 * done in this function:
353
 *
354
 * PRE_CTRL_TO_PARAMS, 0                - ERROR.  action type must be
355
 *                                        determined by a fixup function.
356
 * PRE_CTRL_TO_PARAMS, SET | GET        - |p1| and |p2| are converted to an
357
 *                                        OSSL_PARAM according to the data
358
 *                                        type given in |translattion|.
359
 *                                        For OSSL_PARAM_UNSIGNED_INTEGER,
360
 *                                        a BIGNUM passed as |p2| is accepted.
361
 * POST_CTRL_TO_PARAMS, GET             - If the OSSL_PARAM data type is a
362
 *                                        STRING or PTR type, |p1| is set
363
 *                                        to the OSSL_PARAM return size, and
364
 *                                        |p2| is set to the string.
365
 * PRE_CTRL_STR_TO_PARAMS, !SET         - ERROR.  That combination is not
366
 *                                        supported.
367
 * PRE_CTRL_STR_TO_PARAMS, SET          - |p2| is taken as a string, and is
368
 *                                        converted to an OSSL_PARAM in a
369
 *                                        standard manner, guided by the
370
 *                                        param key and data type from
371
 *                                        |translation|.
372
 * PRE_PARAMS_TO_CTRL, SET              - the OSSL_PARAM is converted to
373
 *                                        |p1| and |p2| according to the
374
 *                                        data type given in |translation|
375
 *                                        For OSSL_PARAM_UNSIGNED_INTEGER,
376
 *                                        if |p2| is non-NULL, then |*p2|
377
 *                                        is assigned a BIGNUM, otherwise
378
 *                                        |p1| is assigned an unsigned int.
379
 * POST_PARAMS_TO_CTRL, GET             - |p1| and |p2| are converted to
380
 *                                        an OSSL_PARAM, in the same manner
381
 *                                        as for the combination of
382
 *                                        PRE_CTRL_TO_PARAMS, SET.
383
 */
384
static int default_fixup_args(enum state state,
385
                              const struct translation_st *translation,
386
                              struct translation_ctx_st *ctx)
387
0
{
388
0
    int ret;
389
390
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
391
0
        return ret;
392
393
0
    switch (state) {
394
0
    default:
395
        /* For states this function should never have been called with */
396
0
        ERR_raise_data(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
397
0
                       "[action:%d, state:%d]", ctx->action_type, state);
398
0
        return 0;
399
400
    /*
401
     * PRE_CTRL_TO_PARAMS and POST_CTRL_TO_PARAMS handle ctrl to params
402
     * translations.  PRE_CTRL_TO_PARAMS is responsible for preparing
403
     * |*params|, and POST_CTRL_TO_PARAMS is responsible for bringing the
404
     * result back to |*p2| and the return value.
405
     */
406
0
    case PRE_CTRL_TO_PARAMS:
407
        /* This is ctrl to params translation, so we need an OSSL_PARAM key */
408
0
        if (ctx->action_type == NONE) {
409
            /*
410
             * No action type is an error here.  That's a case for a
411
             * special fixup function.
412
             */
413
0
            ERR_raise_data(ERR_LIB_EVP, ERR_R_UNSUPPORTED,
414
0
                           "[action:%d, state:%d]", ctx->action_type, state);
415
0
            return 0;
416
0
        }
417
418
0
        if (translation->optype != 0) {
419
0
            if ((EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx->pctx)
420
0
                 && ctx->pctx->op.sig.algctx == NULL)
421
0
                || (EVP_PKEY_CTX_IS_DERIVE_OP(ctx->pctx)
422
0
                    && ctx->pctx->op.kex.algctx == NULL)
423
0
                || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx->pctx)
424
0
                    && ctx->pctx->op.ciph.algctx == NULL)
425
0
                || (EVP_PKEY_CTX_IS_KEM_OP(ctx->pctx)
426
0
                    && ctx->pctx->op.encap.algctx == NULL)
427
                /*
428
                 * The following may be unnecessary, but we have them
429
                 * for good measure...
430
                 */
431
0
                || (EVP_PKEY_CTX_IS_GEN_OP(ctx->pctx)
432
0
                    && ctx->pctx->op.keymgmt.genctx == NULL)
433
0
                || (EVP_PKEY_CTX_IS_FROMDATA_OP(ctx->pctx)
434
0
                    && ctx->pctx->op.keymgmt.genctx == NULL)) {
435
0
                ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
436
                /* Uses the same return values as EVP_PKEY_CTX_ctrl */
437
0
                return -2;
438
0
            }
439
0
        }
440
441
        /*
442
         * OSSL_PARAM_construct_TYPE() works equally well for both SET and GET.
443
         */
444
0
        switch (translation->param_data_type) {
445
0
        case OSSL_PARAM_INTEGER:
446
0
            *ctx->params = OSSL_PARAM_construct_int(translation->param_key,
447
0
                                                    &ctx->p1);
448
0
            break;
449
0
        case OSSL_PARAM_UNSIGNED_INTEGER:
450
            /*
451
             * BIGNUMs are passed via |p2|.  For all ctrl's that just want
452
             * to pass a simple integer via |p1|, |p2| is expected to be
453
             * NULL.
454
             *
455
             * Note that this allocates a buffer, which the cleanup function
456
             * must deallocate.
457
             */
458
0
            if (ctx->p2 != NULL) {
459
0
                if (ctx->action_type == SET) {
460
0
                    ctx->buflen = BN_num_bytes(ctx->p2);
461
0
                    if ((ctx->allocated_buf
462
0
                         = OPENSSL_malloc(ctx->buflen)) == NULL)
463
0
                        return 0;
464
0
                    if (BN_bn2nativepad(ctx->p2,
465
0
                                         ctx->allocated_buf, ctx->buflen) < 0) {
466
0
                        OPENSSL_free(ctx->allocated_buf);
467
0
                        ctx->allocated_buf = NULL;
468
0
                        return 0;
469
0
                    }
470
0
                    *ctx->params =
471
0
                        OSSL_PARAM_construct_BN(translation->param_key,
472
0
                                                ctx->allocated_buf,
473
0
                                                ctx->buflen);
474
0
                } else {
475
                    /*
476
                     * No support for getting a BIGNUM by ctrl, this needs
477
                     * fixup_args function support.
478
                     */
479
0
                    ERR_raise_data(ERR_LIB_EVP, ERR_R_UNSUPPORTED,
480
0
                                   "[action:%d, state:%d] trying to get a "
481
0
                                   "BIGNUM via ctrl call",
482
0
                                   ctx->action_type, state);
483
0
                    return 0;
484
0
                }
485
0
            } else {
486
0
                *ctx->params =
487
0
                    OSSL_PARAM_construct_uint(translation->param_key,
488
0
                                              (unsigned int *)&ctx->p1);
489
0
            }
490
0
            break;
491
0
        case OSSL_PARAM_UTF8_STRING:
492
0
            *ctx->params =
493
0
                OSSL_PARAM_construct_utf8_string(translation->param_key,
494
0
                                                 ctx->p2, (size_t)ctx->p1);
495
0
            break;
496
0
        case OSSL_PARAM_UTF8_PTR:
497
0
            *ctx->params =
498
0
                OSSL_PARAM_construct_utf8_ptr(translation->param_key,
499
0
                                              ctx->p2, (size_t)ctx->p1);
500
0
            break;
501
0
        case OSSL_PARAM_OCTET_STRING:
502
0
            *ctx->params =
503
0
                OSSL_PARAM_construct_octet_string(translation->param_key,
504
0
                                                  ctx->p2, (size_t)ctx->p1);
505
0
            break;
506
0
        case OSSL_PARAM_OCTET_PTR:
507
0
            *ctx->params =
508
0
                OSSL_PARAM_construct_octet_ptr(translation->param_key,
509
0
                                               ctx->p2, (size_t)ctx->p1);
510
0
            break;
511
0
        }
512
0
        break;
513
0
    case POST_CTRL_TO_PARAMS:
514
        /*
515
         * Because EVP_PKEY_CTX_ctrl() returns the length of certain objects
516
         * as its return value, we need to ensure that we do it here as well,
517
         * for the OSSL_PARAM data types where this makes sense.
518
         */
519
0
        if (ctx->action_type == GET) {
520
0
            switch (translation->param_data_type) {
521
0
            case OSSL_PARAM_UTF8_STRING:
522
0
            case OSSL_PARAM_UTF8_PTR:
523
0
            case OSSL_PARAM_OCTET_STRING:
524
0
            case OSSL_PARAM_OCTET_PTR:
525
0
                ctx->p1 = (int)ctx->params[0].return_size;
526
0
                break;
527
0
            }
528
0
        }
529
0
        break;
530
531
    /*
532
     * PRE_CTRL_STR_TO_PARAMS and POST_CTRL_STR_TO_PARAMS handle ctrl_str to
533
     * params translations.  PRE_CTRL_TO_PARAMS is responsible for preparing
534
     * |*params|, and POST_CTRL_TO_PARAMS currently has nothing to do, since
535
     * there's no support for getting data via ctrl_str calls.
536
     */
537
0
    case PRE_CTRL_STR_TO_PARAMS:
538
0
        {
539
            /* This is ctrl_str to params translation */
540
0
            const char *tmp_ctrl_str = ctx->ctrl_str;
541
0
            const char *orig_ctrl_str = ctx->ctrl_str;
542
0
            const char *orig_value = ctx->p2;
543
0
            const OSSL_PARAM *settable = NULL;
544
0
            int exists = 0;
545
546
            /* Only setting is supported here */
547
0
            if (ctx->action_type != SET) {
548
0
                ERR_raise_data(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED,
549
0
                                   "[action:%d, state:%d] only setting allowed",
550
0
                                   ctx->action_type, state);
551
0
                return 0;
552
0
            }
553
554
            /*
555
             * If no translation exists, we simply pass the control string
556
             * unmodified.
557
             */
558
0
            if (translation != NULL) {
559
0
                tmp_ctrl_str = ctx->ctrl_str = translation->param_key;
560
561
0
                if (ctx->ishex) {
562
0
                    strcpy(ctx->name_buf, "hex");
563
0
                    if (OPENSSL_strlcat(ctx->name_buf, tmp_ctrl_str,
564
0
                                        sizeof(ctx->name_buf)) <= 3) {
565
0
                        ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
566
0
                        return -1;
567
0
                    }
568
0
                    tmp_ctrl_str = ctx->name_buf;
569
0
                }
570
0
            }
571
572
0
            settable = EVP_PKEY_CTX_settable_params(ctx->pctx);
573
0
            if (!OSSL_PARAM_allocate_from_text(ctx->params, settable,
574
0
                                               tmp_ctrl_str,
575
0
                                               ctx->p2, strlen(ctx->p2),
576
0
                                               &exists)) {
577
0
                if (!exists) {
578
0
                    ERR_raise_data(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED,
579
0
                                   "[action:%d, state:%d] name=%s, value=%s",
580
0
                                   ctx->action_type, state,
581
0
                                   orig_ctrl_str, orig_value);
582
0
                    return -2;
583
0
                }
584
0
                return 0;
585
0
            }
586
0
            ctx->allocated_buf = ctx->params->data;
587
0
            ctx->buflen = ctx->params->data_size;
588
0
        }
589
0
        break;
590
0
    case POST_CTRL_STR_TO_PARAMS:
591
        /* Nothing to be done */
592
0
        break;
593
594
    /*
595
     * PRE_PARAMS_TO_CTRL and POST_PARAMS_TO_CTRL handle params to ctrl
596
     * translations.  PRE_PARAMS_TO_CTRL is responsible for preparing
597
     * |p1| and |p2|, and POST_PARAMS_TO_CTRL is responsible for bringing
598
     * the EVP_PKEY_CTX_ctrl() return value (passed as |p1|) and |p2| back
599
     * to |*params|.
600
     *
601
     * PKEY is treated just like POST_PARAMS_TO_CTRL, making it easy
602
     * for the related fixup_args functions to just set |p1| and |p2|
603
     * appropriately and leave it to this section of code to fix up
604
     * |ctx->params| accordingly.
605
     */
606
0
    case PKEY:
607
0
    case POST_PARAMS_TO_CTRL:
608
0
        ret = ctx->p1;
609
        /* FALLTHRU */
610
0
    case PRE_PARAMS_TO_CTRL:
611
0
        {
612
            /* This is params to ctrl translation */
613
0
            if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET) {
614
                /* For the PRE state, only setting needs some work to be done */
615
616
                /* When setting, we populate |p1| and |p2| from |*params| */
617
0
                switch (translation->param_data_type) {
618
0
                case OSSL_PARAM_INTEGER:
619
0
                    return OSSL_PARAM_get_int(ctx->params, &ctx->p1);
620
0
                case OSSL_PARAM_UNSIGNED_INTEGER:
621
0
                    if (ctx->p2 != NULL) {
622
                        /* BIGNUM passed down with p2 */
623
0
                        if (!OSSL_PARAM_get_BN(ctx->params, ctx->p2))
624
0
                            return 0;
625
0
                    } else {
626
                        /* Normal C unsigned int passed down */
627
0
                        if (!OSSL_PARAM_get_uint(ctx->params,
628
0
                                                 (unsigned int *)&ctx->p1))
629
0
                            return 0;
630
0
                    }
631
0
                    return 1;
632
0
                case OSSL_PARAM_UTF8_STRING:
633
0
                    return OSSL_PARAM_get_utf8_string(ctx->params,
634
0
                                                      ctx->p2, ctx->sz);
635
0
                case OSSL_PARAM_OCTET_STRING:
636
0
                    return OSSL_PARAM_get_octet_string(ctx->params,
637
0
                                                       &ctx->p2, ctx->sz,
638
0
                                                       (size_t *)&ctx->p1);
639
0
                case OSSL_PARAM_OCTET_PTR:
640
0
                    return OSSL_PARAM_get_octet_ptr(ctx->params,
641
0
                                                    ctx->p2, &ctx->sz);
642
0
                default:
643
0
                    ERR_raise_data(ERR_LIB_EVP, ERR_R_UNSUPPORTED,
644
0
                                   "[action:%d, state:%d] "
645
0
                                   "unknown OSSL_PARAM data type %d",
646
0
                                   ctx->action_type, state,
647
0
                                   translation->param_data_type);
648
0
                    return 0;
649
0
                }
650
0
            } else if ((state == POST_PARAMS_TO_CTRL || state == PKEY)
651
0
                       && ctx->action_type == GET) {
652
                /* For the POST state, only getting needs some work to be done */
653
0
                unsigned int param_data_type = translation->param_data_type;
654
0
                size_t size = (size_t)ctx->p1;
655
656
0
                if (state == PKEY)
657
0
                    size = ctx->sz;
658
0
                if (param_data_type == 0) {
659
                    /* we must have a fixup_args function to work */
660
0
                    if (!ossl_assert(translation->fixup_args != NULL)) {
661
0
                        ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
662
0
                        return 0;
663
0
                    }
664
0
                    param_data_type = ctx->params->data_type;
665
0
                }
666
                /* When getting, we populate |*params| from |p1| and |p2| */
667
0
                switch (param_data_type) {
668
0
                case OSSL_PARAM_INTEGER:
669
0
                    return OSSL_PARAM_set_int(ctx->params, ctx->p1);
670
0
                case OSSL_PARAM_UNSIGNED_INTEGER:
671
0
                    if (ctx->p2 != NULL) {
672
                        /* BIGNUM passed back */
673
0
                        return OSSL_PARAM_set_BN(ctx->params, ctx->p2);
674
0
                    } else {
675
                        /* Normal C unsigned int passed back */
676
0
                        return OSSL_PARAM_set_uint(ctx->params,
677
0
                                                   (unsigned int)ctx->p1);
678
0
                    }
679
0
                    return 0;
680
0
                case OSSL_PARAM_UTF8_STRING:
681
0
                    return OSSL_PARAM_set_utf8_string(ctx->params, ctx->p2);
682
0
                case OSSL_PARAM_OCTET_STRING:
683
0
                    return OSSL_PARAM_set_octet_string(ctx->params, ctx->p2,
684
0
                                                       size);
685
0
                case OSSL_PARAM_OCTET_PTR:
686
0
                    return OSSL_PARAM_set_octet_ptr(ctx->params, *(void **)ctx->p2,
687
0
                                                    size);
688
0
                default:
689
0
                    ERR_raise_data(ERR_LIB_EVP, ERR_R_UNSUPPORTED,
690
0
                                   "[action:%d, state:%d] "
691
0
                                   "unsupported OSSL_PARAM data type %d",
692
0
                                   ctx->action_type, state,
693
0
                                   translation->param_data_type);
694
0
                    return 0;
695
0
                }
696
0
            } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == GET) {
697
0
                if (translation->param_data_type == OSSL_PARAM_OCTET_PTR)
698
0
                    ctx->p2 = &ctx->bufp;
699
0
            }
700
0
        }
701
        /* Any other combination is simply pass-through */
702
0
        break;
703
0
    }
704
0
    return ret;
705
0
}
706
707
static int
708
cleanup_translation_ctx(enum state state,
709
                        const struct translation_st *translation,
710
                        struct translation_ctx_st *ctx)
711
0
{
712
0
    if (ctx->allocated_buf != NULL)
713
0
        OPENSSL_free(ctx->allocated_buf);
714
0
    ctx->allocated_buf = NULL;
715
0
    return 1;
716
0
}
717
718
/*
719
 * fix_cipher_md fixes up an EVP_CIPHER / EVP_MD to its name on SET,
720
 * and cipher / md name to EVP_MD on GET.
721
 */
722
static const char *get_cipher_name(void *cipher)
723
0
{
724
0
    return EVP_CIPHER_get0_name(cipher);
725
0
}
726
727
static const char *get_md_name(void *md)
728
0
{
729
0
    return EVP_MD_get0_name(md);
730
0
}
731
732
static const void *get_cipher_by_name(OSSL_LIB_CTX *libctx, const char *name)
733
0
{
734
0
    return evp_get_cipherbyname_ex(libctx, name);
735
0
}
736
737
static const void *get_md_by_name(OSSL_LIB_CTX *libctx, const char *name)
738
0
{
739
0
    return evp_get_digestbyname_ex(libctx, name);
740
0
}
741
742
static int fix_cipher_md(enum state state,
743
                         const struct translation_st *translation,
744
                         struct translation_ctx_st *ctx,
745
                         const char *(*get_name)(void *algo),
746
                         const void *(*get_algo_by_name)(OSSL_LIB_CTX *libctx,
747
                                                         const char *name))
748
0
{
749
0
    int ret = 1;
750
751
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
752
0
        return ret;
753
754
0
    if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
755
        /*
756
         * |ctx->p2| contains the address to an EVP_CIPHER or EVP_MD pointer
757
         * to be filled in.  We need to remember it, then make |ctx->p2|
758
         * point at a buffer to be filled in with the name, and |ctx->p1|
759
         * with its size.  default_fixup_args() will take care of the rest
760
         * for us.
761
         */
762
0
        ctx->orig_p2 = ctx->p2;
763
0
        ctx->p2 = ctx->name_buf;
764
0
        ctx->p1 = sizeof(ctx->name_buf);
765
0
    } else if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET) {
766
        /*
767
         * In different parts of OpenSSL, this ctrl command is used
768
         * differently.  Some calls pass a NID as p1, others pass an
769
         * EVP_CIPHER pointer as p2...
770
         */
771
0
        ctx->p2 = (char *)(ctx->p2 == NULL
772
0
                           ? OBJ_nid2sn(ctx->p1)
773
0
                           : get_name(ctx->p2));
774
0
        ctx->p1 = strlen(ctx->p2);
775
0
    } else if (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET) {
776
0
        ctx->p2 = (ctx->p2 == NULL ? "" : (char *)get_name(ctx->p2));
777
0
        ctx->p1 = strlen(ctx->p2);
778
0
    }
779
780
0
    if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
781
0
        return ret;
782
783
0
    if (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET) {
784
        /*
785
         * Here's how we reuse |ctx->orig_p2| that was set in the
786
         * PRE_CTRL_TO_PARAMS state above.
787
         */
788
0
        *(void **)ctx->orig_p2 =
789
0
            (void *)get_algo_by_name(ctx->pctx->libctx, ctx->p2);
790
0
        ctx->p1 = 1;
791
0
    } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET) {
792
0
        ctx->p2 = (void *)get_algo_by_name(ctx->pctx->libctx, ctx->p2);
793
0
        ctx->p1 = 0;
794
0
    }
795
796
0
    return ret;
797
0
}
798
799
static int fix_cipher(enum state state,
800
                      const struct translation_st *translation,
801
                      struct translation_ctx_st *ctx)
802
0
{
803
0
    return fix_cipher_md(state, translation, ctx,
804
0
                         get_cipher_name, get_cipher_by_name);
805
0
}
806
807
static int fix_md(enum state state,
808
                  const struct translation_st *translation,
809
                  struct translation_ctx_st *ctx)
810
0
{
811
0
    return fix_cipher_md(state, translation, ctx,
812
0
                         get_md_name, get_md_by_name);
813
0
}
814
815
static int fix_distid_len(enum state state,
816
                          const struct translation_st *translation,
817
                          struct translation_ctx_st *ctx)
818
0
{
819
0
    int ret = default_fixup_args(state, translation, ctx);
820
821
0
    if (ret > 0) {
822
0
        ret = 0;
823
0
        if ((state == POST_CTRL_TO_PARAMS
824
0
             || state == POST_CTRL_STR_TO_PARAMS) && ctx->action_type == GET) {
825
0
            *(size_t *)ctx->p2 = ctx->sz;
826
0
            ret = 1;
827
0
        }
828
0
    }
829
0
    return ret;
830
0
}
831
832
struct kdf_type_map_st {
833
    int kdf_type_num;
834
    const char *kdf_type_str;
835
};
836
837
static int fix_kdf_type(enum state state,
838
                        const struct translation_st *translation,
839
                        struct translation_ctx_st *ctx,
840
                        const struct kdf_type_map_st *kdf_type_map)
841
0
{
842
    /*
843
     * The EVP_PKEY_CTRL_DH_KDF_TYPE ctrl command is a bit special, in
844
     * that it's used both for setting a value, and for getting it, all
845
     * depending on the value if |p1|; if |p1| is -2, the backend is
846
     * supposed to place the current kdf type in |p2|, and if not, |p1|
847
     * is interpreted as the new kdf type.
848
     */
849
0
    int ret = 0;
850
851
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
852
0
        return ret;
853
854
0
    if (state == PRE_CTRL_TO_PARAMS) {
855
        /*
856
         * In |translations|, the initial value for |ctx->action_type| must
857
         * be NONE.
858
         */
859
0
        if (!ossl_assert(ctx->action_type == NONE))
860
0
            return 0;
861
862
        /* The action type depends on the value of *p1 */
863
0
        if (ctx->p1 == -2) {
864
            /*
865
             * The OSSL_PARAMS getter needs space to store a copy of the kdf
866
             * type string.  We use |ctx->name_buf|, which has enough space
867
             * allocated.
868
             *
869
             * (this wouldn't be needed if the OSSL_xxx_PARAM_KDF_TYPE
870
             * had the data type OSSL_PARAM_UTF8_PTR)
871
             */
872
0
            ctx->p2 = ctx->name_buf;
873
0
            ctx->p1 = sizeof(ctx->name_buf);
874
0
            ctx->action_type = GET;
875
0
        } else {
876
0
            ctx->action_type = SET;
877
0
        }
878
0
    }
879
880
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
881
0
        return ret;
882
883
0
    if ((state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET)
884
0
        || (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET)) {
885
0
        ret = -2;
886
        /* Convert KDF type numbers to strings */
887
0
        for (; kdf_type_map->kdf_type_str != NULL; kdf_type_map++)
888
0
            if (ctx->p1 == kdf_type_map->kdf_type_num) {
889
0
                ctx->p2 = (char *)kdf_type_map->kdf_type_str;
890
0
                ret = 1;
891
0
                break;
892
0
            }
893
0
        if (ret <= 0)
894
0
            goto end;
895
0
        ctx->p1 = strlen(ctx->p2);
896
0
    }
897
898
0
    if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
899
0
        return ret;
900
901
0
    if ((state == POST_CTRL_TO_PARAMS && ctx->action_type == GET)
902
0
        || (state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET)) {
903
0
        ctx->p1 = ret = -1;
904
905
        /* Convert KDF type strings to numbers */
906
0
        for (; kdf_type_map->kdf_type_str != NULL; kdf_type_map++)
907
0
            if (OPENSSL_strcasecmp(ctx->p2, kdf_type_map->kdf_type_str) == 0) {
908
0
                ctx->p1 = kdf_type_map->kdf_type_num;
909
0
                ret = 1;
910
0
                break;
911
0
            }
912
0
        ctx->p2 = NULL;
913
0
    } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == GET) {
914
0
        ctx->p1 = -2;
915
0
    }
916
0
 end:
917
0
    return ret;
918
0
}
919
920
/* EVP_PKEY_CTRL_DH_KDF_TYPE */
921
static int fix_dh_kdf_type(enum state state,
922
                           const struct translation_st *translation,
923
                           struct translation_ctx_st *ctx)
924
0
{
925
0
    static const struct kdf_type_map_st kdf_type_map[] = {
926
0
        { EVP_PKEY_DH_KDF_NONE, "" },
927
0
        { EVP_PKEY_DH_KDF_X9_42, OSSL_KDF_NAME_X942KDF_ASN1 },
928
0
        { 0, NULL }
929
0
    };
930
931
0
    return fix_kdf_type(state, translation, ctx, kdf_type_map);
932
0
}
933
934
/* EVP_PKEY_CTRL_EC_KDF_TYPE */
935
static int fix_ec_kdf_type(enum state state,
936
                           const struct translation_st *translation,
937
                           struct translation_ctx_st *ctx)
938
0
{
939
0
    static const struct kdf_type_map_st kdf_type_map[] = {
940
0
        { EVP_PKEY_ECDH_KDF_NONE, "" },
941
0
        { EVP_PKEY_ECDH_KDF_X9_63, OSSL_KDF_NAME_X963KDF },
942
0
        { 0, NULL }
943
0
    };
944
945
0
    return fix_kdf_type(state, translation, ctx, kdf_type_map);
946
0
}
947
948
/* EVP_PKEY_CTRL_DH_KDF_OID, EVP_PKEY_CTRL_GET_DH_KDF_OID, ...??? */
949
static int fix_oid(enum state state,
950
                   const struct translation_st *translation,
951
                   struct translation_ctx_st *ctx)
952
0
{
953
0
    int ret;
954
955
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
956
0
        return ret;
957
958
0
    if ((state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET)
959
0
        || (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET)) {
960
        /*
961
         * We're translating from ctrl to params and setting the OID, or
962
         * we're translating from params to ctrl and getting the OID.
963
         * Either way, |ctx->p2| points at an ASN1_OBJECT, and needs to have
964
         * that replaced with the corresponding name.
965
         * default_fixup_args() will then be able to convert that to the
966
         * corresponding OSSL_PARAM.
967
         */
968
0
        OBJ_obj2txt(ctx->name_buf, sizeof(ctx->name_buf), ctx->p2, 0);
969
0
        ctx->p2 = (char *)ctx->name_buf;
970
0
        ctx->p1 = 0; /* let default_fixup_args() figure out the length */
971
0
    }
972
973
0
    if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
974
0
        return ret;
975
976
0
    if ((state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET)
977
0
        || (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET)) {
978
        /*
979
         * We're translating from ctrl to params and setting the OID name,
980
         * or we're translating from params to ctrl and getting the OID
981
         * name.  Either way, default_fixup_args() has placed the OID name
982
         * in |ctx->p2|, all we need to do now is to replace that with the
983
         * corresponding ASN1_OBJECT.
984
         */
985
0
        ctx->p2 = (ASN1_OBJECT *)OBJ_txt2obj(ctx->p2, 0);
986
0
    }
987
988
0
    return ret;
989
0
}
990
991
/* EVP_PKEY_CTRL_DH_NID */
992
static int fix_dh_nid(enum state state,
993
                      const struct translation_st *translation,
994
                      struct translation_ctx_st *ctx)
995
0
{
996
0
    int ret;
997
998
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
999
0
        return ret;
1000
1001
    /* This is only settable */
1002
0
    if (ctx->action_type != SET)
1003
0
        return 0;
1004
1005
0
    if (state == PRE_CTRL_TO_PARAMS) {
1006
0
        if ((ctx->p2 = (char *)ossl_ffc_named_group_get_name
1007
0
             (ossl_ffc_uid_to_dh_named_group(ctx->p1))) == NULL) {
1008
0
            ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_VALUE);
1009
0
            return 0;
1010
0
        }
1011
0
        ctx->p1 = 0;
1012
0
    }
1013
1014
0
    return default_fixup_args(state, translation, ctx);
1015
0
}
1016
1017
/* EVP_PKEY_CTRL_DH_RFC5114 */
1018
static int fix_dh_nid5114(enum state state,
1019
                          const struct translation_st *translation,
1020
                          struct translation_ctx_st *ctx)
1021
0
{
1022
0
    int ret;
1023
1024
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
1025
0
        return ret;
1026
1027
    /* This is only settable */
1028
0
    if (ctx->action_type != SET)
1029
0
        return 0;
1030
1031
0
    switch (state) {
1032
0
    case PRE_CTRL_TO_PARAMS:
1033
0
        if ((ctx->p2 = (char *)ossl_ffc_named_group_get_name
1034
0
             (ossl_ffc_uid_to_dh_named_group(ctx->p1))) == NULL) {
1035
0
            ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_VALUE);
1036
0
            return 0;
1037
0
        }
1038
1039
0
        ctx->p1 = 0;
1040
0
        break;
1041
1042
0
    case PRE_CTRL_STR_TO_PARAMS:
1043
0
        if (ctx->p2 == NULL)
1044
0
            return 0;
1045
0
        if ((ctx->p2 = (char *)ossl_ffc_named_group_get_name
1046
0
             (ossl_ffc_uid_to_dh_named_group(atoi(ctx->p2)))) == NULL) {
1047
0
            ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_VALUE);
1048
0
            return 0;
1049
0
        }
1050
1051
0
        ctx->p1 = 0;
1052
0
        break;
1053
1054
0
    default:
1055
0
        break;
1056
0
    }
1057
1058
0
    return default_fixup_args(state, translation, ctx);
1059
0
}
1060
1061
/* EVP_PKEY_CTRL_DH_PARAMGEN_TYPE */
1062
static int fix_dh_paramgen_type(enum state state,
1063
                                const struct translation_st *translation,
1064
                                struct translation_ctx_st *ctx)
1065
0
{
1066
0
    int ret;
1067
1068
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
1069
0
        return ret;
1070
1071
    /* This is only settable */
1072
0
    if (ctx->action_type != SET)
1073
0
        return 0;
1074
1075
0
    if (state == PRE_CTRL_STR_TO_PARAMS) {
1076
0
        if ((ctx->p2 = (char *)ossl_dh_gen_type_id2name(atoi(ctx->p2)))
1077
0
             == NULL) {
1078
0
            ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_VALUE);
1079
0
            return 0;
1080
0
        }
1081
0
        ctx->p1 = strlen(ctx->p2);
1082
0
    }
1083
1084
0
    return default_fixup_args(state, translation, ctx);
1085
0
}
1086
1087
/* EVP_PKEY_CTRL_EC_PARAM_ENC */
1088
static int fix_ec_param_enc(enum state state,
1089
                            const struct translation_st *translation,
1090
                            struct translation_ctx_st *ctx)
1091
0
{
1092
0
    int ret;
1093
1094
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
1095
0
        return ret;
1096
1097
    /* This is currently only settable */
1098
0
    if (ctx->action_type != SET)
1099
0
        return 0;
1100
1101
0
    if (state == PRE_CTRL_TO_PARAMS) {
1102
0
        switch (ctx->p1) {
1103
0
        case OPENSSL_EC_EXPLICIT_CURVE:
1104
0
            ctx->p2 = OSSL_PKEY_EC_ENCODING_EXPLICIT;
1105
0
            break;
1106
0
        case OPENSSL_EC_NAMED_CURVE:
1107
0
            ctx->p2 = OSSL_PKEY_EC_ENCODING_GROUP;
1108
0
            break;
1109
0
        default:
1110
0
            ret = -2;
1111
0
            goto end;
1112
0
        }
1113
0
        ctx->p1 = 0;
1114
0
    }
1115
1116
0
    if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1117
0
        return ret;
1118
1119
0
    if (state == PRE_PARAMS_TO_CTRL) {
1120
0
        if (strcmp(ctx->p2, OSSL_PKEY_EC_ENCODING_EXPLICIT) == 0)
1121
0
            ctx->p1 = OPENSSL_EC_EXPLICIT_CURVE;
1122
0
        else if (strcmp(ctx->p2, OSSL_PKEY_EC_ENCODING_GROUP) == 0)
1123
0
            ctx->p1 = OPENSSL_EC_NAMED_CURVE;
1124
0
        else
1125
0
            ctx->p1 = ret = -2;
1126
0
        ctx->p2 = NULL;
1127
0
    }
1128
1129
0
 end:
1130
0
    if (ret == -2)
1131
0
        ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1132
0
    return ret;
1133
0
}
1134
1135
/* EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID */
1136
static int fix_ec_paramgen_curve_nid(enum state state,
1137
                                     const struct translation_st *translation,
1138
                                     struct translation_ctx_st *ctx)
1139
0
{
1140
0
    char *p2 = NULL;
1141
0
    int ret;
1142
1143
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
1144
0
        return ret;
1145
1146
    /* This is currently only settable */
1147
0
    if (ctx->action_type != SET)
1148
0
        return 0;
1149
1150
0
    if (state == PRE_CTRL_TO_PARAMS) {
1151
0
        ctx->p2 = (char *)OBJ_nid2sn(ctx->p1);
1152
0
        ctx->p1 = 0;
1153
0
    } else if (state == PRE_PARAMS_TO_CTRL) {
1154
        /*
1155
         * We're translating from params to ctrl and setting the curve name.
1156
         * The ctrl function needs it to be a NID, but meanwhile, we need
1157
         * space to get the curve name from the param.  |ctx->name_buf| is
1158
         * sufficient for that.
1159
         * The double indirection is necessary for default_fixup_args()'s
1160
         * call of OSSL_PARAM_get_utf8_string() to be done correctly.
1161
         */
1162
0
        p2 = ctx->name_buf;
1163
0
        ctx->p2 = &p2;
1164
0
        ctx->sz = sizeof(ctx->name_buf);
1165
0
    }
1166
1167
0
    if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1168
0
        return ret;
1169
1170
0
    if (state == PRE_PARAMS_TO_CTRL) {
1171
0
        ctx->p1 = OBJ_sn2nid(p2);
1172
0
        ctx->p2 = NULL;
1173
0
    }
1174
1175
0
    return ret;
1176
0
}
1177
1178
/* EVP_PKEY_CTRL_EC_ECDH_COFACTOR */
1179
static int fix_ecdh_cofactor(enum state state,
1180
                             const struct translation_st *translation,
1181
                             struct translation_ctx_st *ctx)
1182
0
{
1183
    /*
1184
     * The EVP_PKEY_CTRL_EC_ECDH_COFACTOR ctrl command is a bit special, in
1185
     * that it's used both for setting a value, and for getting it, all
1186
     * depending on the value if |ctx->p1|; if |ctx->p1| is -2, the backend is
1187
     * supposed to place the current cofactor mode in |ctx->p2|, and if not,
1188
     * |ctx->p1| is interpreted as the new cofactor mode.
1189
     */
1190
0
    int ret = 0;
1191
1192
0
    if (state == PRE_CTRL_TO_PARAMS) {
1193
        /*
1194
         * The initial value for |ctx->action_type| must be zero.
1195
         * evp_pkey_ctrl_to_params() takes it from the translation item.
1196
         */
1197
0
        if (!ossl_assert(ctx->action_type == NONE))
1198
0
            return 0;
1199
1200
        /* The action type depends on the value of ctx->p1 */
1201
0
        if (ctx->p1 == -2)
1202
0
            ctx->action_type = GET;
1203
0
        else
1204
0
            ctx->action_type = SET;
1205
0
    } else if (state == PRE_CTRL_STR_TO_PARAMS) {
1206
0
        ctx->action_type = SET;
1207
0
    } else if (state == PRE_PARAMS_TO_CTRL) {
1208
        /* The initial value for |ctx->action_type| must not be zero. */
1209
0
        if (!ossl_assert(ctx->action_type != NONE))
1210
0
            return 0;
1211
0
    }
1212
1213
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
1214
0
        return ret;
1215
1216
0
    if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET) {
1217
0
        if (ctx->p1 < -1 || ctx->p1 > 1) {
1218
            /* Uses the same return value of pkey_ec_ctrl() */
1219
0
            return -2;
1220
0
        }
1221
0
    }
1222
1223
0
    if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1224
0
        return ret;
1225
1226
0
    if (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET) {
1227
0
        if (ctx->p1 < 0 || ctx->p1 > 1) {
1228
            /*
1229
             * The provider should return either 0 or 1, any other value is a
1230
             * provider error.
1231
             */
1232
0
            ctx->p1 = ret = -1;
1233
0
        }
1234
0
    } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == GET) {
1235
0
        ctx->p1 = -2;
1236
0
    }
1237
1238
0
    return ret;
1239
0
}
1240
1241
/* EVP_PKEY_CTRL_RSA_PADDING, EVP_PKEY_CTRL_GET_RSA_PADDING */
1242
static int fix_rsa_padding_mode(enum state state,
1243
                                const struct translation_st *translation,
1244
                                struct translation_ctx_st *ctx)
1245
0
{
1246
0
    static const OSSL_ITEM str_value_map[] = {
1247
0
        { RSA_PKCS1_PADDING,            "pkcs1"  },
1248
0
        { RSA_NO_PADDING,               "none"   },
1249
0
        { RSA_PKCS1_OAEP_PADDING,       "oaep"   },
1250
0
        { RSA_PKCS1_OAEP_PADDING,       "oeap"   },
1251
0
        { RSA_X931_PADDING,             "x931"   },
1252
0
        { RSA_PKCS1_PSS_PADDING,        "pss"    },
1253
        /* Special case, will pass directly as an integer */
1254
0
        { RSA_PKCS1_WITH_TLS_PADDING,   NULL     }
1255
0
    };
1256
0
    int ret;
1257
1258
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
1259
0
        return ret;
1260
1261
0
    if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
1262
        /*
1263
         * EVP_PKEY_CTRL_GET_RSA_PADDING returns the padding mode in the
1264
         * weirdest way for a ctrl.  Instead of doing like all other ctrls
1265
         * that return a simple, i.e. just have that as a return value,
1266
         * this particular ctrl treats p2 as the address for the int to be
1267
         * returned.  We must therefore remember |ctx->p2|, then make
1268
         * |ctx->p2| point at a buffer to be filled in with the name, and
1269
         * |ctx->p1| with its size.  default_fixup_args() will take care
1270
         * of the rest for us, along with the POST_CTRL_TO_PARAMS && GET
1271
         * code section further down.
1272
         */
1273
0
        ctx->orig_p2 = ctx->p2;
1274
0
        ctx->p2 = ctx->name_buf;
1275
0
        ctx->p1 = sizeof(ctx->name_buf);
1276
0
    } else if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET) {
1277
        /*
1278
         * Ideally, we should use utf8 strings for the diverse padding modes.
1279
         * We only came here because someone called EVP_PKEY_CTX_ctrl(),
1280
         * though, and since that can reasonably be seen as legacy code
1281
         * that uses the diverse RSA macros for the padding mode, and we
1282
         * know that at least our providers can handle the numeric modes,
1283
         * we take the cheap route for now.
1284
         *
1285
         * The other solution would be to match |ctx->p1| against entries
1286
         * in str_value_map and pass the corresponding string.  However,
1287
         * since we don't have a string for RSA_PKCS1_WITH_TLS_PADDING,
1288
         * we have to do this same hack at least for that one.
1289
         *
1290
         * Since the "official" data type for the RSA padding mode is utf8
1291
         * string, we cannot count on default_fixup_args().  Instead, we
1292
         * build the OSSL_PARAM item ourselves and return immediately.
1293
         */
1294
0
        ctx->params[0] = OSSL_PARAM_construct_int(translation->param_key,
1295
0
                                                  &ctx->p1);
1296
0
        return 1;
1297
0
    } else if (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET) {
1298
0
        size_t i;
1299
1300
        /*
1301
         * The EVP_PKEY_CTX_get_params() caller may have asked for a utf8
1302
         * string, or may have asked for an integer of some sort.  If they
1303
         * ask for an integer, we respond directly.  If not, we translate
1304
         * the response from the ctrl function into a string.
1305
         */
1306
0
        switch (ctx->params->data_type) {
1307
0
        case OSSL_PARAM_INTEGER:
1308
0
            return OSSL_PARAM_get_int(ctx->params, &ctx->p1);
1309
0
        case OSSL_PARAM_UNSIGNED_INTEGER:
1310
0
            return OSSL_PARAM_get_uint(ctx->params, (unsigned int *)&ctx->p1);
1311
0
        default:
1312
0
            break;
1313
0
        }
1314
1315
0
        for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1316
0
            if (ctx->p1 == (int)str_value_map[i].id)
1317
0
                break;
1318
0
        }
1319
0
        if (i == OSSL_NELEM(str_value_map)) {
1320
0
            ERR_raise_data(ERR_LIB_RSA, RSA_R_UNKNOWN_PADDING_TYPE,
1321
0
                           "[action:%d, state:%d] padding number %d",
1322
0
                           ctx->action_type, state, ctx->p1);
1323
0
            return -2;
1324
0
        }
1325
        /*
1326
         * If we don't have a string, we can't do anything.  The caller
1327
         * should have asked for a number...
1328
         */
1329
0
        if (str_value_map[i].ptr == NULL) {
1330
0
            ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1331
0
            return -2;
1332
0
        }
1333
0
        ctx->p2 = str_value_map[i].ptr;
1334
0
        ctx->p1 = strlen(ctx->p2);
1335
0
    }
1336
1337
0
    if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1338
0
        return ret;
1339
1340
0
    if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1341
0
        || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1342
0
        size_t i;
1343
1344
0
        for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1345
0
            if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1346
0
                break;
1347
0
        }
1348
1349
0
        if (i == OSSL_NELEM(str_value_map)) {
1350
0
            ERR_raise_data(ERR_LIB_RSA, RSA_R_UNKNOWN_PADDING_TYPE,
1351
0
                           "[action:%d, state:%d] padding name %s",
1352
0
                           ctx->action_type, state, ctx->p1);
1353
0
            ctx->p1 = ret = -2;
1354
0
        } else if (state == POST_CTRL_TO_PARAMS) {
1355
            /* EVP_PKEY_CTRL_GET_RSA_PADDING weirdness explained further up */
1356
0
            *(int *)ctx->orig_p2 = str_value_map[i].id;
1357
0
        } else {
1358
0
            ctx->p1 = str_value_map[i].id;
1359
0
        }
1360
0
        ctx->p2 = NULL;
1361
0
    }
1362
1363
0
    return ret;
1364
0
}
1365
1366
/* EVP_PKEY_CTRL_RSA_PSS_SALTLEN, EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN */
1367
static int fix_rsa_pss_saltlen(enum state state,
1368
                               const struct translation_st *translation,
1369
                               struct translation_ctx_st *ctx)
1370
0
{
1371
0
    static const OSSL_ITEM str_value_map[] = {
1372
0
        { (unsigned int)RSA_PSS_SALTLEN_DIGEST, "digest" },
1373
0
        { (unsigned int)RSA_PSS_SALTLEN_MAX,    "max"    },
1374
0
        { (unsigned int)RSA_PSS_SALTLEN_AUTO,   "auto"   }
1375
0
    };
1376
0
    int ret;
1377
1378
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
1379
0
        return ret;
1380
1381
0
    if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
1382
        /*
1383
         * EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN returns the saltlen by filling
1384
         * in the int pointed at by p2.  This is potentially as weird as
1385
         * the way EVP_PKEY_CTRL_GET_RSA_PADDING works, except that saltlen
1386
         * might be a negative value, so it wouldn't work as a legitimate
1387
         * return value.
1388
         * In any case, we must therefore remember |ctx->p2|, then make
1389
         * |ctx->p2| point at a buffer to be filled in with the name, and
1390
         * |ctx->p1| with its size.  default_fixup_args() will take care
1391
         * of the rest for us, along with the POST_CTRL_TO_PARAMS && GET
1392
         * code section further down.
1393
         */
1394
0
        ctx->orig_p2 = ctx->p2;
1395
0
        ctx->p2 = ctx->name_buf;
1396
0
        ctx->p1 = sizeof(ctx->name_buf);
1397
0
    } else if ((ctx->action_type == SET && state == PRE_CTRL_TO_PARAMS)
1398
0
        || (ctx->action_type == GET && state == POST_PARAMS_TO_CTRL)) {
1399
0
        size_t i;
1400
1401
0
        for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1402
0
            if (ctx->p1 == (int)str_value_map[i].id)
1403
0
                break;
1404
0
        }
1405
0
        if (i == OSSL_NELEM(str_value_map)) {
1406
0
            BIO_snprintf(ctx->name_buf, sizeof(ctx->name_buf), "%d", ctx->p1);
1407
0
        } else {
1408
            /* This won't truncate but it will quiet static analysers */
1409
0
            strncpy(ctx->name_buf, str_value_map[i].ptr, sizeof(ctx->name_buf) - 1);
1410
0
            ctx->name_buf[sizeof(ctx->name_buf) - 1] = '\0';
1411
0
        }
1412
0
        ctx->p2 = ctx->name_buf;
1413
0
        ctx->p1 = strlen(ctx->p2);
1414
0
    }
1415
1416
0
    if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1417
0
        return ret;
1418
1419
0
    if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1420
0
        || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1421
0
        size_t i;
1422
0
        int val;
1423
1424
0
        for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1425
0
            if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1426
0
                break;
1427
0
        }
1428
1429
0
        val = i == OSSL_NELEM(str_value_map) ? atoi(ctx->p2)
1430
0
                                             : (int)str_value_map[i].id;
1431
0
        if (state == POST_CTRL_TO_PARAMS) {
1432
            /*
1433
             * EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN weirdness explained further
1434
             * up
1435
             */
1436
0
            *(int *)ctx->orig_p2 = val;
1437
0
        } else {
1438
0
            ctx->p1 = val;
1439
0
        }
1440
0
        ctx->p2 = NULL;
1441
0
    }
1442
1443
0
    return ret;
1444
0
}
1445
1446
/* EVP_PKEY_CTRL_HKDF_MODE */
1447
static int fix_hkdf_mode(enum state state,
1448
                         const struct translation_st *translation,
1449
                         struct translation_ctx_st *ctx)
1450
0
{
1451
0
    static const OSSL_ITEM str_value_map[] = {
1452
0
        { EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND, "EXTRACT_AND_EXPAND" },
1453
0
        { EVP_KDF_HKDF_MODE_EXTRACT_ONLY,       "EXTRACT_ONLY"       },
1454
0
        { EVP_KDF_HKDF_MODE_EXPAND_ONLY,        "EXPAND_ONLY"        }
1455
0
    };
1456
0
    int ret;
1457
1458
0
    if ((ret = default_check(state, translation, ctx)) <= 0)
1459
0
        return ret;
1460
1461
0
    if ((ctx->action_type == SET && state == PRE_CTRL_TO_PARAMS)
1462
0
        || (ctx->action_type == GET && state == POST_PARAMS_TO_CTRL)) {
1463
0
        size_t i;
1464
1465
0
        for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1466
0
            if (ctx->p1 == (int)str_value_map[i].id)
1467
0
                break;
1468
0
        }
1469
0
        if (i == OSSL_NELEM(str_value_map))
1470
0
            return 0;
1471
0
        ctx->p2 = str_value_map[i].ptr;
1472
0
        ctx->p1 = strlen(ctx->p2);
1473
0
    }
1474
1475
0
    if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1476
0
        return ret;
1477
1478
0
    if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1479
0
        || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1480
0
        size_t i;
1481
1482
0
        for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1483
0
            if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1484
0
                break;
1485
0
        }
1486
0
        if (i == OSSL_NELEM(str_value_map))
1487
0
            return 0;
1488
0
        if (state == POST_CTRL_TO_PARAMS)
1489
0
            ret = str_value_map[i].id;
1490
0
        else
1491
0
            ctx->p1 = str_value_map[i].id;
1492
0
        ctx->p2 = NULL;
1493
0
    }
1494
1495
0
    return 1;
1496
0
}
1497
1498
/*-
1499
 * Payload getters
1500
 * ===============
1501
 *
1502
 * These all get the data they want, then call default_fixup_args() as
1503
 * a post-ctrl GET fixup.  They all get NULL ctx, ctrl_cmd, ctrl_str,
1504
 * p1, sz
1505
 */
1506
1507
/* Pilfering DH, DSA and EC_KEY */
1508
static int get_payload_group_name(enum state state,
1509
                                  const struct translation_st *translation,
1510
                                  struct translation_ctx_st *ctx)
1511
0
{
1512
0
    EVP_PKEY *pkey = ctx->p2;
1513
1514
0
    ctx->p2 = NULL;
1515
0
    switch (EVP_PKEY_get_base_id(pkey)) {
1516
0
#ifndef OPENSSL_NO_DH
1517
0
    case EVP_PKEY_DH:
1518
0
        {
1519
0
            const DH *dh = EVP_PKEY_get0_DH(pkey);
1520
0
            int uid = DH_get_nid(dh);
1521
1522
0
            if (uid != NID_undef) {
1523
0
                const DH_NAMED_GROUP *dh_group =
1524
0
                    ossl_ffc_uid_to_dh_named_group(uid);
1525
1526
0
                ctx->p2 = (char *)ossl_ffc_named_group_get_name(dh_group);
1527
0
            }
1528
0
        }
1529
0
        break;
1530
0
#endif
1531
0
#ifndef OPENSSL_NO_EC
1532
0
    case EVP_PKEY_EC:
1533
0
        {
1534
0
            const EC_GROUP *grp =
1535
0
                EC_KEY_get0_group(EVP_PKEY_get0_EC_KEY(pkey));
1536
0
            int nid = NID_undef;
1537
1538
0
            if (grp != NULL)
1539
0
                nid = EC_GROUP_get_curve_name(grp);
1540
0
            if (nid != NID_undef)
1541
0
                ctx->p2 = (char *)OSSL_EC_curve_nid2name(nid);
1542
0
        }
1543
0
        break;
1544
0
#endif
1545
0
    default:
1546
0
        ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1547
0
        return 0;
1548
0
    }
1549
1550
    /*
1551
     * Quietly ignoring unknown groups matches the behaviour on the provider
1552
     * side.
1553
     */
1554
0
    if (ctx->p2 == NULL)
1555
0
        return 1;
1556
1557
0
    ctx->p1 = strlen(ctx->p2);
1558
0
    return default_fixup_args(state, translation, ctx);
1559
0
}
1560
1561
static int get_payload_private_key(enum state state,
1562
                                   const struct translation_st *translation,
1563
                                   struct translation_ctx_st *ctx)
1564
0
{
1565
0
    EVP_PKEY *pkey = ctx->p2;
1566
1567
0
    ctx->p2 = NULL;
1568
0
    if (ctx->params->data_type != OSSL_PARAM_UNSIGNED_INTEGER)
1569
0
        return 0;
1570
1571
0
    switch (EVP_PKEY_get_base_id(pkey)) {
1572
0
#ifndef OPENSSL_NO_DH
1573
0
    case EVP_PKEY_DH:
1574
0
        {
1575
0
            const DH *dh = EVP_PKEY_get0_DH(pkey);
1576
1577
0
            ctx->p2 = (BIGNUM *)DH_get0_priv_key(dh);
1578
0
        }
1579
0
        break;
1580
0
#endif
1581
0
#ifndef OPENSSL_NO_EC
1582
0
    case EVP_PKEY_EC:
1583
0
        {
1584
0
            const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1585
1586
0
            ctx->p2 = (BIGNUM *)EC_KEY_get0_private_key(ec);
1587
0
        }
1588
0
        break;
1589
0
#endif
1590
0
    default:
1591
0
        ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1592
0
        return 0;
1593
0
    }
1594
1595
0
    return default_fixup_args(state, translation, ctx);
1596
0
}
1597
1598
static int get_payload_public_key(enum state state,
1599
                                  const struct translation_st *translation,
1600
                                  struct translation_ctx_st *ctx)
1601
0
{
1602
0
    EVP_PKEY *pkey = ctx->p2;
1603
0
    unsigned char *buf = NULL;
1604
0
    int ret;
1605
1606
0
    ctx->p2 = NULL;
1607
0
    switch (EVP_PKEY_get_base_id(pkey)) {
1608
0
#ifndef OPENSSL_NO_DH
1609
0
    case EVP_PKEY_DHX:
1610
0
    case EVP_PKEY_DH:
1611
0
        switch (ctx->params->data_type) {
1612
0
        case OSSL_PARAM_OCTET_STRING:
1613
0
            ctx->sz = ossl_dh_key2buf(EVP_PKEY_get0_DH(pkey), &buf, 0, 1);
1614
0
            ctx->p2 = buf;
1615
0
            break;
1616
0
        case OSSL_PARAM_UNSIGNED_INTEGER:
1617
0
            ctx->p2 = (void *)DH_get0_pub_key(EVP_PKEY_get0_DH(pkey));
1618
0
            break;
1619
0
        default:
1620
0
            return 0;
1621
0
        }
1622
0
        break;
1623
0
#endif
1624
0
#ifndef OPENSSL_NO_DSA
1625
0
    case EVP_PKEY_DSA:
1626
0
        if (ctx->params->data_type == OSSL_PARAM_UNSIGNED_INTEGER) {
1627
0
            ctx->p2 = (void *)DSA_get0_pub_key(EVP_PKEY_get0_DSA(pkey));
1628
0
            break;
1629
0
        }
1630
0
        return 0;
1631
0
#endif
1632
0
#ifndef OPENSSL_NO_EC
1633
0
    case EVP_PKEY_EC:
1634
0
        if (ctx->params->data_type == OSSL_PARAM_OCTET_STRING) {
1635
0
            const EC_KEY *eckey = EVP_PKEY_get0_EC_KEY(pkey);
1636
0
            BN_CTX *bnctx = BN_CTX_new_ex(ossl_ec_key_get_libctx(eckey));
1637
0
            const EC_GROUP *ecg = EC_KEY_get0_group(eckey);
1638
0
            const EC_POINT *point = EC_KEY_get0_public_key(eckey);
1639
1640
0
            if (bnctx == NULL)
1641
0
                return 0;
1642
0
            ctx->sz = EC_POINT_point2buf(ecg, point,
1643
0
                                         POINT_CONVERSION_COMPRESSED,
1644
0
                                         &buf, bnctx);
1645
0
            ctx->p2 = buf;
1646
0
            BN_CTX_free(bnctx);
1647
0
            break;
1648
0
        }
1649
0
        return 0;
1650
0
#endif
1651
0
    default:
1652
0
        ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1653
0
        return 0;
1654
0
    }
1655
1656
0
    ret = default_fixup_args(state, translation, ctx);
1657
0
    OPENSSL_free(buf);
1658
0
    return ret;
1659
0
}
1660
1661
static int get_payload_public_key_ec(enum state state,
1662
                                     const struct translation_st *translation,
1663
                                     struct translation_ctx_st *ctx)
1664
0
{
1665
0
#ifndef OPENSSL_NO_EC
1666
0
    EVP_PKEY *pkey = ctx->p2;
1667
0
    const EC_KEY *eckey = EVP_PKEY_get0_EC_KEY(pkey);
1668
0
    BN_CTX *bnctx;
1669
0
    const EC_POINT *point;
1670
0
    const EC_GROUP *ecg;
1671
0
    BIGNUM *x = NULL;
1672
0
    BIGNUM *y = NULL;
1673
0
    int ret = 0;
1674
1675
0
    ctx->p2 = NULL;
1676
1677
0
    if (eckey == NULL) {
1678
0
        ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1679
0
        return 0;
1680
0
    }
1681
1682
0
    bnctx = BN_CTX_new_ex(ossl_ec_key_get_libctx(eckey));
1683
0
    if (bnctx == NULL)
1684
0
        return 0;
1685
1686
0
    point = EC_KEY_get0_public_key(eckey);
1687
0
    ecg = EC_KEY_get0_group(eckey);
1688
1689
    /* Caller should have requested a BN, fail if not */
1690
0
    if (ctx->params->data_type != OSSL_PARAM_UNSIGNED_INTEGER)
1691
0
        goto out;
1692
1693
0
    x = BN_CTX_get(bnctx);
1694
0
    y = BN_CTX_get(bnctx);
1695
0
    if (y == NULL)
1696
0
        goto out;
1697
1698
0
    if (!EC_POINT_get_affine_coordinates(ecg, point, x, y, bnctx))
1699
0
        goto out;
1700
1701
0
    if (strncmp(ctx->params->key, OSSL_PKEY_PARAM_EC_PUB_X, 2) == 0)
1702
0
        ctx->p2 = x;
1703
0
    else if (strncmp(ctx->params->key, OSSL_PKEY_PARAM_EC_PUB_Y, 2) == 0)
1704
0
        ctx->p2 = y;
1705
0
    else
1706
0
        goto out;
1707
1708
    /* Return the payload */
1709
0
    ret = default_fixup_args(state, translation, ctx);
1710
0
out:
1711
0
    BN_CTX_free(bnctx);
1712
0
    return ret;
1713
#else
1714
    ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1715
    return 0;
1716
#endif
1717
0
}
1718
1719
static int get_payload_bn(enum state state,
1720
                          const struct translation_st *translation,
1721
                          struct translation_ctx_st *ctx, const BIGNUM *bn)
1722
0
{
1723
0
    if (bn == NULL)
1724
0
        return 0;
1725
0
    if (ctx->params->data_type != OSSL_PARAM_UNSIGNED_INTEGER)
1726
0
        return 0;
1727
0
    ctx->p2 = (BIGNUM *)bn;
1728
1729
0
    return default_fixup_args(state, translation, ctx);
1730
0
}
1731
1732
static int get_dh_dsa_payload_p(enum state state,
1733
                                const struct translation_st *translation,
1734
                                struct translation_ctx_st *ctx)
1735
0
{
1736
0
    const BIGNUM *bn = NULL;
1737
0
    EVP_PKEY *pkey = ctx->p2;
1738
1739
0
    switch (EVP_PKEY_get_base_id(pkey)) {
1740
0
#ifndef OPENSSL_NO_DH
1741
0
    case EVP_PKEY_DH:
1742
0
        bn = DH_get0_p(EVP_PKEY_get0_DH(pkey));
1743
0
        break;
1744
0
#endif
1745
0
#ifndef OPENSSL_NO_DSA
1746
0
    case EVP_PKEY_DSA:
1747
0
        bn = DSA_get0_p(EVP_PKEY_get0_DSA(pkey));
1748
0
        break;
1749
0
#endif
1750
0
    default:
1751
0
        ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1752
0
    }
1753
1754
0
    return get_payload_bn(state, translation, ctx, bn);
1755
0
}
1756
1757
static int get_dh_dsa_payload_q(enum state state,
1758
                                const struct translation_st *translation,
1759
                                struct translation_ctx_st *ctx)
1760
0
{
1761
0
    const BIGNUM *bn = NULL;
1762
1763
0
    switch (EVP_PKEY_get_base_id(ctx->p2)) {
1764
0
#ifndef OPENSSL_NO_DH
1765
0
    case EVP_PKEY_DH:
1766
0
        bn = DH_get0_q(EVP_PKEY_get0_DH(ctx->p2));
1767
0
        break;
1768
0
#endif
1769
0
#ifndef OPENSSL_NO_DSA
1770
0
    case EVP_PKEY_DSA:
1771
0
        bn = DSA_get0_q(EVP_PKEY_get0_DSA(ctx->p2));
1772
0
        break;
1773
0
#endif
1774
0
    }
1775
1776
0
    return get_payload_bn(state, translation, ctx, bn);
1777
0
}
1778
1779
static int get_dh_dsa_payload_g(enum state state,
1780
                                const struct translation_st *translation,
1781
                                struct translation_ctx_st *ctx)
1782
0
{
1783
0
    const BIGNUM *bn = NULL;
1784
1785
0
    switch (EVP_PKEY_get_base_id(ctx->p2)) {
1786
0
#ifndef OPENSSL_NO_DH
1787
0
    case EVP_PKEY_DH:
1788
0
        bn = DH_get0_g(EVP_PKEY_get0_DH(ctx->p2));
1789
0
        break;
1790
0
#endif
1791
0
#ifndef OPENSSL_NO_DSA
1792
0
    case EVP_PKEY_DSA:
1793
0
        bn = DSA_get0_g(EVP_PKEY_get0_DSA(ctx->p2));
1794
0
        break;
1795
0
#endif
1796
0
    }
1797
1798
0
    return get_payload_bn(state, translation, ctx, bn);
1799
0
}
1800
1801
static int get_payload_int(enum state state,
1802
                           const struct translation_st *translation,
1803
                           struct translation_ctx_st *ctx,
1804
                           const int val)
1805
0
{
1806
0
    if (ctx->params->data_type != OSSL_PARAM_INTEGER)
1807
0
        return 0;
1808
0
    ctx->p1 = val;
1809
0
    ctx->p2 = NULL;
1810
1811
0
    return default_fixup_args(state, translation, ctx);
1812
0
}
1813
1814
static int get_ec_decoded_from_explicit_params(enum state state,
1815
                                               const struct translation_st *translation,
1816
                                               struct translation_ctx_st *ctx)
1817
0
{
1818
0
    int val = 0;
1819
0
    EVP_PKEY *pkey = ctx->p2;
1820
1821
0
    switch (EVP_PKEY_base_id(pkey)) {
1822
0
#ifndef OPENSSL_NO_EC
1823
0
    case EVP_PKEY_EC:
1824
0
        val = EC_KEY_decoded_from_explicit_params(EVP_PKEY_get0_EC_KEY(pkey));
1825
0
        if (val < 0) {
1826
0
            ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
1827
0
            return 0;
1828
0
        }
1829
0
        break;
1830
0
#endif
1831
0
    default:
1832
0
        ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1833
0
        return 0;
1834
0
    }
1835
1836
0
    return get_payload_int(state, translation, ctx, val);
1837
0
}
1838
1839
static int get_rsa_payload_n(enum state state,
1840
                             const struct translation_st *translation,
1841
                             struct translation_ctx_st *ctx)
1842
0
{
1843
0
    const BIGNUM *bn = NULL;
1844
1845
0
    if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA
1846
0
        && EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA_PSS)
1847
0
        return 0;
1848
0
    bn = RSA_get0_n(EVP_PKEY_get0_RSA(ctx->p2));
1849
1850
0
    return get_payload_bn(state, translation, ctx, bn);
1851
0
}
1852
1853
static int get_rsa_payload_e(enum state state,
1854
                             const struct translation_st *translation,
1855
                             struct translation_ctx_st *ctx)
1856
0
{
1857
0
    const BIGNUM *bn = NULL;
1858
1859
0
    if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA
1860
0
        && EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA_PSS)
1861
0
        return 0;
1862
0
    bn = RSA_get0_e(EVP_PKEY_get0_RSA(ctx->p2));
1863
1864
0
    return get_payload_bn(state, translation, ctx, bn);
1865
0
}
1866
1867
static int get_rsa_payload_d(enum state state,
1868
                             const struct translation_st *translation,
1869
                             struct translation_ctx_st *ctx)
1870
0
{
1871
0
    const BIGNUM *bn = NULL;
1872
1873
0
    if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA
1874
0
        && EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA_PSS)
1875
0
        return 0;
1876
0
    bn = RSA_get0_d(EVP_PKEY_get0_RSA(ctx->p2));
1877
1878
0
    return get_payload_bn(state, translation, ctx, bn);
1879
0
}
1880
1881
static int get_rsa_payload_factor(enum state state,
1882
                                  const struct translation_st *translation,
1883
                                  struct translation_ctx_st *ctx,
1884
                                  size_t factornum)
1885
0
{
1886
0
    const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1887
0
    const BIGNUM *bn = NULL;
1888
1889
0
    switch (factornum) {
1890
0
    case 0:
1891
0
        bn = RSA_get0_p(r);
1892
0
        break;
1893
0
    case 1:
1894
0
        bn = RSA_get0_q(r);
1895
0
        break;
1896
0
    default:
1897
0
        {
1898
0
            size_t pnum = RSA_get_multi_prime_extra_count(r);
1899
0
            const BIGNUM *factors[10];
1900
1901
0
            if (factornum - 2 < pnum
1902
0
                && RSA_get0_multi_prime_factors(r, factors))
1903
0
                bn = factors[factornum - 2];
1904
0
        }
1905
0
        break;
1906
0
    }
1907
1908
0
    return get_payload_bn(state, translation, ctx, bn);
1909
0
}
1910
1911
static int get_rsa_payload_exponent(enum state state,
1912
                                    const struct translation_st *translation,
1913
                                    struct translation_ctx_st *ctx,
1914
                                    size_t exponentnum)
1915
0
{
1916
0
    const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1917
0
    const BIGNUM *bn = NULL;
1918
1919
0
    switch (exponentnum) {
1920
0
    case 0:
1921
0
        bn = RSA_get0_dmp1(r);
1922
0
        break;
1923
0
    case 1:
1924
0
        bn = RSA_get0_dmq1(r);
1925
0
        break;
1926
0
    default:
1927
0
        {
1928
0
            size_t pnum = RSA_get_multi_prime_extra_count(r);
1929
0
            const BIGNUM *exps[10], *coeffs[10];
1930
1931
0
            if (exponentnum - 2 < pnum
1932
0
                && RSA_get0_multi_prime_crt_params(r, exps, coeffs))
1933
0
                bn = exps[exponentnum - 2];
1934
0
        }
1935
0
        break;
1936
0
    }
1937
1938
0
    return get_payload_bn(state, translation, ctx, bn);
1939
0
}
1940
1941
static int get_rsa_payload_coefficient(enum state state,
1942
                                       const struct translation_st *translation,
1943
                                       struct translation_ctx_st *ctx,
1944
                                       size_t coefficientnum)
1945
0
{
1946
0
    const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1947
0
    const BIGNUM *bn = NULL;
1948
1949
0
    switch (coefficientnum) {
1950
0
    case 0:
1951
0
        bn = RSA_get0_iqmp(r);
1952
0
        break;
1953
0
    default:
1954
0
        {
1955
0
            size_t pnum = RSA_get_multi_prime_extra_count(r);
1956
0
            const BIGNUM *exps[10], *coeffs[10];
1957
1958
0
            if (coefficientnum - 1 < pnum
1959
0
                && RSA_get0_multi_prime_crt_params(r, exps, coeffs))
1960
0
                bn = coeffs[coefficientnum - 1];
1961
0
        }
1962
0
        break;
1963
0
    }
1964
1965
0
    return get_payload_bn(state, translation, ctx, bn);
1966
0
}
1967
1968
#define IMPL_GET_RSA_PAYLOAD_FACTOR(n)                                  \
1969
    static int                                                          \
1970
    get_rsa_payload_f##n(enum state state,                              \
1971
                         const struct translation_st *translation,      \
1972
                         struct translation_ctx_st *ctx)                \
1973
0
    {                                                                   \
1974
0
        if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA               \
1975
0
            && EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA_PSS)       \
1976
0
            return 0;                                                   \
1977
0
        return get_rsa_payload_factor(state, translation, ctx, n - 1);  \
1978
0
    }
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_f1
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_f2
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_f3
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_f4
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_f5
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_f6
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_f7
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_f8
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_f9
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_f10
1979
1980
#define IMPL_GET_RSA_PAYLOAD_EXPONENT(n)                                \
1981
    static int                                                          \
1982
    get_rsa_payload_e##n(enum state state,                              \
1983
                         const struct translation_st *translation,      \
1984
                         struct translation_ctx_st *ctx)                \
1985
0
    {                                                                   \
1986
0
        if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA               \
1987
0
            && EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA_PSS)       \
1988
0
            return 0;                                                   \
1989
0
        return get_rsa_payload_exponent(state, translation, ctx,        \
1990
0
                                        n - 1);                         \
1991
0
    }
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_e1
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_e2
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_e3
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_e4
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_e5
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_e6
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_e7
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_e8
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_e9
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_e10
1992
1993
#define IMPL_GET_RSA_PAYLOAD_COEFFICIENT(n)                             \
1994
    static int                                                          \
1995
    get_rsa_payload_c##n(enum state state,                              \
1996
                         const struct translation_st *translation,      \
1997
                         struct translation_ctx_st *ctx)                \
1998
0
    {                                                                   \
1999
0
        if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA               \
2000
0
            && EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA_PSS)       \
2001
0
            return 0;                                                   \
2002
0
        return get_rsa_payload_coefficient(state, translation, ctx,     \
2003
0
                                           n - 1);                      \
2004
0
    }
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_c1
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_c2
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_c3
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_c4
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_c5
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_c6
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_c7
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_c8
Unexecuted instantiation: ctrl_params_translate.c:get_rsa_payload_c9
2005
2006
IMPL_GET_RSA_PAYLOAD_FACTOR(1)
2007
IMPL_GET_RSA_PAYLOAD_FACTOR(2)
2008
IMPL_GET_RSA_PAYLOAD_FACTOR(3)
2009
IMPL_GET_RSA_PAYLOAD_FACTOR(4)
2010
IMPL_GET_RSA_PAYLOAD_FACTOR(5)
2011
IMPL_GET_RSA_PAYLOAD_FACTOR(6)
2012
IMPL_GET_RSA_PAYLOAD_FACTOR(7)
2013
IMPL_GET_RSA_PAYLOAD_FACTOR(8)
2014
IMPL_GET_RSA_PAYLOAD_FACTOR(9)
2015
IMPL_GET_RSA_PAYLOAD_FACTOR(10)
2016
IMPL_GET_RSA_PAYLOAD_EXPONENT(1)
2017
IMPL_GET_RSA_PAYLOAD_EXPONENT(2)
2018
IMPL_GET_RSA_PAYLOAD_EXPONENT(3)
2019
IMPL_GET_RSA_PAYLOAD_EXPONENT(4)
2020
IMPL_GET_RSA_PAYLOAD_EXPONENT(5)
2021
IMPL_GET_RSA_PAYLOAD_EXPONENT(6)
2022
IMPL_GET_RSA_PAYLOAD_EXPONENT(7)
2023
IMPL_GET_RSA_PAYLOAD_EXPONENT(8)
2024
IMPL_GET_RSA_PAYLOAD_EXPONENT(9)
2025
IMPL_GET_RSA_PAYLOAD_EXPONENT(10)
2026
IMPL_GET_RSA_PAYLOAD_COEFFICIENT(1)
2027
IMPL_GET_RSA_PAYLOAD_COEFFICIENT(2)
2028
IMPL_GET_RSA_PAYLOAD_COEFFICIENT(3)
2029
IMPL_GET_RSA_PAYLOAD_COEFFICIENT(4)
2030
IMPL_GET_RSA_PAYLOAD_COEFFICIENT(5)
2031
IMPL_GET_RSA_PAYLOAD_COEFFICIENT(6)
2032
IMPL_GET_RSA_PAYLOAD_COEFFICIENT(7)
2033
IMPL_GET_RSA_PAYLOAD_COEFFICIENT(8)
2034
IMPL_GET_RSA_PAYLOAD_COEFFICIENT(9)
2035
2036
static int fix_group_ecx(enum state state,
2037
                         const struct translation_st *translation,
2038
                         struct translation_ctx_st *ctx)
2039
0
{
2040
0
    const char *value = NULL;
2041
2042
0
    switch (state) {
2043
0
    case PRE_PARAMS_TO_CTRL:
2044
0
        if (!EVP_PKEY_CTX_IS_GEN_OP(ctx->pctx))
2045
0
            return 0;
2046
0
        ctx->action_type = NONE;
2047
0
        return 1;
2048
0
    case POST_PARAMS_TO_CTRL:
2049
0
        if (OSSL_PARAM_get_utf8_string_ptr(ctx->params, &value) == 0 ||
2050
0
            OPENSSL_strcasecmp(ctx->pctx->keytype, value) != 0) {
2051
0
            ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_INVALID_ARGUMENT);
2052
0
            ctx->p1 = 0;
2053
0
            return 0;
2054
0
        }
2055
0
        ctx->p1 = 1;
2056
0
        return 1;
2057
0
    default:
2058
0
        return 0;
2059
0
    }
2060
0
}
2061
2062
/*-
2063
 * The translation table itself
2064
 * ============================
2065
 */
2066
2067
static const struct translation_st evp_pkey_ctx_translations[] = {
2068
    /*
2069
     * DistID: we pass it to the backend as an octet string,
2070
     * but get it back as a pointer to an octet string.
2071
     *
2072
     * Note that the EVP_PKEY_CTRL_GET1_ID_LEN is purely for legacy purposes
2073
     * that has no separate counterpart in OSSL_PARAM terms, since we get
2074
     * the length of the DistID automatically when getting the DistID itself.
2075
     */
2076
    { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2077
      EVP_PKEY_CTRL_SET1_ID, "distid", "hexdistid",
2078
      OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_STRING, NULL },
2079
    { GET, -1, -1, -1,
2080
      EVP_PKEY_CTRL_GET1_ID, "distid", "hexdistid",
2081
      OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_PTR, NULL },
2082
    { GET, -1, -1, -1,
2083
      EVP_PKEY_CTRL_GET1_ID_LEN, NULL, NULL,
2084
      OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_PTR, fix_distid_len },
2085
2086
    /*-
2087
     * DH & DHX
2088
     * ========
2089
     */
2090
2091
    /*
2092
     * EVP_PKEY_CTRL_DH_KDF_TYPE is used both for setting and getting.  The
2093
     * fixup function has to handle this...
2094
     */
2095
    { NONE, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
2096
      EVP_PKEY_CTRL_DH_KDF_TYPE, NULL, NULL,
2097
      OSSL_EXCHANGE_PARAM_KDF_TYPE, OSSL_PARAM_UTF8_STRING,
2098
      fix_dh_kdf_type },
2099
    { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
2100
      EVP_PKEY_CTRL_DH_KDF_MD, NULL, NULL,
2101
      OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2102
    { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
2103
      EVP_PKEY_CTRL_GET_DH_KDF_MD, NULL, NULL,
2104
      OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2105
    { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
2106
      EVP_PKEY_CTRL_DH_KDF_OUTLEN, NULL, NULL,
2107
      OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2108
    { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
2109
      EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, NULL, NULL,
2110
      OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2111
    { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
2112
      EVP_PKEY_CTRL_DH_KDF_UKM, NULL, NULL,
2113
      OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_STRING, NULL },
2114
    { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
2115
      EVP_PKEY_CTRL_GET_DH_KDF_UKM, NULL, NULL,
2116
      OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_PTR, NULL },
2117
    { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
2118
      EVP_PKEY_CTRL_DH_KDF_OID, NULL, NULL,
2119
      OSSL_KDF_PARAM_CEK_ALG, OSSL_PARAM_UTF8_STRING, fix_oid },
2120
    { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
2121
      EVP_PKEY_CTRL_GET_DH_KDF_OID, NULL, NULL,
2122
      OSSL_KDF_PARAM_CEK_ALG, OSSL_PARAM_UTF8_STRING, fix_oid },
2123
2124
    /* DHX Keygen Parameters that are shared with DH */
2125
    { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_PARAMGEN,
2126
      EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, "dh_paramgen_type", NULL,
2127
      OSSL_PKEY_PARAM_FFC_TYPE, OSSL_PARAM_UTF8_STRING, fix_dh_paramgen_type },
2128
    { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_PARAMGEN,
2129
      EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, "dh_paramgen_prime_len", NULL,
2130
      OSSL_PKEY_PARAM_FFC_PBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2131
    { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_PARAMGEN  | EVP_PKEY_OP_KEYGEN,
2132
      EVP_PKEY_CTRL_DH_NID, "dh_param", NULL,
2133
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, NULL },
2134
    { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_PARAMGEN  | EVP_PKEY_OP_KEYGEN,
2135
      EVP_PKEY_CTRL_DH_RFC5114, "dh_rfc5114", NULL,
2136
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_dh_nid5114 },
2137
2138
    /* DH Keygen Parameters that are shared with DHX */
2139
    { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
2140
      EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, "dh_paramgen_type", NULL,
2141
      OSSL_PKEY_PARAM_FFC_TYPE, OSSL_PARAM_UTF8_STRING, fix_dh_paramgen_type },
2142
    { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
2143
      EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, "dh_paramgen_prime_len", NULL,
2144
      OSSL_PKEY_PARAM_FFC_PBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2145
    { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
2146
      EVP_PKEY_CTRL_DH_NID, "dh_param", NULL,
2147
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_dh_nid },
2148
    { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN  | EVP_PKEY_OP_KEYGEN,
2149
      EVP_PKEY_CTRL_DH_RFC5114, "dh_rfc5114", NULL,
2150
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_dh_nid5114 },
2151
2152
    /* DH specific Keygen Parameters */
2153
    { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
2154
      EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, "dh_paramgen_generator", NULL,
2155
      OSSL_PKEY_PARAM_DH_GENERATOR, OSSL_PARAM_INTEGER, NULL },
2156
2157
    /* DHX specific Keygen Parameters */
2158
    { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_PARAMGEN,
2159
      EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, "dh_paramgen_subprime_len", NULL,
2160
      OSSL_PKEY_PARAM_FFC_QBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2161
2162
    { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_DERIVE,
2163
      EVP_PKEY_CTRL_DH_PAD, "dh_pad", NULL,
2164
      OSSL_EXCHANGE_PARAM_PAD, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2165
2166
    /*-
2167
     * DSA
2168
     * ===
2169
     */
2170
    { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
2171
      EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, "dsa_paramgen_bits", NULL,
2172
      OSSL_PKEY_PARAM_FFC_PBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2173
    { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
2174
      EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS, "dsa_paramgen_q_bits", NULL,
2175
      OSSL_PKEY_PARAM_FFC_QBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2176
    { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
2177
      EVP_PKEY_CTRL_DSA_PARAMGEN_MD, "dsa_paramgen_md", NULL,
2178
      OSSL_PKEY_PARAM_FFC_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2179
2180
    /*-
2181
     * EC
2182
     * ==
2183
     */
2184
    { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
2185
      EVP_PKEY_CTRL_EC_PARAM_ENC, "ec_param_enc", NULL,
2186
      OSSL_PKEY_PARAM_EC_ENCODING, OSSL_PARAM_UTF8_STRING, fix_ec_param_enc },
2187
    { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
2188
      EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, "ec_paramgen_curve", NULL,
2189
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING,
2190
      fix_ec_paramgen_curve_nid },
2191
    /*
2192
     * EVP_PKEY_CTRL_EC_ECDH_COFACTOR and EVP_PKEY_CTRL_EC_KDF_TYPE are used
2193
     * both for setting and getting.  The fixup function has to handle this...
2194
     */
2195
    { NONE, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2196
      EVP_PKEY_CTRL_EC_ECDH_COFACTOR, "ecdh_cofactor_mode", NULL,
2197
      OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE, OSSL_PARAM_INTEGER,
2198
      fix_ecdh_cofactor },
2199
    { NONE, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2200
      EVP_PKEY_CTRL_EC_KDF_TYPE, NULL, NULL,
2201
      OSSL_EXCHANGE_PARAM_KDF_TYPE, OSSL_PARAM_UTF8_STRING, fix_ec_kdf_type },
2202
    { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2203
      EVP_PKEY_CTRL_EC_KDF_MD, "ecdh_kdf_md", NULL,
2204
      OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2205
    { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2206
      EVP_PKEY_CTRL_GET_EC_KDF_MD, NULL, NULL,
2207
      OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2208
    { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2209
      EVP_PKEY_CTRL_EC_KDF_OUTLEN, NULL, NULL,
2210
      OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2211
    { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2212
      EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN, NULL, NULL,
2213
      OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2214
    { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2215
      EVP_PKEY_CTRL_EC_KDF_UKM, NULL, NULL,
2216
      OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_STRING, NULL },
2217
    { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2218
      EVP_PKEY_CTRL_GET_EC_KDF_UKM, NULL, NULL,
2219
      OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_PTR, NULL },
2220
2221
    /*-
2222
     * SM2
2223
     * ==
2224
     */
2225
    { SET, EVP_PKEY_SM2, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
2226
      EVP_PKEY_CTRL_EC_PARAM_ENC, "ec_param_enc", NULL,
2227
      OSSL_PKEY_PARAM_EC_ENCODING, OSSL_PARAM_UTF8_STRING, fix_ec_param_enc },
2228
    { SET, EVP_PKEY_SM2, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
2229
      EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, "ec_paramgen_curve", NULL,
2230
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING,
2231
      fix_ec_paramgen_curve_nid },
2232
    /*
2233
     * EVP_PKEY_CTRL_EC_ECDH_COFACTOR and EVP_PKEY_CTRL_EC_KDF_TYPE are used
2234
     * both for setting and getting.  The fixup function has to handle this...
2235
     */
2236
    { NONE, EVP_PKEY_SM2, 0, EVP_PKEY_OP_DERIVE,
2237
      EVP_PKEY_CTRL_EC_ECDH_COFACTOR, "ecdh_cofactor_mode", NULL,
2238
      OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE, OSSL_PARAM_INTEGER,
2239
      fix_ecdh_cofactor },
2240
    { NONE, EVP_PKEY_SM2, 0, EVP_PKEY_OP_DERIVE,
2241
      EVP_PKEY_CTRL_EC_KDF_TYPE, NULL, NULL,
2242
      OSSL_EXCHANGE_PARAM_KDF_TYPE, OSSL_PARAM_UTF8_STRING, fix_ec_kdf_type },
2243
    { SET, EVP_PKEY_SM2, 0, EVP_PKEY_OP_DERIVE,
2244
      EVP_PKEY_CTRL_EC_KDF_MD, "ecdh_kdf_md", NULL,
2245
      OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2246
    { GET, EVP_PKEY_SM2, 0, EVP_PKEY_OP_DERIVE,
2247
      EVP_PKEY_CTRL_GET_EC_KDF_MD, NULL, NULL,
2248
      OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2249
    { SET, EVP_PKEY_SM2, 0, EVP_PKEY_OP_DERIVE,
2250
      EVP_PKEY_CTRL_EC_KDF_OUTLEN, NULL, NULL,
2251
      OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2252
    { GET, EVP_PKEY_SM2, 0, EVP_PKEY_OP_DERIVE,
2253
      EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN, NULL, NULL,
2254
      OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2255
    { SET, EVP_PKEY_SM2, 0, EVP_PKEY_OP_DERIVE,
2256
      EVP_PKEY_CTRL_EC_KDF_UKM, NULL, NULL,
2257
      OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_STRING, NULL },
2258
    { GET, EVP_PKEY_SM2, 0, EVP_PKEY_OP_DERIVE,
2259
      EVP_PKEY_CTRL_GET_EC_KDF_UKM, NULL, NULL,
2260
      OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_PTR, NULL },
2261
    /*-
2262
     * RSA
2263
     * ===
2264
     */
2265
2266
    /*
2267
     * RSA padding modes are numeric with ctrls, strings with ctrl_strs,
2268
     * and can be both with OSSL_PARAM.  We standardise on strings here,
2269
     * fix_rsa_padding_mode() does the work when the caller has a different
2270
     * idea.
2271
     */
2272
    { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2273
      EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2274
      EVP_PKEY_CTRL_RSA_PADDING, "rsa_padding_mode", NULL,
2275
      OSSL_PKEY_PARAM_PAD_MODE, OSSL_PARAM_UTF8_STRING, fix_rsa_padding_mode },
2276
    { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2277
      EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2278
      EVP_PKEY_CTRL_GET_RSA_PADDING, NULL, NULL,
2279
      OSSL_PKEY_PARAM_PAD_MODE, OSSL_PARAM_UTF8_STRING, fix_rsa_padding_mode },
2280
2281
    { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2282
      EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2283
      EVP_PKEY_CTRL_RSA_MGF1_MD, "rsa_mgf1_md", NULL,
2284
      OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2285
    { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2286
      EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2287
      EVP_PKEY_CTRL_GET_RSA_MGF1_MD, NULL, NULL,
2288
      OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2289
2290
    /*
2291
     * RSA-PSS saltlen is essentially numeric, but certain values can be
2292
     * expressed as keywords (strings) with ctrl_str.  The corresponding
2293
     * OSSL_PARAM allows both forms.
2294
     * fix_rsa_pss_saltlen() takes care of the distinction.
2295
     */
2296
    { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_TYPE_SIG,
2297
      EVP_PKEY_CTRL_RSA_PSS_SALTLEN, "rsa_pss_saltlen", NULL,
2298
      OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, OSSL_PARAM_UTF8_STRING,
2299
      fix_rsa_pss_saltlen },
2300
    { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_TYPE_SIG,
2301
      EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN, NULL, NULL,
2302
      OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, OSSL_PARAM_UTF8_STRING,
2303
      fix_rsa_pss_saltlen },
2304
2305
    { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2306
      EVP_PKEY_CTRL_RSA_OAEP_MD, "rsa_oaep_md", NULL,
2307
      OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2308
    { GET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2309
      EVP_PKEY_CTRL_GET_RSA_OAEP_MD, NULL, NULL,
2310
      OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2311
    /*
2312
     * The "rsa_oaep_label" ctrl_str expects the value to always be hex.
2313
     * This is accommodated by default_fixup_args() above, which mimics that
2314
     * expectation for any translation item where |ctrl_str| is NULL and
2315
     * |ctrl_hexstr| is non-NULL.
2316
     */
2317
    { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2318
      EVP_PKEY_CTRL_RSA_OAEP_LABEL, NULL, "rsa_oaep_label",
2319
      OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_STRING, NULL },
2320
    { GET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2321
      EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL, NULL, NULL,
2322
      OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_PTR, NULL },
2323
2324
    { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2325
      EVP_PKEY_CTRL_RSA_IMPLICIT_REJECTION, NULL,
2326
      "rsa_pkcs1_implicit_rejection",
2327
      OSSL_ASYM_CIPHER_PARAM_IMPLICIT_REJECTION, OSSL_PARAM_UNSIGNED_INTEGER,
2328
      NULL },
2329
2330
    { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2331
      EVP_PKEY_CTRL_MD, "rsa_pss_keygen_md", NULL,
2332
      OSSL_ALG_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2333
    { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2334
      EVP_PKEY_CTRL_RSA_MGF1_MD, "rsa_pss_keygen_mgf1_md", NULL,
2335
      OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2336
    { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2337
      EVP_PKEY_CTRL_RSA_PSS_SALTLEN, "rsa_pss_keygen_saltlen", NULL,
2338
      OSSL_SIGNATURE_PARAM_PSS_SALTLEN, OSSL_PARAM_INTEGER, NULL },
2339
    { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_KEYGEN,
2340
      EVP_PKEY_CTRL_RSA_KEYGEN_BITS, "rsa_keygen_bits", NULL,
2341
      OSSL_PKEY_PARAM_RSA_BITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2342
    { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_KEYGEN,
2343
      EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP, "rsa_keygen_pubexp", NULL,
2344
      OSSL_PKEY_PARAM_RSA_E, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2345
    { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_KEYGEN,
2346
      EVP_PKEY_CTRL_RSA_KEYGEN_PRIMES, "rsa_keygen_primes", NULL,
2347
      OSSL_PKEY_PARAM_RSA_PRIMES, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2348
2349
    /*-
2350
     * SipHash
2351
     * ======
2352
     */
2353
    { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2354
      EVP_PKEY_CTRL_SET_DIGEST_SIZE, "digestsize", NULL,
2355
      OSSL_MAC_PARAM_SIZE, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2356
2357
    /*-
2358
     * TLS1-PRF
2359
     * ========
2360
     */
2361
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2362
      EVP_PKEY_CTRL_TLS_MD, "md", NULL,
2363
      OSSL_KDF_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2364
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2365
      EVP_PKEY_CTRL_TLS_SECRET, "secret", "hexsecret",
2366
      OSSL_KDF_PARAM_SECRET, OSSL_PARAM_OCTET_STRING, NULL },
2367
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2368
      EVP_PKEY_CTRL_TLS_SEED, "seed", "hexseed",
2369
      OSSL_KDF_PARAM_SEED, OSSL_PARAM_OCTET_STRING, NULL },
2370
2371
    /*-
2372
     * HKDF
2373
     * ====
2374
     */
2375
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2376
      EVP_PKEY_CTRL_HKDF_MD, "md", NULL,
2377
      OSSL_KDF_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2378
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2379
      EVP_PKEY_CTRL_HKDF_SALT, "salt", "hexsalt",
2380
      OSSL_KDF_PARAM_SALT, OSSL_PARAM_OCTET_STRING, NULL },
2381
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2382
      EVP_PKEY_CTRL_HKDF_KEY, "key", "hexkey",
2383
      OSSL_KDF_PARAM_KEY, OSSL_PARAM_OCTET_STRING, NULL },
2384
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2385
      EVP_PKEY_CTRL_HKDF_INFO, "info", "hexinfo",
2386
      OSSL_KDF_PARAM_INFO, OSSL_PARAM_OCTET_STRING, NULL },
2387
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2388
      EVP_PKEY_CTRL_HKDF_MODE, "mode", NULL,
2389
      OSSL_KDF_PARAM_MODE, OSSL_PARAM_INTEGER, fix_hkdf_mode },
2390
2391
    /*-
2392
     * Scrypt
2393
     * ======
2394
     */
2395
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2396
      EVP_PKEY_CTRL_PASS, "pass", "hexpass",
2397
      OSSL_KDF_PARAM_PASSWORD, OSSL_PARAM_OCTET_STRING, NULL },
2398
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2399
      EVP_PKEY_CTRL_SCRYPT_SALT, "salt", "hexsalt",
2400
      OSSL_KDF_PARAM_SALT, OSSL_PARAM_OCTET_STRING, NULL },
2401
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2402
      EVP_PKEY_CTRL_SCRYPT_N, "N", NULL,
2403
      OSSL_KDF_PARAM_SCRYPT_N, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2404
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2405
      EVP_PKEY_CTRL_SCRYPT_R, "r", NULL,
2406
      OSSL_KDF_PARAM_SCRYPT_R, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2407
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2408
      EVP_PKEY_CTRL_SCRYPT_P, "p", NULL,
2409
      OSSL_KDF_PARAM_SCRYPT_P, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2410
    { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2411
      EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES, "maxmem_bytes", NULL,
2412
      OSSL_KDF_PARAM_SCRYPT_MAXMEM, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2413
2414
    { SET, -1, -1, EVP_PKEY_OP_KEYGEN | EVP_PKEY_OP_TYPE_CRYPT,
2415
      EVP_PKEY_CTRL_CIPHER, NULL, NULL,
2416
      OSSL_PKEY_PARAM_CIPHER, OSSL_PARAM_UTF8_STRING, fix_cipher },
2417
    { SET, -1, -1, EVP_PKEY_OP_KEYGEN,
2418
      EVP_PKEY_CTRL_SET_MAC_KEY, "key", "hexkey",
2419
      OSSL_PKEY_PARAM_PRIV_KEY, OSSL_PARAM_OCTET_STRING, NULL },
2420
2421
    { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2422
      EVP_PKEY_CTRL_MD, NULL, NULL,
2423
      OSSL_SIGNATURE_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2424
    { GET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2425
      EVP_PKEY_CTRL_GET_MD, NULL, NULL,
2426
      OSSL_SIGNATURE_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2427
2428
    /*-
2429
     * ECX
2430
     * ===
2431
     */
2432
    { SET, EVP_PKEY_X25519, EVP_PKEY_X25519, EVP_PKEY_OP_KEYGEN, -1, NULL, NULL,
2433
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_group_ecx },
2434
    { SET, EVP_PKEY_X25519, EVP_PKEY_X25519, EVP_PKEY_OP_PARAMGEN, -1, NULL, NULL,
2435
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_group_ecx },
2436
    { SET, EVP_PKEY_X448, EVP_PKEY_X448, EVP_PKEY_OP_KEYGEN, -1, NULL, NULL,
2437
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_group_ecx },
2438
    { SET, EVP_PKEY_X448, EVP_PKEY_X448, EVP_PKEY_OP_PARAMGEN, -1, NULL, NULL,
2439
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_group_ecx },
2440
};
2441
2442
static const struct translation_st evp_pkey_translations[] = {
2443
    /*
2444
     * The following contain no ctrls, they are exclusively here to extract
2445
     * key payloads from legacy keys, using OSSL_PARAMs, and rely entirely
2446
     * on |fixup_args| to pass the actual data.  The |fixup_args| should
2447
     * expect to get the EVP_PKEY pointer through |ctx->p2|.
2448
     */
2449
2450
    /* DH, DSA & EC */
2451
    { GET, -1, -1, -1, 0, NULL, NULL,
2452
      OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING,
2453
      get_payload_group_name },
2454
    { GET, -1, -1, -1, 0, NULL, NULL,
2455
      OSSL_PKEY_PARAM_PRIV_KEY, OSSL_PARAM_UNSIGNED_INTEGER,
2456
      get_payload_private_key },
2457
    { GET, -1, -1, -1, 0, NULL, NULL,
2458
      OSSL_PKEY_PARAM_PUB_KEY,
2459
      0 /* no data type, let get_payload_public_key() handle that */,
2460
      get_payload_public_key },
2461
    { GET, -1, -1, -1, 0, NULL, NULL,
2462
        OSSL_PKEY_PARAM_EC_PUB_X, OSSL_PARAM_UNSIGNED_INTEGER,
2463
        get_payload_public_key_ec },
2464
    { GET, -1, -1, -1, 0, NULL, NULL,
2465
        OSSL_PKEY_PARAM_EC_PUB_Y, OSSL_PARAM_UNSIGNED_INTEGER,
2466
        get_payload_public_key_ec },
2467
2468
    /* DH and DSA */
2469
    { GET, -1, -1, -1, 0, NULL, NULL,
2470
      OSSL_PKEY_PARAM_FFC_P, OSSL_PARAM_UNSIGNED_INTEGER,
2471
      get_dh_dsa_payload_p },
2472
    { GET, -1, -1, -1, 0, NULL, NULL,
2473
      OSSL_PKEY_PARAM_FFC_G, OSSL_PARAM_UNSIGNED_INTEGER,
2474
      get_dh_dsa_payload_g },
2475
    { GET, -1, -1, -1, 0, NULL, NULL,
2476
      OSSL_PKEY_PARAM_FFC_Q, OSSL_PARAM_UNSIGNED_INTEGER,
2477
      get_dh_dsa_payload_q },
2478
2479
    /* RSA */
2480
    { GET, -1, -1, -1, 0, NULL, NULL,
2481
      OSSL_PKEY_PARAM_RSA_N, OSSL_PARAM_UNSIGNED_INTEGER,
2482
      get_rsa_payload_n },
2483
    { GET, -1, -1, -1, 0, NULL, NULL,
2484
      OSSL_PKEY_PARAM_RSA_E, OSSL_PARAM_UNSIGNED_INTEGER,
2485
      get_rsa_payload_e },
2486
    { GET, -1, -1, -1, 0, NULL, NULL,
2487
      OSSL_PKEY_PARAM_RSA_D, OSSL_PARAM_UNSIGNED_INTEGER,
2488
      get_rsa_payload_d },
2489
    { GET, -1, -1, -1, 0, NULL, NULL,
2490
      OSSL_PKEY_PARAM_RSA_FACTOR1, OSSL_PARAM_UNSIGNED_INTEGER,
2491
      get_rsa_payload_f1 },
2492
    { GET, -1, -1, -1, 0, NULL, NULL,
2493
      OSSL_PKEY_PARAM_RSA_FACTOR2, OSSL_PARAM_UNSIGNED_INTEGER,
2494
      get_rsa_payload_f2 },
2495
    { GET, -1, -1, -1, 0, NULL, NULL,
2496
      OSSL_PKEY_PARAM_RSA_FACTOR3, OSSL_PARAM_UNSIGNED_INTEGER,
2497
      get_rsa_payload_f3 },
2498
    { GET, -1, -1, -1, 0, NULL, NULL,
2499
      OSSL_PKEY_PARAM_RSA_FACTOR4, OSSL_PARAM_UNSIGNED_INTEGER,
2500
      get_rsa_payload_f4 },
2501
    { GET, -1, -1, -1, 0, NULL, NULL,
2502
      OSSL_PKEY_PARAM_RSA_FACTOR5, OSSL_PARAM_UNSIGNED_INTEGER,
2503
      get_rsa_payload_f5 },
2504
    { GET, -1, -1, -1, 0, NULL, NULL,
2505
      OSSL_PKEY_PARAM_RSA_FACTOR6, OSSL_PARAM_UNSIGNED_INTEGER,
2506
      get_rsa_payload_f6 },
2507
    { GET, -1, -1, -1, 0, NULL, NULL,
2508
      OSSL_PKEY_PARAM_RSA_FACTOR7, OSSL_PARAM_UNSIGNED_INTEGER,
2509
      get_rsa_payload_f7 },
2510
    { GET, -1, -1, -1, 0, NULL, NULL,
2511
      OSSL_PKEY_PARAM_RSA_FACTOR8, OSSL_PARAM_UNSIGNED_INTEGER,
2512
      get_rsa_payload_f8 },
2513
    { GET, -1, -1, -1, 0, NULL, NULL,
2514
      OSSL_PKEY_PARAM_RSA_FACTOR9, OSSL_PARAM_UNSIGNED_INTEGER,
2515
      get_rsa_payload_f9 },
2516
    { GET, -1, -1, -1, 0, NULL, NULL,
2517
      OSSL_PKEY_PARAM_RSA_FACTOR10, OSSL_PARAM_UNSIGNED_INTEGER,
2518
      get_rsa_payload_f10 },
2519
    { GET, -1, -1, -1, 0, NULL, NULL,
2520
      OSSL_PKEY_PARAM_RSA_EXPONENT1, OSSL_PARAM_UNSIGNED_INTEGER,
2521
      get_rsa_payload_e1 },
2522
    { GET, -1, -1, -1, 0, NULL, NULL,
2523
      OSSL_PKEY_PARAM_RSA_EXPONENT2, OSSL_PARAM_UNSIGNED_INTEGER,
2524
      get_rsa_payload_e2 },
2525
    { GET, -1, -1, -1, 0, NULL, NULL,
2526
      OSSL_PKEY_PARAM_RSA_EXPONENT3, OSSL_PARAM_UNSIGNED_INTEGER,
2527
      get_rsa_payload_e3 },
2528
    { GET, -1, -1, -1, 0, NULL, NULL,
2529
      OSSL_PKEY_PARAM_RSA_EXPONENT4, OSSL_PARAM_UNSIGNED_INTEGER,
2530
      get_rsa_payload_e4 },
2531
    { GET, -1, -1, -1, 0, NULL, NULL,
2532
      OSSL_PKEY_PARAM_RSA_EXPONENT5, OSSL_PARAM_UNSIGNED_INTEGER,
2533
      get_rsa_payload_e5 },
2534
    { GET, -1, -1, -1, 0, NULL, NULL,
2535
      OSSL_PKEY_PARAM_RSA_EXPONENT6, OSSL_PARAM_UNSIGNED_INTEGER,
2536
      get_rsa_payload_e6 },
2537
    { GET, -1, -1, -1, 0, NULL, NULL,
2538
      OSSL_PKEY_PARAM_RSA_EXPONENT7, OSSL_PARAM_UNSIGNED_INTEGER,
2539
      get_rsa_payload_e7 },
2540
    { GET, -1, -1, -1, 0, NULL, NULL,
2541
      OSSL_PKEY_PARAM_RSA_EXPONENT8, OSSL_PARAM_UNSIGNED_INTEGER,
2542
      get_rsa_payload_e8 },
2543
    { GET, -1, -1, -1, 0, NULL, NULL,
2544
      OSSL_PKEY_PARAM_RSA_EXPONENT9, OSSL_PARAM_UNSIGNED_INTEGER,
2545
      get_rsa_payload_e9 },
2546
    { GET, -1, -1, -1, 0, NULL, NULL,
2547
      OSSL_PKEY_PARAM_RSA_EXPONENT10, OSSL_PARAM_UNSIGNED_INTEGER,
2548
      get_rsa_payload_e10 },
2549
    { GET, -1, -1, -1, 0, NULL, NULL,
2550
      OSSL_PKEY_PARAM_RSA_COEFFICIENT1, OSSL_PARAM_UNSIGNED_INTEGER,
2551
      get_rsa_payload_c1 },
2552
    { GET, -1, -1, -1, 0, NULL, NULL,
2553
      OSSL_PKEY_PARAM_RSA_COEFFICIENT2, OSSL_PARAM_UNSIGNED_INTEGER,
2554
      get_rsa_payload_c2 },
2555
    { GET, -1, -1, -1, 0, NULL, NULL,
2556
      OSSL_PKEY_PARAM_RSA_COEFFICIENT3, OSSL_PARAM_UNSIGNED_INTEGER,
2557
      get_rsa_payload_c3 },
2558
    { GET, -1, -1, -1, 0, NULL, NULL,
2559
      OSSL_PKEY_PARAM_RSA_COEFFICIENT4, OSSL_PARAM_UNSIGNED_INTEGER,
2560
      get_rsa_payload_c4 },
2561
    { GET, -1, -1, -1, 0, NULL, NULL,
2562
      OSSL_PKEY_PARAM_RSA_COEFFICIENT5, OSSL_PARAM_UNSIGNED_INTEGER,
2563
      get_rsa_payload_c5 },
2564
    { GET, -1, -1, -1, 0, NULL, NULL,
2565
      OSSL_PKEY_PARAM_RSA_COEFFICIENT6, OSSL_PARAM_UNSIGNED_INTEGER,
2566
      get_rsa_payload_c6 },
2567
    { GET, -1, -1, -1, 0, NULL, NULL,
2568
      OSSL_PKEY_PARAM_RSA_COEFFICIENT7, OSSL_PARAM_UNSIGNED_INTEGER,
2569
      get_rsa_payload_c7 },
2570
    { GET, -1, -1, -1, 0, NULL, NULL,
2571
      OSSL_PKEY_PARAM_RSA_COEFFICIENT8, OSSL_PARAM_UNSIGNED_INTEGER,
2572
      get_rsa_payload_c8 },
2573
    { GET, -1, -1, -1, 0, NULL, NULL,
2574
      OSSL_PKEY_PARAM_RSA_COEFFICIENT9, OSSL_PARAM_UNSIGNED_INTEGER,
2575
      get_rsa_payload_c9 },
2576
2577
    /* EC */
2578
    { GET, -1, -1, -1, 0, NULL, NULL,
2579
      OSSL_PKEY_PARAM_EC_DECODED_FROM_EXPLICIT_PARAMS, OSSL_PARAM_INTEGER,
2580
      get_ec_decoded_from_explicit_params },
2581
};
2582
2583
static const struct translation_st *
2584
lookup_translation(struct translation_st *tmpl,
2585
                   const struct translation_st *translations,
2586
                   size_t translations_num)
2587
0
{
2588
0
    size_t i;
2589
2590
0
    for (i = 0; i < translations_num; i++) {
2591
0
        const struct translation_st *item = &translations[i];
2592
2593
        /*
2594
         * Sanity check the translation table item.
2595
         *
2596
         * 1.  Either both keytypes are -1, or neither of them are.
2597
         * 2.  TBA...
2598
         */
2599
0
        if (!ossl_assert((item->keytype1 == -1) == (item->keytype2 == -1)))
2600
0
            continue;
2601
2602
2603
        /*
2604
         * Base search criteria: check that the optype and keytypes match,
2605
         * if relevant.  All callers must synthesise these bits somehow.
2606
         */
2607
0
        if (item->optype != -1 && (tmpl->optype & item->optype) == 0)
2608
0
            continue;
2609
        /*
2610
         * This expression is stunningly simple thanks to the sanity check
2611
         * above.
2612
         */
2613
0
        if (item->keytype1 != -1
2614
0
            && tmpl->keytype1 != item->keytype1
2615
0
            && tmpl->keytype2 != item->keytype2)
2616
0
            continue;
2617
2618
        /*
2619
         * Done with the base search criteria, now we check the criteria for
2620
         * the individual types of translations:
2621
         * ctrl->params, ctrl_str->params, and params->ctrl
2622
         */
2623
0
        if (tmpl->ctrl_num != 0) {
2624
0
            if (tmpl->ctrl_num != item->ctrl_num)
2625
0
                continue;
2626
0
        } else if (tmpl->ctrl_str != NULL) {
2627
0
            const char *ctrl_str = NULL;
2628
0
            const char *ctrl_hexstr = NULL;
2629
2630
            /*
2631
             * Search criteria that originates from a ctrl_str is only used
2632
             * for setting, never for getting.  Therefore, we only look at
2633
             * the setter items.
2634
             */
2635
0
            if (item->action_type != NONE
2636
0
                && item->action_type != SET)
2637
0
                continue;
2638
            /*
2639
             * At least one of the ctrl cmd names must be match the ctrl
2640
             * cmd name in the template.
2641
             */
2642
0
            if (item->ctrl_str != NULL
2643
0
                && OPENSSL_strcasecmp(tmpl->ctrl_str, item->ctrl_str) == 0)
2644
0
                ctrl_str = tmpl->ctrl_str;
2645
0
            else if (item->ctrl_hexstr != NULL
2646
0
                     && OPENSSL_strcasecmp(tmpl->ctrl_hexstr,
2647
0
                                           item->ctrl_hexstr) == 0)
2648
0
                ctrl_hexstr = tmpl->ctrl_hexstr;
2649
0
            else
2650
0
                continue;
2651
2652
            /* Modify the template to signal which string matched */
2653
0
            tmpl->ctrl_str = ctrl_str;
2654
0
            tmpl->ctrl_hexstr = ctrl_hexstr;
2655
0
        } else if (tmpl->param_key != NULL) {
2656
            /*
2657
             * Search criteria that originates from an OSSL_PARAM setter or
2658
             * getter.
2659
             *
2660
             * Ctrls were fundamentally bidirectional, with only the ctrl
2661
             * command macro name implying direction (if you're lucky).
2662
             * A few ctrl commands were even taking advantage of the
2663
             * bidirectional nature, making the direction depend in the
2664
             * value of the numeric argument.
2665
             *
2666
             * OSSL_PARAM functions are fundamentally different, in that
2667
             * setters and getters are separated, so the data direction is
2668
             * implied by the function that's used.  The same OSSL_PARAM
2669
             * key name can therefore be used in both directions.  We must
2670
             * therefore take the action type into account in this case.
2671
             */
2672
0
            if ((item->action_type != NONE
2673
0
                 && tmpl->action_type != item->action_type)
2674
0
                || (item->param_key != NULL
2675
0
                    && OPENSSL_strcasecmp(tmpl->param_key,
2676
0
                                          item->param_key) != 0))
2677
0
                continue;
2678
0
        } else {
2679
0
            return NULL;
2680
0
        }
2681
2682
0
        return item;
2683
0
    }
2684
2685
0
    return NULL;
2686
0
}
2687
2688
static const struct translation_st *
2689
lookup_evp_pkey_ctx_translation(struct translation_st *tmpl)
2690
0
{
2691
0
    return lookup_translation(tmpl, evp_pkey_ctx_translations,
2692
0
                              OSSL_NELEM(evp_pkey_ctx_translations));
2693
0
}
2694
2695
static const struct translation_st *
2696
lookup_evp_pkey_translation(struct translation_st *tmpl)
2697
0
{
2698
0
    return lookup_translation(tmpl, evp_pkey_translations,
2699
0
                              OSSL_NELEM(evp_pkey_translations));
2700
0
}
2701
2702
/* This must ONLY be called for provider side operations */
2703
int evp_pkey_ctx_ctrl_to_param(EVP_PKEY_CTX *pctx,
2704
                               int keytype, int optype,
2705
                               int cmd, int p1, void *p2)
2706
0
{
2707
0
    struct translation_ctx_st ctx = { 0, };
2708
0
    struct translation_st tmpl = { 0, };
2709
0
    const struct translation_st *translation = NULL;
2710
0
    OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
2711
0
    int ret;
2712
0
    fixup_args_fn *fixup = default_fixup_args;
2713
2714
0
    if (keytype == -1)
2715
0
        keytype = pctx->legacy_keytype;
2716
0
    tmpl.ctrl_num = cmd;
2717
0
    tmpl.keytype1 = tmpl.keytype2 = keytype;
2718
0
    tmpl.optype = optype;
2719
0
    translation = lookup_evp_pkey_ctx_translation(&tmpl);
2720
2721
0
    if (translation == NULL) {
2722
0
        ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
2723
0
        return -2;
2724
0
    }
2725
2726
0
    if (pctx->pmeth != NULL
2727
0
        && pctx->pmeth->pkey_id != translation->keytype1
2728
0
        && pctx->pmeth->pkey_id != translation->keytype2)
2729
0
        return -1;
2730
2731
0
    if (translation->fixup_args != NULL)
2732
0
        fixup = translation->fixup_args;
2733
0
    ctx.action_type = translation->action_type;
2734
0
    ctx.ctrl_cmd = cmd;
2735
0
    ctx.p1 = p1;
2736
0
    ctx.p2 = p2;
2737
0
    ctx.pctx = pctx;
2738
0
    ctx.params = params;
2739
2740
0
    ret = fixup(PRE_CTRL_TO_PARAMS, translation, &ctx);
2741
2742
0
    if (ret > 0) {
2743
0
        switch (ctx.action_type) {
2744
0
        default:
2745
            /* fixup_args is expected to make sure this is dead code */
2746
0
            break;
2747
0
        case GET:
2748
0
            ret = evp_pkey_ctx_get_params_strict(pctx, ctx.params);
2749
0
            break;
2750
0
        case SET:
2751
0
            ret = evp_pkey_ctx_set_params_strict(pctx, ctx.params);
2752
0
            break;
2753
0
        }
2754
0
    }
2755
2756
    /*
2757
     * In POST, we pass the return value as p1, allowing the fixup_args
2758
     * function to affect it by changing its value.
2759
     */
2760
0
    if (ret > 0) {
2761
0
        ctx.p1 = ret;
2762
0
        fixup(POST_CTRL_TO_PARAMS, translation, &ctx);
2763
0
        ret = ctx.p1;
2764
0
    }
2765
2766
0
    cleanup_translation_ctx(POST_CTRL_TO_PARAMS, translation, &ctx);
2767
2768
0
    return ret;
2769
0
}
2770
2771
/* This must ONLY be called for provider side operations */
2772
int evp_pkey_ctx_ctrl_str_to_param(EVP_PKEY_CTX *pctx,
2773
                                   const char *name, const char *value)
2774
0
{
2775
0
    struct translation_ctx_st ctx = { 0, };
2776
0
    struct translation_st tmpl = { 0, };
2777
0
    const struct translation_st *translation = NULL;
2778
0
    OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
2779
0
    int keytype = pctx->legacy_keytype;
2780
0
    int optype = pctx->operation == 0 ? -1 : pctx->operation;
2781
0
    int ret;
2782
0
    fixup_args_fn *fixup = default_fixup_args;
2783
2784
0
    tmpl.action_type = SET;
2785
0
    tmpl.keytype1 = tmpl.keytype2 = keytype;
2786
0
    tmpl.optype = optype;
2787
0
    tmpl.ctrl_str = name;
2788
0
    tmpl.ctrl_hexstr = name;
2789
0
    translation = lookup_evp_pkey_ctx_translation(&tmpl);
2790
2791
0
    if (translation != NULL) {
2792
0
        if (translation->fixup_args != NULL)
2793
0
            fixup = translation->fixup_args;
2794
0
        ctx.action_type = translation->action_type;
2795
0
        ctx.ishex = (tmpl.ctrl_hexstr != NULL);
2796
0
    } else {
2797
        /* String controls really only support setting */
2798
0
        ctx.action_type = SET;
2799
0
    }
2800
0
    ctx.ctrl_str = name;
2801
0
    ctx.p1 = (int)strlen(value);
2802
0
    ctx.p2 = (char *)value;
2803
0
    ctx.pctx = pctx;
2804
0
    ctx.params = params;
2805
2806
0
    ret = fixup(PRE_CTRL_STR_TO_PARAMS, translation, &ctx);
2807
2808
0
    if (ret > 0) {
2809
0
        switch (ctx.action_type) {
2810
0
        default:
2811
            /* fixup_args is expected to make sure this is dead code */
2812
0
            break;
2813
0
        case GET:
2814
            /*
2815
             * this is dead code, but must be present, or some compilers
2816
             * will complain
2817
             */
2818
0
            break;
2819
0
        case SET:
2820
0
            ret = evp_pkey_ctx_set_params_strict(pctx, ctx.params);
2821
0
            break;
2822
0
        }
2823
0
    }
2824
2825
0
    if (ret > 0)
2826
0
        ret = fixup(POST_CTRL_STR_TO_PARAMS, translation, &ctx);
2827
2828
0
    cleanup_translation_ctx(CLEANUP_CTRL_STR_TO_PARAMS, translation, &ctx);
2829
2830
0
    return ret;
2831
0
}
2832
2833
/* This must ONLY be called for legacy operations */
2834
static int evp_pkey_ctx_setget_params_to_ctrl(EVP_PKEY_CTX *pctx,
2835
                                              enum action action_type,
2836
                                              OSSL_PARAM *params)
2837
0
{
2838
0
    int keytype = pctx->legacy_keytype;
2839
0
    int optype = pctx->operation == 0 ? -1 : pctx->operation;
2840
2841
0
    for (; params != NULL && params->key != NULL; params++) {
2842
0
        struct translation_ctx_st ctx = { 0, };
2843
0
        struct translation_st tmpl = { 0, };
2844
0
        const struct translation_st *translation = NULL;
2845
0
        fixup_args_fn *fixup = default_fixup_args;
2846
0
        int ret;
2847
2848
0
        tmpl.action_type = action_type;
2849
0
        tmpl.keytype1 = tmpl.keytype2 = keytype;
2850
0
        tmpl.optype = optype;
2851
0
        tmpl.param_key = params->key;
2852
0
        translation = lookup_evp_pkey_ctx_translation(&tmpl);
2853
2854
0
        if (translation != NULL) {
2855
0
            if (translation->fixup_args != NULL)
2856
0
                fixup = translation->fixup_args;
2857
0
            ctx.action_type = translation->action_type;
2858
0
            ctx.ctrl_cmd = translation->ctrl_num;
2859
0
        }
2860
0
        ctx.pctx = pctx;
2861
0
        ctx.params = params;
2862
2863
0
        ret = fixup(PRE_PARAMS_TO_CTRL, translation, &ctx);
2864
2865
0
        if (ret > 0 && ctx.action_type != NONE)
2866
0
            ret = EVP_PKEY_CTX_ctrl(pctx, keytype, optype,
2867
0
                                    ctx.ctrl_cmd, ctx.p1, ctx.p2);
2868
2869
        /*
2870
         * In POST, we pass the return value as p1, allowing the fixup_args
2871
         * function to put it to good use, or maybe affect it.
2872
         */
2873
0
        if (ret > 0) {
2874
0
            ctx.p1 = ret;
2875
0
            fixup(POST_PARAMS_TO_CTRL, translation, &ctx);
2876
0
            ret = ctx.p1;
2877
0
        }
2878
2879
0
        cleanup_translation_ctx(CLEANUP_PARAMS_TO_CTRL, translation, &ctx);
2880
2881
0
        if (ret <= 0)
2882
0
            return 0;
2883
0
    }
2884
0
    return 1;
2885
0
}
2886
2887
int evp_pkey_ctx_set_params_to_ctrl(EVP_PKEY_CTX *ctx, const OSSL_PARAM *params)
2888
0
{
2889
0
    return evp_pkey_ctx_setget_params_to_ctrl(ctx, SET, (OSSL_PARAM *)params);
2890
0
}
2891
2892
int evp_pkey_ctx_get_params_to_ctrl(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
2893
0
{
2894
0
    return evp_pkey_ctx_setget_params_to_ctrl(ctx, GET, params);
2895
0
}
2896
2897
/* This must ONLY be called for legacy EVP_PKEYs */
2898
static int evp_pkey_setget_params_to_ctrl(const EVP_PKEY *pkey,
2899
                                          enum action action_type,
2900
                                          OSSL_PARAM *params)
2901
0
{
2902
0
    int ret = 1;
2903
2904
0
    for (; params != NULL && params->key != NULL; params++) {
2905
0
        struct translation_ctx_st ctx = { 0, };
2906
0
        struct translation_st tmpl = { 0, };
2907
0
        const struct translation_st *translation = NULL;
2908
0
        fixup_args_fn *fixup = default_fixup_args;
2909
2910
0
        tmpl.action_type = action_type;
2911
0
        tmpl.param_key = params->key;
2912
0
        translation = lookup_evp_pkey_translation(&tmpl);
2913
2914
0
        if (translation != NULL) {
2915
0
            if (translation->fixup_args != NULL)
2916
0
                fixup = translation->fixup_args;
2917
0
            ctx.action_type = translation->action_type;
2918
0
        }
2919
0
        ctx.p2 = (void *)pkey;
2920
0
        ctx.params = params;
2921
2922
        /*
2923
         * EVP_PKEY doesn't have any ctrl function, so we rely completely
2924
         * on fixup_args to do the whole work.  Also, we currently only
2925
         * support getting.
2926
         */
2927
0
        if (!ossl_assert(translation != NULL)
2928
0
            || !ossl_assert(translation->action_type == GET)
2929
0
            || !ossl_assert(translation->fixup_args != NULL)) {
2930
0
            return -2;
2931
0
        }
2932
2933
0
        ret = fixup(PKEY, translation, &ctx);
2934
2935
0
        cleanup_translation_ctx(PKEY, translation, &ctx);
2936
0
    }
2937
0
    return ret;
2938
0
}
2939
2940
int evp_pkey_get_params_to_ctrl(const EVP_PKEY *pkey, OSSL_PARAM *params)
2941
0
{
2942
0
    return evp_pkey_setget_params_to_ctrl(pkey, GET, params);
2943
0
}