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