Coverage Report

Created: 2025-06-13 06:56

/src/openssl/crypto/asn1/a_mbstr.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 1999-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 "crypto/ctype.h"
12
#include "internal/cryptlib.h"
13
#include "internal/unicode.h"
14
#include <openssl/asn1.h>
15
16
static int traverse_string(const unsigned char *p, int len, int inform,
17
                           int (*rfunc) (unsigned long value, void *in),
18
                           void *arg);
19
static int in_utf8(unsigned long value, void *arg);
20
static int out_utf8(unsigned long value, void *arg);
21
static int type_str(unsigned long value, void *arg);
22
static int cpy_asc(unsigned long value, void *arg);
23
static int cpy_bmp(unsigned long value, void *arg);
24
static int cpy_univ(unsigned long value, void *arg);
25
static int cpy_utf8(unsigned long value, void *arg);
26
27
/*
28
 * These functions take a string in UTF8, ASCII or multibyte form and a mask
29
 * of permissible ASN1 string types. It then works out the minimal type
30
 * (using the order Numeric < Printable < IA5 < T61 < BMP < Universal < UTF8)
31
 * and creates a string of the correct type with the supplied data. Yes this is
32
 * horrible: it has to be :-( The 'ncopy' form checks minimum and maximum
33
 * size limits too.
34
 */
35
36
int ASN1_mbstring_copy(ASN1_STRING **out, const unsigned char *in, int len,
37
                       int inform, unsigned long mask)
38
0
{
39
0
    return ASN1_mbstring_ncopy(out, in, len, inform, mask, 0, 0);
40
0
}
41
42
int ASN1_mbstring_ncopy(ASN1_STRING **out, const unsigned char *in, int len,
43
                        int inform, unsigned long mask,
44
                        long minsize, long maxsize)
