Coverage Report

Created: 2025-12-10 06:24

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/crypto/dsa/dsa_ameth.c
Line
Count
Source
1
/*
2
 * Copyright 2006-2024 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
 * DSA low level APIs are deprecated for public use, but still ok for
12
 * internal use.
13
 */
14
#include "internal/deprecated.h"
15
16
#include <stdio.h>
17
#include <openssl/x509.h>
18
#include <openssl/asn1.h>
19
#include <openssl/bn.h>
20
#include <openssl/core_names.h>
21
#include <openssl/param_build.h>
22
#include "internal/cryptlib.h"
23
#include "crypto/asn1.h"
24
#include "crypto/dsa.h"
25
#include "crypto/evp.h"
26
#include "internal/ffc.h"
27
#include "dsa_local.h"
28
29
static int dsa_pub_decode(EVP_PKEY *pkey, const X509_PUBKEY *pubkey)
30
0
{
31
0
    const unsigned char *p, *pm;
32
0
    int pklen, pmlen;
33
0
    int ptype;
34
0
    const void *pval;
35
0
    const ASN1_STRING *pstr;
36
0
    X509_ALGOR *palg;
37
0
    ASN1_INTEGER *public_key = NULL;
38
39
0
    DSA *dsa = NULL;
40
41
0
    if (!X509_PUBKEY_get0_param(NULL, &p, &pklen, &palg, pubkey))
42
0
        return 0;
43
0
    X509_ALGOR_get0(NULL, &ptype, &pval, palg);
44
45
0
    if (ptype == V_ASN1_SEQUENCE) {
46
0
        pstr = pval;
47
0
        pm = pstr->data;
48
0
        pmlen = pstr->length;
49
50
0
        if ((dsa = d2i_DSAparams(NULL, &pm, pmlen)) == NULL) {
51
0
            ERR_raise(ERR_LIB_DSA, DSA_R_DECODE_ERROR);
52
0
            goto err;
53
0
        }
54
55
0
    } else if ((ptype == V_ASN1_NULL) || (ptype == V_ASN1_UNDEF)) {
56
0
        if ((dsa = DSA_new()) == NULL) {
57
0
            ERR_raise(ERR_LIB_DSA, ERR_R_DSA_LIB);
58
0
            goto err;
59
0
        }
60
0
    } else {
61
0
        ERR_raise(ERR_LIB_DSA, DSA_R_PARAMETER_ENCODING_ERROR);
62
0
        goto err;
63
0
    }
64
65
0
    if ((public_key = d2i_ASN1_INTEGER(NULL, &p, pklen)) == NULL) {
66
0
        ERR_raise(ERR_LIB_DSA, DSA_R_DECODE_ERROR);
67
0
        goto err;
68
0
    }
69
70
0
    if ((dsa->pub_key = ASN1_INTEGER_to_BN(public_key, NULL)) == NULL) {
71
0
        ERR_raise(ERR_LIB_DSA, DSA_R_BN_DECODE_ERROR);
72
0
        goto err;
73
0
    }
74
75
0
    dsa->dirty_cnt++;
76
0
    ASN1_INTEGER_free(public_key);
77
0
    EVP_PKEY_assign_DSA(pkey, dsa);
78
0
    return 1;
79
80
0
err:
81
0
    ASN1_INTEGER_free(public_key);
82
0
    DSA_free(dsa);
83
0
    return 0;
84
0
}
85
86
static int dsa_pub_encode(X509_PUBKEY *pk, const EVP_PKEY *pkey)
87
0
{
88
0
    DSA *dsa;
89
0
    int ptype;
90
0
    unsigned char *penc = NULL;
91
0
    int penclen;
92
0
    ASN1_STRING *str = NULL;
93
0
    ASN1_INTEGER *pubint = NULL;
94
0
    ASN1_OBJECT *aobj;
95
96
0
    dsa = pkey->pkey.dsa;
97
0
    if (pkey->save_parameters
98
0
        && dsa->params.p != NULL
99
0
        && dsa->params.q != NULL
100
0
        && dsa->params.g != NULL) {
101
0
        str = ASN1_STRING_new();
102
0
        if (str == NULL) {
103
0
            ERR_raise(ERR_LIB_DSA, ERR_R_ASN1_LIB);
104
0
            goto err;
105
0
        }
106
0
        str->length = i2d_DSAparams(dsa, &str->data);
107
0
        if (str->length <= 0) {
108
0
            ERR_raise(ERR_LIB_DSA, ERR_R_ASN1_LIB);
109
0
            goto err;
110
0
        }
111
0
        ptype = V_ASN1_SEQUENCE;
112
0
    } else
113
0
        ptype = V_ASN1_UNDEF;
114
115
0
    pubint = BN_to_ASN1_INTEGER(dsa->pub_key, NULL);
116
117
0
    if (pubint == NULL) {
118
0
        ERR_raise(ERR_LIB_DSA, ERR_R_ASN1_LIB);
119
0
        goto err;
120
0
    }
121
122
0
    penclen = i2d_ASN1_INTEGER(pubint, &penc);
123
0
    ASN1_INTEGER_free(pubint);
124
125
0
    if (penclen <= 0) {
126
0
        ERR_raise(ERR_LIB_DSA, ERR_R_ASN1_LIB);
127
0
        goto err;
128
0
    }
129
130
0
    aobj = OBJ_nid2obj(EVP_PKEY_DSA);
131
0
    if (aobj == NULL)
132
0
        goto err;
133
134
0
    if (X509_PUBKEY_set0_param(pk, aobj, ptype, str, penc, penclen))
135
0
        return 1;
136
137
0
err:
138
0
    OPENSSL_free(penc);
139
0
    ASN1_STRING_free(str);
140
141
0
    return 0;
142
0
}
143
144
/*
145
 * In PKCS#8 DSA: you just get a private key integer and parameters in the
146
 * AlgorithmIdentifier the pubkey must be recalculated.
147
 */
