More PKCS#8 stuff. Support for unencrypted forms of private key.
[openssl.git] / crypto / pem / pem.h
index 92631b8666e71d210bf779b4e8e608978ff5f9f0..7c02356f1ec2495cca4eff851a84811522758bca 100644 (file)
@@ -1,4 +1,4 @@
-/* crypto/pem/pem.org */
+/* crypto/pem/pem.h */
 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
  * All rights reserved.
  *
  * [including the GNU Public Licence.]
  */
 
-/* WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING 
- *
- * Always modify pem.org since pem.h is automatically generated from
- * it during SSLeay configuration.
- *
- * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
- */
-
 #ifndef HEADER_PEM_H
 #define HEADER_PEM_H
 
@@ -71,9 +63,9 @@
 extern "C" {
 #endif
 
-#include "evp.h"
-#include "x509.h"
-#include "pem2.h"
+#include <openssl/evp.h>
+#include <openssl/x509.h>
+#include <openssl/pem2.h>
 
 #define PEM_OBJ_UNDEF          0
 #define PEM_OBJ_X509           1
@@ -112,11 +104,13 @@ extern "C" {
 #define PEM_STRING_X509_REQ_OLD        "NEW CERTIFICATE REQUEST"
 #define PEM_STRING_X509_REQ    "CERTIFICATE REQUEST"
 #define PEM_STRING_X509_CRL    "X509 CRL"
-#define PEM_STRING_EVP_PKEY    "PRIVATE KEY"
+#define PEM_STRING_EVP_PKEY    "ANY PRIVATE KEY"
 #define PEM_STRING_RSA         "RSA PRIVATE KEY"
 #define PEM_STRING_RSA_PUBLIC  "RSA PUBLIC KEY"
 #define PEM_STRING_DSA         "DSA PRIVATE KEY"
 #define PEM_STRING_PKCS7       "PKCS7"
+#define PEM_STRING_PKCS8       "ENCRYPTED PRIVATE KEY"
+#define PEM_STRING_PKCS8INF    "PRIVATE KEY"
 #define PEM_STRING_DHPARAMS    "DH PARAMETERS"
 #define PEM_STRING_SSL_SESSION "SSL SESSION PARAMETERS"
 #define PEM_STRING_DSAPARAMS   "DSA PARAMETERS"
@@ -325,34 +319,40 @@ typedef struct pem_ctx_st
 
 #endif
 
-#ifndef NOPROTO
+typedef int pem_password_cb(char *buf, int size, int rwflag);
+/* "size" should be size_t, obviously, but it was always used
+ * without a parameter list declaration, which makes it "int" */
+
 int    PEM_get_EVP_CIPHER_INFO(char *header, EVP_CIPHER_INFO *cipher);
 int    PEM_do_header (EVP_CIPHER_INFO *cipher, unsigned char *data,long *len,
-               int (*callback)());
+       pem_password_cb *);
 
 #ifdef HEADER_BIO_H
 int    PEM_read_bio(BIO *bp, char **name, char **header,
                unsigned char **data,long *len);
-int    PEM_write_bio(BIO *bp,char *name,char *hdr,unsigned char *data,
+int    PEM_write_bio(BIO *bp,const char *name,char *hdr,unsigned char *data,
                long len);
-char * PEM_ASN1_read_bio(char *(*d2i)(),char *name,BIO *bp,char **x,
-               int (*cb)());
-int    PEM_ASN1_write_bio(int (*i2d)(),char *name,BIO *bp,char *x,
-               EVP_CIPHER *enc,unsigned char *kstr,int klen,int (*callback)());
-STACK *        PEM_X509_INFO_read_bio(BIO *bp, STACK *sk, int (*cb)());
+char * PEM_ASN1_read_bio(char *(*d2i)(),const char *name,BIO *bp,char **x,
+               pem_password_cb *);
+int    PEM_ASN1_write_bio(int (*i2d)(),const char *name,BIO *bp,char *x,
+                          const EVP_CIPHER *enc,unsigned char *kstr,int klen,
+                          pem_password_cb *);
+STACK_OF(X509_INFO) *  PEM_X509_INFO_read_bio(BIO *bp, STACK_OF(X509_INFO) *sk, pem_password_cb *);
 int    PEM_X509_INFO_write_bio(BIO *bp,X509_INFO *xi, EVP_CIPHER *enc,
-               unsigned char *kstr, int klen, int (*cb)());
+               unsigned char *kstr, int klen, pem_password_cb *);
 #endif
 
 #ifndef WIN16
 int    PEM_read(FILE *fp, char **name, char **header,
                unsigned char **data,long *len);
 int    PEM_write(FILE *fp,char *name,char *hdr,unsigned char *data,long len);
-char * PEM_ASN1_read(char *(*d2i)(),char *name,FILE *fp,char **x,
-               int (*cb)());
-int    PEM_ASN1_write(int (*i2d)(),char *name,FILE *fp,char *x,
-               EVP_CIPHER *enc,unsigned char *kstr,int klen,int (*callback)());
-STACK *        PEM_X509_INFO_read(FILE *fp, STACK *sk, int (*cb)());
+char * PEM_ASN1_read(char *(*d2i)(),const char *name,FILE *fp,char **x,
+       pem_password_cb *);
+int    PEM_ASN1_write(int (*i2d)(),const char *name,FILE *fp,char *x,
+                      const EVP_CIPHER *enc,unsigned char *kstr,int klen,
+                      pem_password_cb *);
+STACK_OF(X509_INFO) *  PEM_X509_INFO_read(FILE *fp, STACK_OF(X509_INFO) *sk,
+       pem_password_cb *);
 #endif
 
 int    PEM_SealInit(PEM_ENCODE_SEAL_CTX *ctx, EVP_CIPHER *type,
@@ -368,153 +368,128 @@ void    PEM_SignUpdate(EVP_MD_CTX *ctx,unsigned char *d,unsigned int cnt);
 int    PEM_SignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
                unsigned int *siglen, EVP_PKEY *pkey);
 
+void   ERR_load_PEM_strings(void);
+
 void   PEM_proc_type(char *buf, int type);
-void   PEM_dek_info(char *buf, char *type, int len, char *str);
+void   PEM_dek_info(char *buf, const char *type, int len, char *str);
 
 #ifndef SSLEAY_MACROS
 
+#ifdef VMS
+/* Too long names need to be abbreviated to at most 31 characters */
+#undef PEM_write_NETSCAPE_CERT_SEQUENCE
+#define PEM_write_NETSCAPE_CERT_SEQUENCE PEM_write_NETSCAPE_CERT_SEQ
+#undef PEM_read_bio_NETSCAPE_CERT_SEQUENCE
+#define PEM_read_bio_NETSCAPE_CERT_SEQUENCE PEM_read_bio_NETSCAPE_CERT_SEQ
+#undef PEM_write_bio_NETSCAPE_CERT_SEQUENCE
+#define PEM_write_bio_NETSCAPE_CERT_SEQUENCE PEM_write_bio_NETSCAPE_CERT_SEQ
+#endif
+
 #ifndef WIN16
-X509 *PEM_read_X509(FILE *fp,X509 **x,int (*cb)());
-X509_REQ *PEM_read_X509_REQ(FILE *fp,X509_REQ **x,int (*cb)());
-X509_CRL *PEM_read_X509_CRL(FILE *fp,X509_CRL **x,int (*cb)());
-RSA *PEM_read_RSAPrivateKey(FILE *fp,RSA **x,int (*cb)());
-RSA *PEM_read_RSAPublicKey(FILE *fp,RSA **x,int (*cb)());
-DSA *PEM_read_DSAPrivateKey(FILE *fp,DSA **x,int (*cb)());
-EVP_PKEY *PEM_read_PrivateKey(FILE *fp,EVP_PKEY **x,int (*cb)());
-PKCS7 *PEM_read_PKCS7(FILE *fp,PKCS7 **x,int (*cb)());
-DH *PEM_read_DHparams(FILE *fp,DH **x,int (*cb)());
-DSA *PEM_read_DSAparams(FILE *fp,DSA **x,int (*cb)());
-NETSCAPE_CERT_SEQUENCE *PEM_read_NETSCAPE_CERT_SEQUENCE(FILE *fp,NETSCAPE_CERT_SEQUENCE **x,int (*cb)());
+X509 *PEM_read_X509(FILE *fp,X509 **x, pem_password_cb *);
+X509_REQ *PEM_read_X509_REQ(FILE *fp,X509_REQ **x, pem_password_cb *);
+X509_CRL *PEM_read_X509_CRL(FILE *fp,X509_CRL **x, pem_password_cb *);
+#ifndef NO_RSA
+RSA *PEM_read_RSAPrivateKey(FILE *fp,RSA **x, pem_password_cb *);
+RSA *PEM_read_RSAPublicKey(FILE *fp,RSA **x, pem_password_cb *);
+#endif
+#ifndef NO_DSA
+DSA *PEM_read_DSAPrivateKey(FILE *fp,DSA **x, pem_password_cb *);
+DSA *PEM_read_DSAparams(FILE *fp,DSA **x, pem_password_cb *);
+#endif
+#ifndef NO_DH
+DH *PEM_read_DHparams(FILE *fp,DH **x, pem_password_cb *);
+#endif
+EVP_PKEY *PEM_read_PrivateKey(FILE *fp,EVP_PKEY **x, pem_password_cb *);
+PKCS7 *PEM_read_PKCS7(FILE *fp,PKCS7 **x, pem_password_cb *);
+NETSCAPE_CERT_SEQUENCE *PEM_read_NETSCAPE_CERT_SEQUENCE(FILE *fp,NETSCAPE_CERT_SEQUENCE **x, pem_password_cb *);
+X509_SIG *PEM_read_PKCS8(FILE *fp,X509_SIG **x, pem_password_cb *);
+PKCS8_PRIV_KEY_INFO *PEM_read_PKCS8_PRIV_KEY_INFO(FILE *fp,
+                               PKCS8_PRIV_KEY_INFO **x, pem_password_cb *);
 int PEM_write_X509(FILE *fp,X509 *x);
 int PEM_write_X509_REQ(FILE *fp,X509_REQ *x);
 int PEM_write_X509_CRL(FILE *fp,X509_CRL *x);
+#ifndef NO_RSA
 int PEM_write_RSAPrivateKey(FILE *fp,RSA *x,EVP_CIPHER *enc,unsigned char *kstr,
-        int klen,int (*cb)());
+        int klen, pem_password_cb *);
 int PEM_write_RSAPublicKey(FILE *fp,RSA *x);
