1 /* crypto/pkcs7/pkcs7.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
59 #ifndef HEADER_PKCS7_H
60 #define HEADER_PKCS7_H
72 Digest_Encryption_ID rsaEncryption
73 Key_Encryption_ID rsaEncryption
76 typedef struct pkcs7_issuer_and_serial_st
80 } PKCS7_ISSUER_AND_SERIAL;
82 typedef struct pkcs7_signer_info_st
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 ] */
92 /* The private key to sign with */
96 typedef struct pkcs7_recip_info_st
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 */
105 typedef struct pkcs7_signed_st
107 ASN1_INTEGER *version; /* version 1 */
108 STACK /* X509_ALGOR's */ *md_algs; /* md used */
109 STACK /* X509 */ *cert; /* [ 0 ] */
110 STACK /* X509_CRL */ *crl; /* [ 1 ] */
111 STACK /* PKCS7_SIGNER_INFO */ *signer_info;
113 struct pkcs7_st *contents;
115 /* The above structure is very very similar to PKCS7_SIGN_ENVELOPE.
116 * How about merging the two */
118 typedef struct pkcs7_enc_content_st
120 ASN1_OBJECT *content_type;
121 X509_ALGOR *algorithm;
122 ASN1_OCTET_STRING *enc_data; /* [ 0 ] */
125 typedef struct pkcs7_enveloped_st
127 ASN1_INTEGER *version; /* version 0 */
128 STACK /* PKCS7_RECIP_INFO */ *recipientinfo;
129 PKCS7_ENC_CONTENT *enc_data;
132 typedef struct pkcs7_signedandenveloped_st
134 ASN1_INTEGER *version; /* version 1 */
135 STACK /* X509_ALGOR's */ *md_algs; /* md used */
136 STACK /* X509 */ *cert; /* [ 0 ] */
137 STACK /* X509_CRL */ *crl; /* [ 1 ] */
138 STACK /* PKCS7_SIGNER_INFO */ *signer_info;
140 PKCS7_ENC_CONTENT *enc_data;
141 STACK /* PKCS7_RECIP_INFO */ *recipientinfo;
142 } PKCS7_SIGN_ENVELOPE;
144 typedef struct pkcs7_digest_st
146 ASN1_INTEGER *version; /* version 0 */
147 X509_ALGOR *md; /* md used */
148 struct pkcs7_st *contents;
149 ASN1_OCTET_STRING *digest;
152 typedef struct pkcs7_encrypted_st
154 ASN1_INTEGER *version; /* version 0 */
155 PKCS7_ENC_CONTENT *enc_data;
158 typedef struct pkcs7_st
160 /* The following is non NULL if it contains ASN1 encoding of
165 #define PKCS7_S_HEADER 0
166 #define PKCS7_S_BODY 1
167 #define PKCS7_S_TAIL 2
168 int state; /* used during processing */
173 /* content as defined by the type */
174 /* all encryption/message digests are applied to the 'contents',
175 * leaving out the 'type' field. */
180 ASN1_OCTET_STRING *data;
182 /* NID_pkcs7_signed */
185 /* NID_pkcs7_enveloped */
186 PKCS7_ENVELOPE *enveloped;
188 /* NID_pkcs7_signedAndEnveloped */
189 PKCS7_SIGN_ENVELOPE *signed_and_enveloped;
191 /* NID_pkcs7_digest */
192 PKCS7_DIGEST *digest;
194 /* NID_pkcs7_encrypted */
195 PKCS7_ENCRYPT *encrypted;
199 #define PKCS7_OP_SET_DETACHED_SIGNATURE 1
200 #define PKCS7_OP_GET_DETACHED_SIGNATURE 2
202 #define PKCS7_type_is_signed(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_signed)
203 #define PKCS7_type_is_data(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_data)
205 #define PKCS7_set_detached(p,v) \
206 PKCS7_ctrl(p,PKCS7_OP_SET_DETACHED_SIGNATURE,v,NULL)
207 #define PKCS7_get_detached(p) \
208 PKCS7_ctrl(p,PKCS7_OP_GET_DETACHED_SIGNATURE,0,NULL)
212 #define PKCS7_ISSUER_AND_SERIAL_digest(data,type,md,len) \
213 ASN1_digest((int (*)())i2d_PKCS7_ISSUER_AND_SERIAL,type,\
219 PKCS7_ISSUER_AND_SERIAL *PKCS7_ISSUER_AND_SERIAL_new(void );
220 void PKCS7_ISSUER_AND_SERIAL_free(
221 PKCS7_ISSUER_AND_SERIAL *a);
222 int i2d_PKCS7_ISSUER_AND_SERIAL(
223 PKCS7_ISSUER_AND_SERIAL *a,unsigned char **pp);
224 PKCS7_ISSUER_AND_SERIAL *d2i_PKCS7_ISSUER_AND_SERIAL(
225 PKCS7_ISSUER_AND_SERIAL **a,
226 unsigned char **pp, long length);
228 #ifndef SSLEAY_MACROS
229 int PKCS7_ISSUER_AND_SERIAL_digest(PKCS7_ISSUER_AND_SERIAL *data,EVP_MD *type,
230 unsigned char *md,unsigned int *len);
232 PKCS7 *d2i_PKCS7_fp(FILE *fp,PKCS7 *p7);
233 int i2d_PKCS7_fp(FILE *fp,PKCS7 *p7);
235 PKCS7 *PKCS7_dup(PKCS7 *p7);
236 PKCS7 *d2i_PKCS7_bio(BIO *bp,PKCS7 *p7);
237 int i2d_PKCS7_bio(BIO *bp,PKCS7 *p7);
240 PKCS7_SIGNER_INFO *PKCS7_SIGNER_INFO_new(void);
241 void PKCS7_SIGNER_INFO_free(PKCS7_SIGNER_INFO *a);
242 int i2d_PKCS7_SIGNER_INFO(PKCS7_SIGNER_INFO *a,
244 PKCS7_SIGNER_INFO *d2i_PKCS7_SIGNER_INFO(PKCS7_SIGNER_INFO **a,
245 unsigned char **pp,long length);
247 PKCS7_RECIP_INFO *PKCS7_RECIP_INFO_new(void);
248 void PKCS7_RECIP_INFO_free(PKCS7_RECIP_INFO *a);
249 int i2d_PKCS7_RECIP_INFO(PKCS7_RECIP_INFO *a,
251 PKCS7_RECIP_INFO *d2i_PKCS7_RECIP_INFO(PKCS7_RECIP_INFO **a,
252 unsigned char **pp,long length);
254 PKCS7_SIGNED *PKCS7_SIGNED_new(void);
255 void PKCS7_SIGNED_free(PKCS7_SIGNED *a);
256 int i2d_PKCS7_SIGNED(PKCS7_SIGNED *a,
258 PKCS7_SIGNED *d2i_PKCS7_SIGNED(PKCS7_SIGNED **a,
259 unsigned char **pp,long length);
261 PKCS7_ENC_CONTENT *PKCS7_ENC_CONTENT_new(void);
262 void PKCS7_ENC_CONTENT_free(PKCS7_ENC_CONTENT *a);
263 int i2d_PKCS7_ENC_CONTENT(PKCS7_ENC_CONTENT *a,
265 PKCS7_ENC_CONTENT *d2i_PKCS7_ENC_CONTENT(PKCS7_ENC_CONTENT **a,
266 unsigned char **pp,long length);
268 PKCS7_ENVELOPE *PKCS7_ENVELOPE_new(void);
269 void PKCS7_ENVELOPE_free(PKCS7_ENVELOPE *a);
270 int i2d_PKCS7_ENVELOPE(PKCS7_ENVELOPE *a,
272 PKCS7_ENVELOPE *d2i_PKCS7_ENVELOPE(PKCS7_ENVELOPE **a,
273 unsigned char **pp,long length);
275 PKCS7_SIGN_ENVELOPE *PKCS7_SIGN_ENVELOPE_new(void);
276 void PKCS7_SIGN_ENVELOPE_free(PKCS7_SIGN_ENVELOPE *a);
277 int i2d_PKCS7_SIGN_ENVELOPE(PKCS7_SIGN_ENVELOPE *a,
279 PKCS7_SIGN_ENVELOPE *d2i_PKCS7_SIGN_ENVELOPE(PKCS7_SIGN_ENVELOPE **a,
280 unsigned char **pp,long length);
282 PKCS7_DIGEST *PKCS7_DIGEST_new(void);
283 void PKCS7_DIGEST_free(PKCS7_DIGEST *a);
284 int i2d_PKCS7_DIGEST(PKCS7_DIGEST *a,
286 PKCS7_DIGEST *d2i_PKCS7_DIGEST(PKCS7_DIGEST **a,
287 unsigned char **pp,long length);
289 PKCS7_ENCRYPT *PKCS7_ENCRYPT_new(void);
290 void PKCS7_ENCRYPT_free(PKCS7_ENCRYPT *a);
291 int i2d_PKCS7_ENCRYPT(PKCS7_ENCRYPT *a,
293 PKCS7_ENCRYPT *d2i_PKCS7_ENCRYPT(PKCS7_ENCRYPT **a,
294 unsigned char **pp,long length);
296 PKCS7 *PKCS7_new(void);
297 void PKCS7_free(PKCS7 *a);
298 void PKCS7_content_free(PKCS7 *a);
299 int i2d_PKCS7(PKCS7 *a,
301 PKCS7 *d2i_PKCS7(PKCS7 **a,
302 unsigned char **pp,long length);
304 void ERR_load_PKCS7_strings(void);
307 long PKCS7_ctrl(PKCS7 *p7, int cmd, long larg, char *parg);
309 int PKCS7_set_type(PKCS7 *p7, int type);
310 int PKCS7_set_content(PKCS7 *p7, PKCS7 *p7_data);
311 int PKCS7_SIGNER_INFO_set(PKCS7_SIGNER_INFO *p7i, X509 *x509, EVP_PKEY *pkey,
313 int PKCS7_add_signer(PKCS7 *p7, PKCS7_SIGNER_INFO *p7i);
314 int PKCS7_add_certificate(PKCS7 *p7, X509 *x509);
315 int PKCS7_add_crl(PKCS7 *p7, X509_CRL *x509);
316 int PKCS7_content_new(PKCS7 *p7, int nid);
317 int PKCS7_dataSign(PKCS7 *p7, BIO *bio);
318 int PKCS7_dataVerify(X509_STORE *cert_store, X509_STORE_CTX *ctx,
319 BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si);
321 BIO *PKCS7_dataInit(PKCS7 *p7, BIO *bio);
322 /*int PKCS7_DataFinal(PKCS7 *p7, BIO *bio); */
324 PKCS7_SIGNER_INFO *PKCS7_add_signature(PKCS7 *p7, X509 *x509,
325 EVP_PKEY *pkey, EVP_MD *dgst);
326 X509 *PKCS7_cert_from_signer_info(PKCS7 *p7, PKCS7_SIGNER_INFO *si);
327 STACK *PKCS7_get_signer_info(PKCS7 *p7);
329 PKCS7_RECIP_INFO *PKCS7_add_recipient(PKCS7 *p7, X509 *x509);
330 int PKCS7_add_recipient_info(PKCS7 *p7, PKCS7_RECIP_INFO *ri);
331 int PKCS7_RECIP_INFO_set(PKCS7_RECIP_INFO *p7i, X509 *x509);
332 int PKCS7_set_cipher(PKCS7 *p7, EVP_CIPHER *cipher);
338 PKCS7_ISSUER_AND_SERIAL *PKCS7_ISSUER_AND_SERIAL_new();
339 void PKCS7_ISSUER_AND_SERIAL_free();
340 int i2d_PKCS7_ISSUER_AND_SERIAL();
341 PKCS7_ISSUER_AND_SERIAL *d2i_PKCS7_ISSUER_AND_SERIAL();
343 #ifndef SSLEAY_MACROS
344 int PKCS7_ISSUER_AND_SERIAL_digest();
346 PKCS7 *d2i_PKCS7_fp();
350 PKCS7 *d2i_PKCS7_bio();
355 PKCS7_SIGNER_INFO *PKCS7_SIGNER_INFO_new();
356 void PKCS7_SIGNER_INFO_free();
357 int i2d_PKCS7_SIGNER_INFO();
358 PKCS7_SIGNER_INFO *d2i_PKCS7_SIGNER_INFO();
359 PKCS7_RECIP_INFO *PKCS7_RECIP_INFO_new();
360 void PKCS7_RECIP_INFO_free();
361 int i2d_PKCS7_RECIP_INFO();
362 PKCS7_RECIP_INFO *d2i_PKCS7_RECIP_INFO();
363 PKCS7_SIGNED *PKCS7_SIGNED_new();
364 void PKCS7_SIGNED_free();
365 int i2d_PKCS7_SIGNED();
366 PKCS7_SIGNED *d2i_PKCS7_SIGNED();
367 PKCS7_ENC_CONTENT *PKCS7_ENC_CONTENT_new();
368 void PKCS7_ENC_CONTENT_free();
369 int i2d_PKCS7_ENC_CONTENT();
370 PKCS7_ENC_CONTENT *d2i_PKCS7_ENC_CONTENT();
371 PKCS7_ENVELOPE *PKCS7_ENVELOPE_new();
372 void PKCS7_ENVELOPE_free();
373 int i2d_PKCS7_ENVELOPE();
374 PKCS7_ENVELOPE *d2i_PKCS7_ENVELOPE();
375 PKCS7_SIGN_ENVELOPE *PKCS7_SIGN_ENVELOPE_new();
376 void PKCS7_SIGN_ENVELOPE_free();
377 int i2d_PKCS7_SIGN_ENVELOPE();
378 PKCS7_SIGN_ENVELOPE *d2i_PKCS7_SIGN_ENVELOPE();
379 PKCS7_DIGEST *PKCS7_DIGEST_new();
380 void PKCS7_DIGEST_free();
381 int i2d_PKCS7_DIGEST();
382 PKCS7_DIGEST *d2i_PKCS7_DIGEST();
383 PKCS7_ENCRYPT *PKCS7_ENCRYPT_new();
384 void PKCS7_ENCRYPT_free();
385 int i2d_PKCS7_ENCRYPT();
386 PKCS7_ENCRYPT *d2i_PKCS7_ENCRYPT();
389 void PKCS7_content_free();
393 void ERR_load_PKCS7_strings();
396 int PKCS7_set_type();
397 int PKCS7_set_content();
398 int PKCS7_SIGNER_INFO_set();
399 int PKCS7_add_signer();
400 int PKCS7_add_certificate();
402 int PKCS7_content_new();
403 int PKCS7_dataSign();
404 int PKCS7_dataVerify();
405 BIO *PKCS7_dataInit();
406 PKCS7_SIGNER_INFO *PKCS7_add_signature();
407 X509 *PKCS7_cert_from_signer_info();
408 STACK *PKCS7_get_signer_info();
410 PKCS7_RECIP_INFO *PKCS7_add_recipient();
411 int PKCS7_add_recipient_info();
412 int PKCS7_RECIP_INFO_set();
413 int PKCS7_set_cipher();
417 /* BEGIN ERROR CODES */
418 /* Error codes for the PKCS7 functions. */
420 /* Function codes. */
421 #define PKCS7_F_PKCS7_ADD_CERTIFICATE 100
422 #define PKCS7_F_PKCS7_ADD_CRL 101
423 #define PKCS7_F_PKCS7_ADD_RECIPIENT_INFO 102
424 #define PKCS7_F_PKCS7_ADD_SIGNER 103
425 #define PKCS7_F_PKCS7_CTRL 104
426 #define PKCS7_F_PKCS7_DATAINIT 105
427 #define PKCS7_F_PKCS7_DATASIGN 106
428 #define PKCS7_F_PKCS7_DATAVERIFY 107
429 #define PKCS7_F_PKCS7_SET_CIPHER 108
430 #define PKCS7_F_PKCS7_SET_CONTENT 109
431 #define PKCS7_F_PKCS7_SET_TYPE 110
434 #define PKCS7_R_INTERNAL_ERROR 100
435 #define PKCS7_R_OPERATION_NOT_SUPPORTED_ON_THIS_TYPE 101
436 #define PKCS7_R_SIGNATURE_FAILURE 102
437 #define PKCS7_R_UNABLE_TO_FIND_CERTIFICATE 103
438 #define PKCS7_R_UNABLE_TO_FIND_MEM_BIO 104
439 #define PKCS7_R_UNABLE_TO_FIND_MESSAGE_DIGEST 105
440 #define PKCS7_R_UNKNOWN_DIGEST_TYPE 106
441 #define PKCS7_R_UNSUPPORTED_CIPHER_TYPE 107
442 #define PKCS7_R_UNSUPPORTED_CONTENT_TYPE 108
443 #define PKCS7_R_WRONG_CONTENT_TYPE 109