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