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
66 #include <openssl/bio.h>
67 #include <openssl/x509.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_OF(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_OF(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_get_signed_attributes(si) ((si)->auth_attr)
203 #define PKCS7_get_attributes(si) ((si)->unauth_attr)
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)
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)
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,\
225 PKCS7_ISSUER_AND_SERIAL
*PKCS7_ISSUER_AND_SERIAL_new(void );
226 void PKCS7_ISSUER_AND_SERIAL_free(
227 PKCS7_ISSUER_AND_SERIAL
*a
);
228 int i2d_PKCS7_ISSUER_AND_SERIAL(
229 PKCS7_ISSUER_AND_SERIAL
*a
,unsigned char **pp
);
230 PKCS7_ISSUER_AND_SERIAL
*d2i_PKCS7_ISSUER_AND_SERIAL(
231 PKCS7_ISSUER_AND_SERIAL
**a
,
232 unsigned char **pp
, long length
);
234 #ifndef SSLEAY_MACROS
235 int PKCS7_ISSUER_AND_SERIAL_digest(PKCS7_ISSUER_AND_SERIAL
*data
,EVP_MD
*type
,
236 unsigned char *md
,unsigned int *len
);
238 PKCS7
*d2i_PKCS7_fp(FILE *fp
,PKCS7
*p7
);
239 int i2d_PKCS7_fp(FILE *fp
,PKCS7
*p7
);
241 PKCS7
*PKCS7_dup(PKCS7
*p7
);
242 PKCS7
*d2i_PKCS7_bio(BIO
*bp
,PKCS7
*p7
);
243 int i2d_PKCS7_bio(BIO
*bp
,PKCS7
*p7
);
246 PKCS7_SIGNER_INFO
*PKCS7_SIGNER_INFO_new(void);
247 void PKCS7_SIGNER_INFO_free(PKCS7_SIGNER_INFO
*a
);
248 int i2d_PKCS7_SIGNER_INFO(PKCS7_SIGNER_INFO
*a
,
250 PKCS7_SIGNER_INFO
*d2i_PKCS7_SIGNER_INFO(PKCS7_SIGNER_INFO
**a
,
251 unsigned char **pp
,long length
);
253 PKCS7_RECIP_INFO
*PKCS7_RECIP_INFO_new(void);
254 void PKCS7_RECIP_INFO_free(PKCS7_RECIP_INFO
*a
);
255 int i2d_PKCS7_RECIP_INFO(PKCS7_RECIP_INFO
*a
,
257 PKCS7_RECIP_INFO
*d2i_PKCS7_RECIP_INFO(PKCS7_RECIP_INFO
**a
,
258 unsigned char **pp
,long length
);
260 PKCS7_SIGNED
*PKCS7_SIGNED_new(void);
261 void PKCS7_SIGNED_free(PKCS7_SIGNED
*a
);
262 int i2d_PKCS7_SIGNED(PKCS7_SIGNED
*a
,
264 PKCS7_SIGNED
*d2i_PKCS7_SIGNED(PKCS7_SIGNED
**a
,
265 unsigned char **pp
,long length
);
267 PKCS7_ENC_CONTENT
*PKCS7_ENC_CONTENT_new(void);
268 void PKCS7_ENC_CONTENT_free(PKCS7_ENC_CONTENT
*a
);
269 int i2d_PKCS7_ENC_CONTENT(PKCS7_ENC_CONTENT
*a
,
271 PKCS7_ENC_CONTENT
*d2i_PKCS7_ENC_CONTENT(PKCS7_ENC_CONTENT
**a
,
272 unsigned char **pp
,long length
);
274 PKCS7_ENVELOPE
*PKCS7_ENVELOPE_new(void);
275 void PKCS7_ENVELOPE_free(PKCS7_ENVELOPE
*a
);
276 int i2d_PKCS7_ENVELOPE(PKCS7_ENVELOPE
*a
,
278 PKCS7_ENVELOPE
*d2i_PKCS7_ENVELOPE(PKCS7_ENVELOPE
**a
,
279 unsigned char **pp
,long length
);
281 PKCS7_SIGN_ENVELOPE
*PKCS7_SIGN_ENVELOPE_new(void);
282 void PKCS7_SIGN_ENVELOPE_free(PKCS7_SIGN_ENVELOPE
*a
);
283 int i2d_PKCS7_SIGN_ENVELOPE(PKCS7_SIGN_ENVELOPE
*a
,
285 PKCS7_SIGN_ENVELOPE
*d2i_PKCS7_SIGN_ENVELOPE(PKCS7_SIGN_ENVELOPE
**a
,
286 unsigned char **pp
,long length
);
288 PKCS7_DIGEST
*PKCS7_DIGEST_new(void);
289 void PKCS7_DIGEST_free(PKCS7_DIGEST
*a
);
290 int i2d_PKCS7_DIGEST(PKCS7_DIGEST
*a
,
292 PKCS7_DIGEST
*d2i_PKCS7_DIGEST(PKCS7_DIGEST
**a
,
293 unsigned char **pp
,long length
);
295 PKCS7_ENCRYPT
*PKCS7_ENCRYPT_new(void);
296 void PKCS7_ENCRYPT_free(PKCS7_ENCRYPT
*a
);
297 int i2d_PKCS7_ENCRYPT(PKCS7_ENCRYPT
*a
,
299 PKCS7_ENCRYPT
*d2i_PKCS7_ENCRYPT(PKCS7_ENCRYPT
**a
,
300 unsigned char **pp
,long length
);
302 PKCS7
*PKCS7_new(void);
303 void PKCS7_free(PKCS7
*a
);
304 void PKCS7_content_free(PKCS7
*a
);
305 int i2d_PKCS7(PKCS7
*a
,
307 PKCS7
*d2i_PKCS7(PKCS7
**a
,
308 unsigned char **pp
,long length
);
310 void ERR_load_PKCS7_strings(void);
313 long PKCS7_ctrl(PKCS7
*p7
, int cmd
, long larg
, char *parg
);
315 int PKCS7_set_type(PKCS7
*p7
, int type
);
316 int PKCS7_set_content(PKCS7
*p7
, PKCS7
*p7_data
);
317 int PKCS7_SIGNER_INFO_set(PKCS7_SIGNER_INFO
*p7i
, X509
*x509
, EVP_PKEY
*pkey
,
319 int PKCS7_add_signer(PKCS7
*p7
, PKCS7_SIGNER_INFO
*p7i
);
320 int PKCS7_add_certificate(PKCS7
*p7
, X509
*x509
);
321 int PKCS7_add_crl(PKCS7
*p7
, X509_CRL
*x509
);
322 int PKCS7_content_new(PKCS7
*p7
, int nid
);
323 int PKCS7_dataVerify(X509_STORE
*cert_store
, X509_STORE_CTX
*ctx
,
324 BIO
*bio
, PKCS7
*p7
, PKCS7_SIGNER_INFO
*si
);
326 BIO
*PKCS7_dataInit(PKCS7
*p7
, BIO
*bio
);
327 int PKCS7_dataFinal(PKCS7
*p7
, BIO
*bio
);
328 BIO
*PKCS7_dataDecode(PKCS7
*p7
, EVP_PKEY
*pkey
, BIO
*in_bio
, X509_STORE
*xs
);
331 PKCS7_SIGNER_INFO
*PKCS7_add_signature(PKCS7
*p7
, X509
*x509
,
332 EVP_PKEY
*pkey
, EVP_MD
*dgst
);
333 X509
*PKCS7_cert_from_signer_info(PKCS7
*p7
, PKCS7_SIGNER_INFO
*si
);
334 STACK
*PKCS7_get_signer_info(PKCS7
*p7
);
336 PKCS7_RECIP_INFO
*PKCS7_add_recipient(PKCS7
*p7
, X509
*x509
);
337 int PKCS7_add_recipient_info(PKCS7
*p7
, PKCS7_RECIP_INFO
*ri
);
338 int PKCS7_RECIP_INFO_set(PKCS7_RECIP_INFO
*p7i
, X509
*x509
);
339 int PKCS7_set_cipher(PKCS7
*p7
, EVP_CIPHER
*cipher
);
341 PKCS7_ISSUER_AND_SERIAL
*PKCS7_get_issuer_and_serial(PKCS7
*p7
, int idx
);
342 ASN1_OCTET_STRING
*PKCS7_digest_from_attributes(STACK
*sk
);
343 int PKCS7_add_signed_attribute(PKCS7_SIGNER_INFO
*p7si
,int nid
,int type
,
345 int PKCS7_add_attribute (PKCS7_SIGNER_INFO
*p7si
, int nid
, int atrtype
,
347 ASN1_TYPE
*PKCS7_get_attribute(PKCS7_SIGNER_INFO
*si
, int nid
);
348 ASN1_TYPE
*PKCS7_get_signed_attribute(PKCS7_SIGNER_INFO
*si
, int nid
);
349 int PKCS7_set_signed_attributes(PKCS7_SIGNER_INFO
*p7si
, STACK
*sk
);
350 int PKCS7_set_attributes(PKCS7_SIGNER_INFO
*p7si
, STACK
*sk
);
355 PKCS7_ISSUER_AND_SERIAL
*PKCS7_ISSUER_AND_SERIAL_new();
356 void PKCS7_ISSUER_AND_SERIAL_free();
357 int i2d_PKCS7_ISSUER_AND_SERIAL();
358 PKCS7_ISSUER_AND_SERIAL
*d2i_PKCS7_ISSUER_AND_SERIAL();
360 #ifndef SSLEAY_MACROS
361 int PKCS7_ISSUER_AND_SERIAL_digest();
363 PKCS7
*d2i_PKCS7_fp();
367 PKCS7
*d2i_PKCS7_bio();
372 PKCS7_SIGNER_INFO
*PKCS7_SIGNER_INFO_new();
373 void PKCS7_SIGNER_INFO_free();
374 int i2d_PKCS7_SIGNER_INFO();
375 PKCS7_SIGNER_INFO
*d2i_PKCS7_SIGNER_INFO();
376 PKCS7_RECIP_INFO
*PKCS7_RECIP_INFO_new();
377 void PKCS7_RECIP_INFO_free();
378 int i2d_PKCS7_RECIP_INFO();
379 PKCS7_RECIP_INFO
*d2i_PKCS7_RECIP_INFO();
380 PKCS7_SIGNED
*PKCS7_SIGNED_new();
381 void PKCS7_SIGNED_free();
382 int i2d_PKCS7_SIGNED();
383 PKCS7_SIGNED
*d2i_PKCS7_SIGNED();
384 PKCS7_ENC_CONTENT
*PKCS7_ENC_CONTENT_new();
385 void PKCS7_ENC_CONTENT_free();
386 int i2d_PKCS7_ENC_CONTENT();
387 PKCS7_ENC_CONTENT
*d2i_PKCS7_ENC_CONTENT();
388 PKCS7_ENVELOPE
*PKCS7_ENVELOPE_new();
389 void PKCS7_ENVELOPE_free();
390 int i2d_PKCS7_ENVELOPE();
391 PKCS7_ENVELOPE
*d2i_PKCS7_ENVELOPE();
392 PKCS7_SIGN_ENVELOPE
*PKCS7_SIGN_ENVELOPE_new();
393 void PKCS7_SIGN_ENVELOPE_free();
394 int i2d_PKCS7_SIGN_ENVELOPE();
395 PKCS7_SIGN_ENVELOPE
*d2i_PKCS7_SIGN_ENVELOPE();
396 PKCS7_DIGEST
*PKCS7_DIGEST_new();
397 void PKCS7_DIGEST_free();
398 int i2d_PKCS7_DIGEST();
399 PKCS7_DIGEST
*d2i_PKCS7_DIGEST();
400 PKCS7_ENCRYPT
*PKCS7_ENCRYPT_new();
401 void PKCS7_ENCRYPT_free();
402 int i2d_PKCS7_ENCRYPT();
403 PKCS7_ENCRYPT
*d2i_PKCS7_ENCRYPT();
406 void PKCS7_content_free();
410 void ERR_load_PKCS7_strings();
413 int PKCS7_set_type();
414 int PKCS7_set_content();
415 int PKCS7_SIGNER_INFO_set();
416 int PKCS7_add_signer();
417 int PKCS7_add_certificate();
419 int PKCS7_content_new();
420 int PKCS7_dataVerify();
421 BIO
*PKCS7_dataInit();
422 int PKCS7_dataFinal();
423 BIO
*PKCS7_dataDecode();
424 PKCS7_SIGNER_INFO
*PKCS7_add_signature();
425 X509
*PKCS7_cert_from_signer_info();
426 STACK
*PKCS7_get_signer_info();
428 PKCS7_RECIP_INFO
*PKCS7_add_recipient();
429 int PKCS7_add_recipient_info();
430 int PKCS7_RECIP_INFO_set();
431 int PKCS7_set_cipher();
433 PKCS7_ISSUER_AND_SERIAL
*PKCS7_get_issuer_and_serial();
434 ASN1_OCTET_STRING
*PKCS7_digest_from_attributes();
435 int PKCS7_add_signed_attribute();
436 int PKCS7_add_attribute();
437 ASN1_TYPE
*PKCS7_get_attribute();
438 ASN1_TYPE
*PKCS7_get_signed_attribute();
439 void PKCS7_set_signed_attributes();
440 void PKCS7_set_attributes();
445 /* BEGIN ERROR CODES */
446 /* The following lines are auto generated by the script mkerr.pl. Any changes
447 * made after this point may be overwritten when the script is next run.
450 /* Error codes for the PKCS7 functions. */
452 /* Function codes. */
453 #define PKCS7_F_PKCS7_ADD_CERTIFICATE 100
454 #define PKCS7_F_PKCS7_ADD_CRL 101
455 #define PKCS7_F_PKCS7_ADD_RECIPIENT_INFO 102
456 #define PKCS7_F_PKCS7_ADD_SIGNER 103
457 #define PKCS7_F_PKCS7_CTRL 104
458 #define PKCS7_F_PKCS7_DATAINIT 105
459 #define PKCS7_F_PKCS7_DATASIGN 106
460 #define PKCS7_F_PKCS7_DATAVERIFY 107
461 #define PKCS7_F_PKCS7_SET_CIPHER 108
462 #define PKCS7_F_PKCS7_SET_CONTENT 109
463 #define PKCS7_F_PKCS7_SET_TYPE 110
464 #define PKCS7_F_PKCS7_SIGNENVELOPEDECRYPT 111
467 #define PKCS7_R_DECRYPTED_KEY_IS_WRONG_LENGTH 100
468 #define PKCS7_R_DIGEST_FAILURE 101
469 #define PKCS7_R_INTERNAL_ERROR 102
470 #define PKCS7_R_MISSING_CERIPEND_INFO 103
471 #define PKCS7_R_OPERATION_NOT_SUPPORTED_ON_THIS_TYPE 104
472 #define PKCS7_R_SIGNATURE_FAILURE 105
473 #define PKCS7_R_UNABLE_TO_FIND_CERTIFICATE 106
474 #define PKCS7_R_UNABLE_TO_FIND_MEM_BIO 107
475 #define PKCS7_R_UNABLE_TO_FIND_MESSAGE_DIGEST 108
476 #define PKCS7_R_UNKNOWN_DIGEST_TYPE 109
477 #define PKCS7_R_UNKNOWN_OPERATION 110
478 #define PKCS7_R_UNSUPPORTED_CIPHER_TYPE 111
479 #define PKCS7_R_UNSUPPORTED_CONTENT_TYPE 112
480 #define PKCS7_R_WRONG_CONTENT_TYPE 113
481 #define PKCS7_R_WRONG_PKCS7_TYPE 114