xref: /src/crypto/openssl/crypto/pkcs12/p12_utl.c (revision f25b8c9fb4f58cf61adb47d7570abe7caa6d385d)
1 /*
2  * Copyright 1999-2023 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/pkcs12.h>
13 #include "p12_local.h"
14 #include "crypto/pkcs7/pk7_local.h"
15 
16 /* Cheap and nasty Unicode stuff */
17 
OPENSSL_asc2uni(const char * asc,int asclen,unsigned char ** uni,int * unilen)18 unsigned char *OPENSSL_asc2uni(const char *asc, int asclen,
19     unsigned char **uni, int *unilen)
20 {
21     int ulen, i;
22     unsigned char *unitmp;
23 
24     if (asclen == -1)
25         asclen = strlen(asc);
26     if (asclen < 0)
27         return NULL;
28     ulen = asclen * 2 + 2;
29     if ((unitmp = OPENSSL_malloc(ulen)) == NULL)
30         return NULL;
31     for (i = 0; i < ulen - 2; i += 2) {
32         unitmp[i] = 0;
33         unitmp[i + 1] = asc[i >> 1];
34     }
35     /* Make result double null terminated */
36     unitmp[ulen - 2] = 0;
37     unitmp[ulen - 1] = 0;
38     if (unilen)
39         *unilen = ulen;
40     if (uni)
41         *uni = unitmp;
42     return unitmp;
43 }
44 
OPENSSL_uni2asc(const unsigned char * uni,int unilen)45 char *OPENSSL_uni2asc(const unsigned char *uni, int unilen)
46 {
47     int asclen, i;
48     char *asctmp;
49 
50     /* string must contain an even number of bytes */
51     if (unilen & 1)
52         return NULL;
53     if (unilen < 0)
54         return NULL;
55     asclen = unilen / 2;
56     /* If no terminating zero allow for one */
57     if (!unilen || uni[unilen - 1])
58         asclen++;
59     uni++;
60     if ((asctmp = OPENSSL_malloc(asclen)) == NULL)
61         return NULL;
62     for (i = 0; i < unilen; i += 2)
63         asctmp[i >> 1] = uni[i];
64     asctmp[asclen - 1] = 0;
65     return asctmp;
66 }
67 
68 /*
69  * OPENSSL_{utf82uni|uni2utf8} perform conversion between UTF-8 and
70  * PKCS#12 BMPString format, which is specified as big-endian UTF-16.
71  * One should keep in mind that even though BMPString is passed as
72  * unsigned char *, it's not the kind of string you can exercise e.g.
73  * strlen on. Caller also has to keep in mind that its length is
74  * expressed not in number of UTF-16 characters, but in number of
75  * bytes the string occupies, and treat it, the length, accordingly.
76  */
OPENSSL_utf82uni(const char * asc,int asclen,unsigned char ** uni,int * unilen)77 unsigned char *OPENSSL_utf82uni(const char *asc, int asclen,
78     unsigned char **uni, int *unilen)
79 {
80     int ulen, i, j;
81     unsigned char *unitmp, *ret;
82     unsigned long utf32chr = 0;
83 
84     if (asclen == -1)
85         asclen = strlen(asc);
86 
87     for (ulen = 0, i = 0; i < asclen; i += j) {
88         j = UTF8_getc((const unsigned char *)asc + i, asclen - i, &utf32chr);
89 
90         /*
91          * Following condition is somewhat opportunistic is sense that
92          * decoding failure is used as *indirect* indication that input
93          * string might in fact be extended ASCII/ANSI/ISO-8859-X. The
94          * fallback is taken in hope that it would allow to process
95          * files created with previous OpenSSL version, which used the
96          * naive OPENSSL_asc2uni all along. It might be worth noting
97          * that probability of false positive depends on language. In
98          * cases covered by ISO Latin 1 probability is very low, because
99          * any printable non-ASCII alphabet letter followed by another
100          * or any ASCII character will trigger failure and fallback.
101          * In other cases situation can be intensified by the fact that
102          * English letters are not part of alternative keyboard layout,
103          * but even then there should be plenty of pairs that trigger
104          * decoding failure...
105          */
106         if (j < 0)
107             return OPENSSL_asc2uni(asc, asclen, uni, unilen);
108 
109         if (utf32chr > 0x10FFFF) /* UTF-16 cap */
110             return NULL;
111 
112         if (utf32chr >= 0x10000) /* pair of UTF-16 characters */
113             ulen += 2 * 2;
114         else /* or just one */
115             ulen += 2;
116     }
117 
118     ulen += 2; /* for trailing UTF16 zero */
119 
120     if ((ret = OPENSSL_malloc(ulen)) == NULL)
121         return NULL;
122     /* re-run the loop writing down UTF-16 characters in big-endian order */
123     for (unitmp = ret, i = 0; i < asclen; i += j) {
124         j = UTF8_getc((const unsigned char *)asc + i, asclen - i, &utf32chr);
125         if (utf32chr >= 0x10000) { /* pair if UTF-16 characters */
126             unsigned int hi, lo;
127 
128             utf32chr -= 0x10000;
129             hi = 0xD800 + (utf32chr >> 10);
130             lo = 0xDC00 + (utf32chr & 0x3ff);
131             *unitmp++ = (unsigned char)(hi >> 8);
132             *unitmp++ = (unsigned char)(hi);
133             *unitmp++ = (unsigned char)(lo >> 8);
134             *unitmp++ = (unsigned char)(lo);
135         } else { /* or just one */
136             *unitmp++ = (unsigned char)(utf32chr >> 8);
137             *unitmp++ = (unsigned char)(utf32chr);
138         }
139     }
140     /* Make result double null terminated */
141     *unitmp++ = 0;
142     *unitmp++ = 0;
143     if (unilen)
144         *unilen = ulen;
145     if (uni)
146         *uni = ret;
147     return ret;
148 }
149 
bmp_to_utf8(char * str,const unsigned char * utf16,int len)150 static int bmp_to_utf8(char *str, const unsigned char *utf16, int len)
151 {
152     unsigned long utf32chr;
153 
154     if (len == 0)
155         return 0;
156 
157     if (len < 2)
158         return -1;
159 
160     /* pull UTF-16 character in big-endian order */
161     utf32chr = (utf16[0] << 8) | utf16[1];
162 
163     if (utf32chr >= 0xD800 && utf32chr < 0xE000) { /* two chars */
164         unsigned int lo;
165 
166         if (len < 4)
167             return -1;
168 
169         utf32chr -= 0xD800;
170         utf32chr <<= 10;
171         lo = (utf16[2] << 8) | utf16[3];
172         if (lo < 0xDC00 || lo >= 0xE000)
173             return -1;
174         utf32chr |= lo - 0xDC00;
175         utf32chr += 0x10000;
176     }
177 
178     return UTF8_putc((unsigned char *)str, len > 4 ? 4 : len, utf32chr);
179 }
180 
OPENSSL_uni2utf8(const unsigned char * uni,int unilen)181 char *OPENSSL_uni2utf8(const unsigned char *uni, int unilen)
182 {
183     int asclen, i, j;
184     char *asctmp;
185 
186     /* string must contain an even number of bytes */
187     if (unilen & 1)
188         return NULL;
189 
190     for (asclen = 0, i = 0; i < unilen;) {
191         j = bmp_to_utf8(NULL, uni + i, unilen - i);
192         /*
193          * falling back to OPENSSL_uni2asc makes lesser sense [than
194          * falling back to OPENSSL_asc2uni in OPENSSL_utf82uni above],
195          * it's done rather to maintain symmetry...
196          */
197         if (j < 0)
198             return OPENSSL_uni2asc(uni, unilen);
199         if (j == 4)
200             i += 4;
201         else
202             i += 2;
203         asclen += j;
204     }
205 
206     /* If no terminating zero allow for one */
207     if (!unilen || (uni[unilen - 2] || uni[unilen - 1]))
208         asclen++;
209 
210     if ((asctmp = OPENSSL_malloc(asclen)) == NULL)
211         return NULL;
212 
213     /* re-run the loop emitting UTF-8 string */
214     for (asclen = 0, i = 0; i < unilen;) {
215         j = bmp_to_utf8(asctmp + asclen, uni + i, unilen - i);
216         /* when UTF8_putc fails */
217         if (j < 0) {
218             OPENSSL_free(asctmp);
219             return NULL;
220         }
221         if (j == 4)
222             i += 4;
223         else
224             i += 2;
225         asclen += j;
226     }
227 
228     /* If no terminating zero write one */
229     if (!unilen || (uni[unilen - 2] || uni[unilen - 1]))
230         asctmp[asclen] = '\0';
231 
232     return asctmp;
233 }
234 
i2d_PKCS12_bio(BIO * bp,const PKCS12 * p12)235 int i2d_PKCS12_bio(BIO *bp, const PKCS12 *p12)
236 {
237     return ASN1_item_i2d_bio(ASN1_ITEM_rptr(PKCS12), bp, p12);
238 }
239 
240 #ifndef OPENSSL_NO_STDIO
i2d_PKCS12_fp(FILE * fp,const PKCS12 * p12)241 int i2d_PKCS12_fp(FILE *fp, const PKCS12 *p12)
242 {
243     return ASN1_item_i2d_fp(ASN1_ITEM_rptr(PKCS12), fp, p12);
244 }
245 #endif
246 
d2i_PKCS12_bio(BIO * bp,PKCS12 ** p12)247 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12)
248 {
249     OSSL_LIB_CTX *libctx = NULL;
250     const char *propq = NULL;
251     const PKCS7_CTX *p7ctx = NULL;
252 
253     if (p12 != NULL) {
254         p7ctx = ossl_pkcs12_get0_pkcs7ctx(*p12);
255         if (p7ctx != NULL) {
256             libctx = ossl_pkcs7_ctx_get0_libctx(p7ctx);
257             propq = ossl_pkcs7_ctx_get0_propq(p7ctx);
258         }
259     }
260     return ASN1_item_d2i_bio_ex(ASN1_ITEM_rptr(PKCS12), bp, p12, libctx, propq);
261 }
262 
263 #ifndef OPENSSL_NO_STDIO
d2i_PKCS12_fp(FILE * fp,PKCS12 ** p12)264 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12)
265 {
266     OSSL_LIB_CTX *libctx = NULL;
267     const char *propq = NULL;
268     const PKCS7_CTX *p7ctx = NULL;
269 
270     if (p12 != NULL) {
271         p7ctx = ossl_pkcs12_get0_pkcs7ctx(*p12);
272         if (p7ctx != NULL) {
273             libctx = ossl_pkcs7_ctx_get0_libctx(p7ctx);
274             propq = ossl_pkcs7_ctx_get0_propq(p7ctx);
275         }
276     }
277     return ASN1_item_d2i_fp_ex(ASN1_ITEM_rptr(PKCS12), fp, p12, libctx, propq);
278 }
279 #endif
280