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