148
149
static int dsa_priv_decode(EVP_PKEY *pkey, const PKCS8_PRIV_KEY_INFO *p8)
150
0
{
151
0
    int ret = 0;
152
0
    DSA *dsa = ossl_dsa_key_from_pkcs8(p8, NULL, NULL);
153
154
0
    if (dsa != NULL) {
155
0
        ret = 1;
156
0
        EVP_PKEY_assign_DSA(pkey, dsa);
157
0
    }
158
159
0
    return ret;
160
0
}
161
162
static int dsa_priv_encode(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pkey)
163
0
{
164
0
    ASN1_STRING *params = NULL;
165
0
    ASN1_INTEGER *prkey = NULL;
166
0
    unsigned char *dp = NULL;
167
0
    int dplen;
168
169
0
    if (pkey->pkey.dsa == NULL || pkey->pkey.dsa->priv_key == NULL) {
170
0
        ERR_raise(ERR_LIB_DSA, DSA_R_MISSING_PARAMETERS);
171
0
        goto err;
172
0
    }
173
174
0
    params = ASN1_STRING_new();
175
176
0
    if (params == NULL) {
177
0
        ERR_raise(ERR_LIB_DSA, ERR_R_ASN1_LIB);
178
0
        goto err;
179
0
    }
180
181
0
    params->length = i2d_DSAparams(pkey->pkey.dsa, &params->data);
182
0
    if (params->length <= 0) {
183
0
        ERR_raise(ERR_LIB_DSA, ERR_R_ASN1_LIB);
184
0
        goto err;
185
0
    }
186
0
    params->type = V_ASN1_SEQUENCE;
187
188
    /* Get private key into integer */
189
0
    prkey = BN_to_ASN1_INTEGER(pkey->pkey.dsa->priv_key, NULL);
190
191
0
    if (prkey == NULL) {
192
0
        ERR_raise(ERR_LIB_DSA, DSA_R_BN_ERROR);
193
0
        goto err;
194
0
    }
195
196
0
    dplen = i2d_ASN1_INTEGER(prkey, &dp);
197
198
0
    ASN1_STRING_clear_free(prkey);
199
200
0
    if (dplen <= 0) {
201
0
        ERR_raise(ERR_LIB_DSA, DSA_R_BN_ERROR);
202
0
        goto err;
203
0
    }
204
205
0
    if (!PKCS8_pkey_set0(p8, OBJ_nid2obj(NID_dsa), 0,
206
0
            V_ASN1_SEQUENCE, params, dp, dplen)) {
207
0
        OPENSSL_clear_free(dp, dplen);
208
0
        goto err;
209
0
    }
210
0
    return 1;
211
212
0
err:
213
0
    ASN1_STRING_free(params);
214
0
    return 0;
215
0
}
216
217
static int int_dsa_size(const EVP_PKEY *pkey)
218
0
{
219
0
    return DSA_size(pkey->pkey.dsa);
220
0
}
221
222
static int dsa_bits(const EVP_PKEY *pkey)
223
0
{
224
0
    return DSA_bits(pkey->pkey.dsa);
225
0
}
226
227
static int dsa_security_bits(const EVP_PKEY *pkey)
228
0
{
229
0
    return DSA_security_bits(pkey->pkey.dsa);
230
0
}
231
232
static int dsa_missing_parameters(const EVP_PKEY *pkey)
233
0
{
234
0
    DSA *dsa;
235
0
    dsa = pkey->pkey.dsa;
236
0
    return dsa == NULL
237
0
        || dsa->params.p == NULL
238
0
        || dsa->params.q == NULL
239
0
        || dsa->params.g == NULL;
240
0
}
241
242
static int dsa_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
243
0
{
244
0
    if (to->pkey.dsa == NULL) {
245
0
        to->pkey.dsa = DSA_new();
246
0
        if (to->pkey.dsa == NULL)
247
0
            return 0;
248
0
    }
249
0
    if (!ossl_ffc_params_copy(&to->pkey.dsa->params, &from->pkey.dsa->params))
250
0
        return 0;
251
252
0
    to->pkey.dsa->dirty_cnt++;
253
0
    return 1;
254
0
}
255
256
static int dsa_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
257
0
{
258
0
    return ossl_ffc_params_cmp(&a->pkey.dsa->params, &b->pkey.dsa->params, 1);
259
0
}
260
261
static int dsa_pub_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
262
0
{
263
0
    return BN_cmp(b->pkey.dsa->pub_key, a->pkey.dsa->pub_key) == 0;
264
0
}
265
266
static void int_dsa_free(EVP_PKEY *pkey)
267
0
{
268
0
    DSA_free(pkey->pkey.dsa);
269
0
}
270
271
static int do_dsa_print(BIO *bp, const DSA *x, int off, int ptype)
272
0
{
273
0
    int ret = 0;
274
0
    const char *ktype = NULL;
275
0
    const BIGNUM *priv_key, *pub_key;
276
0
    int mod_len = 0;
277
278
0
    if (x->params.p != NULL)
279
0
        mod_len = DSA_bits(x);
280
281
0
    if (ptype == 2)
282
0
        priv_key = x->priv_key;
283
0
    else
284
0
        priv_key = NULL;
285
286
0
    if (ptype > 0)
287
0
        pub_key = x->pub_key;
288
0
    else
289
0
        pub_key = NULL;
290
291
0
    if (ptype == 2)
292
0
        ktype = "Private-Key";
293
0
    else if (ptype == 1)
294
0
        ktype = "Public-Key";
295
0
    else
296
0
        ktype = "DSA-Parameters";
297
298
0
    if (priv_key != NULL) {
299
0
        if (!BIO_indent(bp, off, 128))
300
0
            goto err;
301
0
        if (BIO_printf(bp, "%s: (%d bit)\n", ktype, mod_len) <= 0)
302
0
            goto err;
303
0
    } else {
304
0
        if (BIO_printf(bp, "Public-Key: (%d bit)\n", mod_len) <= 0)
305
0
            goto err;
306
0
    }
307
308
0
    if (!ASN1_bn_print(bp, "priv:", priv_key, NULL, off))
309
0
        goto err;
310
0
    if (!ASN1_bn_print(bp, "pub: ", pub_key, NULL, off))
311
0
        goto err;
312
0
    if (!ossl_ffc_params_print(bp, &x->params, off))
313
0
        goto err;
314
0
    ret = 1;
315
0
err:
316
0
    return ret;
317
0
}
318
319
static int dsa_param_decode(EVP_PKEY *pkey,
320
    const unsigned char **pder, int derlen)