-int PEM_write_DSAPrivateKey(FILE *fp,DSA *x,EVP_CIPHER *enc,unsigned char *kstr,
-        int klen,int (*cb)());
+#endif
+#ifndef NO_DSA
+int PEM_write_DSAPrivateKey(FILE *fp,DSA *x,const EVP_CIPHER *enc,
+                           unsigned char *kstr,
+        int klen, pem_password_cb *);
+#endif
 int PEM_write_PrivateKey(FILE *fp,EVP_PKEY *x,EVP_CIPHER *enc,
-       unsigned char *kstr,int klen,int (*cb)());
+       unsigned char *kstr,int klen, pem_password_cb *);
 int PEM_write_PKCS7(FILE *fp,PKCS7 *x);
+#ifndef NO_DH
 int PEM_write_DHparams(FILE *fp,DH *x);
+#endif
+#ifndef NO_DSA
 int PEM_write_DSAparams(FILE *fp,DSA *x);
+#endif
 int PEM_write_NETSCAPE_CERT_SEQUENCE(FILE *fp,NETSCAPE_CERT_SEQUENCE *x);
+int PEM_write_PKCS8(FILE *fp,X509_SIG *x);
+int PEM_write_PKCS8_PRIV_KEY_INFO(FILE *fp,PKCS8_PRIV_KEY_INFO *x);
 #endif
 
 #ifdef HEADER_BIO_H
