First public contribution.
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.]
61 #include <openssl/buffer.h>
62 #include <openssl/objects.h>
63 #include <openssl/evp.h>
64 #include <openssl/rand.h>
65 #include <openssl/x509.h>
66 #include <openssl/pem.h>
67 #include <openssl/pkcs12.h>
68 #ifndef OPENSSL_NO_DES
69 #include <openssl/des.h>
72 const char PEM_version[]="PEM" OPENSSL_VERSION_PTEXT;
76 static int load_iv(char **fromp,unsigned char *to, int num);
77 static int check_pem(const char *nm, const char *name);
79 EXPORT_C int PEM_def_callback(char *buf, int num, int w, void *key)
81 #ifdef OPENSSL_NO_FP_API
82 /* We should not ever call the default callback routine from
84 PEMerr(PEM_F_PEM_DEF_CALLBACK,ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
96 prompt=EVP_get_pw_prompt();
98 prompt="Enter PEM pass phrase:";
102 i=EVP_read_pw_string(buf,num,prompt,w);
105 PEMerr(PEM_F_PEM_DEF_CALLBACK,PEM_R_PROBLEMS_GETTING_PASSWORD);
106 memset(buf,0,(unsigned int)num);
112 fprintf(stderr,"phrase is too short, needs to be at least %d chars\n",MIN_LENGTH);
121 EXPORT_C void PEM_proc_type(char *buf, int type)
125 if (type == PEM_TYPE_ENCRYPTED)
127 else if (type == PEM_TYPE_MIC_CLEAR)
129 else if (type == PEM_TYPE_MIC_ONLY)
134 BUF_strlcat(buf,"Proc-Type: 4,",PEM_BUFSIZE);
135 BUF_strlcat(buf,str,PEM_BUFSIZE);
136 BUF_strlcat(buf,"\n",PEM_BUFSIZE);
139 EXPORT_C void PEM_dek_info(char *buf, const char *type, int len, char *str)
141 static const unsigned char map[17]="0123456789ABCDEF";
145 BUF_strlcat(buf,"DEK-Info: ",PEM_BUFSIZE);
146 BUF_strlcat(buf,type,PEM_BUFSIZE);
147 BUF_strlcat(buf,",",PEM_BUFSIZE);
149 if (j + (len * 2) + 1 > PEM_BUFSIZE)
151 for (i=0; i<len; i++)
153 buf[j+i*2] =map[(str[i]>>4)&0x0f];
154 buf[j+i*2+1]=map[(str[i] )&0x0f];
160 #ifndef OPENSSL_NO_FP_API
161 EXPORT_C void *PEM_ASN1_read(d2i_of_void *d2i, const char *name, FILE *fp, void **x,
162 pem_password_cb *cb, void *u)
167 if ((b=BIO_new(BIO_s_file())) == NULL)
169 PEMerr(PEM_F_PEM_ASN1_READ,ERR_R_BUF_LIB);
172 BIO_set_fp(b,fp,BIO_NOCLOSE);
173 ret=PEM_ASN1_read_bio(d2i,name,b,x,cb,u);
179 static int check_pem(const char *nm, const char *name)
181 /* Normal matching nm and name */
182 if (!strcmp(nm,name)) return 1;
184 /* Make PEM_STRING_EVP_PKEY match any private key */
186 if(!strcmp(nm,PEM_STRING_PKCS8) &&
187 !strcmp(name,PEM_STRING_EVP_PKEY)) return 1;
189 if(!strcmp(nm,PEM_STRING_PKCS8INF) &&
190 !strcmp(name,PEM_STRING_EVP_PKEY)) return 1;
192 if(!strcmp(nm,PEM_STRING_RSA) &&
193 !strcmp(name,PEM_STRING_EVP_PKEY)) return 1;
195 if(!strcmp(nm,PEM_STRING_DSA) &&
196 !strcmp(name,PEM_STRING_EVP_PKEY)) return 1;
198 if(!strcmp(nm,PEM_STRING_ECPRIVATEKEY) &&
199 !strcmp(name,PEM_STRING_EVP_PKEY)) return 1;
200 /* Permit older strings */
202 if(!strcmp(nm,PEM_STRING_X509_OLD) &&
203 !strcmp(name,PEM_STRING_X509)) return 1;
205 if(!strcmp(nm,PEM_STRING_X509_REQ_OLD) &&
206 !strcmp(name,PEM_STRING_X509_REQ)) return 1;
208 /* Allow normal certs to be read as trusted certs */
209 if(!strcmp(nm,PEM_STRING_X509) &&
210 !strcmp(name,PEM_STRING_X509_TRUSTED)) return 1;
212 if(!strcmp(nm,PEM_STRING_X509_OLD) &&
213 !strcmp(name,PEM_STRING_X509_TRUSTED)) return 1;
215 /* Some CAs use PKCS#7 with CERTIFICATE headers */
216 if(!strcmp(nm, PEM_STRING_X509) &&
217 !strcmp(name, PEM_STRING_PKCS7)) return 1;
222 EXPORT_C int PEM_bytes_read_bio(unsigned char **pdata, long *plen, char **pnm, const char *name, BIO *bp,
223 pem_password_cb *cb, void *u)
225 EVP_CIPHER_INFO cipher;
226 char *nm=NULL,*header=NULL;
227 unsigned char *data=NULL;
233 if (!PEM_read_bio(bp,&nm,&header,&data,&len)) {
234 if(ERR_GET_REASON(ERR_peek_error()) ==
236 ERR_add_error_data(2, "Expecting: ", name);
239 if(check_pem(nm, name)) break;
241 OPENSSL_free(header);
244 if (!PEM_get_EVP_CIPHER_INFO(header,&cipher)) goto err;
245 if (!PEM_do_header(&cipher,data,&len,cb,u)) goto err;
256 if (!ret || !pnm) OPENSSL_free(nm);
257 OPENSSL_free(header);
258 if (!ret) OPENSSL_free(data);
262 #ifndef OPENSSL_NO_FP_API
263 EXPORT_C int PEM_ASN1_write(i2d_of_void *i2d, const char *name, FILE *fp,
264 char *x, const EVP_CIPHER *enc, unsigned char *kstr,
265 int klen, pem_password_cb *callback, void *u)
270 if ((b=BIO_new(BIO_s_file())) == NULL)
272 PEMerr(PEM_F_PEM_ASN1_WRITE,ERR_R_BUF_LIB);
275 BIO_set_fp(b,fp,BIO_NOCLOSE);
276 ret=PEM_ASN1_write_bio(i2d,name,b,x,enc,kstr,klen,callback,u);
282 EXPORT_C int PEM_ASN1_write_bio(i2d_of_void *i2d, const char *name, BIO *bp,
283 char *x, const EVP_CIPHER *enc, unsigned char *kstr,
284 int klen, pem_password_cb *callback, void *u)
287 int dsize=0,i,j,ret=0;
288 unsigned char *p,*data=NULL;
289 const char *objstr=NULL;
290 char buf[PEM_BUFSIZE];
291 unsigned char key[EVP_MAX_KEY_LENGTH];
292 unsigned char iv[EVP_MAX_IV_LENGTH];
296 objstr=OBJ_nid2sn(EVP_CIPHER_nid(enc));
299 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO,PEM_R_UNSUPPORTED_CIPHER);
304 if ((dsize=i2d(x,NULL)) < 0)
306 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO,ERR_R_ASN1_LIB);
310 /* dzise + 8 bytes are needed */
311 /* actually it needs the cipher block size extra... */
312 data=(unsigned char *)OPENSSL_malloc((unsigned int)dsize+20);
315 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO,ERR_R_MALLOC_FAILURE);
325 if (callback == NULL)
326 klen=PEM_def_callback(buf,PEM_BUFSIZE,1,u);
328 klen=(*callback)(buf,PEM_BUFSIZE,1,u);
331 PEMerr(PEM_F_PEM_ASN1_WRITE_BIO,PEM_R_READ_KEY);
334 #ifdef CHARSET_EBCDIC
335 /* Convert the pass phrase from EBCDIC */
336 ebcdic2ascii(buf, buf, klen);
338 kstr=(unsigned char *)buf;
340 RAND_add(data,i,0);/* put in the RSA key. */
341 OPENSSL_assert(enc->iv_len <= (int)sizeof(iv));
342 if (RAND_pseudo_bytes(iv,enc->iv_len) < 0) /* Generate a salt */
344 /* The 'iv' is used as the iv and as a salt. It is
345 * NOT taken from the BytesToKey function */
346 EVP_BytesToKey(enc,EVP_md5(),iv,kstr,klen,1,key,NULL);
348 if (kstr == (unsigned char *)buf) OPENSSL_cleanse(buf,PEM_BUFSIZE);
350 OPENSSL_assert(strlen(objstr)+23+2*enc->iv_len+13 <= sizeof buf);
353 PEM_proc_type(buf,PEM_TYPE_ENCRYPTED);
354 PEM_dek_info(buf,objstr,enc->iv_len,(char *)iv);
357 EVP_CIPHER_CTX_init(&ctx);
358 EVP_EncryptInit_ex(&ctx,enc,NULL,key,iv);
359 EVP_EncryptUpdate(&ctx,data,&j,data,i);
360 EVP_EncryptFinal_ex(&ctx,&(data[j]),&i);
361 EVP_CIPHER_CTX_cleanup(&ctx);
370 i=PEM_write_bio(bp,name,buf,data,i);
373 OPENSSL_cleanse(key,sizeof(key));
374 OPENSSL_cleanse(iv,sizeof(iv));
375 OPENSSL_cleanse((char *)&ctx,sizeof(ctx));
376 OPENSSL_cleanse(buf,PEM_BUFSIZE);
379 OPENSSL_cleanse(data,(unsigned int)dsize);
385 EXPORT_C int PEM_do_header(EVP_CIPHER_INFO *cipher, unsigned char *data, long *plen,
386 pem_password_cb *callback,void *u)
391 unsigned char key[EVP_MAX_KEY_LENGTH];
392 char buf[PEM_BUFSIZE];
396 if (cipher->cipher == NULL) return(1);
397 if (callback == NULL)
398 klen=PEM_def_callback(buf,PEM_BUFSIZE,0,u);
400 klen=callback(buf,PEM_BUFSIZE,0,u);
403 PEMerr(PEM_F_PEM_DO_HEADER,PEM_R_BAD_PASSWORD_READ);
406 #ifdef CHARSET_EBCDIC
407 /* Convert the pass phrase from EBCDIC */
408 ebcdic2ascii(buf, buf, klen);
411 EVP_BytesToKey(cipher->cipher,EVP_md5(),&(cipher->iv[0]),
412 (unsigned char *)buf,klen,1,key,NULL);
415 EVP_CIPHER_CTX_init(&ctx);
416 EVP_DecryptInit_ex(&ctx,cipher->cipher,NULL, key,&(cipher->iv[0]));
417 EVP_DecryptUpdate(&ctx,data,&i,data,j);
418 o=EVP_DecryptFinal_ex(&ctx,&(data[i]),&j);
419 EVP_CIPHER_CTX_cleanup(&ctx);
420 OPENSSL_cleanse((char *)buf,sizeof(buf));
421 OPENSSL_cleanse((char *)key,sizeof(key));
425 PEMerr(PEM_F_PEM_DO_HEADER,PEM_R_BAD_DECRYPT);
432 EXPORT_C int PEM_get_EVP_CIPHER_INFO(char *header, EVP_CIPHER_INFO *cipher)
435 const EVP_CIPHER *enc=NULL;
437 char **header_pp = &header;
440 if ((header == NULL) || (*header == '\0') || (*header == '\n'))
442 if (strncmp(header,"Proc-Type: ",11) != 0)
443 { PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO,PEM_R_NOT_PROC_TYPE); return(0); }
445 if (*header != '4') return(0); header++;
446 if (*header != ',') return(0); header++;
447 if (strncmp(header,"ENCRYPTED",9) != 0)
448 { PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO,PEM_R_NOT_ENCRYPTED); return(0); }
449 for (; (*header != '\n') && (*header != '\0'); header++)
452 { PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO,PEM_R_SHORT_HEADER); return(0); }
454 if (strncmp(header,"DEK-Info: ",10) != 0)
455 { PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO,PEM_R_NOT_DEK_INFO); return(0); }
462 #ifndef CHARSET_EBCDIC
463 if (!( ((c >= 'A') && (c <= 'Z')) || (c == '-') ||
464 ((c >= '0') && (c <= '9'))))
467 if (!( isupper(c) || (c == '-') ||
475 cipher->cipher=enc=EVP_get_cipherbyname(p);
481 PEMerr(PEM_F_PEM_GET_EVP_CIPHER_INFO,PEM_R_UNSUPPORTED_ENCRYPTION);
484 if (!load_iv(header_pp,&(cipher->iv[0]),enc->iv_len))
490 static int load_iv(char **fromp, unsigned char *to, int num)
496 for (i=0; i<num; i++) to[i]=0;
498 for (i=0; i<num; i++)
500 if ((*from >= '0') && (*from <= '9'))
502 else if ((*from >= 'A') && (*from <= 'F'))
504 else if ((*from >= 'a') && (*from <= 'f'))
508 PEMerr(PEM_F_LOAD_IV,PEM_R_BAD_IV_CHARS);
512 to[i/2]|=v<<(long)((!(i&1))*4);
519 #ifndef OPENSSL_NO_FP_API
520 EXPORT_C int PEM_write(FILE *fp, char *name, char *header, unsigned char *data,
526 if ((b=BIO_new(BIO_s_file())) == NULL)
528 PEMerr(PEM_F_PEM_WRITE,ERR_R_BUF_LIB);
531 BIO_set_fp(b,fp,BIO_NOCLOSE);
532 ret=PEM_write_bio(b, name, header, data,len);
538 EXPORT_C int PEM_write_bio(BIO *bp, const char *name, char *header, unsigned char *data,
542 unsigned char *buf = NULL;
544 int reason=ERR_R_BUF_LIB;
546 EVP_EncodeInit(&ctx);
549 if ( (BIO_write(bp,"-----BEGIN ",11) != 11) ||
550 (BIO_write(bp,name,nlen) != nlen) ||
551 (BIO_write(bp,"-----\n",6) != 6))
557 if ( (BIO_write(bp,header,i) != i) ||
558 (BIO_write(bp,"\n",1) != 1))
562 buf = OPENSSL_malloc(PEM_BUFSIZE*8);
565 reason=ERR_R_MALLOC_FAILURE;
572 n=(int)((len>(PEM_BUFSIZE*5))?(PEM_BUFSIZE*5):len);
573 EVP_EncodeUpdate(&ctx,buf,&outl,&(data[j]),n);
574 if ((outl) && (BIO_write(bp,(char *)buf,outl) != outl))
580 EVP_EncodeFinal(&ctx,buf,&outl);
581 if ((outl > 0) && (BIO_write(bp,(char *)buf,outl) != outl)) goto err;
582 OPENSSL_cleanse(buf, PEM_BUFSIZE*8);
585 if ( (BIO_write(bp,"-----END ",9) != 9) ||
586 (BIO_write(bp,name,nlen) != nlen) ||
587 (BIO_write(bp,"-----\n",6) != 6))
592 OPENSSL_cleanse(buf, PEM_BUFSIZE*8);
595 PEMerr(PEM_F_PEM_WRITE_BIO,reason);
599 #ifndef OPENSSL_NO_FP_API
600 EXPORT_C int PEM_read(FILE *fp, char **name, char **header, unsigned char **data,
606 if ((b=BIO_new(BIO_s_file())) == NULL)
608 PEMerr(PEM_F_PEM_READ,ERR_R_BUF_LIB);
611 BIO_set_fp(b,fp,BIO_NOCLOSE);
612 ret=PEM_read_bio(b, name, header, data,len);
618 EXPORT_C int PEM_read_bio(BIO *bp, char **name, char **header, unsigned char **data,
622 int end=0,i,k,bl=0,hl=0,nohead=0;
626 BUF_MEM *dataB,*tmpB;
629 headerB=BUF_MEM_new();
631 if ((nameB == NULL) || (headerB == NULL) || (dataB == NULL))
634 BUF_MEM_free(headerB);
636 PEMerr(PEM_F_PEM_READ_BIO,ERR_R_MALLOC_FAILURE);
643 i=BIO_gets(bp,buf,254);
647 PEMerr(PEM_F_PEM_READ_BIO,PEM_R_NO_START_LINE);
651 while ((i >= 0) && (buf[i] <= ' ')) i--;
652 buf[++i]='\n'; buf[++i]='\0';
654 if (strncmp(buf,"-----BEGIN ",11) == 0)
656 i=strlen(&(buf[11]));
658 if (strncmp(&(buf[11+i-6]),"-----\n",6) != 0)
660 if (!BUF_MEM_grow(nameB,i+9))
662 PEMerr(PEM_F_PEM_READ_BIO,ERR_R_MALLOC_FAILURE);
665 memcpy(nameB->data,&(buf[11]),i-6);
666 nameB->data[i-6]='\0';
671 if (!BUF_MEM_grow(headerB,256))
672 { PEMerr(PEM_F_PEM_READ_BIO,ERR_R_MALLOC_FAILURE); goto err; }
673 headerB->data[0]='\0';
676 i=BIO_gets(bp,buf,254);
679 while ((i >= 0) && (buf[i] <= ' ')) i--;
680 buf[++i]='\n'; buf[++i]='\0';
682 if (buf[0] == '\n') break;
683 if (!BUF_MEM_grow(headerB,hl+i+9))
684 { PEMerr(PEM_F_PEM_READ_BIO,ERR_R_MALLOC_FAILURE); goto err; }
685 if (strncmp(buf,"-----END ",9) == 0)
690 memcpy(&(headerB->data[hl]),buf,i);
691 headerB->data[hl+i]='\0';
696 if (!BUF_MEM_grow(dataB,1024))
697 { PEMerr(PEM_F_PEM_READ_BIO,ERR_R_MALLOC_FAILURE); goto err; }
703 i=BIO_gets(bp,buf,254);
706 while ((i >= 0) && (buf[i] <= ' ')) i--;
707 buf[++i]='\n'; buf[++i]='\0';
710 if (strncmp(buf,"-----END ",9) == 0)
713 if (!BUF_MEM_grow_clean(dataB,i+bl+9))
715 PEMerr(PEM_F_PEM_READ_BIO,ERR_R_MALLOC_FAILURE);
718 memcpy(&(dataB->data[bl]),buf,i);
719 dataB->data[bl+i]='\0';
724 i=BIO_gets(bp,buf,254);
727 while ((i >= 0) && (buf[i] <= ' ')) i--;
728 buf[++i]='\n'; buf[++i]='\0';
741 i=strlen(nameB->data);
742 if ( (strncmp(buf,"-----END ",9) != 0) ||
743 (strncmp(nameB->data,&(buf[9]),i) != 0) ||
744 (strncmp(&(buf[9+i]),"-----\n",6) != 0))
746 PEMerr(PEM_F_PEM_READ_BIO,PEM_R_BAD_END_LINE);
750 EVP_DecodeInit(&ctx);
751 i=EVP_DecodeUpdate(&ctx,
752 (unsigned char *)dataB->data,&bl,
753 (unsigned char *)dataB->data,bl);
756 PEMerr(PEM_F_PEM_READ_BIO,PEM_R_BAD_BASE64_DECODE);
759 i=EVP_DecodeFinal(&ctx,(unsigned char *)&(dataB->data[bl]),&k);
762 PEMerr(PEM_F_PEM_READ_BIO,PEM_R_BAD_BASE64_DECODE);
767 if (bl == 0) goto err;
769 *header=headerB->data;
770 *data=(unsigned char *)dataB->data;
773 OPENSSL_free(headerB);
778 BUF_MEM_free(headerB);