321
0
{
322
0
    DSA *dsa;
323
324
0
    if ((dsa = d2i_DSAparams(NULL, pder, derlen)) == NULL)
325
0
        return 0;
326
327
0
    dsa->dirty_cnt++;
328
0
    EVP_PKEY_assign_DSA(pkey, dsa);
329
0
    return 1;
330
0
}
331
332
static int dsa_param_encode(const EVP_PKEY *pkey, unsigned char **pder)
333
0
{
334
0
    return i2d_DSAparams(pkey->pkey.dsa, pder);
335
0
}
336
337
static int dsa_param_print(BIO *bp, const EVP_PKEY *pkey, int indent,
338
    ASN1_PCTX *ctx)
339
0
{
340
0
    return do_dsa_print(bp, pkey->pkey.dsa, indent, 0);
341
0
}
342
343
static int dsa_pub_print(BIO *bp, const EVP_PKEY *pkey, int indent,
344
    ASN1_PCTX *ctx)
345
0
{
346
0
    return do_dsa_print(bp, pkey->pkey.dsa, indent, 1);
347
0
}
348
349
static int dsa_priv_print(BIO *bp, const EVP_PKEY *pkey, int indent,
350
    ASN1_PCTX *ctx)
351
0
{
352
0
    return do_dsa_print(bp, pkey->pkey.dsa, indent, 2);
353
0
}
354
355
static int old_dsa_priv_decode(EVP_PKEY *pkey,
356
    const unsigned char **pder, int derlen)
