1 /* crypto/pem/pem_lib.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.] */
62 #include <openssl/base64.h>
63 #include <openssl/buf.h>
64 #include <openssl/des.h>
65 #include <openssl/err.h>
66 #include <openssl/evp.h>
67 #include <openssl/mem.h>
68 #include <openssl/obj.h>
69 #include <openssl/pem.h>
70 #include <openssl/rand.h>
71 #include <openssl/x509.h>
73 #include "../evp/internal.h"
78 static int load_iv(char **fromp,unsigned char *to, int num);
79 static int check_pem(const char *nm, const char *name);
80 int pem_check_suffix(const char *pem_str, const char *suffix);
82 void PEM_proc_type(char *buf, int type)
86 if (type == PEM_TYPE_ENCRYPTED)
88 else if (type == PEM_TYPE_MIC_CLEAR)
90 else if (type == PEM_TYPE_MIC_ONLY)
95 BUF_strlcat(buf,"Proc-Type: 4,",PEM_BUFSIZE);
96 BUF_strlcat(buf,str,PEM_BUFSIZE);
97 BUF_strlcat(buf,"\n",PEM_BUFSIZE);
100 void PEM_dek_info(char *buf, const char *type, int len, char *str)
102 static const unsigned char map[17]="0123456789ABCDEF";
106 BUF_strlcat(buf,"DEK-Info: ",PEM_BUFSIZE);
107 BUF_strlcat(buf,type,PEM_BUFSIZE);
108 BUF_strlcat(buf,",",PEM_BUFSIZE);
110 if (j + (len * 2) + 1 > PEM_BUFSIZE)
112 for (i=0; i<len; i++)
114 buf[j+i*2] =map[(str[i]>>4)&0x0f];
115 buf[j+i*2+1]=map[(str[i] )&0x0f];
121 #ifndef OPENSSL_NO_FP_API
122 void *PEM_ASN1_read(d2i_of_void *d2i, const char *name, FILE *fp, void **x,
123 pem_password_cb *cb, void *u)
128 if ((b=BIO_new(BIO_s_file())) == NULL)
130 OPENSSL_PUT_ERROR(PEM, PEM_ASN1_read, ERR_R_BUF_LIB);
133 BIO_set_fp(b,fp,BIO_NOCLOSE);
134 ret=PEM_ASN1_read_bio(d2i,name,b,x,cb,u);
140 static int check_pem(const char *nm, const char *name)
142 /* Normal matching nm and name */
143 if (!strcmp(nm,name)) return 1;
145 /* Make PEM_STRING_EVP_PKEY match any private key */
147 if(!strcmp(name,PEM_STRING_EVP_PKEY))
150 const EVP_PKEY_ASN1_METHOD *ameth;
151 if(!strcmp(nm,PEM_STRING_PKCS8))
153 if(!strcmp(nm,PEM_STRING_PKCS8INF))
155 slen = pem_check_suffix(nm, "PRIVATE KEY");
158 /* NB: ENGINE implementations wont contain
159 * a deprecated old private key decode function
160 * so don't look for them.
162 ameth = EVP_PKEY_asn1_find_str(NULL, nm, slen);
163 if (ameth && ameth->old_priv_decode)
169 if(!strcmp(name,PEM_STRING_PARAMETERS))
172 const EVP_PKEY_ASN1_METHOD *ameth;
173 slen = pem_check_suffix(nm, "PARAMETERS");
177 ameth = EVP_PKEY_asn1_find_str(&e, nm, slen);
181 if (ameth->param_decode)
190 /* If reading DH parameters handle X9.42 DH format too */
191 if(!strcmp(nm,PEM_STRING_DHXPARAMS) &&
192 !strcmp(name,PEM_STRING_DHPARAMS)) return 1;
194 /* Permit older strings */
196 if(!strcmp(nm,PEM_STRING_X509_OLD) &&
197 !strcmp(name,PEM_STRING_X509)) return 1;
199 if(!strcmp(nm,PEM_STRING_X509_REQ_OLD) &&
200 !strcmp(name,PEM_STRING_X509_REQ)) return 1;
202 /* Allow normal certs to be read as trusted certs */
203 if(!strcmp(nm,PEM_STRING_X509) &&
204 !strcmp(name,PEM_STRING_X509_TRUSTED)) return 1;
206 if(!strcmp(nm,PEM_STRING_X509_OLD) &&
207 !strcmp(name,PEM_STRING_X509_TRUSTED)) return 1;
209 /* Some CAs use PKCS#7 with CERTIFICATE headers */
210 if(!strcmp(nm, PEM_STRING_X509) &&
211 !strcmp(name, PEM_STRING_PKCS7)) return 1;
213 if(!strcmp(nm, PEM_STRING_PKCS7_SIGNED) &&
214 !strcmp(name, PEM_STRING_PKCS7)) return 1;
216 #ifndef OPENSSL_NO_CMS
217 if(!strcmp(nm, PEM_STRING_X509) &&
218 !strcmp(name, PEM_STRING_CMS)) return 1;
219 /* Allow CMS to be read from PKCS#7 headers */
220 if(!strcmp(nm, PEM_STRING_PKCS7) &&
221 !strcmp(name, PEM_STRING_CMS)) return 1;
227 int PEM_bytes_read_bio(unsigned char **pdata, long *plen, char **pnm, const char *name, BIO *bp,
228 pem_password_cb *cb, void *u)
230 EVP_CIPHER_INFO cipher;
231 char *nm=NULL,*header=NULL;
232 unsigned char *data=NULL;
238 if (!PEM_read_bio(bp,&nm,&header,&data,&len)) {
239 if(ERR_GET_REASON(ERR_peek_error()) ==
241 ERR_add_error_data(2, "Expecting: ", name);
244 if(check_pem(nm, name)) break;
246 OPENSSL_free(header);
249 if (!PEM_get_EVP_CIPHER_INFO(header,&cipher)) goto err;
250 if (!PEM_do_header(&cipher,data,&len,cb,u)) goto err;
261 if (!ret || !pnm) OPENSSL_free(nm);
262 OPENSSL_free(header);
263 if (!ret) OPENSSL_free(data);
267 #ifndef OPENSSL_NO_FP_API
268 int PEM_ASN1_write(i2d_of_void *i2d, const char *name, FILE *fp,
269 void *x, const EVP_CIPHER *enc, unsigned char *kstr,
270 int klen, pem_password_cb *callback, void *u)
275 if ((b=BIO_new(BIO_s_file())) == NULL)
277 OPENSSL_PUT_ERROR(PEM, PEM_ASN1_write, ERR_R_BUF_LIB);
280 BIO_set_fp(b,fp,BIO_NOCLOSE);
281 ret=PEM_ASN1_write_bio(i2d,name,b,x,enc,kstr,klen,callback,u);
287 int PEM_ASN1_write_bio(i2d_of_void *i2d, const char *name, BIO *bp,
288 void *x, const EVP_CIPHER *enc, unsigned char *kstr,
289 int klen, pem_password_cb *callback, void *u)
292 int dsize=0,i,j,ret=0;
293 unsigned char *p,*data=NULL;
294 const char *objstr=NULL;
295 char buf[PEM_BUFSIZE];
296 unsigned char key[EVP_MAX_KEY_LENGTH];
297 unsigned char iv[EVP_MAX_IV_LENGTH];
301 objstr=OBJ_nid2sn(EVP_CIPHER_nid(enc));
304 OPENSSL_PUT_ERROR(PEM, PEM_ASN1_write_bio, PEM_R_UNSUPPORTED_CIPHER);
309 if ((dsize=i2d(x,NULL)) < 0)
311 OPENSSL_PUT_ERROR(PEM, PEM_ASN1_write_bio, ERR_R_ASN1_LIB);
315 /* dzise + 8 bytes are needed */
316 /* actually it needs the cipher block size extra... */
317 data=(unsigned char *)OPENSSL_malloc((unsigned int)dsize+20);
320 OPENSSL_PUT_ERROR(PEM, PEM_ASN1_write_bio, ERR_R_MALLOC_FAILURE);
328 const unsigned iv_len = EVP_CIPHER_iv_length(enc);
334 klen=(*callback)(buf,PEM_BUFSIZE,1,u);
337 OPENSSL_PUT_ERROR(PEM, PEM_ASN1_write_bio, PEM_R_READ_KEY);
340 kstr=(unsigned char *)buf;
342 assert(iv_len <= (int)sizeof(iv));
343 if (RAND_pseudo_bytes(iv,iv_len) < 0) /* Generate a salt */
345 /* The 'iv' is used as the iv and as a salt. It is
346 * NOT taken from the BytesToKey function */
347 if (!EVP_BytesToKey(enc,EVP_md5(),iv,kstr,klen,1,key,NULL))
350 if (kstr == (unsigned char *)buf) OPENSSL_cleanse(buf,PEM_BUFSIZE);
352 assert(strlen(objstr)+23+2*iv_len+13 <= sizeof buf);
355 PEM_proc_type(buf,PEM_TYPE_ENCRYPTED);
356 PEM_dek_info(buf,objstr,iv_len,(char *)iv);
359 EVP_CIPHER_CTX_init(&ctx);
361 if (!EVP_EncryptInit_ex(&ctx,enc,NULL,key,iv)
362 || !EVP_EncryptUpdate(&ctx,data,&j,data,i)
363 || !EVP_EncryptFinal_ex(&ctx,&(data[j]),&i))
365 EVP_CIPHER_CTX_cleanup(&ctx);
375 i=PEM_write_bio(bp,name,buf,data,i);
378 OPENSSL_cleanse(key,sizeof(key));
379 OPENSSL_cleanse(iv,sizeof(iv));
380 OPENSSL_cleanse((char *)&ctx,sizeof(ctx));
381 OPENSSL_cleanse(buf,PEM_BUFSIZE);
384 OPENSSL_cleanse(data,(unsigned int)dsize);
390 int PEM_do_header(EVP_CIPHER_INFO *cipher, unsigned char *data, long *plen,
391 pem_password_cb *callback,void *u)
396 unsigned char key[EVP_MAX_KEY_LENGTH];
397 char buf[PEM_BUFSIZE];
401 if (cipher->cipher == NULL) return(1);
405 klen=callback(buf,PEM_BUFSIZE,0,u);
408 OPENSSL_PUT_ERROR(PEM, PEM_do_header, PEM_R_BAD_PASSWORD_READ);
412 if (!EVP_BytesToKey(cipher->cipher,EVP_md5(),&(cipher->iv[0]),
413 (unsigned char *)buf,klen,1,key,NULL))
417 EVP_CIPHER_CTX_init(&ctx);
418 o = EVP_DecryptInit_ex(&ctx,cipher->cipher,NULL, key,&(cipher->iv[0]));
420 o = EVP_DecryptUpdate(&ctx,data,&i,data,j);
422 o = EVP_DecryptFinal_ex(&ctx,&(data[i]),&j);
423 EVP_CIPHER_CTX_cleanup(&ctx);
424 OPENSSL_cleanse((char *)buf,sizeof(buf));
425 OPENSSL_cleanse((char *)key,sizeof(key));
428 OPENSSL_PUT_ERROR(PEM, PEM_do_header, PEM_R_BAD_DECRYPT);
436 static const EVP_CIPHER* cipher_by_name(const char *name) {
437 if (strcmp(name, "DES-CBC") == 0) {
438 return EVP_des_cbc();
439 } else if (strcmp(name, "AES-128-CBC") == 0) {
440 return EVP_aes_128_cbc();
441 } else if (strcmp(name, "AES-256-CBC") == 0) {
442 return EVP_aes_256_cbc();
448 int PEM_get_EVP_CIPHER_INFO(char *header, EVP_CIPHER_INFO *cipher)
450 const EVP_CIPHER *enc=NULL;
452 char **header_pp = &header;
455 if ((header == NULL) || (*header == '\0') || (*header == '\n'))
457 if (strncmp(header,"Proc-Type: ",11) != 0)
458 { OPENSSL_PUT_ERROR(PEM, PEM_get_EVP_CIPHER_INFO, PEM_R_NOT_PROC_TYPE); return(0); }
460 if (*header != '4') return(0); header++;
461 if (*header != ',') return(0); header++;
462 if (strncmp(header,"ENCRYPTED",9) != 0)
463 { OPENSSL_PUT_ERROR(PEM, PEM_get_EVP_CIPHER_INFO, PEM_R_NOT_ENCRYPTED); return(0); }
464 for (; (*header != '\n') && (*header != '\0'); header++)
467 { OPENSSL_PUT_ERROR(PEM, PEM_get_EVP_CIPHER_INFO, PEM_R_SHORT_HEADER); return(0); }
469 if (strncmp(header,"DEK-Info: ",10) != 0)
470 { OPENSSL_PUT_ERROR(PEM, PEM_get_EVP_CIPHER_INFO, PEM_R_NOT_DEK_INFO); return(0); }
477 if (!( ((c >= 'A') && (c <= 'Z')) || (c == '-') ||
478 ((c >= '0') && (c <= '9'))))
483 cipher->cipher=enc=cipher_by_name(p);
489 OPENSSL_PUT_ERROR(PEM, PEM_get_EVP_CIPHER_INFO, PEM_R_UNSUPPORTED_ENCRYPTION);
492 if (!load_iv(header_pp,&(cipher->iv[0]),EVP_CIPHER_iv_length(enc)))
498 static int load_iv(char **fromp, unsigned char *to, int num)
504 for (i=0; i<num; i++) to[i]=0;
506 for (i=0; i<num; i++)
508 if ((*from >= '0') && (*from <= '9'))
510 else if ((*from >= 'A') && (*from <= 'F'))
512 else if ((*from >= 'a') && (*from <= 'f'))
516 OPENSSL_PUT_ERROR(PEM, load_iv, PEM_R_BAD_IV_CHARS);
520 to[i/2]|=v<<(long)((!(i&1))*4);
527 #ifndef OPENSSL_NO_FP_API
528 int PEM_write(FILE *fp, const char *name, const char *header,
529 const unsigned char *data, long len)
534 if ((b=BIO_new(BIO_s_file())) == NULL)
536 OPENSSL_PUT_ERROR(PEM, PEM_write, ERR_R_BUF_LIB);
539 BIO_set_fp(b,fp,BIO_NOCLOSE);
540 ret=PEM_write_bio(b, name, header, data,len);
546 int PEM_write_bio(BIO *bp, const char *name, const char *header,
547 const unsigned char *data, long len)
550 unsigned char *buf = NULL;
552 int reason=ERR_R_BUF_LIB;
554 EVP_EncodeInit(&ctx);
557 if ( (BIO_write(bp,"-----BEGIN ",11) != 11) ||
558 (BIO_write(bp,name,nlen) != nlen) ||
559 (BIO_write(bp,"-----\n",6) != 6))
565 if ( (BIO_write(bp,header,i) != i) ||
566 (BIO_write(bp,"\n",1) != 1))
570 buf = OPENSSL_malloc(PEM_BUFSIZE*8);
573 reason=ERR_R_MALLOC_FAILURE;
580 n=(int)((len>(PEM_BUFSIZE*5))?(PEM_BUFSIZE*5):len);
581 EVP_EncodeUpdate(&ctx,buf,&outl,&(data[j]),n);
582 if ((outl) && (BIO_write(bp,(char *)buf,outl) != outl))
588 EVP_EncodeFinal(&ctx,buf,&outl);
589 if ((outl > 0) && (BIO_write(bp,(char *)buf,outl) != outl)) goto err;
590 OPENSSL_cleanse(buf, PEM_BUFSIZE*8);
593 if ( (BIO_write(bp,"-----END ",9) != 9) ||
594 (BIO_write(bp,name,nlen) != nlen) ||
595 (BIO_write(bp,"-----\n",6) != 6))
600 OPENSSL_cleanse(buf, PEM_BUFSIZE*8);
603 OPENSSL_PUT_ERROR(PEM, PEM_write_bio, reason);
607 #ifndef OPENSSL_NO_FP_API
608 int PEM_read(FILE *fp, char **name, char **header, unsigned char **data,
614 if ((b=BIO_new(BIO_s_file())) == NULL)
616 OPENSSL_PUT_ERROR(PEM, PEM_read, ERR_R_BUF_LIB);
619 BIO_set_fp(b,fp,BIO_NOCLOSE);
620 ret=PEM_read_bio(b, name, header, data,len);
626 int PEM_read_bio(BIO *bp, char **name, char **header, unsigned char **data,
630 int end=0,i,k,bl=0,hl=0,nohead=0;
634 BUF_MEM *dataB,*tmpB;
637 headerB=BUF_MEM_new();
639 if ((nameB == NULL) || (headerB == NULL) || (dataB == NULL))
642 BUF_MEM_free(headerB);
644 OPENSSL_PUT_ERROR(PEM, PEM_read_bio, ERR_R_MALLOC_FAILURE);
651 i=BIO_gets(bp,buf,254);
655 OPENSSL_PUT_ERROR(PEM, PEM_read_bio, PEM_R_NO_START_LINE);
659 while ((i >= 0) && (buf[i] <= ' ')) i--;
660 buf[++i]='\n'; buf[++i]='\0';
662 if (strncmp(buf,"-----BEGIN ",11) == 0)
664 i=strlen(&(buf[11]));
666 if (strncmp(&(buf[11+i-6]),"-----\n",6) != 0)
668 if (!BUF_MEM_grow(nameB,i+9))
670 OPENSSL_PUT_ERROR(PEM, PEM_read_bio, ERR_R_MALLOC_FAILURE);
673 memcpy(nameB->data,&(buf[11]),i-6);
674 nameB->data[i-6]='\0';
679 if (!BUF_MEM_grow(headerB,256))
680 { OPENSSL_PUT_ERROR(PEM, PEM_read_bio, ERR_R_MALLOC_FAILURE); goto err; }
681 headerB->data[0]='\0';
684 i=BIO_gets(bp,buf,254);
687 while ((i >= 0) && (buf[i] <= ' ')) i--;
688 buf[++i]='\n'; buf[++i]='\0';
690 if (buf[0] == '\n') break;
691 if (!BUF_MEM_grow(headerB,hl+i+9))
692 { OPENSSL_PUT_ERROR(PEM, PEM_read_bio, ERR_R_MALLOC_FAILURE); goto err; }
693 if (strncmp(buf,"-----END ",9) == 0)
698 memcpy(&(headerB->data[hl]),buf,i);
699 headerB->data[hl+i]='\0';
704 if (!BUF_MEM_grow(dataB,1024))
705 { OPENSSL_PUT_ERROR(PEM, PEM_read_bio, ERR_R_MALLOC_FAILURE); goto err; }
711 i=BIO_gets(bp,buf,254);
714 while ((i >= 0) && (buf[i] <= ' ')) i--;
715 buf[++i]='\n'; buf[++i]='\0';
718 if (strncmp(buf,"-----END ",9) == 0)
721 if (!BUF_MEM_grow_clean(dataB,i+bl+9))
723 OPENSSL_PUT_ERROR(PEM, PEM_read_bio, ERR_R_MALLOC_FAILURE);
726 memcpy(&(dataB->data[bl]),buf,i);
727 dataB->data[bl+i]='\0';
732 i=BIO_gets(bp,buf,254);
735 while ((i >= 0) && (buf[i] <= ' ')) i--;
736 buf[++i]='\n'; buf[++i]='\0';
749 i=strlen(nameB->data);
750 if ( (strncmp(buf,"-----END ",9) != 0) ||
751 (strncmp(nameB->data,&(buf[9]),i) != 0) ||
752 (strncmp(&(buf[9+i]),"-----\n",6) != 0))
754 OPENSSL_PUT_ERROR(PEM, PEM_read_bio, PEM_R_BAD_END_LINE);
758 EVP_DecodeInit(&ctx);
759 i=EVP_DecodeUpdate(&ctx,
760 (unsigned char *)dataB->data,&bl,
761 (unsigned char *)dataB->data,bl);
764 OPENSSL_PUT_ERROR(PEM, PEM_read_bio, PEM_R_BAD_BASE64_DECODE);
767 i=EVP_DecodeFinal(&ctx,(unsigned char *)&(dataB->data[bl]),&k);
770 OPENSSL_PUT_ERROR(PEM, PEM_read_bio, PEM_R_BAD_BASE64_DECODE);
775 if (bl == 0) goto err;
777 *header=headerB->data;
778 *data=(unsigned char *)dataB->data;
781 OPENSSL_free(headerB);
786 BUF_MEM_free(headerB);
791 /* Check pem string and return prefix length.
792 * If for example the pem_str == "RSA PRIVATE KEY" and suffix = "PRIVATE KEY"
793 * the return value is 3 for the string "RSA".
796 int pem_check_suffix(const char *pem_str, const char *suffix)
798 int pem_len = strlen(pem_str);
799 int suffix_len = strlen(suffix);
801 if (suffix_len + 1 >= pem_len)
803 p = pem_str + pem_len - suffix_len;
804 if (strcmp(p, suffix))