ssl: Correct filename in README
[openssl.git] / crypto / x509 / x_x509.c
1 /*
2  * Copyright 1995-2021 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 #include <stdio.h>
11 #include "internal/cryptlib.h"
12 #include <openssl/evp.h>
13 #include <openssl/asn1t.h>
14 #include <openssl/x509.h>
15 #include <openssl/x509v3.h>
16 #include "crypto/x509.h"
17
18 ASN1_SEQUENCE_enc(X509_CINF, enc, 0) = {
19         ASN1_EXP_OPT(X509_CINF, version, ASN1_INTEGER, 0),
20         ASN1_EMBED(X509_CINF, serialNumber, ASN1_INTEGER),
21         ASN1_EMBED(X509_CINF, signature, X509_ALGOR),
22         ASN1_SIMPLE(X509_CINF, issuer, X509_NAME),
23         ASN1_EMBED(X509_CINF, validity, X509_VAL),
24         ASN1_SIMPLE(X509_CINF, subject, X509_NAME),
25         ASN1_SIMPLE(X509_CINF, key, X509_PUBKEY),
26         ASN1_IMP_OPT(X509_CINF, issuerUID, ASN1_BIT_STRING, 1),
27         ASN1_IMP_OPT(X509_CINF, subjectUID, ASN1_BIT_STRING, 2),
28         ASN1_EXP_SEQUENCE_OF_OPT(X509_CINF, extensions, X509_EXTENSION, 3)
29 } ASN1_SEQUENCE_END_enc(X509_CINF, X509_CINF)
30
31 IMPLEMENT_ASN1_FUNCTIONS(X509_CINF)
32 /* X509 top level structure needs a bit of customisation */
33
34 extern void ossl_policy_cache_free(X509_POLICY_CACHE *cache);
35
36 static int x509_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
37                    void *exarg)
38 {
39     X509 *ret = (X509 *)*pval;
40
41     switch (operation) {
42
43     case ASN1_OP_D2I_PRE:
44         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_X509, ret, &ret->ex_data);
45         X509_CERT_AUX_free(ret->aux);
46         ASN1_OCTET_STRING_free(ret->skid);
47         AUTHORITY_KEYID_free(ret->akid);
48         CRL_DIST_POINTS_free(ret->crldp);
49         ossl_policy_cache_free(ret->policy_cache);
50         GENERAL_NAMES_free(ret->altname);
51         NAME_CONSTRAINTS_free(ret->nc);
52 #ifndef OPENSSL_NO_RFC3779
53         sk_IPAddressFamily_pop_free(ret->rfc3779_addr, IPAddressFamily_free);
54         ASIdentifiers_free(ret->rfc3779_asid);
55 #endif
56         ASN1_OCTET_STRING_free(ret->distinguishing_id);
57
58         /* fall thru */
59
60     case ASN1_OP_NEW_POST:
61         ret->ex_cached = 0;
62         ret->ex_kusage = 0;
63         ret->ex_xkusage = 0;
64         ret->ex_nscert = 0;
65         ret->ex_flags = 0;
66         ret->ex_pathlen = -1;
67         ret->ex_pcpathlen = -1;
68         ret->skid = NULL;
69         ret->akid = NULL;
70         ret->policy_cache = NULL;
71         ret->altname = NULL;
72         ret->nc = NULL;
73 #ifndef OPENSSL_NO_RFC3779
74         ret->rfc3779_addr = NULL;
75         ret->rfc3779_asid = NULL;
76 #endif
77         ret->distinguishing_id = NULL;
78         ret->aux = NULL;
79         ret->crldp = NULL;
80         if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_X509, ret, &ret->ex_data))
81             return 0;
82         break;
83
84     case ASN1_OP_FREE_POST:
85         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_X509, ret, &ret->ex_data);
86         X509_CERT_AUX_free(ret->aux);
87         ASN1_OCTET_STRING_free(ret->skid);
88         AUTHORITY_KEYID_free(ret->akid);
89         CRL_DIST_POINTS_free(ret->crldp);
90         ossl_policy_cache_free(ret->policy_cache);
91         GENERAL_NAMES_free(ret->altname);
92         NAME_CONSTRAINTS_free(ret->nc);
93 #ifndef OPENSSL_NO_RFC3779
94         sk_IPAddressFamily_pop_free(ret->rfc3779_addr, IPAddressFamily_free);
95         ASIdentifiers_free(ret->rfc3779_asid);
96 #endif
97         ASN1_OCTET_STRING_free(ret->distinguishing_id);
98         OPENSSL_free(ret->propq);
99         break;
100
101     case ASN1_OP_DUP_POST:
102         {
103             X509 *old = exarg;
104
105             if (!ossl_x509_set0_libctx(ret, old->libctx, old->propq))
106                 return 0;
107             if (old->cert_info.key != NULL) {
108                 EVP_PKEY *pkey = X509_PUBKEY_get0(old->cert_info.key);
109
110                 if (pkey != NULL) {
111                     pkey = EVP_PKEY_dup(pkey);
112                     if (pkey == NULL) {
113                         ERR_raise(ERR_LIB_X509, ERR_R_MALLOC_FAILURE);
114                         return 0;
115                     }
116                     if (!X509_PUBKEY_set(&ret->cert_info.key, pkey)) {
117                         EVP_PKEY_free(pkey);
118                         ERR_raise(ERR_LIB_X509, ERR_R_INTERNAL_ERROR);
119                         return 0;
120                     }
121                     EVP_PKEY_free(pkey);
122                 }
123             }
124         }
125         break;
126     case ASN1_OP_GET0_LIBCTX:
127         {
128             OSSL_LIB_CTX **libctx = exarg;
129
130             *libctx = ret->libctx;
131         }
132         break;
133     case ASN1_OP_GET0_PROPQ:
134         {
135             const char **propq = exarg;
136
137             *propq = ret->propq;
138         }
139         break;
140     default:
141         break;
142     }
143
144     return 1;
145 }
146
147 ASN1_SEQUENCE_ref(X509, x509_cb) = {
148         ASN1_EMBED(X509, cert_info, X509_CINF),
149         ASN1_EMBED(X509, sig_alg, X509_ALGOR),
150         ASN1_EMBED(X509, signature, ASN1_BIT_STRING)
151 } ASN1_SEQUENCE_END_ref(X509, X509)
152
153 IMPLEMENT_ASN1_FUNCTIONS(X509)
154 IMPLEMENT_ASN1_DUP_FUNCTION(X509)
155
156 /*
157  * This should only be used if the X509 object was embedded inside another
158  * asn1 object and it needs a libctx to operate.
159  * Use X509_new_ex() instead if possible.
160  */
161 int ossl_x509_set0_libctx(X509 *x, OSSL_LIB_CTX *libctx, const char *propq)
162 {
163     if (x != NULL) {
164         x->libctx = libctx;
165         OPENSSL_free(x->propq);
166         x->propq = NULL;
167         if (propq != NULL) {
168             x->propq = OPENSSL_strdup(propq);
169             if (x->propq == NULL)
170                 return 0;
171         }
172     }
173     return 1;
174 }
175
176 X509 *X509_new_ex(OSSL_LIB_CTX *libctx, const char *propq)
177 {
178     X509 *cert = NULL;
179
180     cert = (X509 *)ASN1_item_new_ex(X509_it(), libctx, propq);
181     if (!ossl_x509_set0_libctx(cert, libctx, propq)) {
182         X509_free(cert);
183         cert = NULL;
184     }
185     return cert;
186 }
187
188 int X509_set_ex_data(X509 *r, int idx, void *arg)
189 {
190     return CRYPTO_set_ex_data(&r->ex_data, idx, arg);
191 }
192
193 void *X509_get_ex_data(const X509 *r, int idx)
194 {
195     return CRYPTO_get_ex_data(&r->ex_data, idx);
196 }
197
198 /*
199  * X509_AUX ASN1 routines. X509_AUX is the name given to a certificate with
200  * extra info tagged on the end. Since these functions set how a certificate
201  * is trusted they should only be used when the certificate comes from a
202  * reliable source such as local storage.
203  */
204
205 X509 *d2i_X509_AUX(X509 **a, const unsigned char **pp, long length)
206 {
207     const unsigned char *q;
208     X509 *ret;
209     int freeret = 0;
210
211     /* Save start position */
212     q = *pp;
213
214     if (a == NULL || *a == NULL)
215         freeret = 1;
216     ret = d2i_X509(a, &q, length);
217     /* If certificate unreadable then forget it */
218     if (ret == NULL)
219         return NULL;
220     /* update length */
221     length -= q - *pp;
222     if (length > 0 && !d2i_X509_CERT_AUX(&ret->aux, &q, length))
223         goto err;
224     *pp = q;
225     return ret;
226  err:
227     if (freeret) {
228         X509_free(ret);
229         if (a)
230             *a = NULL;
231     }
232     return NULL;
233 }
234
235 /*
236  * Serialize trusted certificate to *pp or just return the required buffer
237  * length if pp == NULL.  We ultimately want to avoid modifying *pp in the
238  * error path, but that depends on similar hygiene in lower-level functions.
239  * Here we avoid compounding the problem.
240  */
241 static int i2d_x509_aux_internal(const X509 *a, unsigned char **pp)
242 {
243     int length, tmplen;
244     unsigned char *start = pp != NULL ? *pp : NULL;
245
246     /*
247      * This might perturb *pp on error, but fixing that belongs in i2d_X509()
248      * not here.  It should be that if a == NULL length is zero, but we check
249      * both just in case.
250      */
251     length = i2d_X509(a, pp);
252     if (length <= 0 || a == NULL)
253         return length;
254
255     tmplen = i2d_X509_CERT_AUX(a->aux, pp);
256     if (tmplen < 0) {
257         if (start != NULL)
258             *pp = start;
259         return tmplen;
260     }
261     length += tmplen;
262
263     return length;
264 }
265
266 /*
267  * Serialize trusted certificate to *pp, or just return the required buffer
268  * length if pp == NULL.
269  *
270  * When pp is not NULL, but *pp == NULL, we allocate the buffer, but since
271  * we're writing two ASN.1 objects back to back, we can't have i2d_X509() do
272  * the allocation, nor can we allow i2d_X509_CERT_AUX() to increment the
273  * allocated buffer.
274  */
275 int i2d_X509_AUX(const X509 *a, unsigned char **pp)
276 {
277     int length;
278     unsigned char *tmp;
279
280     /* Buffer provided by caller */
281     if (pp == NULL || *pp != NULL)
282         return i2d_x509_aux_internal(a, pp);
283
284     /* Obtain the combined length */
285     if ((length = i2d_x509_aux_internal(a, NULL)) <= 0)
286         return length;
287
288     /* Allocate requisite combined storage */
289     *pp = tmp = OPENSSL_malloc(length);
290     if (tmp == NULL) {
291         ERR_raise(ERR_LIB_X509, ERR_R_MALLOC_FAILURE);
292         return -1;
293     }
294
295     /* Encode, but keep *pp at the originally malloced pointer */
296     length = i2d_x509_aux_internal(a, &tmp);
297     if (length <= 0) {
298         OPENSSL_free(*pp);
299         *pp = NULL;
300     }
301     return length;
302 }
303
304 int i2d_re_X509_tbs(X509 *x, unsigned char **pp)
305 {
306     x->cert_info.enc.modified = 1;
307     return i2d_X509_CINF(&x->cert_info, pp);
308 }
309
310 void X509_get0_signature(const ASN1_BIT_STRING **psig,
311                          const X509_ALGOR **palg, const X509 *x)
312 {
313     if (psig)
314         *psig = &x->signature;
315     if (palg)
316         *palg = &x->sig_alg;
317 }
318
319 int X509_get_signature_nid(const X509 *x)
320 {
321     return OBJ_obj2nid(x->sig_alg.algorithm);
322 }
323
324 void X509_set0_distinguishing_id(X509 *x, ASN1_OCTET_STRING *d_id)
325 {
326     ASN1_OCTET_STRING_free(x->distinguishing_id);
327     x->distinguishing_id = d_id;
328 }
329
330 ASN1_OCTET_STRING *X509_get0_distinguishing_id(X509 *x)
331 {
332     return x->distinguishing_id;
333 }