1 /* crypto/cms/cms_lcl.h */
3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
6 /* ====================================================================
7 * Copyright (c) 2008 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
55 #ifndef HEADER_CMS_LCL_H
56 # define HEADER_CMS_LCL_H
62 # include <openssl/x509.h>
65 * Cryptographic message syntax (CMS) structures: taken from RFC3852
68 /* Forward references */
70 typedef struct CMS_IssuerAndSerialNumber_st CMS_IssuerAndSerialNumber;
71 typedef struct CMS_EncapsulatedContentInfo_st CMS_EncapsulatedContentInfo;
72 typedef struct CMS_SignerIdentifier_st CMS_SignerIdentifier;
73 typedef struct CMS_SignedData_st CMS_SignedData;
74 typedef struct CMS_OtherRevocationInfoFormat_st CMS_OtherRevocationInfoFormat;
75 typedef struct CMS_OriginatorInfo_st CMS_OriginatorInfo;
76 typedef struct CMS_EncryptedContentInfo_st CMS_EncryptedContentInfo;
77 typedef struct CMS_EnvelopedData_st CMS_EnvelopedData;
78 typedef struct CMS_DigestedData_st CMS_DigestedData;
79 typedef struct CMS_EncryptedData_st CMS_EncryptedData;
80 typedef struct CMS_AuthenticatedData_st CMS_AuthenticatedData;
81 typedef struct CMS_CompressedData_st CMS_CompressedData;
82 typedef struct CMS_OtherCertificateFormat_st CMS_OtherCertificateFormat;
83 typedef struct CMS_KeyTransRecipientInfo_st CMS_KeyTransRecipientInfo;
84 typedef struct CMS_OriginatorPublicKey_st CMS_OriginatorPublicKey;
85 typedef struct CMS_OriginatorIdentifierOrKey_st CMS_OriginatorIdentifierOrKey;
86 typedef struct CMS_KeyAgreeRecipientInfo_st CMS_KeyAgreeRecipientInfo;
87 typedef struct CMS_RecipientKeyIdentifier_st CMS_RecipientKeyIdentifier;
88 typedef struct CMS_KeyAgreeRecipientIdentifier_st
89 CMS_KeyAgreeRecipientIdentifier;
90 typedef struct CMS_KEKIdentifier_st CMS_KEKIdentifier;
91 typedef struct CMS_KEKRecipientInfo_st CMS_KEKRecipientInfo;
92 typedef struct CMS_PasswordRecipientInfo_st CMS_PasswordRecipientInfo;
93 typedef struct CMS_OtherRecipientInfo_st CMS_OtherRecipientInfo;
94 typedef struct CMS_ReceiptsFrom_st CMS_ReceiptsFrom;
96 struct CMS_ContentInfo_st {
97 ASN1_OBJECT *contentType;
99 ASN1_OCTET_STRING *data;
100 CMS_SignedData *signedData;
101 CMS_EnvelopedData *envelopedData;
102 CMS_DigestedData *digestedData;
103 CMS_EncryptedData *encryptedData;
104 CMS_AuthenticatedData *authenticatedData;
105 CMS_CompressedData *compressedData;
107 /* Other types ... */
112 DECLARE_STACK_OF(CMS_CertificateChoices)
114 struct CMS_SignedData_st {
116 STACK_OF(X509_ALGOR) *digestAlgorithms;
117 CMS_EncapsulatedContentInfo *encapContentInfo;
118 STACK_OF(CMS_CertificateChoices) *certificates;
119 STACK_OF(CMS_RevocationInfoChoice) *crls;
120 STACK_OF(CMS_SignerInfo) *signerInfos;
123 struct CMS_EncapsulatedContentInfo_st {
124 ASN1_OBJECT *eContentType;
125 ASN1_OCTET_STRING *eContent;
126 /* Set to 1 if incomplete structure only part set up */
130 struct CMS_SignerInfo_st {
132 CMS_SignerIdentifier *sid;
133 X509_ALGOR *digestAlgorithm;
134 STACK_OF(X509_ATTRIBUTE) *signedAttrs;
135 X509_ALGOR *signatureAlgorithm;
136 ASN1_OCTET_STRING *signature;
137 STACK_OF(X509_ATTRIBUTE) *unsignedAttrs;
138 /* Signing certificate and key */
141 /* Digest and public key context for alternative parameters */
146 struct CMS_SignerIdentifier_st {
149 CMS_IssuerAndSerialNumber *issuerAndSerialNumber;
150 ASN1_OCTET_STRING *subjectKeyIdentifier;
154 struct CMS_EnvelopedData_st {
156 CMS_OriginatorInfo *originatorInfo;
157 STACK_OF(CMS_RecipientInfo) *recipientInfos;
158 CMS_EncryptedContentInfo *encryptedContentInfo;
159 STACK_OF(X509_ATTRIBUTE) *unprotectedAttrs;
162 struct CMS_OriginatorInfo_st {
163 STACK_OF(CMS_CertificateChoices) *certificates;
164 STACK_OF(CMS_RevocationInfoChoice) *crls;
167 struct CMS_EncryptedContentInfo_st {
168 ASN1_OBJECT *contentType;
169 X509_ALGOR *contentEncryptionAlgorithm;
170 ASN1_OCTET_STRING *encryptedContent;
171 /* Content encryption algorithm and key */
172 const EVP_CIPHER *cipher;
175 /* Set to 1 if we are debugging decrypt and don't fake keys for MMA */
179 struct CMS_RecipientInfo_st {
182 CMS_KeyTransRecipientInfo *ktri;
183 CMS_KeyAgreeRecipientInfo *kari;
184 CMS_KEKRecipientInfo *kekri;
185 CMS_PasswordRecipientInfo *pwri;
186 CMS_OtherRecipientInfo *ori;
190 typedef CMS_SignerIdentifier CMS_RecipientIdentifier;
192 struct CMS_KeyTransRecipientInfo_st {
194 CMS_RecipientIdentifier *rid;
195 X509_ALGOR *keyEncryptionAlgorithm;
196 ASN1_OCTET_STRING *encryptedKey;
197 /* Recipient Key and cert */
200 /* Public key context for this operation */
204 struct CMS_KeyAgreeRecipientInfo_st {
206 CMS_OriginatorIdentifierOrKey *originator;
207 ASN1_OCTET_STRING *ukm;
208 X509_ALGOR *keyEncryptionAlgorithm;
209 STACK_OF(CMS_RecipientEncryptedKey) *recipientEncryptedKeys;
210 /* Public key context associated with current operation */
212 /* Cipher context for CEK wrapping */
216 struct CMS_OriginatorIdentifierOrKey_st {
219 CMS_IssuerAndSerialNumber *issuerAndSerialNumber;
220 ASN1_OCTET_STRING *subjectKeyIdentifier;
221 CMS_OriginatorPublicKey *originatorKey;
225 struct CMS_OriginatorPublicKey_st {
226 X509_ALGOR *algorithm;
227 ASN1_BIT_STRING *publicKey;
230 struct CMS_RecipientEncryptedKey_st {
231 CMS_KeyAgreeRecipientIdentifier *rid;
232 ASN1_OCTET_STRING *encryptedKey;
233 /* Public key associated with this recipient */
237 struct CMS_KeyAgreeRecipientIdentifier_st {
240 CMS_IssuerAndSerialNumber *issuerAndSerialNumber;
241 CMS_RecipientKeyIdentifier *rKeyId;
245 struct CMS_RecipientKeyIdentifier_st {
246 ASN1_OCTET_STRING *subjectKeyIdentifier;
247 ASN1_GENERALIZEDTIME *date;
248 CMS_OtherKeyAttribute *other;
251 struct CMS_KEKRecipientInfo_st {
253 CMS_KEKIdentifier *kekid;
254 X509_ALGOR *keyEncryptionAlgorithm;
255 ASN1_OCTET_STRING *encryptedKey;
256 /* Extra info: symmetric key to use */
261 struct CMS_KEKIdentifier_st {
262 ASN1_OCTET_STRING *keyIdentifier;
263 ASN1_GENERALIZEDTIME *date;
264 CMS_OtherKeyAttribute *other;
267 struct CMS_PasswordRecipientInfo_st {
269 X509_ALGOR *keyDerivationAlgorithm;
270 X509_ALGOR *keyEncryptionAlgorithm;
271 ASN1_OCTET_STRING *encryptedKey;
272 /* Extra info: password to use */
277 struct CMS_OtherRecipientInfo_st {
278 ASN1_OBJECT *oriType;
282 struct CMS_DigestedData_st {
284 X509_ALGOR *digestAlgorithm;
285 CMS_EncapsulatedContentInfo *encapContentInfo;
286 ASN1_OCTET_STRING *digest;
289 struct CMS_EncryptedData_st {
291 CMS_EncryptedContentInfo *encryptedContentInfo;
292 STACK_OF(X509_ATTRIBUTE) *unprotectedAttrs;
295 struct CMS_AuthenticatedData_st {
297 CMS_OriginatorInfo *originatorInfo;
298 STACK_OF(CMS_RecipientInfo) *recipientInfos;
299 X509_ALGOR *macAlgorithm;
300 X509_ALGOR *digestAlgorithm;
301 CMS_EncapsulatedContentInfo *encapContentInfo;
302 STACK_OF(X509_ATTRIBUTE) *authAttrs;
303 ASN1_OCTET_STRING *mac;
304 STACK_OF(X509_ATTRIBUTE) *unauthAttrs;
307 struct CMS_CompressedData_st {
309 X509_ALGOR *compressionAlgorithm;
310 STACK_OF(CMS_RecipientInfo) *recipientInfos;
311 CMS_EncapsulatedContentInfo *encapContentInfo;
314 struct CMS_RevocationInfoChoice_st {
318 CMS_OtherRevocationInfoFormat *other;
322 # define CMS_REVCHOICE_CRL 0
323 # define CMS_REVCHOICE_OTHER 1
325 struct CMS_OtherRevocationInfoFormat_st {
326 ASN1_OBJECT *otherRevInfoFormat;
327 ASN1_TYPE *otherRevInfo;
330 struct CMS_CertificateChoices {
334 ASN1_STRING *extendedCertificate; /* Obsolete */
335 ASN1_STRING *v1AttrCert; /* Left encoded for now */
336 ASN1_STRING *v2AttrCert; /* Left encoded for now */
337 CMS_OtherCertificateFormat *other;
341 # define CMS_CERTCHOICE_CERT 0
342 # define CMS_CERTCHOICE_EXCERT 1
343 # define CMS_CERTCHOICE_V1ACERT 2
344 # define CMS_CERTCHOICE_V2ACERT 3
345 # define CMS_CERTCHOICE_OTHER 4
347 struct CMS_OtherCertificateFormat_st {
348 ASN1_OBJECT *otherCertFormat;
349 ASN1_TYPE *otherCert;
353 * This is also defined in pkcs7.h but we duplicate it to allow the CMS code
354 * to be independent of PKCS#7
357 struct CMS_IssuerAndSerialNumber_st {
359 ASN1_INTEGER *serialNumber;
362 struct CMS_OtherKeyAttribute_st {
363 ASN1_OBJECT *keyAttrId;
369 # ifdef HEADER_X509V3_H
371 struct CMS_ReceiptRequest_st {
372 ASN1_OCTET_STRING *signedContentIdentifier;
373 CMS_ReceiptsFrom *receiptsFrom;
374 STACK_OF(GENERAL_NAMES) *receiptsTo;
377 struct CMS_ReceiptsFrom_st {
381 STACK_OF(GENERAL_NAMES) *receiptList;
386 struct CMS_Receipt_st {
388 ASN1_OBJECT *contentType;
389 ASN1_OCTET_STRING *signedContentIdentifier;
390 ASN1_OCTET_STRING *originatorSignatureValue;
393 DECLARE_ASN1_FUNCTIONS(CMS_ContentInfo)
394 DECLARE_ASN1_ITEM(CMS_SignerInfo)
395 DECLARE_ASN1_ITEM(CMS_IssuerAndSerialNumber)
396 DECLARE_ASN1_ITEM(CMS_Attributes_Sign)
397 DECLARE_ASN1_ITEM(CMS_Attributes_Verify)
398 DECLARE_ASN1_ITEM(CMS_RecipientInfo)
399 DECLARE_ASN1_ITEM(CMS_PasswordRecipientInfo)
400 DECLARE_ASN1_ALLOC_FUNCTIONS(CMS_IssuerAndSerialNumber)
402 # define CMS_SIGNERINFO_ISSUER_SERIAL 0
403 # define CMS_SIGNERINFO_KEYIDENTIFIER 1
405 # define CMS_RECIPINFO_ISSUER_SERIAL 0
406 # define CMS_RECIPINFO_KEYIDENTIFIER 1
408 # define CMS_REK_ISSUER_SERIAL 0
409 # define CMS_REK_KEYIDENTIFIER 1
411 # define CMS_OIK_ISSUER_SERIAL 0
412 # define CMS_OIK_KEYIDENTIFIER 1
413 # define CMS_OIK_PUBKEY 2
415 BIO *cms_content_bio(CMS_ContentInfo *cms);
417 CMS_ContentInfo *cms_Data_create(void);
419 CMS_ContentInfo *cms_DigestedData_create(const EVP_MD *md);
420 BIO *cms_DigestedData_init_bio(CMS_ContentInfo *cms);
421 int cms_DigestedData_do_final(CMS_ContentInfo *cms, BIO *chain, int verify);
423 BIO *cms_SignedData_init_bio(CMS_ContentInfo *cms);
424 int cms_SignedData_final(CMS_ContentInfo *cms, BIO *chain);
425 int cms_set1_SignerIdentifier(CMS_SignerIdentifier *sid, X509 *cert,
427 int cms_SignerIdentifier_get0_signer_id(CMS_SignerIdentifier *sid,
428 ASN1_OCTET_STRING **keyid,
431 int cms_SignerIdentifier_cert_cmp(CMS_SignerIdentifier *sid, X509 *cert);
433 CMS_ContentInfo *cms_CompressedData_create(int comp_nid);
434 BIO *cms_CompressedData_init_bio(CMS_ContentInfo *cms);
436 BIO *cms_DigestAlgorithm_init_bio(X509_ALGOR *digestAlgorithm);
437 int cms_DigestAlgorithm_find_ctx(EVP_MD_CTX *mctx, BIO *chain,
440 int cms_ias_cert_cmp(CMS_IssuerAndSerialNumber *ias, X509 *cert);
441 int cms_keyid_cert_cmp(ASN1_OCTET_STRING *keyid, X509 *cert);
442 int cms_set1_ias(CMS_IssuerAndSerialNumber **pias, X509 *cert);
443 int cms_set1_keyid(ASN1_OCTET_STRING **pkeyid, X509 *cert);
445 BIO *cms_EncryptedContent_init_bio(CMS_EncryptedContentInfo *ec);
446 BIO *cms_EncryptedData_init_bio(CMS_ContentInfo *cms);
447 int cms_EncryptedContent_init(CMS_EncryptedContentInfo *ec,
448 const EVP_CIPHER *cipher,
449 const unsigned char *key, size_t keylen);
451 int cms_Receipt_verify(CMS_ContentInfo *cms, CMS_ContentInfo *req_cms);
452 int cms_msgSigDigest_add1(CMS_SignerInfo *dest, CMS_SignerInfo *src);
453 ASN1_OCTET_STRING *cms_encode_Receipt(CMS_SignerInfo *si);
455 BIO *cms_EnvelopedData_init_bio(CMS_ContentInfo *cms);
456 CMS_EnvelopedData *cms_get0_enveloped(CMS_ContentInfo *cms);
457 int cms_env_asn1_ctrl(CMS_RecipientInfo *ri, int cmd);
458 int cms_pkey_get_ri_type(EVP_PKEY *pk);
460 int cms_RecipientInfo_kari_init(CMS_RecipientInfo *ri, X509 *recip,
461 EVP_PKEY *pk, unsigned int flags);
462 int cms_RecipientInfo_kari_encrypt(CMS_ContentInfo *cms,
463 CMS_RecipientInfo *ri);
466 int cms_RecipientInfo_pwri_crypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri,
469 DECLARE_ASN1_ITEM(CMS_CertificateChoices)
470 DECLARE_ASN1_ITEM(CMS_DigestedData)
471 DECLARE_ASN1_ITEM(CMS_EncryptedData)
472 DECLARE_ASN1_ITEM(CMS_EnvelopedData)
473 DECLARE_ASN1_ITEM(CMS_KEKRecipientInfo)
474 DECLARE_ASN1_ITEM(CMS_KeyAgreeRecipientInfo)
475 DECLARE_ASN1_ITEM(CMS_KeyTransRecipientInfo)
476 DECLARE_ASN1_ITEM(CMS_OriginatorPublicKey)
477 DECLARE_ASN1_ITEM(CMS_OtherKeyAttribute)
478 DECLARE_ASN1_ITEM(CMS_Receipt)
479 DECLARE_ASN1_ITEM(CMS_ReceiptRequest)
480 DECLARE_ASN1_ITEM(CMS_RecipientEncryptedKey)
481 DECLARE_ASN1_ITEM(CMS_RecipientKeyIdentifier)
482 DECLARE_ASN1_ITEM(CMS_RevocationInfoChoice)
483 DECLARE_ASN1_ITEM(CMS_SignedData)
484 DECLARE_ASN1_ITEM(CMS_CompressedData)