357
0
{
358
0
    DSA *dsa;
359
360
0
    if ((dsa = d2i_DSAPrivateKey(NULL, pder, derlen)) == NULL) {
361
0
        ERR_raise(ERR_LIB_DSA, ERR_R_DSA_LIB);
362
0
        return 0;
363
0
    }
364
0
    dsa->dirty_cnt++;
365
0
    EVP_PKEY_assign_DSA(pkey, dsa);
366
0
    return 1;
367
0
}
368
369
static int old_dsa_priv_encode(const EVP_PKEY *pkey, unsigned char **pder)
370
0
{
371
0
    return i2d_DSAPrivateKey(pkey->pkey.dsa, pder);
372
0
}
373
374
static int dsa_sig_print(BIO *bp, const X509_ALGOR *sigalg,
375
    const ASN1_STRING *sig, int indent, ASN1_PCTX *pctx)
376
0
{
377
0
    DSA_SIG *dsa_sig;
378
0
    const unsigned char *p;
379
380
0
    if (sig == NULL) {
381
0
        if (BIO_puts(bp, "\n") <= 0)
382
0
            return 0;
383
0
        else
384
0
            return 1;
385
0
    }
386
0
    p = sig->data;
387
0
    dsa_sig = d2i_DSA_SIG(NULL, &p, sig->length);
388
0
    if (dsa_sig != NULL) {
389
0
        int rv = 0;
390
0
        const BIGNUM *r, *s;
391
392
0
        DSA_SIG_get0(dsa_sig, &r, &s);
393
394
0
        if (BIO_write(bp, "\n", 1) != 1)
395
0
            goto err;
396
397
0
        if (!ASN1_bn_print(bp, "r:   ", r, NULL, indent))
398
0
            goto err;
399
0
        if (!ASN1_bn_print(bp, "s:   ", s, NULL, indent))
400
0
            goto err;
401
0
        rv = 1;
402
0
    err:
403
0
        DSA_SIG_free(dsa_sig);
404
0
        return rv;
405
0
    }
406
0
    if (BIO_puts(bp, "\n") <= 0)
407
0
        return 0;
408
0
    return X509_signature_dump(bp, sig, indent);
409
0
}
410
411
static int dsa_pkey_ctrl(EVP_PKEY *pkey, int op, long arg1, void *arg2)
412
0
{
413
0
    switch (op) {
414
0
    case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
415
0
        *(int *)arg2 = NID_sha256;
416
0
        return 1;
417
418
0
    default:
419
0
        return -2;
420
0
    }
421
0
}
422
423
static size_t dsa_pkey_dirty_cnt(const EVP_PKEY *pkey)
424
0
{
425
0
    return pkey->pkey.dsa->dirty_cnt;
426
0
}
427
428
static int dsa_pkey_export_to(const EVP_PKEY *from, void *to_keydata,
429
    OSSL_FUNC_keymgmt_import_fn *importer,
430
    OSSL_LIB_CTX *libctx, const char *propq)
