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>
70 /* Under Win32 this is defined in wincrypt.h */
71 #undef PKCS7_ISSUER_AND_SERIAL
77 Digest_Encryption_ID rsaEncryption
78 Key_Encryption_ID rsaEncryption
81 typedef struct pkcs7_issuer_and_serial_st
85 } PKCS7_ISSUER_AND_SERIAL;
87 typedef struct pkcs7_signer_info_st
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 ] */
97 /* The private key to sign with */
101 typedef struct pkcs7_recip_info_st
103 ASN1_INTEGER *version; /* version 0 */
104 PKCS7_ISSUER_AND_SERIAL *issuer_and_serial;
105 X509_ALGOR *key_enc_algor;
106 ASN1_OCTET_STRING *enc_key;
107 X509 *cert; /* get the pub-key from this */
110 typedef struct pkcs7_signed_st
112 ASN1_INTEGER *version; /* version 1 */
113 STACK_OF(X509_ALGOR) *md_algs; /* md used */
114 STACK_OF(X509) *cert; /* [ 0 ] */
115 STACK /* X509_CRL */ *crl; /* [ 1 ] */
116 STACK /* PKCS7_SIGNER_INFO */ *signer_info;
118 struct pkcs7_st *contents;
120 /* The above structure is very very similar to PKCS7_SIGN_ENVELOPE.
121 * How about merging the two */
123 typedef struct pkcs7_enc_content_st
125 ASN1_OBJECT *content_type;
126 X509_ALGOR *algorithm;
127 ASN1_OCTET_STRING *enc_data; /* [ 0 ] */
128 const EVP_CIPHER *cipher;
131 typedef struct pkcs7_enveloped_st
133 ASN1_INTEGER *version; /* version 0 */
134 STACK /* PKCS7_RECIP_INFO */ *recipientinfo;
135 PKCS7_ENC_CONTENT *enc_data;
138 typedef struct pkcs7_signedandenveloped_st
140 ASN1_INTEGER *version; /* version 1 */
141 STACK_OF(X509_ALGOR) *md_algs; /* md used */
142 STACK_OF(X509) *cert; /* [ 0 ] */
143 STACK /* X509_CRL */ *crl; /* [ 1 ] */
144 STACK /* PKCS7_SIGNER_INFO */ *signer_info;
146 PKCS7_ENC_CONTENT *enc_data;
147 STACK /* PKCS7_RECIP_INFO */ *recipientinfo;
148 } PKCS7_SIGN_ENVELOPE;
150 typedef struct pkcs7_digest_st
152 ASN1_INTEGER *version; /* version 0 */
153 X509_ALGOR *md; /* md used */
154 struct pkcs7_st *contents;
155 ASN1_OCTET_STRING *digest;
158 typedef struct pkcs7_encrypted_st
160 ASN1_INTEGER *version; /* version 0 */
161 PKCS7_ENC_CONTENT *enc_data;
164 typedef struct pkcs7_st
166 /* The following is non NULL if it contains ASN1 encoding of
171 #define PKCS7_S_HEADER 0
172 #define PKCS7_S_BODY 1
173 #define PKCS7_S_TAIL 2
174 int state; /* used during processing */
179 /* content as defined by the type */
180 /* all encryption/message digests are applied to the 'contents',
181 * leaving out the 'type' field. */
186 ASN1_OCTET_STRING *data;
188 /* NID_pkcs7_signed */
191 /* NID_pkcs7_enveloped */
192 PKCS7_ENVELOPE *enveloped;
194 /* NID_pkcs7_signedAndEnveloped */
195 PKCS7_SIGN_ENVELOPE *signed_and_enveloped;
197 /* NID_pkcs7_digest */
198 PKCS7_DIGEST *digest;
200 /* NID_pkcs7_encrypted */
201 PKCS7_ENCRYPT *encrypted;
205 #define PKCS7_OP_SET_DETACHED_SIGNATURE 1
206 #define PKCS7_OP_GET_DETACHED_SIGNATURE 2
208 #define PKCS7_get_signed_attributes(si) ((si)->auth_attr)
209 #define PKCS7_get_attributes(si) ((si)->unauth_attr)
211 #define PKCS7_type_is_signed(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_signed)
212 #define PKCS7_type_is_signedAndEnveloped(a) \
213 (OBJ_obj2nid((a)->type) == NID_pkcs7_signedAndEnveloped)
214 #define PKCS7_type_is_data(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_data)
216 #define PKCS7_set_detached(p,v) \
217 PKCS7_ctrl(p,PKCS7_OP_SET_DETACHED_SIGNATURE,v,NULL)
218 #define PKCS7_get_detached(p) \
219 PKCS7_ctrl(p,PKCS7_OP_GET_DETACHED_SIGNATURE,0,NULL)
222 #ifndef PKCS7_ISSUER_AND_SERIAL_digest
223 #define PKCS7_ISSUER_AND_SERIAL_digest(data,type,md,len) \
224 ASN1_digest((int (*)())i2d_PKCS7_ISSUER_AND_SERIAL,type,\
230 PKCS7_ISSUER_AND_SERIAL *PKCS7_ISSUER_AND_SERIAL_new(void );
231 void PKCS7_ISSUER_AND_SERIAL_free(
232 PKCS7_ISSUER_AND_SERIAL *a);
233 int i2d_PKCS7_ISSUER_AND_SERIAL(
234 PKCS7_ISSUER_AND_SERIAL *a,unsigned char **pp);
235 PKCS7_ISSUER_AND_SERIAL *d2i_PKCS7_ISSUER_AND_SERIAL(
236 PKCS7_ISSUER_AND_SERIAL **a,
237 unsigned char **pp, long length);
239 #ifndef SSLEAY_MACROS
240 int PKCS7_ISSUER_AND_SERIAL_digest(PKCS7_ISSUER_AND_SERIAL *data,EVP_MD *type,
241 unsigned char *md,unsigned int *len);
243 PKCS7 *d2i_PKCS7_fp(FILE *fp,PKCS7 **p7);
244 int i2d_PKCS7_fp(FILE *fp,PKCS7 *p7);
246 PKCS7 *PKCS7_dup(PKCS7 *p7);
247 PKCS7 *d2i_PKCS7_bio(BIO *bp,PKCS7 **p7);
248 int i2d_PKCS7_bio(BIO *bp,PKCS7 *p7);
251 PKCS7_SIGNER_INFO *PKCS7_SIGNER_INFO_new(void);
252 void PKCS7_SIGNER_INFO_free(PKCS7_SIGNER_INFO *a);
253 int i2d_PKCS7_SIGNER_INFO(PKCS7_SIGNER_INFO *a,
255 PKCS7_SIGNER_INFO *d2i_PKCS7_SIGNER_INFO(PKCS7_SIGNER_INFO **a,
256 unsigned char **pp,long length);
258 PKCS7_RECIP_INFO *PKCS7_RECIP_INFO_new(void);
259 void PKCS7_RECIP_INFO_free(PKCS7_RECIP_INFO *a);
260 int i2d_PKCS7_RECIP_INFO(PKCS7_RECIP_INFO *a,
262 PKCS7_RECIP_INFO *d2i_PKCS7_RECIP_INFO(PKCS7_RECIP_INFO **a,
263 unsigned char **pp,long length);
265 PKCS7_SIGNED *PKCS7_SIGNED_new(void);
266 void PKCS7_SIGNED_free(PKCS7_SIGNED *a);
267 int i2d_PKCS7_SIGNED(PKCS7_SIGNED *a,
269 PKCS7_SIGNED *d2i_PKCS7_SIGNED(PKCS7_SIGNED **a,
270 unsigned char **pp,long length);
272 PKCS7_ENC_CONTENT *PKCS7_ENC_CONTENT_new(void);
273 void PKCS7_ENC_CONTENT_free(PKCS7_ENC_CONTENT *a);
274 int i2d_PKCS7_ENC_CONTENT(PKCS7_ENC_CONTENT *a,
276 PKCS7_ENC_CONTENT *d2i_PKCS7_ENC_CONTENT(PKCS7_ENC_CONTENT **a,
277 unsigned char **pp,long length);
279 PKCS7_ENVELOPE *PKCS7_ENVELOPE_new(void);
280 void PKCS7_ENVELOPE_free(PKCS7_ENVELOPE *a);
281 int i2d_PKCS7_ENVELOPE(PKCS7_ENVELOPE *a,
283 PKCS7_ENVELOPE *d2i_PKCS7_ENVELOPE(PKCS7_ENVELOPE **a,
284 unsigned char **pp,long length);
286 PKCS7_SIGN_ENVELOPE *PKCS7_SIGN_ENVELOPE_new(void);
287 void PKCS7_SIGN_ENVELOPE_free(PKCS7_SIGN_ENVELOPE *a);
288 int i2d_PKCS7_SIGN_ENVELOPE(PKCS7_SIGN_ENVELOPE *a,
290 PKCS7_SIGN_ENVELOPE *d2i_PKCS7_SIGN_ENVELOPE(PKCS7_SIGN_ENVELOPE **a,
291 unsigned char **pp,long length);
293 PKCS7_DIGEST *PKCS7_DIGEST_new(void);
294 void PKCS7_DIGEST_free(PKCS7_DIGEST *a);
295 int i2d_PKCS7_DIGEST(PKCS7_DIGEST *a,
297 PKCS7_DIGEST *d2i_PKCS7_DIGEST(PKCS7_DIGEST **a,
298 unsigned char **pp,long length);
300 PKCS7_ENCRYPT *PKCS7_ENCRYPT_new(void);
301 void PKCS7_ENCRYPT_free(PKCS7_ENCRYPT *a);
302 int i2d_PKCS7_ENCRYPT(PKCS7_ENCRYPT *a,
304 PKCS7_ENCRYPT *d2i_PKCS7_ENCRYPT(PKCS7_ENCRYPT **a,
305 unsigned char **pp,long length);
307 PKCS7 *PKCS7_new(void);
308 void PKCS7_free(PKCS7 *a);
309 void PKCS7_content_free(PKCS7 *a);
310 int i2d_PKCS7(PKCS7 *a,
312 PKCS7 *d2i_PKCS7(PKCS7 **a,
313 unsigned char **pp,long length);
315 void ERR_load_PKCS7_strings(void);
318 long PKCS7_ctrl(PKCS7 *p7, int cmd, long larg, char *parg);
320 int PKCS7_set_type(PKCS7 *p7, int type);
321 int PKCS7_set_content(PKCS7 *p7, PKCS7 *p7_data);
322 int PKCS7_SIGNER_INFO_set(PKCS7_SIGNER_INFO *p7i, X509 *x509, EVP_PKEY *pkey,
324 int PKCS7_add_signer(PKCS7 *p7, PKCS7_SIGNER_INFO *p7i);
325 int PKCS7_add_certificate(PKCS7 *p7, X509 *x509);
326 int PKCS7_add_crl(PKCS7 *p7, X509_CRL *x509);
327 int PKCS7_content_new(PKCS7 *p7, int nid);
328 int PKCS7_dataVerify(X509_STORE *cert_store, X509_STORE_CTX *ctx,
329 BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si);
331 BIO *PKCS7_dataInit(PKCS7 *p7, BIO *bio);
332 int PKCS7_dataFinal(PKCS7 *p7, BIO *bio);
333 BIO *PKCS7_dataDecode(PKCS7 *p7, EVP_PKEY *pkey, BIO *in_bio, X509 *pcert);
336 PKCS7_SIGNER_INFO *PKCS7_add_signature(PKCS7 *p7, X509 *x509,
337 EVP_PKEY *pkey, EVP_MD *dgst);
338 X509 *PKCS7_cert_from_signer_info(PKCS7 *p7, PKCS7_SIGNER_INFO *si);
339 STACK *PKCS7_get_signer_info(PKCS7 *p7);
341 PKCS7_RECIP_INFO *PKCS7_add_recipient(PKCS7 *p7, X509 *x509);
342 int PKCS7_add_recipient_info(PKCS7 *p7, PKCS7_RECIP_INFO *ri);
343 int PKCS7_RECIP_INFO_set(PKCS7_RECIP_INFO *p7i, X509 *x509);
344 int PKCS7_set_cipher(PKCS7 *p7, const EVP_CIPHER *cipher);
346 PKCS7_ISSUER_AND_SERIAL *PKCS7_get_issuer_and_serial(PKCS7 *p7, int idx);
347 ASN1_OCTET_STRING *PKCS7_digest_from_attributes(STACK_OF(X509_ATTRIBUTE) *sk);
348 int PKCS7_add_signed_attribute(PKCS7_SIGNER_INFO *p7si,int nid,int type,
350 int PKCS7_add_attribute (PKCS7_SIGNER_INFO *p7si, int nid, int atrtype,
352 ASN1_TYPE *PKCS7_get_attribute(PKCS7_SIGNER_INFO *si, int nid);
353 ASN1_TYPE *PKCS7_get_signed_attribute(PKCS7_SIGNER_INFO *si, int nid);
354 int PKCS7_set_signed_attributes(PKCS7_SIGNER_INFO *p7si,
355 STACK_OF(X509_ATTRIBUTE) *sk);
356 int PKCS7_set_attributes(PKCS7_SIGNER_INFO *p7si,STACK_OF(X509_ATTRIBUTE) *sk);
360 /* BEGIN ERROR CODES */
361 /* The following lines are auto generated by the script mkerr.pl. Any changes
362 * made after this point may be overwritten when the script is next run.
365 /* Error codes for the PKCS7 functions. */
367 /* Function codes. */
368 #define PKCS7_F_PKCS7_ADD_CERTIFICATE 100
369 #define PKCS7_F_PKCS7_ADD_CRL 101
370 #define PKCS7_F_PKCS7_ADD_RECIPIENT_INFO 102
371 #define PKCS7_F_PKCS7_ADD_SIGNER 103
372 #define PKCS7_F_PKCS7_CTRL 104
373 #define PKCS7_F_PKCS7_DATADECODE 112
374 #define PKCS7_F_PKCS7_DATAINIT 105
375 #define PKCS7_F_PKCS7_DATASIGN 106
376 #define PKCS7_F_PKCS7_DATAVERIFY 107
377 #define PKCS7_F_PKCS7_SET_CIPHER 108
378 #define PKCS7_F_PKCS7_SET_CONTENT 109
379 #define PKCS7_F_PKCS7_SET_TYPE 110
382 #define PKCS7_R_CIPHER_NOT_INITIALIZED 116
383 #define PKCS7_R_DECRYPTED_KEY_IS_WRONG_LENGTH 100
384 #define PKCS7_R_DIGEST_FAILURE 101
385 #define PKCS7_R_INTERNAL_ERROR 102
386 #define PKCS7_R_MISSING_CERIPEND_INFO 103
387 #define PKCS7_R_NO_RECIPIENT_MATCHES_CERTIFICATE 115
388 #define PKCS7_R_OPERATION_NOT_SUPPORTED_ON_THIS_TYPE 104
389 #define PKCS7_R_SIGNATURE_FAILURE 105
390 #define PKCS7_R_UNABLE_TO_FIND_CERTIFICATE 106
391 #define PKCS7_R_UNABLE_TO_FIND_MEM_BIO 107
392 #define PKCS7_R_UNABLE_TO_FIND_MESSAGE_DIGEST 108
393 #define PKCS7_R_UNKNOWN_DIGEST_TYPE 109
394 #define PKCS7_R_UNKNOWN_OPERATION 110
395 #define PKCS7_R_UNSUPPORTED_CIPHER_TYPE 111
396 #define PKCS7_R_UNSUPPORTED_CONTENT_TYPE 112
397 #define PKCS7_R_WRONG_CONTENT_TYPE 113
398 #define PKCS7_R_WRONG_PKCS7_TYPE 114