Allow fuzz builds to detect string overruns
[openssl.git] / crypto / asn1 / asn1_lib.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 <limits.h>
12 #include "internal/cryptlib.h"
13 #include <openssl/asn1.h>
14 #include "asn1_local.h"
15
16 static int asn1_get_length(const unsigned char **pp, int *inf, long *rl,
17                            long max);
18 static void asn1_put_length(unsigned char **pp, int length);
19
20 static int _asn1_check_infinite_end(const unsigned char **p, long len)
21 {
22     /*
23      * If there is 0 or 1 byte left, the length check should pick things up
24      */
25     if (len <= 0) {
26         return 1;
27     } else {
28         if ((len >= 2) && ((*p)[0] == 0) && ((*p)[1] == 0)) {
29             (*p) += 2;
30             return 1;
31         }
32     }
33     return 0;
34 }
35
36 int ASN1_check_infinite_end(unsigned char **p, long len)
37 {
38     return _asn1_check_infinite_end((const unsigned char **)p, len);
39 }
40
41 int ASN1_const_check_infinite_end(const unsigned char **p, long len)
42 {
43     return _asn1_check_infinite_end(p, len);
44 }
45
46 int ASN1_get_object(const unsigned char **pp, long *plength, int *ptag,
47                     int *pclass, long omax)
48 {
49     int i, ret;
50     long len;
51     const unsigned char *p = *pp;
52     int tag, xclass, inf;
53     long max = omax;
54
55     if (omax <= 0) {
56         ERR_raise(ERR_LIB_ASN1, ASN1_R_TOO_SMALL);
57         return 0x80;
58     }
59     ret = (*p & V_ASN1_CONSTRUCTED);
60     xclass = (*p & V_ASN1_PRIVATE);
61     i = *p & V_ASN1_PRIMITIVE_TAG;
62     if (i == V_ASN1_PRIMITIVE_TAG) { /* high-tag */
63         p++;
64         if (--max == 0)
65             goto err;
66         len = 0;
67         while (*p & 0x80) {
68             len <<= 7L;
69             len |= *(p++) & 0x7f;
70             if (--max == 0)
71                 goto err;
72             if (len > (INT_MAX >> 7L))
73                 goto err;
74         }
75         len <<= 7L;
76         len |= *(p++) & 0x7f;
77         tag = (int)len;
78         if (--max == 0)
79             goto err;
80     } else {
81         tag = i;
82         p++;
83         if (--max == 0)
84             goto err;
85     }
86     *ptag = tag;
87     *pclass = xclass;
88     if (!asn1_get_length(&p, &inf, plength, max))
89         goto err;
90
91     if (inf && !(ret & V_ASN1_CONSTRUCTED))
92         goto err;
93
94     if (*plength > (omax - (p - *pp))) {
95         ERR_raise(ERR_LIB_ASN1, ASN1_R_TOO_LONG);
96         /*
97          * Set this so that even if things are not long enough the values are
98          * set correctly
99          */
100         ret |= 0x80;
101     }
102     *pp = p;
103     return ret | inf;
104  err:
105     ERR_raise(ERR_LIB_ASN1, ASN1_R_HEADER_TOO_LONG);
106     return 0x80;
107 }
108
109 /*
110  * Decode a length field.
111  * The short form is a single byte defining a length 0 - 127.
112  * The long form is a byte 0 - 127 with the top bit set and this indicates
113  * the number of following octets that contain the length.  These octets
114  * are stored most significant digit first.
115  */
116 static int asn1_get_length(const unsigned char **pp, int *inf, long *rl,
117                            long max)
118 {
119     const unsigned char *p = *pp;
120     unsigned long ret = 0;
121     int i;
122
123     if (max-- < 1)
124         return 0;
125     if (*p == 0x80) {
126         *inf = 1;
127         p++;
128     } else {
129         *inf = 0;
130         i = *p & 0x7f;
131         if (*p++ & 0x80) {
132             if (max < i + 1)
133                 return 0;
134             /* Skip leading zeroes */
135             while (i > 0 && *p == 0) {
136                 p++;
137                 i--;
138             }
139             if (i > (int)sizeof(long))
140                 return 0;
141             while (i > 0) {
142                 ret <<= 8;
143                 ret |= *p++;
144                 i--;
145             }
146             if (ret > LONG_MAX)
147                 return 0;
148         } else {
149             ret = i;
150         }
151     }
152     *pp = p;
153     *rl = (long)ret;
154     return 1;
155 }
156
157 /*
158  * constructed == 2 for indefinite length constructed
159  */
160 void ASN1_put_object(unsigned char **pp, int constructed, int length, int tag,
161                      int xclass)
162 {
163     unsigned char *p = *pp;
164     int i, ttag;
165
166     i = (constructed) ? V_ASN1_CONSTRUCTED : 0;
167     i |= (xclass & V_ASN1_PRIVATE);
168     if (tag < 31) {
169         *(p++) = i | (tag & V_ASN1_PRIMITIVE_TAG);
170     } else {
171         *(p++) = i | V_ASN1_PRIMITIVE_TAG;
172         for (i = 0, ttag = tag; ttag > 0; i++)
173             ttag >>= 7;
174         ttag = i;
175         while (i-- > 0) {
176             p[i] = tag & 0x7f;
177             if (i != (ttag - 1))
178                 p[i] |= 0x80;
179             tag >>= 7;
180         }
181         p += ttag;
182     }
183     if (constructed == 2)
184         *(p++) = 0x80;
185     else
186         asn1_put_length(&p, length);
187     *pp = p;
188 }
189
190 int ASN1_put_eoc(unsigned char **pp)
191 {
192     unsigned char *p = *pp;
193
194     *p++ = 0;
195     *p++ = 0;
196     *pp = p;
197     return 2;
198 }
199
200 static void asn1_put_length(unsigned char **pp, int length)
201 {
202     unsigned char *p = *pp;
203     int i, len;
204
205     if (length <= 127) {
206         *(p++) = (unsigned char)length;
207     } else {
208         len = length;
209         for (i = 0; len > 0; i++)
210             len >>= 8;
211         *(p++) = i | 0x80;
212         len = i;
213         while (i-- > 0) {
214             p[i] = length & 0xff;
215             length >>= 8;
216         }
217         p += len;
218     }
219     *pp = p;
220 }
221
222 int ASN1_object_size(int constructed, int length, int tag)
223 {
224     int ret = 1;
225
226     if (length < 0)
227         return -1;
228     if (tag >= 31) {
229         while (tag > 0) {
230             tag >>= 7;
231             ret++;
232         }
233     }
234     if (constructed == 2) {
235         ret += 3;
236     } else {
237         ret++;
238         if (length > 127) {
239             int tmplen = length;
240             while (tmplen > 0) {
241                 tmplen >>= 8;
242                 ret++;
243             }
244         }
245     }
246     if (ret >= INT_MAX - length)
247         return -1;
248     return ret + length;
249 }
250
251 int ASN1_STRING_copy(ASN1_STRING *dst, const ASN1_STRING *str)
252 {
253     if (str == NULL)
254         return 0;
255     dst->type = str->type;
256     if (!ASN1_STRING_set(dst, str->data, str->length))
257         return 0;
258     /* Copy flags but preserve embed value */
259     dst->flags &= ASN1_STRING_FLAG_EMBED;
260     dst->flags |= str->flags & ~ASN1_STRING_FLAG_EMBED;
261     return 1;
262 }
263
264 ASN1_STRING *ASN1_STRING_dup(const ASN1_STRING *str)
265 {
266     ASN1_STRING *ret;
267
268     if (!str)
269         return NULL;
270     ret = ASN1_STRING_new();
271     if (ret == NULL)
272         return NULL;
273     if (!ASN1_STRING_copy(ret, str)) {
274         ASN1_STRING_free(ret);
275         return NULL;
276     }
277     return ret;
278 }
279
280 int ASN1_STRING_set(ASN1_STRING *str, const void *_data, int len_in)
281 {
282     unsigned char *c;
283     const char *data = _data;
284     size_t len;
285
286     if (len_in < 0) {
287         if (data == NULL)
288             return 0;
289         len = strlen(data);
290     } else {
291         len = (size_t)len_in;
292     }
293     /*
294      * Verify that the length fits within an integer for assignment to
295      * str->length below.  The additional 1 is subtracted to allow for the
296      * '\0' terminator even though this isn't strictly necessary.
297      */
298     if (len > INT_MAX - 1) {
299         ERR_raise(ERR_LIB_ASN1, ASN1_R_TOO_LARGE);
300         return 0;
301     }
302     if ((size_t)str->length <= len || str->data == NULL) {
303         c = str->data;
304 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
305         /* No NUL terminator in fuzzing builds */
306         str->data = OPENSSL_realloc(c, len);
307 #else
308         str->data = OPENSSL_realloc(c, len + 1);
309 #endif
310         if (str->data == NULL) {
311             ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
312             str->data = c;
313             return 0;
314         }
315     }
316     str->length = len;
317     if (data != NULL) {
318         memcpy(str->data, data, len);
319 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
320         /*
321          * Add a NUL terminator. This should not be necessary - but we add it as
322          * a safety precaution
323          */
324         str->data[len] = '\0';
325 #endif
326     }
327     return 1;
328 }
329
330 void ASN1_STRING_set0(ASN1_STRING *str, void *data, int len)
331 {
332     OPENSSL_free(str->data);
333     str->data = data;
334     str->length = len;
335 }
336
337 ASN1_STRING *ASN1_STRING_new(void)
338 {
339     return ASN1_STRING_type_new(V_ASN1_OCTET_STRING);
340 }
341
342 ASN1_STRING *ASN1_STRING_type_new(int type)
343 {
344     ASN1_STRING *ret;
345
346     ret = OPENSSL_zalloc(sizeof(*ret));
347     if (ret == NULL) {
348         ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
349         return NULL;
350     }
351     ret->type = type;
352     return ret;
353 }
354
355 void ossl_asn1_string_embed_free(ASN1_STRING *a, int embed)
356 {
357     if (a == NULL)
358         return;
359     if (!(a->flags & ASN1_STRING_FLAG_NDEF))
360         OPENSSL_free(a->data);
361     if (embed == 0)
362         OPENSSL_free(a);
363 }
364
365 void ASN1_STRING_free(ASN1_STRING *a)
366 {
367     if (a == NULL)
368         return;
369     ossl_asn1_string_embed_free(a, a->flags & ASN1_STRING_FLAG_EMBED);
370 }
371
372 void ASN1_STRING_clear_free(ASN1_STRING *a)
373 {
374     if (a == NULL)
375         return;
376     if (a->data && !(a->flags & ASN1_STRING_FLAG_NDEF))
377         OPENSSL_cleanse(a->data, a->length);
378     ASN1_STRING_free(a);
379 }
380
381 int ASN1_STRING_cmp(const ASN1_STRING *a, const ASN1_STRING *b)
382 {
383     int i;
384
385     i = (a->length - b->length);
386     if (i == 0) {
387         i = memcmp(a->data, b->data, a->length);
388         if (i == 0)
389             return a->type - b->type;
390         else
391             return i;
392     } else {
393         return i;
394     }
395 }
396
397 int ASN1_STRING_length(const ASN1_STRING *x)
398 {
399     return x->length;
400 }
401
402 #ifndef OPENSSL_NO_DEPRECATED_3_0
403 void ASN1_STRING_length_set(ASN1_STRING *x, int len)
404 {
405     x->length = len;
406 }
407 #endif
408
409 int ASN1_STRING_type(const ASN1_STRING *x)
410 {
411     return x->type;
412 }
413
414 const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING *x)
415 {
416     return x->data;
417 }
418
419 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
420 unsigned char *ASN1_STRING_data(ASN1_STRING *x)
421 {
422     return x->data;
423 }
424 #endif
425
426 /* |max_len| excludes NUL terminator and may be 0 to indicate no restriction */
427 char *ossl_sk_ASN1_UTF8STRING2text(STACK_OF(ASN1_UTF8STRING) *text,
428                                    const char *sep, size_t max_len)
429 {
430     int i;
431     ASN1_UTF8STRING *current;
432     size_t length = 0, sep_len;
433     char *result = NULL;
434     char *p;
435
436     if (sep == NULL)
437         sep = "";
438     sep_len = strlen(sep);
439
440     for (i = 0; i < sk_ASN1_UTF8STRING_num(text); i++) {
441         current = sk_ASN1_UTF8STRING_value(text, i);
442         if (i > 0)
443             length += sep_len;
444         length += ASN1_STRING_length(current);
445         if (max_len != 0 && length > max_len)
446             return NULL;
447     }
448     if ((result = OPENSSL_malloc(length + 1)) == NULL)
449         return NULL;
450
451     p = result;
452     for (i = 0; i < sk_ASN1_UTF8STRING_num(text); i++) {
453         current = sk_ASN1_UTF8STRING_value(text, i);
454         length = ASN1_STRING_length(current);
455         if (i > 0 && sep_len > 0) {
456             strncpy(p, sep, sep_len + 1); /* using + 1 to silence gcc warning */
457             p += sep_len;
458         }
459         strncpy(p, (const char *)ASN1_STRING_get0_data(current), length);
460         p += length;
461     }
462     *p = '\0';
463
464     return result;
465 }