45
0
{
46
0
    int str_type;
47
0
    int ret;
48
0
    char free_out;
49
0
    int outform, outlen = 0;
50
0
    ASN1_STRING *dest;
51
0
    unsigned char *p;
52
0
    int nchar;
53
0
    int (*cpyfunc) (unsigned long, void *) = NULL;
54
0
    if (len == -1)
55
0
        len = strlen((const char *)in);
56
0
    if (!mask)
57
0
        mask = DIRSTRING_TYPE;
58
0
    if (len < 0)
59
0
        return -1;
60
61
    /* First do a string check and work out the number of characters */
62
0
    switch (inform) {
63
64
0
    case MBSTRING_BMP:
65
0
        if (len & 1) {
66
0
            ERR_raise(ERR_LIB_ASN1, ASN1_R_INVALID_BMPSTRING_LENGTH);
67
0
            return -1;
68
0
        }
69
0
        nchar = len >> 1;
70
0
        break;
71
72
0
    case MBSTRING_UNIV:
73
0
        if (len & 3) {
74
0
            ERR_raise(ERR_LIB_ASN1, ASN1_R_INVALID_UNIVERSALSTRING_LENGTH);
75
0
            return -1;
76
0
        }
77
0
        nchar = len >> 2;
78
0
        break;
79
80
0
    case MBSTRING_UTF8:
81
0
        nchar = 0;
82
        /* This counts the characters and does utf8 syntax checking */
83
0
        ret = traverse_string(in, len, MBSTRING_UTF8, in_utf8, &nchar);
84
0
        if (ret < 0) {
85
0
            ERR_raise(ERR_LIB_ASN1, ASN1_R_INVALID_UTF8STRING);
86
0
            return -1;
87
0
        }
88
0
        break;
89
90
0
    case MBSTRING_ASC:
91
0
        nchar = len;
92
0
        break;
93
94
0
    default:
95
0
        ERR_raise(ERR_LIB_ASN1, ASN1_R_UNKNOWN_FORMAT);
96
0
        return -1;
97
0
    }
98
99
0
    if ((minsize > 0) && (nchar < minsize)) {
100
0
        ERR_raise_data(ERR_LIB_ASN1, ASN1_R_STRING_TOO_SHORT,
101
0
                       "minsize=%ld", minsize);
102
0
        return -1;
103
0
    }
104
105
0
    if ((maxsize > 0) && (nchar > maxsize)) {
106
0
        ERR_raise_data(ERR_LIB_ASN1, ASN1_R_STRING_TOO_LONG,
107
0
                       "maxsize=%ld", maxsize);
108
0
        return -1;
109
0
    }
110
111
    /* Now work out minimal type (if any) */
112
0
    if (traverse_string(in, len, inform, type_str, &mask) < 0) {
113
0
        ERR_raise(ERR_LIB_ASN1, ASN1_R_ILLEGAL_CHARACTERS);
114
0
        return -1;
115
0
    }
116
117
    /* Now work out output format and string type */
118
0
    outform = MBSTRING_ASC;
119
0
    if (mask & B_ASN1_NUMERICSTRING)
120
0
        str_type = V_ASN1_NUMERICSTRING;
121
0
    else if (mask & B_ASN1_PRINTABLESTRING)
122
0
        str_type = V_ASN1_PRINTABLESTRING;
123
0
    else if (mask & B_ASN1_IA5STRING)
124
0
        str_type = V_ASN1_IA5STRING;
125
0
    else if (mask & B_ASN1_T61STRING)
126
0
        str_type = V_ASN1_T61STRING;
127
0
    else if (mask & B_ASN1_BMPSTRING) {
128
0
        str_type = V_ASN1_BMPSTRING;
129
0
        outform = MBSTRING_BMP;
130
0
    } else if (mask & B_ASN1_UNIVERSALSTRING) {
131
0
        str_type = V_ASN1_UNIVERSALSTRING;
132
0
        outform = MBSTRING_UNIV;
133
0
    } else {
134
0
        str_type = V_ASN1_UTF8STRING;
135
0
        outform = MBSTRING_UTF8;
136
0
    }
137
0
    if (!out)
138
0
        return str_type;
139
0
    if (*out) {
140
0
        free_out = 0;
141
0
        dest = *out;
142
0
        ASN1_STRING_set0(dest, NULL, 0);
143
0
        dest->type = str_type;
144
0
    } else {
145
0
        free_out = 1;
146
0
        dest = ASN1_STRING_type_new(str_type);
147
0
        if (dest == NULL) {
148
0
            ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
149
0
            return -1;
150
0
        }
151
0
        *out = dest;
152
0
    }
153
    /* If both the same type just copy across */
154
0
    if (inform == outform) {
155
0
        if (!ASN1_STRING_set(dest, in, len)) {
156
0
            if (free_out) {
157
0
                ASN1_STRING_free(dest);
158
0
                *out = NULL;
159
0
            }
160
0
            ERR_raise(ERR_LIB_ASN1, ERR_R_ASN1_LIB);
161
0
            return -1;
162
0
        }
163
0
        return str_type;
164
0
    }
165
166
    /* Work out how much space the destination will need */
167
0
    switch (outform) {
168
0
    case MBSTRING_ASC:
169
0
        outlen = nchar;
170
0
        cpyfunc = cpy_asc;
171
0
        break;
172
173
0
    case MBSTRING_BMP:
174
0
        outlen = nchar << 1;
175
0
        cpyfunc = cpy_bmp;
176
0
        break;
177
178
0
    case MBSTRING_UNIV:
179
0
        outlen = nchar << 2;
180
0
        cpyfunc = cpy_univ;
181
0
        break;
182
183
0
    case MBSTRING_UTF8:
184
0
        outlen = 0;
185
0
        traverse_string(in, len, inform, out_utf8, &outlen);
186
0
        cpyfunc = cpy_utf8;
187
0
        break;
188
0
    }
189
0
    if ((p = OPENSSL_malloc(outlen + 1)) == NULL) {
190
0
        if (free_out) {
191
0
            ASN1_STRING_free(dest);
192
0
            *out = NULL;
193
0
        }
194
0
        return -1;
195
0
    }
196
0
    dest->length = outlen;
197
0
    dest->data = p;
198
0
    p[outlen] = 0;
199
0
    traverse_string(in, len, inform, cpyfunc, &p);
200
0
    return str_type;
201
0
}
202
203
/*
204
 * This function traverses a string and passes the value of each character to
205
 * an optional function along with a void * argument.
206
 */
207
208
static int traverse_string(const unsigned char *p, int len, int inform,
209
                           int (*rfunc) (unsigned long value, void *in),
210
                           void *arg)
