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