pem.h revision 296465
1/* crypto/pem/pem.h */
2/* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
3 * All rights reserved.
4 *
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.
8 *
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).
15 *
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.
22 *
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
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)"
40 *
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
51 * SUCH DAMAGE.
52 *
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.]
57 */
58
59#ifndef HEADER_PEM_H
60# define HEADER_PEM_H
61
62# include <openssl/e_os2.h>
63# ifndef OPENSSL_NO_BIO
64#  include <openssl/bio.h>
65# endif
66# ifndef OPENSSL_NO_STACK
67#  include <openssl/stack.h>
68# endif
69# include <openssl/evp.h>
70# include <openssl/x509.h>
71# include <openssl/pem2.h>
72
73#ifdef  __cplusplus
74extern "C" {
75#endif
76
77# define PEM_BUFSIZE             1024
78
79# define PEM_OBJ_UNDEF           0
80# define PEM_OBJ_X509            1
81# define PEM_OBJ_X509_REQ        2
82# define PEM_OBJ_CRL             3
83# define PEM_OBJ_SSL_SESSION     4
84# define PEM_OBJ_PRIV_KEY        10
85# define PEM_OBJ_PRIV_RSA        11
86# define PEM_OBJ_PRIV_DSA        12
87# define PEM_OBJ_PRIV_DH         13
88# define PEM_OBJ_PUB_RSA         14
89# define PEM_OBJ_PUB_DSA         15
90# define PEM_OBJ_PUB_DH          16
91# define PEM_OBJ_DHPARAMS        17
92# define PEM_OBJ_DSAPARAMS       18
93# define PEM_OBJ_PRIV_RSA_PUBLIC 19
94# define PEM_OBJ_PRIV_ECDSA      20
95# define PEM_OBJ_PUB_ECDSA       21
96# define PEM_OBJ_ECPARAMETERS    22
97
98# define PEM_ERROR               30
99# define PEM_DEK_DES_CBC         40
100# define PEM_DEK_IDEA_CBC        45
101# define PEM_DEK_DES_EDE         50
102# define PEM_DEK_DES_ECB         60
103# define PEM_DEK_RSA             70
104# define PEM_DEK_RSA_MD2         80
105# define PEM_DEK_RSA_MD5         90
106
107# define PEM_MD_MD2              NID_md2
108# define PEM_MD_MD5              NID_md5
109# define PEM_MD_SHA              NID_sha
110# define PEM_MD_MD2_RSA          NID_md2WithRSAEncryption
111# define PEM_MD_MD5_RSA          NID_md5WithRSAEncryption
112# define PEM_MD_SHA_RSA          NID_sha1WithRSAEncryption
113
114# define PEM_STRING_X509_OLD     "X509 CERTIFICATE"
115# define PEM_STRING_X509         "CERTIFICATE"
116# define PEM_STRING_X509_PAIR    "CERTIFICATE PAIR"
117# define PEM_STRING_X509_TRUSTED "TRUSTED CERTIFICATE"
118# define PEM_STRING_X509_REQ_OLD "NEW CERTIFICATE REQUEST"
119# define PEM_STRING_X509_REQ     "CERTIFICATE REQUEST"
120# define PEM_STRING_X509_CRL     "X509 CRL"
121# define PEM_STRING_EVP_PKEY     "ANY PRIVATE KEY"
122# define PEM_STRING_PUBLIC       "PUBLIC KEY"
123# define PEM_STRING_RSA          "RSA PRIVATE KEY"
124# define PEM_STRING_RSA_PUBLIC   "RSA PUBLIC KEY"
125# define PEM_STRING_DSA          "DSA PRIVATE KEY"
126# define PEM_STRING_DSA_PUBLIC   "DSA PUBLIC KEY"
127# define PEM_STRING_PKCS7        "PKCS7"
128# define PEM_STRING_PKCS7_SIGNED "PKCS #7 SIGNED DATA"
129# define PEM_STRING_PKCS8        "ENCRYPTED PRIVATE KEY"
130# define PEM_STRING_PKCS8INF     "PRIVATE KEY"
131# define PEM_STRING_DHPARAMS     "DH PARAMETERS"
132# define PEM_STRING_SSL_SESSION  "SSL SESSION PARAMETERS"
133# define PEM_STRING_DSAPARAMS    "DSA PARAMETERS"
134# define PEM_STRING_ECDSA_PUBLIC "ECDSA PUBLIC KEY"
135# define PEM_STRING_ECPARAMETERS "EC PARAMETERS"
136# define PEM_STRING_ECPRIVATEKEY "EC PRIVATE KEY"
137# define PEM_STRING_CMS          "CMS"
138
139  /*
140   * Note that this structure is initialised by PEM_SealInit and cleaned up
141   * by PEM_SealFinal (at least for now)
142   */
143typedef struct PEM_Encode_Seal_st {
144    EVP_ENCODE_CTX encode;
145    EVP_MD_CTX md;
146    EVP_CIPHER_CTX cipher;
147} PEM_ENCODE_SEAL_CTX;
148
149/* enc_type is one off */
150# define PEM_TYPE_ENCRYPTED      10
151# define PEM_TYPE_MIC_ONLY       20
152# define PEM_TYPE_MIC_CLEAR      30
153# define PEM_TYPE_CLEAR          40
154
155typedef struct pem_recip_st {
156    char *name;
157    X509_NAME *dn;
158    int cipher;
159    int key_enc;
160    /*      char iv[8]; unused and wrong size */
161} PEM_USER;
162
163typedef struct pem_ctx_st {
164    int type;                   /* what type of object */
165    struct {
166        int version;
167        int mode;
168    } proc_type;
169
170    char *domain;
171
172    struct {
173        int cipher;
174        /*-
175        unused, and wrong size
176        unsigned char iv[8]; */
177    } DEK_info;
178
179    PEM_USER *originator;
180
181    int num_recipient;
182    PEM_USER **recipient;
183
184# ifndef OPENSSL_NO_STACK
185    STACK *x509_chain;          /* certificate chain */
186# else
187    char *x509_chain;           /* certificate chain */
188# endif
189    EVP_MD *md;                 /* signature type */
190
191    int md_enc;                 /* is the md encrypted or not? */
192    int md_len;                 /* length of md_data */
193    char *md_data;              /* message digest, could be pkey encrypted */
194
195    EVP_CIPHER *dec;            /* date encryption cipher */
196    int key_len;                /* key length */
197    unsigned char *key;         /* key */
198  /*-
199    unused, and wrong size
200    unsigned char iv[8]; */
201
202    int data_enc;               /* is the data encrypted */
203    int data_len;
204    unsigned char *data;
205} PEM_CTX;
206
207/*
208 * These macros make the PEM_read/PEM_write functions easier to maintain and
209 * write. Now they are all implemented with either: IMPLEMENT_PEM_rw(...) or
210 * IMPLEMENT_PEM_rw_cb(...)
211 */
212
213# ifdef OPENSSL_NO_FP_API
214
215#  define IMPLEMENT_PEM_read_fp(name, type, str, asn1) /**/
216#  define IMPLEMENT_PEM_write_fp(name, type, str, asn1) /**/
217#  define IMPLEMENT_PEM_write_fp_const(name, type, str, asn1) /**/
218#  define IMPLEMENT_PEM_write_cb_fp(name, type, str, asn1) /**/
219#  define IMPLEMENT_PEM_write_cb_fp_const(name, type, str, asn1) /**/
220# else
221
222#  define IMPLEMENT_PEM_read_fp(name, type, str, asn1) \
223type *PEM_read_##name(FILE *fp, type **x, pem_password_cb *cb, void *u)\
224{ \
225    return (type*)PEM_ASN1_read(CHECKED_D2I_OF(type, d2i_##asn1), \
226                                str, fp, \
227                                CHECKED_PPTR_OF(type, x), \
228                                cb, u); \
229}
230
231#  define IMPLEMENT_PEM_write_fp(name, type, str, asn1) \
232int PEM_write_##name(FILE *fp, type *x) \
233{ \
234    return PEM_ASN1_write(CHECKED_I2D_OF(type, i2d_##asn1), \
235                          str, fp, \
236                          CHECKED_PTR_OF(type, x), \
237                          NULL, NULL, 0, NULL, NULL); \
238}
239
240#  define IMPLEMENT_PEM_write_fp_const(name, type, str, asn1) \
241int PEM_write_##name(FILE *fp, const type *x) \
242{ \
243    return PEM_ASN1_write(CHECKED_I2D_OF(const type, i2d_##asn1), \
244                          str, fp, \
245                          CHECKED_PTR_OF(const type, x), \
246                          NULL, NULL, 0, NULL, NULL); \
247}
248
249#  define IMPLEMENT_PEM_write_cb_fp(name, type, str, asn1) \
250int PEM_write_##name(FILE *fp, type *x, const EVP_CIPHER *enc, \
251             unsigned char *kstr, int klen, pem_password_cb *cb, \
252                  void *u) \
253        { \
254            return PEM_ASN1_write(CHECKED_I2D_OF(type, i2d_##asn1), \
255                                  str, fp, \
256                                  CHECKED_PTR_OF(type, x), \
257                                  enc, kstr, klen, cb, u); \
258        }
259
260#  define IMPLEMENT_PEM_write_cb_fp_const(name, type, str, asn1) \
261int PEM_write_##name(FILE *fp, type *x, const EVP_CIPHER *enc, \
262             unsigned char *kstr, int klen, pem_password_cb *cb, \
263                  void *u) \
264        { \
265            return PEM_ASN1_write(CHECKED_I2D_OF(const type, i2d_##asn1), \
266                                  str, fp, \
267                                  CHECKED_PTR_OF(const type, x), \
268                                  enc, kstr, klen, cb, u); \
269        }
270
271# endif
272
273# define IMPLEMENT_PEM_read_bio(name, type, str, asn1) \
274type *PEM_read_bio_##name(BIO *bp, type **x, pem_password_cb *cb, void *u)\
275{ \
276    return (type*)PEM_ASN1_read_bio(CHECKED_D2I_OF(type, d2i_##asn1), \
277                                    str, bp, \
278                                    CHECKED_PPTR_OF(type, x), \
279                                    cb, u); \
280}
281
282# define IMPLEMENT_PEM_write_bio(name, type, str, asn1) \
283int PEM_write_bio_##name(BIO *bp, type *x) \
284{ \
285    return PEM_ASN1_write_bio(CHECKED_I2D_OF(type, i2d_##asn1), \
286                              str, bp, \
287                              CHECKED_PTR_OF(type, x), \
288                              NULL, NULL, 0, NULL, NULL); \
289}
290
291# define IMPLEMENT_PEM_write_bio_const(name, type, str, asn1) \
292int PEM_write_bio_##name(BIO *bp, const type *x) \
293{ \
294    return PEM_ASN1_write_bio(CHECKED_I2D_OF(const type, i2d_##asn1), \
295                              str, bp, \
296                              CHECKED_PTR_OF(const type, x), \
297                              NULL, NULL, 0, NULL, NULL); \
298}
299
300# define IMPLEMENT_PEM_write_cb_bio(name, type, str, asn1) \
301int PEM_write_bio_##name(BIO *bp, type *x, const EVP_CIPHER *enc, \
302             unsigned char *kstr, int klen, pem_password_cb *cb, void *u) \
303        { \
304            return PEM_ASN1_write_bio(CHECKED_I2D_OF(type, i2d_##asn1), \
305                                      str, bp, \
306                                      CHECKED_PTR_OF(type, x), \
307                                      enc, kstr, klen, cb, u); \
308        }
309
310# define IMPLEMENT_PEM_write_cb_bio_const(name, type, str, asn1) \
311int PEM_write_bio_##name(BIO *bp, type *x, const EVP_CIPHER *enc, \
312             unsigned char *kstr, int klen, pem_password_cb *cb, void *u) \
313        { \
314            return PEM_ASN1_write_bio(CHECKED_I2D_OF(const type, i2d_##asn1), \
315                                      str, bp, \
316                                      CHECKED_PTR_OF(const type, x), \
317                                      enc, kstr, klen, cb, u); \
318        }
319
320# define IMPLEMENT_PEM_write(name, type, str, asn1) \
321        IMPLEMENT_PEM_write_bio(name, type, str, asn1) \
322        IMPLEMENT_PEM_write_fp(name, type, str, asn1)
323
324# define IMPLEMENT_PEM_write_const(name, type, str, asn1) \
325        IMPLEMENT_PEM_write_bio_const(name, type, str, asn1) \
326        IMPLEMENT_PEM_write_fp_const(name, type, str, asn1)
327
328# define IMPLEMENT_PEM_write_cb(name, type, str, asn1) \
329        IMPLEMENT_PEM_write_cb_bio(name, type, str, asn1) \
330        IMPLEMENT_PEM_write_cb_fp(name, type, str, asn1)
331
332# define IMPLEMENT_PEM_write_cb_const(name, type, str, asn1) \
333        IMPLEMENT_PEM_write_cb_bio_const(name, type, str, asn1) \
334        IMPLEMENT_PEM_write_cb_fp_const(name, type, str, asn1)
335
336# define IMPLEMENT_PEM_read(name, type, str, asn1) \
337        IMPLEMENT_PEM_read_bio(name, type, str, asn1) \
338        IMPLEMENT_PEM_read_fp(name, type, str, asn1)
339
340# define IMPLEMENT_PEM_rw(name, type, str, asn1) \
341        IMPLEMENT_PEM_read(name, type, str, asn1) \
342        IMPLEMENT_PEM_write(name, type, str, asn1)
343
344# define IMPLEMENT_PEM_rw_const(name, type, str, asn1) \
345        IMPLEMENT_PEM_read(name, type, str, asn1) \
346        IMPLEMENT_PEM_write_const(name, type, str, asn1)
347
348# define IMPLEMENT_PEM_rw_cb(name, type, str, asn1) \
349        IMPLEMENT_PEM_read(name, type, str, asn1) \
350        IMPLEMENT_PEM_write_cb(name, type, str, asn1)
351
352/* These are the same except they are for the declarations */
353
354# if defined(OPENSSL_SYS_WIN16) || defined(OPENSSL_NO_FP_API)
355
356#  define DECLARE_PEM_read_fp(name, type) /**/
357#  define DECLARE_PEM_write_fp(name, type) /**/
358#  define DECLARE_PEM_write_fp_const(name, type) /**/
359#  define DECLARE_PEM_write_cb_fp(name, type) /**/
360# else
361
362#  define DECLARE_PEM_read_fp(name, type) \
363        type *PEM_read_##name(FILE *fp, type **x, pem_password_cb *cb, void *u);
364
365#  define DECLARE_PEM_write_fp(name, type) \
366        int PEM_write_##name(FILE *fp, type *x);
367
368#  define DECLARE_PEM_write_fp_const(name, type) \
369        int PEM_write_##name(FILE *fp, const type *x);
370
371#  define DECLARE_PEM_write_cb_fp(name, type) \
372        int PEM_write_##name(FILE *fp, type *x, const EVP_CIPHER *enc, \
373             unsigned char *kstr, int klen, pem_password_cb *cb, void *u);
374
375# endif
376
377# ifndef OPENSSL_NO_BIO
378#  define DECLARE_PEM_read_bio(name, type) \
379        type *PEM_read_bio_##name(BIO *bp, type **x, pem_password_cb *cb, void *u);
380
381#  define DECLARE_PEM_write_bio(name, type) \
382        int PEM_write_bio_##name(BIO *bp, type *x);
383
384#  define DECLARE_PEM_write_bio_const(name, type) \
385        int PEM_write_bio_##name(BIO *bp, const type *x);
386
387#  define DECLARE_PEM_write_cb_bio(name, type) \
388        int PEM_write_bio_##name(BIO *bp, type *x, const EVP_CIPHER *enc, \
389             unsigned char *kstr, int klen, pem_password_cb *cb, void *u);
390
391# else
392
393#  define DECLARE_PEM_read_bio(name, type) /**/
394#  define DECLARE_PEM_write_bio(name, type) /**/
395#  define DECLARE_PEM_write_bio_const(name, type) /**/
396#  define DECLARE_PEM_write_cb_bio(name, type) /**/
397# endif
398# define DECLARE_PEM_write(name, type) \
399        DECLARE_PEM_write_bio(name, type) \
400        DECLARE_PEM_write_fp(name, type)
401# define DECLARE_PEM_write_const(name, type) \
402        DECLARE_PEM_write_bio_const(name, type) \
403        DECLARE_PEM_write_fp_const(name, type)
404# define DECLARE_PEM_write_cb(name, type) \
405        DECLARE_PEM_write_cb_bio(name, type) \
406        DECLARE_PEM_write_cb_fp(name, type)
407# define DECLARE_PEM_read(name, type) \
408        DECLARE_PEM_read_bio(name, type) \
409        DECLARE_PEM_read_fp(name, type)
410# define DECLARE_PEM_rw(name, type) \
411        DECLARE_PEM_read(name, type) \
412        DECLARE_PEM_write(name, type)
413# define DECLARE_PEM_rw_const(name, type) \
414        DECLARE_PEM_read(name, type) \
415        DECLARE_PEM_write_const(name, type)
416# define DECLARE_PEM_rw_cb(name, type) \
417        DECLARE_PEM_read(name, type) \
418        DECLARE_PEM_write_cb(name, type)
419# ifdef SSLEAY_MACROS
420#  define PEM_write_SSL_SESSION(fp,x) \
421                PEM_ASN1_write((int (*)())i2d_SSL_SESSION, \
422                        PEM_STRING_SSL_SESSION,fp, (char *)x, NULL,NULL,0,NULL,NULL)
423#  define PEM_write_X509(fp,x) \
424                PEM_ASN1_write((int (*)())i2d_X509,PEM_STRING_X509,fp, \
425                        (char *)x, NULL,NULL,0,NULL,NULL)
426#  define PEM_write_X509_REQ(fp,x) PEM_ASN1_write( \
427                (int (*)())i2d_X509_REQ,PEM_STRING_X509_REQ,fp,(char *)x, \
428                        NULL,NULL,0,NULL,NULL)
429#  define PEM_write_X509_CRL(fp,x) \
430                PEM_ASN1_write((int (*)())i2d_X509_CRL,PEM_STRING_X509_CRL, \
431                        fp,(char *)x, NULL,NULL,0,NULL,NULL)
432#  define PEM_write_RSAPrivateKey(fp,x,enc,kstr,klen,cb,u) \
433                PEM_ASN1_write((int (*)())i2d_RSAPrivateKey,PEM_STRING_RSA,fp,\
434                        (char *)x,enc,kstr,klen,cb,u)
435#  define PEM_write_RSAPublicKey(fp,x) \
436                PEM_ASN1_write((int (*)())i2d_RSAPublicKey,\
437                        PEM_STRING_RSA_PUBLIC,fp,(char *)x,NULL,NULL,0,NULL,NULL)
438#  define PEM_write_DSAPrivateKey(fp,x,enc,kstr,klen,cb,u) \
439                PEM_ASN1_write((int (*)())i2d_DSAPrivateKey,PEM_STRING_DSA,fp,\
440                        (char *)x,enc,kstr,klen,cb,u)
441#  define PEM_write_PrivateKey(bp,x,enc,kstr,klen,cb,u) \
442                PEM_ASN1_write((int (*)())i2d_PrivateKey,\
443                (((x)->type == EVP_PKEY_DSA)?PEM_STRING_DSA:PEM_STRING_RSA),\
444                        bp,(char *)x,enc,kstr,klen,cb,u)
445#  define PEM_write_PKCS7(fp,x) \
446                PEM_ASN1_write((int (*)())i2d_PKCS7,PEM_STRING_PKCS7,fp, \
447                        (char *)x, NULL,NULL,0,NULL,NULL)
448#  define PEM_write_DHparams(fp,x) \
449                PEM_ASN1_write((int (*)())i2d_DHparams,PEM_STRING_DHPARAMS,fp,\
450                        (char *)x,NULL,NULL,0,NULL,NULL)
451#  define PEM_write_NETSCAPE_CERT_SEQUENCE(fp,x) \
452                PEM_ASN1_write((int (*)())i2d_NETSCAPE_CERT_SEQUENCE, \
453                        PEM_STRING_X509,fp, \
454                        (char *)x, NULL,NULL,0,NULL,NULL)
455#  define PEM_read_SSL_SESSION(fp,x,cb,u) (SSL_SESSION *)PEM_ASN1_read( \
456        (char *(*)())d2i_SSL_SESSION,PEM_STRING_SSL_SESSION,fp,(char **)x,cb,u)
457#  define PEM_read_X509(fp,x,cb,u) (X509 *)PEM_ASN1_read( \
458        (char *(*)())d2i_X509,PEM_STRING_X509,fp,(char **)x,cb,u)
459#  define PEM_read_X509_REQ(fp,x,cb,u) (X509_REQ *)PEM_ASN1_read( \
460        (char *(*)())d2i_X509_REQ,PEM_STRING_X509_REQ,fp,(char **)x,cb,u)
461#  define PEM_read_X509_CRL(fp,x,cb,u) (X509_CRL *)PEM_ASN1_read( \
462        (char *(*)())d2i_X509_CRL,PEM_STRING_X509_CRL,fp,(char **)x,cb,u)
463#  define PEM_read_RSAPrivateKey(fp,x,cb,u) (RSA *)PEM_ASN1_read( \
464        (char *(*)())d2i_RSAPrivateKey,PEM_STRING_RSA,fp,(char **)x,cb,u)
465#  define PEM_read_RSAPublicKey(fp,x,cb,u) (RSA *)PEM_ASN1_read( \
466        (char *(*)())d2i_RSAPublicKey,PEM_STRING_RSA_PUBLIC,fp,(char **)x,cb,u)
467#  define PEM_read_DSAPrivateKey(fp,x,cb,u) (DSA *)PEM_ASN1_read( \
468        (char *(*)())d2i_DSAPrivateKey,PEM_STRING_DSA,fp,(char **)x,cb,u)
469#  define PEM_read_PrivateKey(fp,x,cb,u) (EVP_PKEY *)PEM_ASN1_read( \
470        (char *(*)())d2i_PrivateKey,PEM_STRING_EVP_PKEY,fp,(char **)x,cb,u)
471#  define PEM_read_PKCS7(fp,x,cb,u) (PKCS7 *)PEM_ASN1_read( \
472        (char *(*)())d2i_PKCS7,PEM_STRING_PKCS7,fp,(char **)x,cb,u)
473#  define PEM_read_DHparams(fp,x,cb,u) (DH *)PEM_ASN1_read( \
474        (char *(*)())d2i_DHparams,PEM_STRING_DHPARAMS,fp,(char **)x,cb,u)
475#  define PEM_read_NETSCAPE_CERT_SEQUENCE(fp,x,cb,u) \
476                (NETSCAPE_CERT_SEQUENCE *)PEM_ASN1_read( \
477        (char *(*)())d2i_NETSCAPE_CERT_SEQUENCE,PEM_STRING_X509,fp,\
478                                                        (char **)x,cb,u)
479#  define PEM_write_bio_X509(bp,x) \
480                PEM_ASN1_write_bio((int (*)())i2d_X509,PEM_STRING_X509,bp, \
481                        (char *)x, NULL,NULL,0,NULL,NULL)
482#  define PEM_write_bio_X509_REQ(bp,x) PEM_ASN1_write_bio( \
483                (int (*)())i2d_X509_REQ,PEM_STRING_X509_REQ,bp,(char *)x, \
484                        NULL,NULL,0,NULL,NULL)
485#  define PEM_write_bio_X509_CRL(bp,x) \
486                PEM_ASN1_write_bio((int (*)())i2d_X509_CRL,PEM_STRING_X509_CRL,\
487                        bp,(char *)x, NULL,NULL,0,NULL,NULL)
488#  define PEM_write_bio_RSAPrivateKey(bp,x,enc,kstr,klen,cb,u) \
489                PEM_ASN1_write_bio((int (*)())i2d_RSAPrivateKey,PEM_STRING_RSA,\
490                        bp,(char *)x,enc,kstr,klen,cb,u)
491#  define PEM_write_bio_RSAPublicKey(bp,x) \
492                PEM_ASN1_write_bio((int (*)())i2d_RSAPublicKey, \
493                        PEM_STRING_RSA_PUBLIC,\
494                        bp,(char *)x,NULL,NULL,0,NULL,NULL)
495#  define PEM_write_bio_DSAPrivateKey(bp,x,enc,kstr,klen,cb,u) \
496                PEM_ASN1_write_bio((int (*)())i2d_DSAPrivateKey,PEM_STRING_DSA,\
497                        bp,(char *)x,enc,kstr,klen,cb,u)
498#  define PEM_write_bio_PrivateKey(bp,x,enc,kstr,klen,cb,u) \
499                PEM_ASN1_write_bio((int (*)())i2d_PrivateKey,\
500                (((x)->type == EVP_PKEY_DSA)?PEM_STRING_DSA:PEM_STRING_RSA),\
501                        bp,(char *)x,enc,kstr,klen,cb,u)
502#  define PEM_write_bio_PKCS7(bp,x) \
503                PEM_ASN1_write_bio((int (*)())i2d_PKCS7,PEM_STRING_PKCS7,bp, \
504                        (char *)x, NULL,NULL,0,NULL,NULL)
505#  define PEM_write_bio_DHparams(bp,x) \
506                PEM_ASN1_write_bio((int (*)())i2d_DHparams,PEM_STRING_DHPARAMS,\
507                        bp,(char *)x,NULL,NULL,0,NULL,NULL)
508#  define PEM_write_bio_DSAparams(bp,x) \
509                PEM_ASN1_write_bio((int (*)())i2d_DSAparams, \
510                        PEM_STRING_DSAPARAMS,bp,(char *)x,NULL,NULL,0,NULL,NULL)
511#  define PEM_write_bio_NETSCAPE_CERT_SEQUENCE(bp,x) \
512                PEM_ASN1_write_bio((int (*)())i2d_NETSCAPE_CERT_SEQUENCE, \
513                        PEM_STRING_X509,bp, \
514                        (char *)x, NULL,NULL,0,NULL,NULL)
515#  define PEM_read_bio_X509(bp,x,cb,u) (X509 *)PEM_ASN1_read_bio( \
516        (char *(*)())d2i_X509,PEM_STRING_X509,bp,(char **)x,cb,u)
517#  define PEM_read_bio_X509_REQ(bp,x,cb,u) (X509_REQ *)PEM_ASN1_read_bio( \
518        (char *(*)())d2i_X509_REQ,PEM_STRING_X509_REQ,bp,(char **)x,cb,u)
519#  define PEM_read_bio_X509_CRL(bp,x,cb,u) (X509_CRL *)PEM_ASN1_read_bio( \
520        (char *(*)())d2i_X509_CRL,PEM_STRING_X509_CRL,bp,(char **)x,cb,u)
521#  define PEM_read_bio_RSAPrivateKey(bp,x,cb,u) (RSA *)PEM_ASN1_read_bio( \
522        (char *(*)())d2i_RSAPrivateKey,PEM_STRING_RSA,bp,(char **)x,cb,u)
523#  define PEM_read_bio_RSAPublicKey(bp,x,cb,u) (RSA *)PEM_ASN1_read_bio( \
524        (char *(*)())d2i_RSAPublicKey,PEM_STRING_RSA_PUBLIC,bp,(char **)x,cb,u)
525#  define PEM_read_bio_DSAPrivateKey(bp,x,cb,u) (DSA *)PEM_ASN1_read_bio( \
526        (char *(*)())d2i_DSAPrivateKey,PEM_STRING_DSA,bp,(char **)x,cb,u)
527#  define PEM_read_bio_PrivateKey(bp,x,cb,u) (EVP_PKEY *)PEM_ASN1_read_bio( \
528        (char *(*)())d2i_PrivateKey,PEM_STRING_EVP_PKEY,bp,(char **)x,cb,u)
529#  define PEM_read_bio_PKCS7(bp,x,cb,u) (PKCS7 *)PEM_ASN1_read_bio( \
530        (char *(*)())d2i_PKCS7,PEM_STRING_PKCS7,bp,(char **)x,cb,u)
531#  define PEM_read_bio_DHparams(bp,x,cb,u) (DH *)PEM_ASN1_read_bio( \
532        (char *(*)())d2i_DHparams,PEM_STRING_DHPARAMS,bp,(char **)x,cb,u)
533#  define PEM_read_bio_DSAparams(bp,x,cb,u) (DSA *)PEM_ASN1_read_bio( \
534        (char *(*)())d2i_DSAparams,PEM_STRING_DSAPARAMS,bp,(char **)x,cb,u)
535#  define PEM_read_bio_NETSCAPE_CERT_SEQUENCE(bp,x,cb,u) \
536                (NETSCAPE_CERT_SEQUENCE *)PEM_ASN1_read_bio( \
537        (char *(*)())d2i_NETSCAPE_CERT_SEQUENCE,PEM_STRING_X509,bp,\
538                                                        (char **)x,cb,u)
539# endif
540# if 1
541/* "userdata": new with OpenSSL 0.9.4 */
542typedef int pem_password_cb (char *buf, int size, int rwflag, void *userdata);
543# else
544/* OpenSSL 0.9.3, 0.9.3a */
545typedef int pem_password_cb (char *buf, int size, int rwflag);
546# endif
547
548int PEM_get_EVP_CIPHER_INFO(char *header, EVP_CIPHER_INFO *cipher);
549int PEM_do_header(EVP_CIPHER_INFO *cipher, unsigned char *data, long *len,
550                  pem_password_cb *callback, void *u);
551
552# ifndef OPENSSL_NO_BIO
553int PEM_read_bio(BIO *bp, char **name, char **header,
554                 unsigned char **data, long *len);
555int PEM_write_bio(BIO *bp, const char *name, char *hdr, unsigned char *data,
556                  long len);
557int PEM_bytes_read_bio(unsigned char **pdata, long *plen, char **pnm,
558                       const char *name, BIO *bp, pem_password_cb *cb,
559                       void *u);
560void *PEM_ASN1_read_bio(d2i_of_void *d2i, const char *name, BIO *bp, void **x,
561                        pem_password_cb *cb, void *u);
562
563#  define PEM_ASN1_read_bio_of(type,d2i,name,bp,x,cb,u) \
564    ((type*)PEM_ASN1_read_bio(CHECKED_D2I_OF(type, d2i), \
565                              name, bp,                 \
566                              CHECKED_PPTR_OF(type, x), \
567                              cb, u))
568
569int PEM_ASN1_write_bio(i2d_of_void *i2d, const char *name, BIO *bp, char *x,
570                       const EVP_CIPHER *enc, unsigned char *kstr, int klen,
571                       pem_password_cb *cb, void *u);
572
573#  define PEM_ASN1_write_bio_of(type,i2d,name,bp,x,enc,kstr,klen,cb,u) \
574    (PEM_ASN1_write_bio(CHECKED_I2D_OF(type, i2d), \
575                        name, bp,                  \
576                        CHECKED_PTR_OF(type, x), \
577                        enc, kstr, klen, cb, u))
578
579STACK_OF(X509_INFO) *PEM_X509_INFO_read_bio(BIO *bp, STACK_OF(X509_INFO) *sk,
580                                            pem_password_cb *cb, void *u);
581int PEM_X509_INFO_write_bio(BIO *bp, X509_INFO *xi, EVP_CIPHER *enc,
582                            unsigned char *kstr, int klen,
583                            pem_password_cb *cd, void *u);
584# endif
585
586# ifndef OPENSSL_SYS_WIN16
587int PEM_read(FILE *fp, char **name, char **header,
588             unsigned char **data, long *len);
589int PEM_write(FILE *fp, char *name, char *hdr, unsigned char *data, long len);
590void *PEM_ASN1_read(d2i_of_void *d2i, const char *name, FILE *fp, void **x,
591                    pem_password_cb *cb, void *u);
592int PEM_ASN1_write(i2d_of_void *i2d, const char *name, FILE *fp,
593                   char *x, const EVP_CIPHER *enc, unsigned char *kstr,
594                   int klen, pem_password_cb *callback, void *u);
595STACK_OF(X509_INFO) *PEM_X509_INFO_read(FILE *fp, STACK_OF(X509_INFO) *sk,
596                                        pem_password_cb *cb, void *u);
597# endif
598
599int PEM_SealInit(PEM_ENCODE_SEAL_CTX *ctx, EVP_CIPHER *type,
600                 EVP_MD *md_type, unsigned char **ek, int *ekl,
601                 unsigned char *iv, EVP_PKEY **pubk, int npubk);
602void PEM_SealUpdate(PEM_ENCODE_SEAL_CTX *ctx, unsigned char *out, int *outl,
603                    unsigned char *in, int inl);
604int PEM_SealFinal(PEM_ENCODE_SEAL_CTX *ctx, unsigned char *sig, int *sigl,
605                  unsigned char *out, int *outl, EVP_PKEY *priv);
606
607void PEM_SignInit(EVP_MD_CTX *ctx, EVP_MD *type);
608void PEM_SignUpdate(EVP_MD_CTX *ctx, unsigned char *d, unsigned int cnt);
609int PEM_SignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
610                  unsigned int *siglen, EVP_PKEY *pkey);
611
612int PEM_def_callback(char *buf, int num, int w, void *key);
613void PEM_proc_type(char *buf, int type);
614void PEM_dek_info(char *buf, const char *type, int len, char *str);
615
616# ifndef SSLEAY_MACROS
617
618#  include <openssl/symhacks.h>
619
620DECLARE_PEM_rw(X509, X509)
621DECLARE_PEM_rw(X509_AUX, X509)
622DECLARE_PEM_rw(X509_CERT_PAIR, X509_CERT_PAIR)
623DECLARE_PEM_rw(X509_REQ, X509_REQ)
624DECLARE_PEM_write(X509_REQ_NEW, X509_REQ)
625DECLARE_PEM_rw(X509_CRL, X509_CRL)
626DECLARE_PEM_rw(PKCS7, PKCS7)
627DECLARE_PEM_rw(NETSCAPE_CERT_SEQUENCE, NETSCAPE_CERT_SEQUENCE)
628DECLARE_PEM_rw(PKCS8, X509_SIG)
629DECLARE_PEM_rw(PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO)
630#  ifndef OPENSSL_NO_RSA
631DECLARE_PEM_rw_cb(RSAPrivateKey, RSA)
632DECLARE_PEM_rw_const(RSAPublicKey, RSA)
633DECLARE_PEM_rw(RSA_PUBKEY, RSA)
634#  endif
635#  ifndef OPENSSL_NO_DSA
636DECLARE_PEM_rw_cb(DSAPrivateKey, DSA)
637DECLARE_PEM_rw(DSA_PUBKEY, DSA)
638DECLARE_PEM_rw_const(DSAparams, DSA)
639#  endif
640#  ifndef OPENSSL_NO_EC
641DECLARE_PEM_rw_const(ECPKParameters, EC_GROUP)
642DECLARE_PEM_rw_cb(ECPrivateKey, EC_KEY)
643DECLARE_PEM_rw(EC_PUBKEY, EC_KEY)
644#  endif
645#  ifndef OPENSSL_NO_DH
646DECLARE_PEM_rw_const(DHparams, DH)
647#  endif
648DECLARE_PEM_rw_cb(PrivateKey, EVP_PKEY)
649DECLARE_PEM_rw(PUBKEY, EVP_PKEY)
650
651int PEM_write_bio_PKCS8PrivateKey_nid(BIO *bp, EVP_PKEY *x, int nid,
652                                      char *kstr, int klen,
653                                      pem_password_cb *cb, void *u);
654int PEM_write_bio_PKCS8PrivateKey(BIO *, EVP_PKEY *, const EVP_CIPHER *,
655                                  char *, int, pem_password_cb *, void *);
656int i2d_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
657                            char *kstr, int klen,
658                            pem_password_cb *cb, void *u);
659int i2d_PKCS8PrivateKey_nid_bio(BIO *bp, EVP_PKEY *x, int nid,
660                                char *kstr, int klen,
661                                pem_password_cb *cb, void *u);
662EVP_PKEY *d2i_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY **x, pem_password_cb *cb,
663                                  void *u);
664
665int i2d_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
666                           char *kstr, int klen,
667                           pem_password_cb *cb, void *u);
668int i2d_PKCS8PrivateKey_nid_fp(FILE *fp, EVP_PKEY *x, int nid,
669                               char *kstr, int klen,
670                               pem_password_cb *cb, void *u);
671int PEM_write_PKCS8PrivateKey_nid(FILE *fp, EVP_PKEY *x, int nid,
672                                  char *kstr, int klen,
673                                  pem_password_cb *cb, void *u);
674
675EVP_PKEY *d2i_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY **x, pem_password_cb *cb,
676                                 void *u);
677
678int PEM_write_PKCS8PrivateKey(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
679                              char *kstr, int klen, pem_password_cb *cd,
680                              void *u);
681
682# endif                         /* SSLEAY_MACROS */
683
684/* BEGIN ERROR CODES */
685/*
686 * The following lines are auto generated by the script mkerr.pl. Any changes
687 * made after this point may be overwritten when the script is next run.
688 */
689void ERR_load_PEM_strings(void);
690
691/* Error codes for the PEM functions. */
692
693/* Function codes. */
694# define PEM_F_D2I_PKCS8PRIVATEKEY_BIO                    120
695# define PEM_F_D2I_PKCS8PRIVATEKEY_FP                     121
696# define PEM_F_DO_PK8PKEY                                 126
697# define PEM_F_DO_PK8PKEY_FP                              125
698# define PEM_F_LOAD_IV                                    101
699# define PEM_F_PEM_ASN1_READ                              102
700# define PEM_F_PEM_ASN1_READ_BIO                          103
701# define PEM_F_PEM_ASN1_WRITE                             104
702# define PEM_F_PEM_ASN1_WRITE_BIO                         105
703# define PEM_F_PEM_DEF_CALLBACK                           100
704# define PEM_F_PEM_DO_HEADER                              106
705# define PEM_F_PEM_F_PEM_WRITE_PKCS8PRIVATEKEY            118
706# define PEM_F_PEM_GET_EVP_CIPHER_INFO                    107
707# define PEM_F_PEM_PK8PKEY                                119
708# define PEM_F_PEM_READ                                   108
709# define PEM_F_PEM_READ_BIO                               109
710# define PEM_F_PEM_READ_BIO_PRIVATEKEY                    123
711# define PEM_F_PEM_READ_PRIVATEKEY                        124
712# define PEM_F_PEM_SEALFINAL                              110
713# define PEM_F_PEM_SEALINIT                               111
714# define PEM_F_PEM_SIGNFINAL                              112
715# define PEM_F_PEM_WRITE                                  113
716# define PEM_F_PEM_WRITE_BIO                              114
717# define PEM_F_PEM_X509_INFO_READ                         115
718# define PEM_F_PEM_X509_INFO_READ_BIO                     116
719# define PEM_F_PEM_X509_INFO_WRITE_BIO                    117
720
721/* Reason codes. */
722# define PEM_R_BAD_BASE64_DECODE                          100
723# define PEM_R_BAD_DECRYPT                                101
724# define PEM_R_BAD_END_LINE                               102
725# define PEM_R_BAD_IV_CHARS                               103
726# define PEM_R_BAD_PASSWORD_READ                          104
727# define PEM_R_ERROR_CONVERTING_PRIVATE_KEY               115
728# define PEM_R_NOT_DEK_INFO                               105
729# define PEM_R_NOT_ENCRYPTED                              106
730# define PEM_R_NOT_PROC_TYPE                              107
731# define PEM_R_NO_START_LINE                              108
732# define PEM_R_PROBLEMS_GETTING_PASSWORD                  109
733# define PEM_R_PUBLIC_KEY_NO_RSA                          110
734# define PEM_R_READ_KEY                                   111
735# define PEM_R_SHORT_HEADER                               112
736# define PEM_R_UNSUPPORTED_CIPHER                         113
737# define PEM_R_UNSUPPORTED_ENCRYPTION                     114
738
739#ifdef  __cplusplus
740}
741#endif
742#endif
743