-X509 *PEM_read_bio_X509(BIO *bp,X509 **x,int (*cb)());
-X509_REQ *PEM_read_bio_X509_REQ(BIO *bp,X509_REQ **x,int (*cb)());
-X509_CRL *PEM_read_bio_X509_CRL(BIO *bp,X509_CRL **x,int (*cb)());
-RSA *PEM_read_bio_RSAPrivateKey(BIO *bp,RSA **x,int (*cb)());
-RSA *PEM_read_bio_RSAPublicKey(BIO *bp,RSA **x,int (*cb)());
-DSA *PEM_read_bio_DSAPrivateKey(BIO *bp,DSA **x,int (*cb)());
-EVP_PKEY *PEM_read_bio_PrivateKey(BIO *bp,EVP_PKEY **x,int (*cb)());
-PKCS7 *PEM_read_bio_PKCS7(BIO *bp,PKCS7 **x,int (*cb)());
-DH *PEM_read_bio_DHparams(BIO *bp,DH **x,int (*cb)());
-NETSCAPE_CERT_SEQUENCE *PEM_read_bio_NETSCAPE_CERT_SEQUENCE(BIO *bp,NETSCAPE_CERT_SEQUENCE **x,int (*cb)());
-DSA *PEM_read_bio_DSAparams(BIO *bp,DSA **x,int (*cb)());
+X509 *PEM_read_bio_X509(BIO *bp,X509 **x, pem_password_cb *);
+X509_REQ *PEM_read_bio_X509_REQ(BIO *bp,X509_REQ **x, pem_password_cb *);
+X509_CRL *PEM_read_bio_X509_CRL(BIO *bp,X509_CRL **x, pem_password_cb *);
+#ifndef NO_RSA
+RSA *PEM_read_bio_RSAPrivateKey(BIO *bp,RSA **x, pem_password_cb *);
+RSA *PEM_read_bio_RSAPublicKey(BIO *bp,RSA **x, pem_password_cb *);
+#endif
+#ifndef NO_DSA
+DSA *PEM_read_bio_DSAPrivateKey(BIO *bp,DSA **x, pem_password_cb *);
+#endif
+EVP_PKEY *PEM_read_bio_PrivateKey(BIO *bp,EVP_PKEY **x, pem_password_cb *);
+PKCS7 *PEM_read_bio_PKCS7(BIO *bp,PKCS7 **x, pem_password_cb *);
+#ifndef NO_DH
+DH *PEM_read_bio_DHparams(BIO *bp,DH **x, pem_password_cb *);
+#endif
+NETSCAPE_CERT_SEQUENCE *PEM_read_bio_NETSCAPE_CERT_SEQUENCE(BIO *bp,NETSCAPE_CERT_SEQUENCE **x, pem_password_cb *);
+X509_SIG *PEM_read_bio_PKCS8(BIO *bp,X509_SIG **x, pem_password_cb *);
+PKCS8_PRIV_KEY_INFO *PEM_read_bio_PKCS8_PRIV_KEY_INFO(BIO *bp,
+                               PKCS8_PRIV_KEY_INFO **x, pem_password_cb *);
+#ifndef NO_DSA
+DSA *PEM_read_bio_DSAparams(BIO *bp,DSA **x, pem_password_cb *);
+#endif
 int PEM_write_bio_X509(BIO *bp,X509 *x);
 int PEM_write_bio_X509_REQ(BIO *bp,X509_REQ *x);
 int PEM_write_bio_X509_CRL(BIO *bp,X509_CRL *x);