211
0
{
212
0
    unsigned long value;
213
0
    int ret;
214
0
    while (len) {
215
0
        if (inform == MBSTRING_ASC) {
216
0
            value = *p++;
217
0
            len--;
218
0
        } else if (inform == MBSTRING_BMP) {
219
0
            value = *p++ << 8;
220
0
            value |= *p++;
221
0
            len -= 2;
222
0
        } else if (inform == MBSTRING_UNIV) {
223
0
            value = ((unsigned long)*p++) << 24;
224
0
            value |= ((unsigned long)*p++) << 16;
225
0
            value |= *p++ << 8;
226
0
            value |= *p++;
227
0
            len -= 4;
228
0
        } else {
229
0
            ret = UTF8_getc(p, len, &value);
230
0
            if (ret < 0)
231
0
                return -1;
232
0
            len -= ret;
233
0
            p += ret;
234
0
        }
235
0
        if (rfunc) {
236
0
            ret = rfunc(value, arg);
237
0
            if (ret <= 0)
238
0
                return ret;
239
0
        }
240
0
    }
241
0
    return 1;
242
0
}
243
244
/* Various utility functions for traverse_string */
245
246
/* Just count number of characters */
247
248
static int in_utf8(unsigned long value, void *arg)
249
0
{
250
0
    int *nchar;
251
252
0
    if (!is_unicode_valid(value))
253
0
        return -2;
254
0
    nchar = arg;
255
0
    (*nchar)++;
256
0
    return 1;
257
0
}
258
259
/* Determine size of output as a UTF8 String */
260
261
static int out_utf8(unsigned long value, void *arg)
262
0
{
263
0
    int *outlen, len;
264
265
0
    len = UTF8_putc(NULL, -1, value);
266
0
    if (len <= 0)
267
0
        return len;
268
0
    outlen = arg;
269
0
    *outlen += len;
270
0
    return 1;
271
0
}
272
273
/*
274
 * Determine the "type" of a string: check each character against a supplied
275
 * "mask".
276
 */
277
278
static int type_str(unsigned long value, void *arg)
279
0
{
280
0
    unsigned long types = *((unsigned long *)arg);
281
0
    const int native = value > INT_MAX ? INT_MAX : ossl_fromascii(value);
282
283
0
    if ((types & B_ASN1_NUMERICSTRING) && !(ossl_isdigit(native)
284
0
                                            || native == ' '))
285
0
        types &= ~B_ASN1_NUMERICSTRING;
286
0
    if ((types & B_ASN1_PRINTABLESTRING) && !ossl_isasn1print(native))
287
0
        types &= ~B_ASN1_PRINTABLESTRING;
288
0
    if ((types & B_ASN1_IA5STRING) && !ossl_isascii(native))
289
0
        types &= ~B_ASN1_IA5STRING;
290
0
    if ((types & B_ASN1_T61STRING) && (value > 0xff))
291
0
        types &= ~B_ASN1_T61STRING;
292
0
    if ((types & B_ASN1_BMPSTRING) && (value > 0xffff))
293
0
        types &= ~B_ASN1_BMPSTRING;
294
0
    if ((types & B_ASN1_UTF8STRING) && !is_unicode_valid(value))
295
0
        types &= ~B_ASN1_UTF8STRING;
296
0
    if (!types)
297
0
        return -1;
298
0
    *((unsigned long *)arg) = types;
299
0
    return 1;
300
0
}
301
302
/* Copy one byte per character ASCII like strings */
303
304
static int cpy_asc(unsigned long value, void *arg)
305
0
{
306
0
    unsigned char **p, *q;
307
0
    p = arg;
308
0
    q = *p;
309
0
    *q = (unsigned char)value;
310
0
    (*p)++;
311
0
    return 1;
312
0
}
313
314
/* Copy two byte per character BMPStrings */
315
316
static int cpy_bmp(unsigned long value, void *arg)
317
0
{
318
0
    unsigned char **p, *q;
319
0
    p = arg;
320
0
    q = *p;
321
0
    *q++ = (unsigned char)((value >> 8) & 0xff);
322
0
    *q = (unsigned char)(value & 0xff);
323
0
    *p += 2;
324
0
    return 1;
325
0
}
326
327
/* Copy four byte per character UniversalStrings */
328
329
static int cpy_univ(unsigned long value, void *arg)
330
0
{
331
0
    unsigned char **p, *q;
332
0
    p = arg;
333
0
    q = *p;
334
0
    *q++ = (unsigned char)((value >> 24) & 0xff);
335
0
    *q++ = (unsigned char)((value >> 16) & 0xff);
336
0
    *q++ = (unsigned char)((value >> 8) & 0xff);
337
0
    *q = (unsigned char)(value & 0xff);
338
0
    *p += 4;
339
0
    return 1;
340
0
}
341
342
/* Copy to a UTF8String */
343
344
static int cpy_utf8(unsigned long value, void *arg)
345
0
{
346
0
    unsigned char **p;
347
0
    int ret;
348
0
    p = arg;
349
    /* We already know there is enough room so pass 0xff as the length */
350
0
    ret = UTF8_putc(*p, 0xff, value);
351
0
    *p += ret;
352
0
    return 1;
353
0
}