Further comment amendments to preserve formatting prior to source reformat
[openssl.git] / crypto / pem / pem.h
index 96e39d47f5483e42fda7df7c7f1702255c6334f8..7c9b92a7dab67113612b55b59907cc4af7dffbb0 100644 (file)
@@ -125,15 +125,18 @@ extern "C" {
 #define PEM_STRING_DSA         "DSA PRIVATE KEY"
 #define PEM_STRING_DSA_PUBLIC  "DSA PUBLIC KEY"
 #define PEM_STRING_PKCS7       "PKCS7"
+#define PEM_STRING_PKCS7_SIGNED        "PKCS #7 SIGNED DATA"
 #define PEM_STRING_PKCS8       "ENCRYPTED PRIVATE KEY"
 #define PEM_STRING_PKCS8INF    "PRIVATE KEY"
 #define PEM_STRING_DHPARAMS    "DH PARAMETERS"
+#define PEM_STRING_DHXPARAMS   "X9.42 DH PARAMETERS"
 #define PEM_STRING_SSL_SESSION "SSL SESSION PARAMETERS"
 #define PEM_STRING_DSAPARAMS   "DSA PARAMETERS"
 #define PEM_STRING_ECDSA_PUBLIC "ECDSA PUBLIC KEY"
 #define PEM_STRING_ECPARAMETERS "EC PARAMETERS"
 #define PEM_STRING_ECPRIVATEKEY        "EC PRIVATE KEY"
 #define PEM_STRING_PARAMETERS  "PARAMETERS"
+#define PEM_STRING_CMS         "CMS"
 
   /* Note that this structure is initialised by PEM_SealInit and cleaned up
      by PEM_SealFinal (at least for now) */
@@ -173,7 +176,8 @@ typedef struct pem_ctx_st
 
        struct  {
                int cipher;
-       /* unused, and wrong size
+       /*-
+          unused, and wrong size
           unsigned char iv[8]; */
                } DEK_info;
                
@@ -182,11 +186,9 @@ typedef struct pem_ctx_st
        int num_recipient;
        PEM_USER **recipient;
 
-#ifndef OPENSSL_NO_STACK
-       STACK *x509_chain;      /* certificate chain */
-#else
-       char *x509_chain;       /* certificate chain */
-#endif
+       /*-
+           XXX(ben): don#t think this is used! 
+               STACK *x509_chain;      / * certificate chain */
        EVP_MD *md;             /* signature type */
 
        int md_enc;             /* is the md encrypted or not? */
@@ -196,7 +198,8 @@ typedef struct pem_ctx_st
        EVP_CIPHER *dec;        /* date encryption cipher */
        int key_len;            /* key length */
        unsigned char *key;     /* key */
-       /* unused, and wrong size
+       /*-
+           unused, and wrong size
           unsigned char iv[8]; */
 
        
@@ -214,7 +217,9 @@ typedef struct pem_ctx_st
 
 #define IMPLEMENT_PEM_read_fp(name, type, str, asn1) /**/
 #define IMPLEMENT_PEM_write_fp(name, type, str, asn1) /**/
+#define IMPLEMENT_PEM_write_fp_const(name, type, str, asn1) /**/
 #define IMPLEMENT_PEM_write_cb_fp(name, type, str, asn1) /**/
+#define IMPLEMENT_PEM_write_cb_fp_const(name, type, str, asn1) /**/
 
 #else
 
@@ -361,6 +366,7 @@ int PEM_write_bio_##name(BIO *bp, type *x, const EVP_CIPHER *enc, \
 
 #define DECLARE_PEM_read_bio(name, type) /**/
 #define DECLARE_PEM_write_bio(name, type) /**/
+#define DECLARE_PEM_write_bio_const(name, type) /**/
 #define DECLARE_PEM_write_cb_bio(name, type) /**/
 
 #endif
@@ -408,8 +414,8 @@ int PEM_do_header (EVP_CIPHER_INFO *cipher, unsigned char *data,long *len,
 #ifndef OPENSSL_NO_BIO
 int    PEM_read_bio(BIO *bp, char **name, char **header,
                unsigned char **data,long *len);
-int    PEM_write_bio(BIO *bp,const char *name,char *hdr,unsigned char *data,
-               long len);
+int    PEM_write_bio(BIO *bp,const char *name, const char *hdr,
+                     const unsigned char *data, long len);
 int PEM_bytes_read_bio(unsigned char **pdata, long *plen, char **pnm, const char *name, BIO *bp,
             pem_password_cb *cb, void *u);
 void * PEM_ASN1_read_bio(d2i_of_void *d2i, const char *name, BIO *bp,
@@ -425,7 +431,8 @@ int PEM_X509_INFO_write_bio(BIO *bp,X509_INFO *xi, EVP_CIPHER *enc,
 
 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);
+int    PEM_write(FILE *fp, const char *name, const char *hdr,
+                 const unsigned char *data, long len);
 void *  PEM_ASN1_read(d2i_of_void *d2i, const char *name, FILE *fp, void **x,
                      pem_password_cb *cb, void *u);
 int    PEM_ASN1_write(i2d_of_void *i2d,const char *name,FILE *fp,
@@ -437,13 +444,13 @@ STACK_OF(X509_INFO) *     PEM_X509_INFO_read(FILE *fp, STACK_OF(X509_INFO) *sk,
 int    PEM_SealInit(PEM_ENCODE_SEAL_CTX *ctx, EVP_CIPHER *type,
                EVP_MD *md_type, unsigned char **ek, int *ekl,
                unsigned char *iv, EVP_PKEY **pubk, int npubk);
-void   PEM_SealUpdate(PEM_ENCODE_SEAL_CTX *ctx, unsigned char *out, int *outl,
+int    PEM_SealUpdate(PEM_ENCODE_SEAL_CTX *ctx, unsigned char *out, int *outl,
                unsigned char *in, int inl);
 int    PEM_SealFinal(PEM_ENCODE_SEAL_CTX *ctx, unsigned char *sig,int *sigl,
                unsigned char *out, int *outl, EVP_PKEY *priv);
 
-void    PEM_SignInit(EVP_MD_CTX *ctx, EVP_MD *type);
-void    PEM_SignUpdate(EVP_MD_CTX *ctx,unsigned char *d,unsigned int cnt);
+int    PEM_SignInit(EVP_MD_CTX *ctx, EVP_MD *type);
+int    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);
 
@@ -501,6 +508,7 @@ DECLARE_PEM_rw(EC_PUBKEY, EC_KEY)
 #ifndef OPENSSL_NO_DH
 
 DECLARE_PEM_rw_const(DHparams, DH)
+DECLARE_PEM_write_const(DHxparams, DH)
 
 #endif
 
@@ -546,10 +554,11 @@ EVP_PKEY *b2i_PrivateKey_bio(BIO *in);
 EVP_PKEY *b2i_PublicKey_bio(BIO *in);
 int i2b_PrivateKey_bio(BIO *out, EVP_PKEY *pk);
 int i2b_PublicKey_bio(BIO *out, EVP_PKEY *pk);
-
+#ifndef OPENSSL_NO_RC4
 EVP_PKEY *b2i_PVK_bio(BIO *in, pem_password_cb *cb, void *u);
 int i2b_PVK_bio(BIO *out, EVP_PKEY *pk, int enclevel,
                pem_password_cb *cb, void *u);
+#endif
 
 
 /* BEGIN ERROR CODES */
@@ -589,8 +598,10 @@ void ERR_load_PEM_strings(void);
 #define PEM_F_PEM_PK8PKEY                               119
 #define PEM_F_PEM_READ                                  108
 #define PEM_F_PEM_READ_BIO                              109
+#define PEM_F_PEM_READ_BIO_DHPARAMS                     141
 #define PEM_F_PEM_READ_BIO_PARAMETERS                   140
 #define PEM_F_PEM_READ_BIO_PRIVATEKEY                   123
+#define PEM_F_PEM_READ_DHPARAMS                                 142
 #define PEM_F_PEM_READ_PRIVATEKEY                       124
 #define PEM_F_PEM_SEALFINAL                             110
 #define PEM_F_PEM_SEALINIT                              111