-int PEM_write_bio_RSAPrivateKey(BIO *fp,RSA *x,EVP_CIPHER *enc,
-        unsigned char *kstr,int klen,int (*cb)());
+#ifndef NO_RSA
+int PEM_write_bio_RSAPrivateKey(BIO *fp,RSA *x,const EVP_CIPHER *enc,
+        unsigned char *kstr,int klen, pem_password_cb *);
 int PEM_write_bio_RSAPublicKey(BIO *fp,RSA *x);
-int PEM_write_bio_DSAPrivateKey(BIO *fp,DSA *x,EVP_CIPHER *enc,
-        unsigned char *kstr,int klen,int (*cb)());
+#endif
+#ifndef NO_DSA
+int PEM_write_bio_DSAPrivateKey(BIO *fp,DSA *x,const EVP_CIPHER *enc,
+        unsigned char *kstr,int klen, pem_password_cb *);
+#endif
 int PEM_write_bio_PrivateKey(BIO *fp,EVP_PKEY *x,EVP_CIPHER *enc,
-        unsigned char *kstr,int klen,int (*cb)());
+        unsigned char *kstr,int klen, pem_password_cb *);
 int PEM_write_bio_PKCS7(BIO *bp,PKCS7 *x);
+#ifndef NO_DH
 int PEM_write_bio_DHparams(BIO *bp,DH *x);
-int PEM_write_bio_DSAparams(BIO *bp,DSA *x);
-int PEM_write_bio_NETSCAPE_CERT_SEQUENCE(BIO *bp,NETSCAPE_CERT_SEQUENCE *x);
 #endif
-
-#endif /* SSLEAY_MACROS */
-
-
-#else
-
-int    PEM_get_EVP_CIPHER_INFO();
-int    PEM_do_header();
-int    PEM_read_bio();
-int    PEM_write_bio();
-#ifndef WIN16
-int    PEM_read();
-int    PEM_write();
-STACK *        PEM_X509_INFO_read();
-char * PEM_ASN1_read();
-int    PEM_ASN1_write();
+#ifndef NO_DSA
+int PEM_write_bio_DSAparams(BIO *bp,DSA *x);
 #endif
