change return (x) to return x
[openssl.git] / crypto / pem / pem_lib.c
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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 <ctype.h>
12 #include <string.h>
13 #include "internal/cryptlib.h"
14 #include <openssl/buffer.h>
15 #include <openssl/objects.h>
16 #include <openssl/evp.h>
17 #include <openssl/rand.h>
18 #include <openssl/x509.h>
19 #include <openssl/pem.h>
20 #include <openssl/pkcs12.h>
21 #include "internal/asn1_int.h"
22 #include <openssl/des.h>
23 #include <openssl/engine.h>
24
25 #define MIN_LENGTH      4
26
27 static int load_iv(char **fromp, unsigned char *to, int num);
28 static int check_pem(const char *nm, const char *name);
29 int pem_check_suffix(const char *pem_str, const char *suffix);
30
31 int PEM_def_callback(char *buf, int num, int w, void *key)
32 {
33     int i, j;
34     const char *prompt;
35
36     if (key) {
37         i = strlen(key);
38         i = (i > num) ? num : i;
39         memcpy(buf, key, i);
40         return i;
41     }
42
43     prompt = EVP_get_pw_prompt();
44     if (prompt == NULL)
45         prompt = "Enter PEM pass phrase:";
46
47     for (;;) {
48         /*
49          * We assume that w == 0 means decryption,
50          * while w == 1 means encryption
51          */
52         int min_len = w ? MIN_LENGTH : 0;
53
54         i = EVP_read_pw_string_min(buf, min_len, num, prompt, w);
55         if (i != 0) {
56             PEMerr(PEM_F_PEM_DEF_CALLBACK, PEM_R_PROBLEMS_GETTING_PASSWORD);
57             memset(buf, 0, (unsigned int)num);
58             return -1;
59         }
60         j = strlen(buf);
61         if (min_len && j < min_len) {
62             fprintf(stderr,
63                     "phrase is too short, needs to be at least %d chars\n",
64                     min_len);
65         } else
66             break;
67     }
68     return j;
69 }
70
71 void PEM_proc_type(char *buf, int type)
72 {
73     const char *str;
74
75     if (type == PEM_TYPE_ENCRYPTED)
76         str = "ENCRYPTED";
77     else if (type == PEM_TYPE_MIC_CLEAR)
78         str = "MIC-CLEAR";
79     else if (type == PEM_TYPE_MIC_ONLY)
80         str = "MIC-ONLY";
81     else
82         str = "BAD-TYPE";
83
84     strcat(buf, "Proc-Type: 4,");
85     strcat(buf, str);
86     strcat(buf, "\n");
87 }
88
89 void PEM_dek_info(char *buf, const char *type, int len, char *str)
90 {
91     static const unsigned char map[17] = "0123456789ABCDEF";
92     long i;
93     int j;
94
95     strcat(buf, "DEK-Info: ");
96     strcat(buf, type);
97     strcat(buf, ",");
98     j = strlen(buf);
99     for (i = 0; i < len; i++) {
100         buf[j + i * 2] = map[(str[i] >> 4) & 0x0f];
101         buf[j + i * 2 + 1] = map[(str[i]) & 0x0f];
102     }
103     buf[j + i * 2] = '\n';
104     buf[j + i * 2 + 1] = '\0';
105 }
106
107 #ifndef OPENSSL_NO_STDIO
108 void *PEM_ASN1_read(d2i_of_void *d2i, const char *name, FILE *fp, void **x,
109                     pem_password_cb *cb, void *u)
110 {
111     BIO *b;
112     void *ret;
113
114     if ((b = BIO_new(BIO_s_file())) == NULL) {
115         PEMerr(PEM_F_PEM_ASN1_READ, ERR_R_BUF_LIB);
116         return 0;
117     }
118     BIO_set_fp(b, fp, BIO_NOCLOSE);
119     ret = PEM_ASN1_read_bio(d2i, name, b, x, cb, u);
120     BIO_free(b);
121     return ret;
122 }
123 #endif
124
125 static int check_pem(const char *nm, const char *name)
126 {
127     /* Normal matching nm and name */
128     if (strcmp(nm, name) == 0)
129         return 1;
130
131     /* Make PEM_STRING_EVP_PKEY match any private key */
132
133     if (strcmp(name, PEM_STRING_EVP_PKEY) == 0) {
134         int slen;
135         const EVP_PKEY_ASN1_METHOD *ameth;
136         if (strcmp(nm, PEM_STRING_PKCS8) == 0)
137             return 1;
138         if (strcmp(nm, PEM_STRING_PKCS8INF) == 0)
139             return 1;
140         slen = pem_check_suffix(nm, "PRIVATE KEY");
141         if (slen > 0) {
142             /*
143              * NB: ENGINE implementations won't contain a deprecated old
144              * private key decode function so don't look for them.
145              */
146             ameth = EVP_PKEY_asn1_find_str(NULL, nm, slen);
147             if (ameth && ameth->old_priv_decode)
148                 return 1;
149         }
150         return 0;
151     }
152
153     if (strcmp(name, PEM_STRING_PARAMETERS) == 0) {
154         int slen;
155         const EVP_PKEY_ASN1_METHOD *ameth;
156         slen = pem_check_suffix(nm, "PARAMETERS");
157         if (slen > 0) {
158             ENGINE *e;
159             ameth = EVP_PKEY_asn1_find_str(&e, nm, slen);
160             if (ameth) {
161                 int r;
162                 if (ameth->param_decode)
163                     r = 1;
164                 else
165                     r = 0;
166 #ifndef OPENSSL_NO_ENGINE
167                 ENGINE_finish(e);
168 #endif
169                 return r;
170             }
171         }
172         return 0;
173     }
174     /* If reading DH parameters handle X9.42 DH format too */
175     if (strcmp(nm, PEM_STRING_DHXPARAMS) == 0
176         && strcmp(name, PEM_STRING_DHPARAMS) == 0)
177         return 1;
178
179     /* Permit older strings */
180
181     if (strcmp(nm, PEM_STRING_X509_OLD) == 0
182         && strcmp(name, PEM_STRING_X509) == 0)
183         return 1;
184
185     if (strcmp(nm, PEM_STRING_X509_REQ_OLD) == 0
186         && strcmp(name, PEM_STRING_X509_REQ) == 0)
187         return 1;
188
189     /* Allow normal certs to be read as trusted certs */
190     if (strcmp(nm, PEM_STRING_X509) == 0
191         && strcmp(name, PEM_STRING_X509_TRUSTED) == 0)
192         return 1;
193
194     if (strcmp(nm, PEM_STRING_X509_OLD) == 0
195         && strcmp(name, PEM_STRING_X509_TRUSTED) == 0)
196         return 1;
197
198     /* Some CAs use PKCS#7 with CERTIFICATE headers */
199     if (strcmp(nm, PEM_STRING_X509) == 0
200         && strcmp(name, PEM_STRING_PKCS7) == 0)
201         return 1;
202
203     if (strcmp(nm, PEM_STRING_PKCS7_SIGNED) == 0
204         && strcmp(name, PEM_STRING_PKCS7) == 0)
205         return 1;
206
207 #ifndef OPENSSL_NO_CMS
208     if (strcmp(nm, PEM_STRING_X509) == 0
209         && strcmp(name, PEM_STRING_CMS) == 0)
210         return 1;
211     /* Allow CMS to be read from PKCS#7 headers */
212     if (strcmp(nm, PEM_STRING_PKCS7) == 0
213         && strcmp(name, PEM_STRING_CMS) == 0)
214         return 1;
215 #endif
216
217     return 0;
218 }
219
220 static void pem_free(void *p, unsigned int flags)
221 {
222     if (flags & PEM_FLAG_SECURE)
223         OPENSSL_secure_free(p);
224     else
225         OPENSSL_free(p);
226 }
227
228 static void *pem_malloc(int num, unsigned int flags)
229 {
230     return (flags & PEM_FLAG_SECURE) ? OPENSSL_secure_malloc(num)
231                                      : OPENSSL_malloc(num);
232 }
233
234 static int pem_bytes_read_bio_flags(unsigned char **pdata, long *plen,
235                                     char **pnm, const char *name, BIO *bp,
236                                     pem_password_cb *cb, void *u,
237                                     unsigned int flags)
238 {
239     EVP_CIPHER_INFO cipher;
240     char *nm = NULL, *header = NULL;
241     unsigned char *data = NULL;
242     long len;
243     int ret = 0;
244
245     do {
246         pem_free(nm, flags);
247         pem_free(header, flags);
248         pem_free(data, flags);
249         if (!PEM_read_bio_ex(bp, &nm, &header, &data, &len, flags)) {
250             if (ERR_GET_REASON(ERR_peek_error()) == PEM_R_NO_START_LINE)
251                 ERR_add_error_data(2, "Expecting: ", name);
252             return 0;
253         }
254     } while (!check_pem(nm, name));
255     if (!PEM_get_EVP_CIPHER_INFO(header, &cipher))
256         goto err;
257     if (!PEM_do_header(&cipher, data, &len, cb, u))
258         goto err;
259
260     *pdata = data;
261     *plen = len;
262
263     if (pnm != NULL)
264         *pnm = nm;
265
266     ret = 1;
267
268  err:
269     if (!ret || pnm == NULL)
270         pem_free(nm, flags);
271     pem_free(header, flags);
272     if (!ret)
273         pem_free(data, flags);
274     return ret;
275 }
276
277 int PEM_bytes_read_bio(unsigned char **pdata, long *plen, char **pnm,
278                        const char *name, BIO *bp, pem_password_cb *cb,
279                        void *u) {
280     return pem_bytes_read_bio_flags(pdata, plen, pnm, name, bp, cb, u,
281                                     PEM_FLAG_EAY_COMPATIBLE);
282 }
283
284 int PEM_bytes_read_bio_secmem(unsigned char **pdata, long *plen, char **pnm,
285                               const char *name, BIO *bp, pem_password_cb *cb,
286                               void *u) {
287     return pem_bytes_read_bio_flags(pdata, plen, pnm, name, bp, cb, u,
288                                     PEM_FLAG_SECURE | PEM_FLAG_EAY_COMPATIBLE);
289 }
290
291 #ifndef OPENSSL_NO_STDIO
292 int PEM_ASN1_write(i2d_of_void *i2d, const char *name, FILE *fp,
293                    void *x, const EVP_CIPHER *enc, unsigned char *kstr,
294                    int klen, pem_password_cb *callback, void *u)
295 {
296     BIO *b;
297     int ret;
298
299     if ((b = BIO_new(BIO_s_file())) == NULL) {
300         PEMerr(PEM_F_PEM_ASN1_WRITE, ERR_R_BUF_LIB);
301         return 0;
302     }
303     BIO_set_fp(b, fp, BIO_NOCLOSE);
304     ret = PEM_ASN1_write_bio(i2d, name, b, x, enc, kstr, klen, callback, u);
305     BIO_free(b);
306     return ret;
307 }
308 #endif
309
310 int PEM_ASN1_write_bio(i2d_of_void *i2d, const char *name, BIO *bp,
311                        void *x, const EVP_CIPHER *enc, unsigned char *kstr,
312                        int klen, pem_password_cb *callback, void *u)
313 {
314     EVP_CIPHER_CTX *ctx = NULL;
315     int dsize = 0, i = 0, j = 0, ret = 0;
316     unsigned char *p, *data = NULL;
317     const char *objstr = NULL;
318     char buf[PEM_BUFSIZE];
319     unsigned char key[EVP_MAX_KEY_LENGTH];
320     unsigned char iv[EVP_MAX_IV_LENGTH];
321
322     if (enc != NULL) {
323         objstr = OBJ_nid2sn(EVP_CIPHER_nid(enc));
324         if (objstr == NULL || EVP_CIPHER_iv_length(enc) == 0) {
325             PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, PEM_R_UNSUPPORTED_CIPHER);
326             goto err;
327         }
328     }
329
330     if ((dsize = i2d(x, NULL)) < 0) {
331         PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, ERR_R_ASN1_LIB);
332         dsize = 0;
333         goto err;
334     }
335     /* dsize + 8 bytes are needed */
336     /* actually it needs the cipher block size extra... */
337     data = OPENSSL_malloc((unsigned int)dsize + 20);
338     if (data == NULL) {
339         PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, ERR_R_MALLOC_FAILURE);
340         goto err;
341     }
342     p = data;
343     i = i2d(x, &p);
344
345     if (enc != NULL) {
346         if (kstr == NULL) {
347             if (callback == NULL)
348                 klen = PEM_def_callback(buf, PEM_BUFSIZE, 1, u);
349             else
350                 klen = (*callback) (buf, PEM_BUFSIZE, 1, u);
351             if (klen <= 0) {
352                 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO, PEM_R_READ_KEY);
353                 goto err;
354             }
355 #ifdef CHARSET_EBCDIC
356             /* Convert the pass phrase from EBCDIC */
357             ebcdic2ascii(buf, buf, klen);
358 #endif
359             kstr = (unsigned char *)buf;
360         }
361         RAND_add(data, i, 0);   /* put in the RSA key. */
362         OPENSSL_assert(EVP_CIPHER_iv_length(enc) <= (int)sizeof(iv));
363         if (RAND_bytes(iv, EVP_CIPHER_iv_length(enc)) <= 0) /* Generate a salt */
364             goto err;
365         /*
366          * The 'iv' is used as the iv and as a salt.  It is NOT taken from
367          * the BytesToKey function
368          */
369         if (!EVP_BytesToKey(enc, EVP_md5(), iv, kstr, klen, 1, key, NULL))
370             goto err;
371
372         if (kstr == (unsigned char *)buf)
373             OPENSSL_cleanse(buf, PEM_BUFSIZE);
374
375         OPENSSL_assert(strlen(objstr) + 23 + 2 * EVP_CIPHER_iv_length(enc) + 13
376                        <= sizeof buf);
377
378         buf[0] = '\0';
379         PEM_proc_type(buf, PEM_TYPE_ENCRYPTED);
380         PEM_dek_info(buf, objstr, EVP_CIPHER_iv_length(enc), (char *)iv);
381         /* k=strlen(buf); */
382
383         ret = 1;
384         if ((ctx = EVP_CIPHER_CTX_new()) == NULL
385             || !EVP_EncryptInit_ex(ctx, enc, NULL, key, iv)
386             || !EVP_EncryptUpdate(ctx, data, &j, data, i)
387             || !EVP_EncryptFinal_ex(ctx, &(data[j]), &i))
388             ret = 0;
389         if (ret == 0)
390             goto err;
391         i += j;
392     } else {
393         ret = 1;
394         buf[0] = '\0';
395     }
396     i = PEM_write_bio(bp, name, buf, data, i);
397     if (i <= 0)
398         ret = 0;
399  err:
400     OPENSSL_cleanse(key, sizeof(key));
401     OPENSSL_cleanse(iv, sizeof(iv));
402     EVP_CIPHER_CTX_free(ctx);
403     OPENSSL_cleanse(buf, PEM_BUFSIZE);
404     OPENSSL_clear_free(data, (unsigned int)dsize);
405     return ret;
406 }
407
408 int PEM_do_header(EVP_CIPHER_INFO *cipher, unsigned char *data, long *plen,
409                   pem_password_cb *callback, void *u)
410 {
411     int ok;
412     int keylen;
413     long len = *plen;
414     int ilen = (int) len;       /* EVP_DecryptUpdate etc. take int lengths */
415     EVP_CIPHER_CTX *ctx;
416     unsigned char key[EVP_MAX_KEY_LENGTH];
417     char buf[PEM_BUFSIZE];
418
419 #if LONG_MAX > INT_MAX
420     /* Check that we did not truncate the length */
421     if (len > INT_MAX) {
422         PEMerr(PEM_F_PEM_DO_HEADER, PEM_R_HEADER_TOO_LONG);
423         return 0;
424     }
425 #endif
426
427     if (cipher->cipher == NULL)
428         return 1;
429     if (callback == NULL)
430         keylen = PEM_def_callback(buf, PEM_BUFSIZE, 0, u);
431     else
432         keylen = callback(buf, PEM_BUFSIZE, 0, u);
433     if (keylen <= 0) {
434         PEMerr(PEM_F_PEM_DO_HEADER, PEM_R_BAD_PASSWORD_READ);
435         return 0;
436     }
437 #ifdef CHARSET_EBCDIC
438     /* Convert the pass phrase from EBCDIC */
439     ebcdic2ascii(buf, buf, keylen);
440 #endif
441
442     if (!EVP_BytesToKey(cipher->cipher, EVP_md5(), &(cipher->iv[0]),
443                         (unsigned char *)buf, keylen, 1, key, NULL))
444         return 0;
445
446     ctx = EVP_CIPHER_CTX_new();
447     if (ctx == NULL)
448         return 0;
449
450     ok = EVP_DecryptInit_ex(ctx, cipher->cipher, NULL, key, &(cipher->iv[0]));
451     if (ok)
452         ok = EVP_DecryptUpdate(ctx, data, &ilen, data, ilen);
453     if (ok) {
454         /* Squirrel away the length of data decrypted so far. */
455         *plen = ilen;
456         ok = EVP_DecryptFinal_ex(ctx, &(data[ilen]), &ilen);
457     }
458     if (ok)
459         *plen += ilen;
460     else
461         PEMerr(PEM_F_PEM_DO_HEADER, PEM_R_BAD_DECRYPT);
462
463     EVP_CIPHER_CTX_free(ctx);
464     OPENSSL_cleanse((char *)buf, sizeof(buf));
465     OPENSSL_cleanse((char *)key, sizeof(key));
466     return ok;
467 }
468
469 /*
470  * This implements a very limited PEM header parser that does not support the
471  * full grammar of rfc1421.  In particular, folded headers are not supported,
472  * nor is additional whitespace.
473  *
474  * A robust implementation would make use of a library that turns the headers
475  * into a BIO from which one folded line is read at a time, and is then split
476  * into a header label and content.  We would then parse the content of the
477  * headers we care about.  This is overkill for just this limited use-case, but
478  * presumably we also parse rfc822-style headers for S/MIME, so a common
479  * abstraction might well be more generally useful.
480  */
481 int PEM_get_EVP_CIPHER_INFO(char *header, EVP_CIPHER_INFO *cipher)
482 {
483     static const char ProcType[] = "Proc-Type:";
484     static const char ENCRYPTED[] = "ENCRYPTED";
485     static const char DEKInfo[] = "DEK-Info:";
486     const EVP_CIPHER *enc = NULL;
487     int ivlen;
488     char *dekinfostart, c;
489
490     cipher->cipher = NULL;
491     if ((header == NULL) || (*header == '\0') || (*header == '\n'))
492         return 1;
493
494     if (strncmp(header, ProcType, sizeof(ProcType)-1) != 0) {
495         PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_NOT_PROC_TYPE);
496         return 0;
497     }
498     header += sizeof(ProcType)-1;
499     header += strspn(header, " \t");
500
501     if (*header++ != '4' || *header++ != ',')
502         return 0;
503     header += strspn(header, " \t");
504
505     /* We expect "ENCRYPTED" followed by optional white-space + line break */
506     if (strncmp(header, ENCRYPTED, sizeof(ENCRYPTED)-1) != 0 ||
507         strspn(header+sizeof(ENCRYPTED)-1, " \t\r\n") == 0) {
508         PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_NOT_ENCRYPTED);
509         return 0;
510     }
511     header += sizeof(ENCRYPTED)-1;
512     header += strspn(header, " \t\r");
513     if (*header++ != '\n') {
514         PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_SHORT_HEADER);
515         return 0;
516     }
517
518     /*-
519      * https://tools.ietf.org/html/rfc1421#section-4.6.1.3
520      * We expect "DEK-Info: algo[,hex-parameters]"
521      */
522     if (strncmp(header, DEKInfo, sizeof(DEKInfo)-1) != 0) {
523         PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_NOT_DEK_INFO);
524         return 0;
525     }
526     header += sizeof(DEKInfo)-1;
527     header += strspn(header, " \t");
528
529     /*
530      * DEK-INFO is a comma-separated combination of algorithm name and optional
531      * parameters.
532      */
533     dekinfostart = header;
534     header += strcspn(header, " \t,");
535     c = *header;
536     *header = '\0';
537     cipher->cipher = enc = EVP_get_cipherbyname(dekinfostart);
538     *header = c;
539     header += strspn(header, " \t");
540
541     if (enc == NULL) {
542         PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_UNSUPPORTED_ENCRYPTION);
543         return 0;
544     }
545     ivlen = EVP_CIPHER_iv_length(enc);
546     if (ivlen > 0 && *header++ != ',') {
547         PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_MISSING_DEK_IV);
548         return 0;
549     } else if (ivlen == 0 && *header == ',') {
550         PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO, PEM_R_UNEXPECTED_DEK_IV);
551         return 0;
552     }
553
554     if (!load_iv(&header, cipher->iv, EVP_CIPHER_iv_length(enc)))
555         return 0;
556
557     return 1;
558 }
559
560 static int load_iv(char **fromp, unsigned char *to, int num)
561 {
562     int v, i;
563     char *from;
564
565     from = *fromp;
566     for (i = 0; i < num; i++)
567         to[i] = 0;
568     num *= 2;
569     for (i = 0; i < num; i++) {
570         v = OPENSSL_hexchar2int(*from);
571         if (v < 0) {
572             PEMerr(PEM_F_LOAD_IV, PEM_R_BAD_IV_CHARS);
573             return 0;
574         }
575         from++;
576         to[i / 2] |= v << (long)((!(i & 1)) * 4);
577     }
578
579     *fromp = from;
580     return 1;
581 }
582
583 #ifndef OPENSSL_NO_STDIO
584 int PEM_write(FILE *fp, const char *name, const char *header,
585               const unsigned char *data, long len)
586 {
587     BIO *b;
588     int ret;
589
590     if ((b = BIO_new(BIO_s_file())) == NULL) {
591         PEMerr(PEM_F_PEM_WRITE, ERR_R_BUF_LIB);
592         return 0;
593     }
594     BIO_set_fp(b, fp, BIO_NOCLOSE);
595     ret = PEM_write_bio(b, name, header, data, len);
596     BIO_free(b);
597     return ret;
598 }
599 #endif
600
601 int PEM_write_bio(BIO *bp, const char *name, const char *header,
602                   const unsigned char *data, long len)
603 {
604     int nlen, n, i, j, outl;
605     unsigned char *buf = NULL;
606     EVP_ENCODE_CTX *ctx = EVP_ENCODE_CTX_new();
607     int reason = ERR_R_BUF_LIB;
608
609     if (ctx == NULL) {
610         reason = ERR_R_MALLOC_FAILURE;
611         goto err;
612     }
613
614     EVP_EncodeInit(ctx);
615     nlen = strlen(name);
616
617     if ((BIO_write(bp, "-----BEGIN ", 11) != 11) ||
618         (BIO_write(bp, name, nlen) != nlen) ||
619         (BIO_write(bp, "-----\n", 6) != 6))
620         goto err;
621
622     i = strlen(header);
623     if (i > 0) {
624         if ((BIO_write(bp, header, i) != i) || (BIO_write(bp, "\n", 1) != 1))
625             goto err;
626     }
627
628     buf = OPENSSL_malloc(PEM_BUFSIZE * 8);
629     if (buf == NULL) {
630         reason = ERR_R_MALLOC_FAILURE;
631         goto err;
632     }
633
634     i = j = 0;
635     while (len > 0) {
636         n = (int)((len > (PEM_BUFSIZE * 5)) ? (PEM_BUFSIZE * 5) : len);
637         if (!EVP_EncodeUpdate(ctx, buf, &outl, &(data[j]), n))
638             goto err;
639         if ((outl) && (BIO_write(bp, (char *)buf, outl) != outl))
640             goto err;
641         i += outl;
642         len -= n;
643         j += n;
644     }
645     EVP_EncodeFinal(ctx, buf, &outl);
646     if ((outl > 0) && (BIO_write(bp, (char *)buf, outl) != outl))
647         goto err;
648     if ((BIO_write(bp, "-----END ", 9) != 9) ||
649         (BIO_write(bp, name, nlen) != nlen) ||
650         (BIO_write(bp, "-----\n", 6) != 6))
651         goto err;
652     OPENSSL_clear_free(buf, PEM_BUFSIZE * 8);
653     EVP_ENCODE_CTX_free(ctx);
654     return i + outl;
655  err:
656     OPENSSL_clear_free(buf, PEM_BUFSIZE * 8);
657     EVP_ENCODE_CTX_free(ctx);
658     PEMerr(PEM_F_PEM_WRITE_BIO, reason);
659     return 0;
660 }
661
662 #ifndef OPENSSL_NO_STDIO
663 int PEM_read(FILE *fp, char **name, char **header, unsigned char **data,
664              long *len)
665 {
666     BIO *b;
667     int ret;
668
669     if ((b = BIO_new(BIO_s_file())) == NULL) {
670         PEMerr(PEM_F_PEM_READ, ERR_R_BUF_LIB);
671         return 0;
672     }
673     BIO_set_fp(b, fp, BIO_NOCLOSE);
674     ret = PEM_read_bio(b, name, header, data, len);
675     BIO_free(b);
676     return ret;
677 }
678 #endif
679
680 /* Some helpers for PEM_read_bio_ex(). */
681
682 #define isb64(c) (isalnum(c) || (c) == '+' || (c) == '/' || (c) == '=')
683
684 static int sanitize_line(char *linebuf, int len, unsigned int flags)
685 {
686     int i;
687
688     if (flags & PEM_FLAG_EAY_COMPATIBLE) {
689         /* Strip trailing whitespace */
690         while ((len >= 0) && (linebuf[len] <= ' '))
691             len--;
692         /* Go back to whitespace before applying uniform line ending. */
693         len++;
694     } else if (flags & PEM_FLAG_ONLY_B64) {
695         for (i = 0; i < len; ++i) {
696             if (!isb64(linebuf[i]) || linebuf[i] == '\n' || linebuf[i] == '\r')
697                 break;
698         }
699         len = i;
700     } else {
701         /* EVP_DecodeBlock strips leading and trailing whitespace, so just strip
702          * control characters in-place and let everything through. */
703         for (i = 0; i < len; ++i) {
704             if (linebuf[i] == '\n' || linebuf[i] == '\r')
705                 break;
706             if (iscntrl(linebuf[i]))
707                 linebuf[i] = ' ';
708         }
709         len = i;
710     }
711     /* The caller allocated LINESIZE+1, so this is safe. */
712     linebuf[len++] = '\n';
713     linebuf[len] = '\0';
714     return len;
715 }
716
717 #define LINESIZE 255
718 /* Note trailing spaces for begin and end. */
719 static const char beginstr[] = "-----BEGIN ";
720 static const char endstr[] = "-----END ";
721 static const char tailstr[] = "-----\n";
722 #define BEGINLEN (sizeof(beginstr) - 1)
723 #define ENDLEN (sizeof(endstr) - 1)
724 #define TAILLEN (sizeof(tailstr) - 1)
725 static int get_name(BIO *bp, char **name, unsigned int flags)
726 {
727     char *linebuf;
728     int ret = 0;
729     size_t len;
730
731     /*
732      * Need to hold trailing NUL (accounted for by BIO_gets() and the newline
733      * that will be added by sanitize_line() (the extra '1').
734      */
735     linebuf = pem_malloc(LINESIZE + 1, flags);
736     if (linebuf == NULL) {
737         PEMerr(PEM_F_GET_NAME, ERR_R_MALLOC_FAILURE);
738         return 0;
739     }
740
741     do {
742         len = BIO_gets(bp, linebuf, LINESIZE);
743
744         if (len <= 0) {
745             PEMerr(PEM_F_GET_NAME, PEM_R_NO_START_LINE);
746             goto err;
747         }
748
749         /* Strip trailing garbage and standardize ending. */
750         len = sanitize_line(linebuf, len, flags & ~PEM_FLAG_ONLY_B64);
751
752         /* Allow leading empty or non-matching lines. */
753     } while (strncmp(linebuf, beginstr, BEGINLEN) != 0
754              || len < TAILLEN
755              || strncmp(linebuf + len - TAILLEN, tailstr, TAILLEN) != 0);
756     linebuf[len - TAILLEN] = '\0';
757     len = len - BEGINLEN - TAILLEN + 1;
758     *name = pem_malloc(len, flags);
759     if (*name == NULL) {
760         PEMerr(PEM_F_GET_NAME, ERR_R_MALLOC_FAILURE);
761         goto err;
762     }
763     memcpy(*name, linebuf + BEGINLEN, len);
764     ret = 1;
765
766 err:
767     pem_free(linebuf, flags);
768     return ret;
769 }
770
771 /* Keep track of how much of a header we've seen. */
772 enum header_status {
773     MAYBE_HEADER,
774     IN_HEADER,
775     POST_HEADER
776 };
777
778 /**
779  * Extract the optional PEM header, with details on the type of content and
780  * any encryption used on the contents, and the bulk of the data from the bio.
781  * The end of the header is marked by a blank line; if the end-of-input marker
782  * is reached prior to a blank line, there is no header.
783  *
784  * The header and data arguments are BIO** since we may have to swap them
785  * if there is no header, for efficiency.
786  *
787  * We need the name of the PEM-encoded type to verify the end string.
788  */
789 static int get_header_and_data(BIO *bp, BIO **header, BIO **data, char *name,
790                                unsigned int flags)
791 {
792     BIO *tmp = *header;
793     char *linebuf, *p;
794     int len, line, ret = 0, end = 0;
795     /* 0 if not seen (yet), 1 if reading header, 2 if finished header */
796     enum header_status got_header = MAYBE_HEADER;
797     unsigned int flags_mask;
798     size_t namelen;
799
800     /* Need to hold trailing NUL (accounted for by BIO_gets() and the newline
801      * that will be added by sanitize_line() (the extra '1'). */
802     linebuf = pem_malloc(LINESIZE + 1, flags);
803     if (linebuf == NULL) {
804         PEMerr(PEM_F_GET_HEADER_AND_DATA, ERR_R_MALLOC_FAILURE);
805         return 0;
806     }
807
808     for (line = 0; ; line++) {
809         flags_mask = ~0u;
810         len = BIO_gets(bp, linebuf, LINESIZE);
811         if (len <= 0) {
812             PEMerr(PEM_F_GET_HEADER_AND_DATA, PEM_R_SHORT_HEADER);
813             goto err;
814         }
815
816         if (got_header == MAYBE_HEADER) {
817             if (memchr(linebuf, ':', len) != NULL)
818                 got_header = IN_HEADER;
819         }
820         if (!strncmp(linebuf, endstr, ENDLEN) || got_header == IN_HEADER)
821             flags_mask &= ~PEM_FLAG_ONLY_B64;
822         len = sanitize_line(linebuf, len, flags & flags_mask);
823
824         /* Check for end of header. */
825         if (linebuf[0] == '\n') {
826             if (got_header == POST_HEADER) {
827                 /* Another blank line is an error. */
828                 PEMerr(PEM_F_GET_HEADER_AND_DATA, PEM_R_BAD_END_LINE);
829                 goto err;
830             }
831             got_header = POST_HEADER;
832             tmp = *data;
833             continue;
834         }
835
836         /* Check for end of stream (which means there is no header). */
837         if (strncmp(linebuf, endstr, ENDLEN) == 0) {
838             p = linebuf + ENDLEN;
839             namelen = strlen(name);
840             if (strncmp(p, name, namelen) != 0 ||
841                 strncmp(p + namelen, tailstr, TAILLEN) != 0) {
842                 PEMerr(PEM_F_GET_HEADER_AND_DATA, PEM_R_BAD_END_LINE);
843                 goto err;
844             }
845             if (got_header == MAYBE_HEADER) {
846                 *header = *data;
847                 *data = tmp;
848             }
849             break;
850         } else if (end) {
851             /* Malformed input; short line not at end of data. */
852             PEMerr(PEM_F_GET_HEADER_AND_DATA, PEM_R_BAD_END_LINE);
853             goto err;
854         }
855         /*
856          * Else, a line of text -- could be header or data; we don't
857          * know yet.  Just pass it through.
858          */
859         BIO_puts(tmp, linebuf);
860         /*
861          * Only encrypted files need the line length check applied.
862          */
863         if (got_header == POST_HEADER) {
864             /* 65 includes the trailing newline */
865             if (len > 65)
866                 goto err;
867             if (len < 65)
868                 end = 1;
869         }
870     }
871
872     ret = 1;
873 err:
874     pem_free(linebuf, flags);
875     return ret;
876 }
877
878 /**
879  * Read in PEM-formatted data from the given BIO.
880  *
881  * By nature of the PEM format, all content must be printable ASCII (except
882  * for line endings).  Other characters, or lines that are longer than 80
883  * characters, are malformed input and will be rejected.
884  */
885 int PEM_read_bio_ex(BIO *bp, char **name_out, char **header,
886                     unsigned char **data, long *len_out, unsigned int flags)
887 {
888     EVP_ENCODE_CTX *ctx = EVP_ENCODE_CTX_new();
889     const BIO_METHOD *bmeth;
890     BIO *headerB = NULL, *dataB = NULL;
891     char *name = NULL;
892     int len, taillen, headerlen, ret = 0;
893     BUF_MEM * buf_mem;
894
895     if (ctx == NULL) {
896         PEMerr(PEM_F_PEM_READ_BIO_EX, ERR_R_MALLOC_FAILURE);
897         return 0;
898     }
899
900     *len_out = 0;
901     *name_out = *header = NULL;
902     *data = NULL;
903     if ((flags & PEM_FLAG_EAY_COMPATIBLE) && (flags & PEM_FLAG_ONLY_B64)) {
904         /* These two are mutually incompatible; bail out. */
905         PEMerr(PEM_F_PEM_READ_BIO_EX, ERR_R_PASSED_INVALID_ARGUMENT);
906         goto end;
907     }
908     bmeth = (flags & PEM_FLAG_SECURE) ? BIO_s_secmem() : BIO_s_mem();
909
910     headerB = BIO_new(bmeth);
911     dataB = BIO_new(bmeth);
912     if (headerB == NULL || dataB == NULL) {
913         PEMerr(PEM_F_PEM_READ_BIO_EX, ERR_R_MALLOC_FAILURE);
914         goto end;
915     }
916
917     if (!get_name(bp, &name, flags))
918         goto end;
919     if (!get_header_and_data(bp, &headerB, &dataB, name, flags))
920         goto end;
921
922     EVP_DecodeInit(ctx);
923     BIO_get_mem_ptr(dataB, &buf_mem);
924     len = buf_mem->length;
925     if (EVP_DecodeUpdate(ctx, (unsigned char*)buf_mem->data, &len,
926                          (unsigned char*)buf_mem->data, len) < 0
927             || EVP_DecodeFinal(ctx, (unsigned char*)&(buf_mem->data[len]),
928                                &taillen) < 0) {
929         PEMerr(PEM_F_PEM_READ_BIO_EX, PEM_R_BAD_BASE64_DECODE);
930         goto end;
931     }
932     len += taillen;
933     buf_mem->length = len;
934
935     /* There was no data in the PEM file; avoid malloc(0). */
936     if (len == 0)
937         goto end;
938     headerlen = BIO_get_mem_data(headerB, NULL);
939     *header = pem_malloc(headerlen + 1, flags);
940     *data = pem_malloc(len, flags);
941     if (*header == NULL || *data == NULL) {
942         pem_free(*header, flags);
943         pem_free(*data, flags);
944         goto end;
945     }
946     BIO_read(headerB, *header, headerlen);
947     (*header)[headerlen] = '\0';
948     BIO_read(dataB, *data, len);
949     *len_out = len;
950     *name_out = name;
951     name = NULL;
952     ret = 1;
953
954 end:
955     EVP_ENCODE_CTX_free(ctx);
956     pem_free(name, flags);
957     BIO_free(headerB);
958     BIO_free(dataB);
959     return ret;
960 }
961
962 int PEM_read_bio(BIO *bp, char **name, char **header, unsigned char **data,
963                  long *len)
964 {
965     return PEM_read_bio_ex(bp, name, header, data, len, PEM_FLAG_EAY_COMPATIBLE);
966 }
967
968 /*
969  * Check pem string and return prefix length. If for example the pem_str ==
970  * "RSA PRIVATE KEY" and suffix = "PRIVATE KEY" the return value is 3 for the
971  * string "RSA".
972  */
973
974 int pem_check_suffix(const char *pem_str, const char *suffix)
975 {
976     int pem_len = strlen(pem_str);
977     int suffix_len = strlen(suffix);
978     const char *p;
979     if (suffix_len + 1 >= pem_len)
980         return 0;
981     p = pem_str + pem_len - suffix_len;
982     if (strcmp(p, suffix))
983         return 0;
984     p--;
985     if (*p != ' ')
986         return 0;
987     return p - pem_str;
988 }