crypto/pkcs7/pkcs7.h

   1 /* crypto/pkcs7/pkcs7.h */
   2 /* Copyright (C) 1995-1998 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_PKCS7_H
  60 #define HEADER_PKCS7_H
  61
  62 #ifdef  __cplusplus
  63 extern "C" {
  64 #endif
  65
  66 #include <openssl/bio.h>
  67 #include <openssl/x509.h>
  68
  69 #ifdef VMS
  70 #include <openssl/vms_idhacks.h>
  71 #endif
  72
  73 #ifdef WIN32
  74 /* Under Win32 this is defined in wincrypt.h */
  75 #undef PKCS7_ISSUER_AND_SERIAL
  76 #endif
  77
  78 /*
  79 Encryption_ID           DES-CBC
  80 Digest_ID               MD5
  81 Digest_Encryption_ID    rsaEncryption
  82 Key_Encryption_ID       rsaEncryption
  83 */
  84
  85 typedef struct pkcs7_issuer_and_serial_st
  86         {
  87         X509_NAME *issuer;
  88         ASN1_INTEGER *serial;
  89         } PKCS7_ISSUER_AND_SERIAL;
  90
  91 typedef struct pkcs7_signer_info_st
  92         {
  93         ASN1_INTEGER                    *version;       /* version 1 */
  94         PKCS7_ISSUER_AND_SERIAL         *issuer_and_serial;
  95         X509_ALGOR                      *digest_alg;
  96         STACK_OF(X509_ATTRIBUTE)        *auth_attr;     /* [ 0 ] */
  97         X509_ALGOR                      *digest_enc_alg;
  98         ASN1_OCTET_STRING               *enc_digest;
  99         STACK_OF(X509_ATTRIBUTE)        *unauth_attr;   /* [ 1 ] */
 100
 101         /* The private key to sign with */
 102         EVP_PKEY                        *pkey;
 103         } PKCS7_SIGNER_INFO;
 104
 105 DECLARE_STACK_OF(PKCS7_SIGNER_INFO)
 106 DECLARE_ASN1_SET_OF(PKCS7_SIGNER_INFO)
 107
 108 typedef struct pkcs7_recip_info_st
 109         {
 110         ASN1_INTEGER                    *version;       /* version 0 */
 111         PKCS7_ISSUER_AND_SERIAL         *issuer_and_serial;
 112         X509_ALGOR                      *key_enc_algor;
 113         ASN1_OCTET_STRING               *enc_key;
 114         X509                            *cert; /* get the pub-key from this */
 115         } PKCS7_RECIP_INFO;
 116
 117 DECLARE_STACK_OF(PKCS7_RECIP_INFO)
 118 DECLARE_ASN1_SET_OF(PKCS7_RECIP_INFO)
 119
 120 typedef struct pkcs7_signed_st
 121         {
 122         ASN1_INTEGER                    *version;       /* version 1 */
 123         STACK_OF(X509_ALGOR)            *md_algs;       /* md used */
 124         STACK_OF(X509)                  *cert;          /* [ 0 ] */
 125         STACK_OF(X509_CRL)              *crl;           /* [ 1 ] */
 126         STACK_OF(PKCS7_SIGNER_INFO)     *signer_info;
 127
 128         struct pkcs7_st                 *contents;
 129         } PKCS7_SIGNED;
 130 /* The above structure is very very similar to PKCS7_SIGN_ENVELOPE.
 131  * How about merging the two */
 132
 133 typedef struct pkcs7_enc_content_st
 134         {
 135         ASN1_OBJECT                     *content_type;
 136         X509_ALGOR                      *algorithm;
 137         ASN1_OCTET_STRING               *enc_data;      /* [ 0 ] */
 138         const EVP_CIPHER                *cipher;
 139         } PKCS7_ENC_CONTENT;
 140
 141 typedef struct pkcs7_enveloped_st
 142         {
 143         ASN1_INTEGER                    *version;       /* version 0 */
 144         STACK_OF(PKCS7_RECIP_INFO)      *recipientinfo;
 145         PKCS7_ENC_CONTENT               *enc_data;
 146         } PKCS7_ENVELOPE;
 147
 148 typedef struct pkcs7_signedandenveloped_st
 149         {
 150         ASN1_INTEGER                    *version;       /* version 1 */
 151         STACK_OF(X509_ALGOR)            *md_algs;       /* md used */
 152         STACK_OF(X509)                  *cert;          /* [ 0 ] */
 153         STACK_OF(X509_CRL)              *crl;           /* [ 1 ] */
 154         STACK_OF(PKCS7_SIGNER_INFO)     *signer_info;
 155
 156         PKCS7_ENC_CONTENT               *enc_data;
 157         STACK_OF(PKCS7_RECIP_INFO)      *recipientinfo;
 158         } PKCS7_SIGN_ENVELOPE;
 159
 160 typedef struct pkcs7_digest_st
 161         {
 162         ASN1_INTEGER                    *version;       /* version 0 */
 163         X509_ALGOR                      *md;            /* md used */
 164         struct pkcs7_st                 *contents;
 165         ASN1_OCTET_STRING               *digest;
 166         } PKCS7_DIGEST;
 167
 168 typedef struct pkcs7_encrypted_st
 169         {
 170         ASN1_INTEGER                    *version;       /* version 0 */
 171         PKCS7_ENC_CONTENT               *enc_data;
 172         } PKCS7_ENCRYPT;
 173
 174 typedef struct pkcs7_st
 175         {
 176         /* The following is non NULL if it contains ASN1 encoding of
 177          * this structure */
 178         unsigned char *asn1;
 179         long length;
 180
 181 #define PKCS7_S_HEADER  0
 182 #define PKCS7_S_BODY    1
 183 #define PKCS7_S_TAIL    2
 184         int state; /* used during processing */
 185
 186         int detached;
 187
 188         ASN1_OBJECT *type;
 189         /* content as defined by the type */
 190         /* all encryption/message digests are applied to the 'contents',
 191          * leaving out the 'type' field. */
 192         union   {
 193                 char *ptr;
 194
 195                 /* NID_pkcs7_data */
 196                 ASN1_OCTET_STRING *data;
 197
 198                 /* NID_pkcs7_signed */
 199                 PKCS7_SIGNED *sign;
 200
 201                 /* NID_pkcs7_enveloped */
 202                 PKCS7_ENVELOPE *enveloped;
 203
 204                 /* NID_pkcs7_signedAndEnveloped */
 205                 PKCS7_SIGN_ENVELOPE *signed_and_enveloped;
 206
 207                 /* NID_pkcs7_digest */
 208                 PKCS7_DIGEST *digest;
 209
 210                 /* NID_pkcs7_encrypted */
 211                 PKCS7_ENCRYPT *encrypted;
 212                 } d;
 213         } PKCS7;
 214
 215 #define PKCS7_OP_SET_DETACHED_SIGNATURE 1
 216 #define PKCS7_OP_GET_DETACHED_SIGNATURE 2
 217
 218 #define PKCS7_get_signed_attributes(si) ((si)->auth_attr)
 219 #define PKCS7_get_attributes(si)        ((si)->unauth_attr)
 220
 221 #define PKCS7_type_is_signed(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_signed)
 222 #define PKCS7_type_is_signedAndEnveloped(a) \
 223                 (OBJ_obj2nid((a)->type) == NID_pkcs7_signedAndEnveloped)
 224 #define PKCS7_type_is_data(a)   (OBJ_obj2nid((a)->type) == NID_pkcs7_data)
 225
 226 #define PKCS7_set_detached(p,v) \
 227                 PKCS7_ctrl(p,PKCS7_OP_SET_DETACHED_SIGNATURE,v,NULL)
 228 #define PKCS7_get_detached(p) \
 229                 PKCS7_ctrl(p,PKCS7_OP_GET_DETACHED_SIGNATURE,0,NULL)
 230
 231 #ifdef SSLEAY_MACROS
 232 #ifndef PKCS7_ISSUER_AND_SERIAL_digest
 233 #define PKCS7_ISSUER_AND_SERIAL_digest(data,type,md,len) \
 234         ASN1_digest((int (*)())i2d_PKCS7_ISSUER_AND_SERIAL,type,\
 235                         (char *)data,md,len)
 236 #endif
 237 #endif
 238
 239
 240 PKCS7_ISSUER_AND_SERIAL *PKCS7_ISSUER_AND_SERIAL_new(void );
 241 void                    PKCS7_ISSUER_AND_SERIAL_free(
 242                                 PKCS7_ISSUER_AND_SERIAL *a);
 243 int                     i2d_PKCS7_ISSUER_AND_SERIAL(
 244                                 PKCS7_ISSUER_AND_SERIAL *a,unsigned char **pp);
 245 PKCS7_ISSUER_AND_SERIAL *d2i_PKCS7_ISSUER_AND_SERIAL(
 246                                 PKCS7_ISSUER_AND_SERIAL **a,
 247                                 unsigned char **pp, long length);
 248
 249 #ifndef SSLEAY_MACROS
 250 int PKCS7_ISSUER_AND_SERIAL_digest(PKCS7_ISSUER_AND_SERIAL *data,const EVP_MD *type,
 251         unsigned char *md,unsigned int *len);
 252 #ifndef NO_FP_API
 253 PKCS7 *d2i_PKCS7_fp(FILE *fp,PKCS7 **p7);
 254 int i2d_PKCS7_fp(FILE *fp,PKCS7 *p7);
 255 #endif
 256 PKCS7 *PKCS7_dup(PKCS7 *p7);
 257 PKCS7 *d2i_PKCS7_bio(BIO *bp,PKCS7 **p7);
 258 int i2d_PKCS7_bio(BIO *bp,PKCS7 *p7);
 259 #endif
 260
 261 PKCS7_SIGNER_INFO       *PKCS7_SIGNER_INFO_new(void);
 262 void                    PKCS7_SIGNER_INFO_free(PKCS7_SIGNER_INFO *a);
 263 int                     i2d_PKCS7_SIGNER_INFO(PKCS7_SIGNER_INFO *a,
 264                                 unsigned char **pp);
 265 PKCS7_SIGNER_INFO       *d2i_PKCS7_SIGNER_INFO(PKCS7_SIGNER_INFO **a,
 266                                 unsigned char **pp,long length);
 267
 268 PKCS7_RECIP_INFO        *PKCS7_RECIP_INFO_new(void);
 269 void                    PKCS7_RECIP_INFO_free(PKCS7_RECIP_INFO *a);
 270 int                     i2d_PKCS7_RECIP_INFO(PKCS7_RECIP_INFO *a,
 271                                 unsigned char **pp);
 272 PKCS7_RECIP_INFO        *d2i_PKCS7_RECIP_INFO(PKCS7_RECIP_INFO **a,
 273                                 unsigned char **pp,long length);
 274
 275 PKCS7_SIGNED            *PKCS7_SIGNED_new(void);
 276 void                    PKCS7_SIGNED_free(PKCS7_SIGNED *a);
 277 int                     i2d_PKCS7_SIGNED(PKCS7_SIGNED *a,
 278                                 unsigned char **pp);
 279 PKCS7_SIGNED            *d2i_PKCS7_SIGNED(PKCS7_SIGNED **a,
 280                                 unsigned char **pp,long length);
 281
 282 PKCS7_ENC_CONTENT       *PKCS7_ENC_CONTENT_new(void);
 283 void                    PKCS7_ENC_CONTENT_free(PKCS7_ENC_CONTENT *a);
 284 int                     i2d_PKCS7_ENC_CONTENT(PKCS7_ENC_CONTENT *a,
 285                                 unsigned char **pp);
 286 PKCS7_ENC_CONTENT       *d2i_PKCS7_ENC_CONTENT(PKCS7_ENC_CONTENT **a,
 287                                 unsigned char **pp,long length);
 288
 289 PKCS7_ENVELOPE          *PKCS7_ENVELOPE_new(void);
 290 void                    PKCS7_ENVELOPE_free(PKCS7_ENVELOPE *a);
 291 int                     i2d_PKCS7_ENVELOPE(PKCS7_ENVELOPE *a,
 292                                 unsigned char **pp);
 293 PKCS7_ENVELOPE          *d2i_PKCS7_ENVELOPE(PKCS7_ENVELOPE **a,
 294                                 unsigned char **pp,long length);
 295
 296 PKCS7_SIGN_ENVELOPE     *PKCS7_SIGN_ENVELOPE_new(void);
 297 void                    PKCS7_SIGN_ENVELOPE_free(PKCS7_SIGN_ENVELOPE *a);
 298 int                     i2d_PKCS7_SIGN_ENVELOPE(PKCS7_SIGN_ENVELOPE *a,
 299                                 unsigned char **pp);
 300 PKCS7_SIGN_ENVELOPE     *d2i_PKCS7_SIGN_ENVELOPE(PKCS7_SIGN_ENVELOPE **a,
 301                                 unsigned char **pp,long length);
 302
 303 PKCS7_DIGEST            *PKCS7_DIGEST_new(void);
 304 void                    PKCS7_DIGEST_free(PKCS7_DIGEST *a);
 305 int                     i2d_PKCS7_DIGEST(PKCS7_DIGEST *a,
 306                                 unsigned char **pp);
 307 PKCS7_DIGEST            *d2i_PKCS7_DIGEST(PKCS7_DIGEST **a,
 308                                 unsigned char **pp,long length);
 309
 310 PKCS7_ENCRYPT           *PKCS7_ENCRYPT_new(void);
 311 void                    PKCS7_ENCRYPT_free(PKCS7_ENCRYPT *a);
 312 int                     i2d_PKCS7_ENCRYPT(PKCS7_ENCRYPT *a,
 313                                 unsigned char **pp);
 314 PKCS7_ENCRYPT           *d2i_PKCS7_ENCRYPT(PKCS7_ENCRYPT **a,
 315                                 unsigned char **pp,long length);
 316
 317 PKCS7                   *PKCS7_new(void);
 318 void                    PKCS7_free(PKCS7 *a);
 319 void                    PKCS7_content_free(PKCS7 *a);
 320 int                     i2d_PKCS7(PKCS7 *a,
 321                                 unsigned char **pp);
 322 PKCS7                   *d2i_PKCS7(PKCS7 **a,
 323                                 unsigned char **pp,long length);
 324
 325 void ERR_load_PKCS7_strings(void);
 326
 327
 328 long PKCS7_ctrl(PKCS7 *p7, int cmd, long larg, char *parg);
 329
 330 int PKCS7_set_type(PKCS7 *p7, int type);
 331 int PKCS7_set_content(PKCS7 *p7, PKCS7 *p7_data);
 332 int PKCS7_SIGNER_INFO_set(PKCS7_SIGNER_INFO *p7i, X509 *x509, EVP_PKEY *pkey,
 333         EVP_MD *dgst);
 334 int PKCS7_add_signer(PKCS7 *p7, PKCS7_SIGNER_INFO *p7i);
 335 int PKCS7_add_certificate(PKCS7 *p7, X509 *x509);
 336 int PKCS7_add_crl(PKCS7 *p7, X509_CRL *x509);
 337 int PKCS7_content_new(PKCS7 *p7, int nid);
 338 int PKCS7_dataVerify(X509_STORE *cert_store, X509_STORE_CTX *ctx,
 339         BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si);
 340 int PKCS7_signatureVerify(BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si,
 341                                                                 X509 *x509);
 342
 343 BIO *PKCS7_dataInit(PKCS7 *p7, BIO *bio);
 344 int PKCS7_dataFinal(PKCS7 *p7, BIO *bio);
 345 BIO *PKCS7_dataDecode(PKCS7 *p7, EVP_PKEY *pkey, BIO *in_bio, X509 *pcert);
 346
 347
 348 PKCS7_SIGNER_INFO *PKCS7_add_signature(PKCS7 *p7, X509 *x509,
 349         EVP_PKEY *pkey, EVP_MD *dgst);
 350 X509 *PKCS7_cert_from_signer_info(PKCS7 *p7, PKCS7_SIGNER_INFO *si);
 351 STACK_OF(PKCS7_SIGNER_INFO) *PKCS7_get_signer_info(PKCS7 *p7);
 352
 353 PKCS7_RECIP_INFO *PKCS7_add_recipient(PKCS7 *p7, X509 *x509);
 354 int PKCS7_add_recipient_info(PKCS7 *p7, PKCS7_RECIP_INFO *ri);
 355 int PKCS7_RECIP_INFO_set(PKCS7_RECIP_INFO *p7i, X509 *x509);
 356 int PKCS7_set_cipher(PKCS7 *p7, const EVP_CIPHER *cipher);
 357
 358 PKCS7_ISSUER_AND_SERIAL *PKCS7_get_issuer_and_serial(PKCS7 *p7, int idx);
 359 ASN1_OCTET_STRING *PKCS7_digest_from_attributes(STACK_OF(X509_ATTRIBUTE) *sk);
 360 int PKCS7_add_signed_attribute(PKCS7_SIGNER_INFO *p7si,int nid,int type,
 361         void *data);
 362 int PKCS7_add_attribute (PKCS7_SIGNER_INFO *p7si, int nid, int atrtype,
 363         void *value);
 364 ASN1_TYPE *PKCS7_get_attribute(PKCS7_SIGNER_INFO *si, int nid);
 365 ASN1_TYPE *PKCS7_get_signed_attribute(PKCS7_SIGNER_INFO *si, int nid);
 366 int PKCS7_set_signed_attributes(PKCS7_SIGNER_INFO *p7si,
 367                                 STACK_OF(X509_ATTRIBUTE) *sk);
 368 int PKCS7_set_attributes(PKCS7_SIGNER_INFO *p7si,STACK_OF(X509_ATTRIBUTE) *sk);
 369
 370
 371
 372 /* BEGIN ERROR CODES */
 373 /* The following lines are auto generated by the script mkerr.pl. Any changes
 374  * made after this point may be overwritten when the script is next run.
 375  */
 376
 377 /* Error codes for the PKCS7 functions. */
 378
 379 /* Function codes. */
 380 #define PKCS7_F_PKCS7_ADD_CERTIFICATE                    100
 381 #define PKCS7_F_PKCS7_ADD_CRL                            101
 382 #define PKCS7_F_PKCS7_ADD_RECIPIENT_INFO                 102
 383 #define PKCS7_F_PKCS7_ADD_SIGNER                         103
 384 #define PKCS7_F_PKCS7_CTRL                               104
 385 #define PKCS7_F_PKCS7_DATADECODE                         112
 386 #define PKCS7_F_PKCS7_DATAINIT                           105
 387 #define PKCS7_F_PKCS7_DATASIGN                           106
 388 #define PKCS7_F_PKCS7_DATAVERIFY                         107
 389 #define PKCS7_F_PKCS7_SET_CIPHER                         108
 390 #define PKCS7_F_PKCS7_SET_CONTENT                        109
 391 #define PKCS7_F_PKCS7_SET_TYPE                           110
 392 #define PKCS7_F_PKCS7_SIGNATUREVERIFY                    113
 393
 394 /* Reason codes. */
 395 #define PKCS7_R_CIPHER_NOT_INITIALIZED                   116
 396 #define PKCS7_R_DECRYPTED_KEY_IS_WRONG_LENGTH            100
 397 #define PKCS7_R_DIGEST_FAILURE                           101
 398 #define PKCS7_R_INTERNAL_ERROR                           102
 399 #define PKCS7_R_MISSING_CERIPEND_INFO                    103
 400 #define PKCS7_R_NO_RECIPIENT_MATCHES_CERTIFICATE         115
 401 #define PKCS7_R_OPERATION_NOT_SUPPORTED_ON_THIS_TYPE     104
 402 #define PKCS7_R_SIGNATURE_FAILURE                        105
 403 #define PKCS7_R_UNABLE_TO_FIND_CERTIFICATE               106
 404 #define PKCS7_R_UNABLE_TO_FIND_MEM_BIO                   107
 405 #define PKCS7_R_UNABLE_TO_FIND_MESSAGE_DIGEST            108
 406 #define PKCS7_R_UNKNOWN_DIGEST_TYPE                      109
 407 #define PKCS7_R_UNKNOWN_OPERATION                        110
 408 #define PKCS7_R_UNSUPPORTED_CIPHER_TYPE                  111
 409 #define PKCS7_R_UNSUPPORTED_CONTENT_TYPE                 112
 410 #define PKCS7_R_WRONG_CONTENT_TYPE                       113
 411 #define PKCS7_R_WRONG_PKCS7_TYPE                         114
 412
 413 #ifdef  __cplusplus
 414 }
 415 #endif
 416 #endif
 417