-STACK *        PEM_X509_INFO_read_bio();
-int    PEM_X509_INFO_write_bio();
-char * PEM_ASN1_read_bio();
-int    PEM_ASN1_write_bio();
-int    PEM_SealInit();
-void   PEM_SealUpdate();
-int    PEM_SealFinal();
-void    PEM_SignInit();
-void    PEM_SignUpdate();
-int    PEM_SignFinal();
-
-void   ERR_load_PEM_strings();
-
-void   PEM_proc_type();
-void   PEM_dek_info();
-
-#ifndef SSLEAY_MACROS
-#ifndef WIN16
-X509 *PEM_read_X509();
-X509_REQ *PEM_read_X509_REQ();
-X509_CRL *PEM_read_X509_CRL();
-RSA *PEM_read_RSAPrivateKey();
-RSA *PEM_read_RSAPublicKey();
-DSA *PEM_read_DSAPrivateKey();
-EVP_PKEY *PEM_read_PrivateKey();
-PKCS7 *PEM_read_PKCS7();
-DH *PEM_read_DHparams();
-DSA *PEM_read_DSAparams();
-NETSCAPE_CERT_SEQUENCE *PEM_read_NETSCAPE_CERT_SEQUENCE();
-int PEM_write_X509();
-int PEM_write_X509_REQ();
-int PEM_write_X509_CRL();
-int PEM_write_RSAPrivateKey();
-int PEM_write_RSAPublicKey();
-int PEM_write_DSAPrivateKey();
-int PEM_write_PrivateKey();
-int PEM_write_PKCS7();
-int PEM_write_DHparams();
-int PEM_write_DSAparams();
-int PEM_write_NETSCAPE_CERT_SEQUENCE();
+int PEM_write_bio_NETSCAPE_CERT_SEQUENCE(BIO *bp,NETSCAPE_CERT_SEQUENCE *x);
+int PEM_write_bio_PKCS8(BIO *bp,X509_SIG *x);
+int PEM_write_bio_PKCS8_PRIV_KEY_INFO(BIO *bp,PKCS8_PRIV_KEY_INFO *x);
 #endif
 
-X509 *PEM_read_bio_X509();
-X509_REQ *PEM_read_bio_X509_REQ();
-X509_CRL *PEM_read_bio_X509_CRL();
-RSA *PEM_read_bio_RSAPrivateKey();
-RSA *PEM_read_bio_RSAPublicKey();
-DSA *PEM_read_bio_DSAPrivateKey();
-EVP_PKEY *PEM_read_bio_PrivateKey();
-PKCS7 *PEM_read_bio_PKCS7();
-DH *PEM_read_bio_DHparams();
-DSA *PEM_read_bio_DSAparams();
-NETSCAPE_CERT_SEQUENCE *PEM_read_bio_NETSCAPE_CERT_SEQUENCE();
-int PEM_write_bio_X509();
-int PEM_write_bio_X509_REQ();
-int PEM_write_bio_X509_CRL();
-int PEM_write_bio_RSAPrivateKey();
-int PEM_write_bio_RSAPublicKey();
-int PEM_write_bio_DSAPrivateKey();
-int PEM_write_bio_PrivateKey();
-int PEM_write_bio_PKCS7();
-int PEM_write_bio_DHparams();
-int PEM_write_bio_DSAparams();
-int PEM_write_bio_NETSCAPE_CERT_SEQUENCE();
-
 #endif /* SSLEAY_MACROS */
 
-#endif
 
 /* BEGIN ERROR CODES */
+/* The following lines are auto generated by the script mkerr.pl. Any changes
+ * made after this point may be overwritten when the script is next run.
+ */
+
 /* Error codes for the PEM functions. */
 
 /* Function codes. */
@@ -553,7 +528,7 @@ int PEM_write_bio_NETSCAPE_CERT_SEQUENCE();
 #define PEM_R_SHORT_HEADER                              112
 #define PEM_R_UNSUPPORTED_CIPHER                        113
 #define PEM_R_UNSUPPORTED_ENCRYPTION                    114
+
 #ifdef  __cplusplus
 }
 #endif