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