431
0
{
432
0
    DSA *dsa = from->pkey.dsa;
433
0
    OSSL_PARAM_BLD *tmpl;
434
0
    const BIGNUM *p = DSA_get0_p(dsa), *g = DSA_get0_g(dsa);
435
0
    const BIGNUM *q = DSA_get0_q(dsa), *pub_key = DSA_get0_pub_key(dsa);
436
0
    const BIGNUM *priv_key = DSA_get0_priv_key(dsa);
437
0
    OSSL_PARAM *params;
438
0
    int selection = 0;
439
0
    int rv = 0;
440
441
0
    if (p == NULL || q == NULL || g == NULL)
442
0
        return 0;
443
444
0
    tmpl = OSSL_PARAM_BLD_new();
445
0
    if (tmpl == NULL)
446
0
        return 0;
447
448
0
    if (!OSSL_PARAM_BLD_push_BN(tmpl, OSSL_PKEY_PARAM_FFC_P, p)
449
0
        || !OSSL_PARAM_BLD_push_BN(tmpl, OSSL_PKEY_PARAM_FFC_Q, q)
450
0
        || !OSSL_PARAM_BLD_push_BN(tmpl, OSSL_PKEY_PARAM_FFC_G, g))
451
0
        goto err;
452
0
    selection |= OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS;
453
0
    if (pub_key != NULL) {
454
0
        if (!OSSL_PARAM_BLD_push_BN(tmpl, OSSL_PKEY_PARAM_PUB_KEY,
455
0
                pub_key))
456
0
            goto err;
457
0
        selection |= OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
458
0
    }
459
0
    if (priv_key != NULL) {
460
0
        if (!OSSL_PARAM_BLD_push_BN(tmpl, OSSL_PKEY_PARAM_PRIV_KEY,
461
0
                priv_key))
462
0
            goto err;
463
0
        selection |= OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
464
0
    }
465
466
0
    if ((params = OSSL_PARAM_BLD_to_param(tmpl)) == NULL)
467
0
        goto err;
468
469
    /* We export, the provider imports */
470
0
    rv = importer(to_keydata, selection, params);
471
472
0
    OSSL_PARAM_free(params);
473
0
err:
474
0
    OSSL_PARAM_BLD_free(tmpl);
475
0
    return rv;
476
0
}
477
478
static int dsa_pkey_import_from(const OSSL_PARAM params[], void *vpctx)
479
0
{
480
0
    EVP_PKEY_CTX *pctx = vpctx;
481
0
    EVP_PKEY *pkey = EVP_PKEY_CTX_get0_pkey(pctx);
482
0
    DSA *dsa = ossl_dsa_new(pctx->libctx);
483
484
0
    if (dsa == NULL) {
485
0
        ERR_raise(ERR_LIB_DSA, ERR_R_DSA_LIB);
486
0
        return 0;
487
0
    }
488
489
0
    if (!ossl_dsa_ffc_params_fromdata(dsa, params)
490
0
        || !ossl_dsa_key_fromdata(dsa, params, 1)
491
0
        || !EVP_PKEY_assign_DSA(pkey, dsa)) {
492
0
        DSA_free(dsa);
493
0
        return 0;
494
0
    }
495
0
    return 1;
496
0
}
497
498
static int dsa_pkey_copy(EVP_PKEY *to, EVP_PKEY *from)
499
0
{
500
0
    DSA *dsa = from->pkey.dsa;
501
0
    DSA *dupkey = NULL;
502
0
    int ret;
503
504
0
    if (dsa != NULL) {
505
0
        dupkey = ossl_dsa_dup(dsa, OSSL_KEYMGMT_SELECT_ALL);
506
0
        if (dupkey == NULL)
507
0
            return 0;
508
0
    }
509
510
0
    ret = EVP_PKEY_assign_DSA(to, dupkey);
511
0
    if (!ret)
512
0
        DSA_free(dupkey);
513
0
    return ret;
514
0
}
515
516
/* NB these are sorted in pkey_id order, lowest first */
517
518
const EVP_PKEY_ASN1_METHOD ossl_dsa_asn1_meths[4] = {
519
520
    /* This aliases NID_dsa with NID_dsa_2 */
521
    {
522
        EVP_PKEY_DSA1,
523
        EVP_PKEY_DSA,
524
        ASN1_PKEY_ALIAS },
525
526
    /* This aliases NID_dsaWithSHA with NID_dsaWithSHA_2 */
527
    {
528
        EVP_PKEY_DSA4,
529
        EVP_PKEY_DSA2,
530
        ASN1_PKEY_ALIAS },
531
532
    /* This aliases NID_dsaWithSHA with NID_dsaWithSHA1 */
533
    {
534
        EVP_PKEY_DSA3,
535
        EVP_PKEY_DSA2,
536
        ASN1_PKEY_ALIAS },
537
538
    { EVP_PKEY_DSA,
539
        EVP_PKEY_DSA,
540
        0,
541
542
        "DSA",
543
        "OpenSSL DSA method",
544
545
        dsa_pub_decode,
546
        dsa_pub_encode,
547
        dsa_pub_cmp,
548
        dsa_pub_print,
549
550
        dsa_priv_decode,
551
        dsa_priv_encode,
552
        dsa_priv_print,
553
554
        int_dsa_size,
555
        dsa_bits,
556
        dsa_security_bits,
557
558
        dsa_param_decode,
559
        dsa_param_encode,
560
        dsa_missing_parameters,
561
        dsa_copy_parameters,
562
        dsa_cmp_parameters,
563
        dsa_param_print,
564
        dsa_sig_print,
565
566
        int_dsa_free,
567
        dsa_pkey_ctrl,
568
        old_dsa_priv_decode,
569
        old_dsa_priv_encode,
570
571
        NULL, NULL, NULL,
572
        NULL, NULL, NULL,
573
        NULL, NULL, NULL, NULL,
574
575
        dsa_pkey_dirty_cnt,
576
        dsa_pkey_export_to,
577
        dsa_pkey_import_from,
578
        dsa_pkey_copy }
579
};