Coverage Report

Created: 2026-03-09 06:55

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/crypto/dh/dh_asn1.c
Line
Count
Source
1
/*
2
 * Copyright 2000-2025 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
 * DH 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 "internal/cryptlib.h"
18
#include <openssl/bn.h>
19
#include "dh_local.h"
20
#include <openssl/objects.h>
21
#include <openssl/asn1t.h>
22
#include "crypto/dh.h"
23
24
#include <crypto/asn1.h>
25
26
/* Override the default free and new methods */
27
static int dh_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
28
    void *exarg)
29
0
{
30
0
    if (operation == ASN1_OP_NEW_PRE) {
31
0
        *pval = (ASN1_VALUE *)DH_new();
32
0
        if (*pval != NULL)
33
0
            return 2;
34
0
        return 0;
35
0
    } else if (operation == ASN1_OP_FREE_PRE) {
36
0
        DH_free((DH *)*pval);
37
0
        *pval = NULL;
38
0
        return 2;
39
0
    } else if (operation == ASN1_OP_D2I_POST) {
40
0
        DH *dh = (DH *)*pval;
41
42
0
        DH_clear_flags(dh, DH_FLAG_TYPE_MASK);
43
0
        DH_set_flags(dh, DH_FLAG_TYPE_DH);
44
0
        ossl_dh_cache_named_group(dh);
45
0
        dh->dirty_cnt++;
46
0
    }
47
0
    return 1;
48
0
}
49
50
ASN1_SEQUENCE_cb(DHparams, dh_cb) = {
51
    ASN1_SIMPLE(DH, params.p, BIGNUM),
52
    ASN1_SIMPLE(DH, params.g, BIGNUM),
53
    ASN1_OPT_EMBED(DH, length, ZINT32),
54
} ASN1_SEQUENCE_END_cb(DH, DHparams)
55
56
IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(DH, DHparams, DHparams)
57
58
/*
59
 * Internal only structures for handling X9.42 DH: this gets translated to or
60
 * from a DH structure straight away.
61
 */
62
63
typedef struct {
64
    ASN1_BIT_STRING *seed;
65
    BIGNUM *counter;
66
} int_dhvparams;
67
68
typedef struct {
69
    BIGNUM *p;
70
    BIGNUM *q;
71
    BIGNUM *g;
72
    BIGNUM *j;
73
    int_dhvparams *vparams;
74
} int_dhx942_dh;
75
76
ASN1_SEQUENCE(DHvparams) = {
77
    ASN1_SIMPLE(int_dhvparams, seed, ASN1_BIT_STRING),
78
    ASN1_SIMPLE(int_dhvparams, counter, BIGNUM)
79
0
} static_ASN1_SEQUENCE_END_name(int_dhvparams, DHvparams)
80
81
ASN1_SEQUENCE(DHxparams)
82
    = {
83
          ASN1_SIMPLE(int_dhx942_dh, p, BIGNUM),
84
          ASN1_SIMPLE(int_dhx942_dh, g, BIGNUM),
85
          ASN1_SIMPLE(int_dhx942_dh, q, BIGNUM),
86
          ASN1_OPT(int_dhx942_dh, j, BIGNUM),
87
          ASN1_OPT(int_dhx942_dh, vparams, DHvparams),
88
0
      } static_ASN1_SEQUENCE_END_name(int_dhx942_dh, DHxparams)
89
90
int_dhx942_dh *d2i_int_dhx(int_dhx942_dh **a, const unsigned char **pp, long length);
91
int i2d_int_dhx(const int_dhx942_dh *a, unsigned char **pp);
92
93
IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(int_dhx942_dh, DHxparams, int_dhx)
94
95
DH *d2i_DHxparams(DH **a, const unsigned char **pp, long length)
96
0
{
97
0
    FFC_PARAMS *params;
98
0
    int_dhx942_dh *dhx = NULL;
99
0
    DH *dh = NULL;
100
101
0
    dh = DH_new();
102
0
    if (dh == NULL)
103
0
        return NULL;
104
0
    dhx = d2i_int_dhx(NULL, pp, length);
105
0
    if (dhx == NULL) {
106
0
        DH_free(dh);
107
0
        return NULL;
108
0
    }
109
110
0
    if (a != NULL) {
111
0
        DH_free(*a);
112
0
        *a = dh;
113
0
    }
114
115
0
    params = &dh->params;
116
0
    DH_set0_pqg(dh, dhx->p, dhx->q, dhx->g);
117
0
    ossl_ffc_params_set0_j(params, dhx->j);
118
119
0
    if (dhx->vparams != NULL) {
120
        /* The counter has a maximum value of 4 * numbits(p) - 1 */
121
0
        int counter = (int)BN_get_word(dhx->vparams->counter);
122
0
        ossl_ffc_params_set_validate_params(params, dhx->vparams->seed->data,
123
0
            dhx->vparams->seed->length,
124
0
            counter);
125
0
        ASN1_BIT_STRING_free(dhx->vparams->seed);
126
0
        BN_free(dhx->vparams->counter);
127
0
        OPENSSL_free(dhx->vparams);
128
0
        dhx->vparams = NULL;
129
0
    }
130
131
0
    OPENSSL_free(dhx);
132
0
    DH_clear_flags(dh, DH_FLAG_TYPE_MASK);
133
0
    DH_set_flags(dh, DH_FLAG_TYPE_DHX);
134
0
    return dh;
135
0
}
136
137
int i2d_DHxparams(const DH *dh, unsigned char **pp)
138
0
{
139
0
    int ret = 0;
140
0
    int_dhx942_dh dhx;
141
0
    int_dhvparams dhv = { NULL, NULL };
142
0
    ASN1_BIT_STRING seed;
143
0
    size_t seedlen = 0;
144
0
    const FFC_PARAMS *params = &dh->params;
145
0
    int counter;
146
147
0
    ossl_ffc_params_get0_pqg(params, (const BIGNUM **)&dhx.p,
148
0
        (const BIGNUM **)&dhx.q, (const BIGNUM **)&dhx.g);
149
0
    dhx.j = params->j;
150
0
    ossl_ffc_params_get_validate_params(params, &seed.data, &seedlen, &counter);
151
0
    seed.length = (int)seedlen;
152
153
0
    if (counter != -1 && seed.data != NULL && seed.length > 0) {
154
0
        seed.flags = ASN1_STRING_FLAG_BITS_LEFT;
155
0
        dhv.seed = &seed;
156
0
        dhv.counter = BN_new();
157
0
        if (dhv.counter == NULL)
158
0
            return 0;
159
0
        if (!BN_set_word(dhv.counter, (BN_ULONG)counter))
160
0
            goto err;
161
0
        dhx.vparams = &dhv;
162
0
    } else {
163
0
        dhx.vparams = NULL;
164
0
    }
165
0
    ret = i2d_int_dhx(&dhx, pp);
166
0
err:
167
0
    BN_free(dhv.counter);
168
0
    return ret;
169
0
}