Signed receipt generation code.
[openssl.git] / crypto / cms / cms_ess.c
1 /* crypto/cms/cms_ess.c */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project.
4  */
5 /* ====================================================================
6  * Copyright (c) 2008 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  */
53
54 #include "cryptlib.h"
55 #include <openssl/asn1t.h>
56 #include <openssl/pem.h>
57 #include <openssl/rand.h>
58 #include <openssl/x509v3.h>
59 #include <openssl/err.h>
60 #include <openssl/cms.h>
61 #include "cms_lcl.h"
62 #include "asn1_locl.h"
63
64 DECLARE_ASN1_ITEM(CMS_ReceiptRequest)
65 DECLARE_ASN1_ITEM(CMS_Receipt)
66
67 IMPLEMENT_ASN1_FUNCTIONS(CMS_ReceiptRequest)
68
69 /* ESS services: for now just Signed Receipt related */
70
71 int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr)
72         {
73         ASN1_STRING *str;
74         CMS_ReceiptRequest *rr = NULL;
75         if (prr)
76                 *prr = NULL;
77         str = CMS_signed_get0_data_by_OBJ(si,
78                                 OBJ_nid2obj(NID_id_smime_aa_receiptRequest),
79                                         -3, V_ASN1_SEQUENCE);
80         if (!str)
81                 return 0;
82
83         rr = ASN1_item_unpack(str, ASN1_ITEM_rptr(CMS_ReceiptRequest));
84         if (!rr)
85                 return -1;
86         if (prr)
87                 *prr = rr;
88         else
89                 CMS_ReceiptRequest_free(rr);
90         return 1;
91         }
92
93 CMS_ReceiptRequest *CMS_ReceiptRequest_create0(unsigned char *id, int idlen,
94                                 int allorfirst,
95                                 STACK_OF(GENERAL_NAMES) *receiptList,
96                                 STACK_OF(GENERAL_NAMES) *receiptsTo)
97         {
98         CMS_ReceiptRequest *rr = NULL;
99
100         rr = CMS_ReceiptRequest_new();
101         if (!rr)
102                 goto merr;
103         if (id)
104                 ASN1_STRING_set0(rr->signedContentIdentifier, id, idlen);
105         else
106                 {
107                 if (!ASN1_STRING_set(rr->signedContentIdentifier, NULL, 32))
108                         goto merr;
109                 if (RAND_pseudo_bytes(rr->signedContentIdentifier->data, 32) 
110                                         <= 0)
111                         goto err;
112                 }
113
114         sk_GENERAL_NAMES_pop_free(rr->receiptsTo, GENERAL_NAMES_free);
115         rr->receiptsTo = receiptsTo;
116
117         if (receiptList)
118                 {
119                 rr->receiptsFrom->type = 1;
120                 rr->receiptsFrom->d.receiptList = receiptList;
121                 }
122         else
123                 {
124                 rr->receiptsFrom->type = 0;
125                 rr->receiptsFrom->d.allOrFirstTier = allorfirst;
126                 }
127
128         return rr;
129
130         merr:
131         CMSerr(CMS_F_CMS_RECEIPTREQUEST_CREATE0, ERR_R_MALLOC_FAILURE);
132
133         err:
134         if (rr)
135                 CMS_ReceiptRequest_free(rr);
136
137         return NULL;
138         
139         }
140
141 int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr)
142         {
143         unsigned char *rrder = NULL;
144         int rrderlen, r = 0;
145
146         rrderlen = i2d_CMS_ReceiptRequest(rr, &rrder);
147         if (rrderlen < 0)
148                 goto merr;
149
150         if (!CMS_signed_add1_attr_by_NID(si, NID_id_smime_aa_receiptRequest,
151                                         V_ASN1_SEQUENCE, rrder, rrderlen))
152                 goto merr;
153
154         r = 1;
155
156         merr:
157         if (!r)
158                 CMSerr(CMS_F_CMS_ADD1_RECEIPTREQUEST, ERR_R_MALLOC_FAILURE);
159
160         if (rrder)
161                 OPENSSL_free(rrder);
162
163         return r;
164         
165         }
166
167 void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr,
168                                         ASN1_STRING **pcid,
169                                         int *pallorfirst,
170                                         STACK_OF(GENERAL_NAMES) **plist,
171                                         STACK_OF(GENERAL_NAMES) **prto)
172         {
173         if (pcid)
174                 *pcid = rr->signedContentIdentifier;
175         if (rr->receiptsFrom->type == 0)
176                 {
177                 if (pallorfirst)
178                         *pallorfirst = (int)rr->receiptsFrom->d.allOrFirstTier;
179                 if (plist)
180                         *plist = NULL;
181                 }
182         else
183                 {
184                 if (pallorfirst)
185                         *pallorfirst = -1;
186                 if (plist)
187                         *plist = rr->receiptsFrom->d.receiptList;
188                 }
189         if (prto)
190                 *prto = rr->receiptsTo;
191         }
192
193 /* Digest a SignerInfo structure for msgSigDigest attribute processing */
194
195 static int cms_msgSigDigest(CMS_SignerInfo *si,
196                                 unsigned char *dig, unsigned int *diglen)
197         {
198         const EVP_MD *md;
199         md = EVP_get_digestbyobj(si->digestAlgorithm->algorithm);
200         if (md == NULL)
201                 return 0;
202         if (!ASN1_item_digest(ASN1_ITEM_rptr(CMS_Attributes_Verify), md,
203                                                 si->signedAttrs, dig, diglen))
204                 return 0;
205         return 1;
206         }
207
208 /* Add a msgSigDigest attribute to a SignerInfo */
209
210 int cms_msgSigDigest_add1(CMS_SignerInfo *dest, CMS_SignerInfo *src)
211         {
212         unsigned char dig[EVP_MAX_MD_SIZE];
213         unsigned int diglen;
214         if (!cms_msgSigDigest(src, dig, &diglen))
215                 {
216                 CMSerr(CMS_F_CMS_MSGSIGDIGEST_ADD1, CMS_R_MSGSIGDIGEST_ERROR);
217                 return 0;
218                 }
219         if (!CMS_signed_add1_attr_by_NID(dest, NID_id_smime_aa_msgSigDigest,
220                                         V_ASN1_OCTET_STRING, dig, diglen))
221                 {
222                 CMSerr(CMS_F_CMS_MSGSIGDIGEST_ADD1, ERR_R_MALLOC_FAILURE);
223                 return 0;
224                 }
225         return 1;
226         }
227
228 /* Verify signed receipt after it has already passed normal CMS verify */
229
230 int cms_Receipt_verify(CMS_ContentInfo *cms, CMS_ContentInfo *req_cms)
231         {
232         int r = 0, i;
233         CMS_ReceiptRequest *rr = NULL;
234         CMS_Receipt *rct = NULL;
235         STACK_OF(CMS_SignerInfo) *sis, *osis;
236         CMS_SignerInfo *si, *osi;
237         ASN1_OCTET_STRING *msig, **pcont;
238         ASN1_OBJECT *octype;
239         unsigned char dig[EVP_MAX_MD_SIZE];
240         unsigned int diglen;
241
242         /* Get SignerInfos, also checks SignedData content type */
243         osis = CMS_get0_SignerInfos(req_cms);
244         sis = CMS_get0_SignerInfos(cms);
245         if (!osis || !sis)
246                 goto err;
247
248         if (sk_CMS_SignerInfo_num(sis) != 1)
249                 {
250                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NEED_ONE_SIGNER);
251                 goto err;
252                 }
253
254         /* Check receipt content type */
255         if (OBJ_obj2nid(CMS_get0_eContentType(cms)) != NID_id_smime_ct_receipt)
256                 {
257                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NOT_A_SIGNED_RECEIPT);
258                 goto err;
259                 }
260
261         /* Extract and decode receipt content */
262         pcont = CMS_get0_content(cms);
263         if (!pcont || !*pcont)
264                 {
265                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NO_CONTENT);
266                 goto err;
267                 }
268
269         rct = ASN1_item_unpack(*pcont, ASN1_ITEM_rptr(CMS_Receipt));
270
271         if (!rct)       
272                 {
273                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_RECEIPT_DECODE_ERROR);
274                 goto err;
275                 }
276
277         /* Locate original request */
278
279         for (i = 0; i < sk_CMS_SignerInfo_num(osis); i++)
280                 {
281                 osi = sk_CMS_SignerInfo_value(osis, i);
282                 if (!ASN1_STRING_cmp(osi->signature,
283                                         rct->originatorSignatureValue))
284                         break;
285                 }
286
287         if (i == sk_CMS_SignerInfo_num(osis))
288                 {
289                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NO_MATCHING_SIGNATURE);
290                 goto err;
291                 }
292
293         si = sk_CMS_SignerInfo_value(sis, 0);
294
295         /* Get msgSigDigest value and compare */
296
297         msig = CMS_signed_get0_data_by_OBJ(si,
298                                 OBJ_nid2obj(NID_id_smime_aa_msgSigDigest),
299                                         -3, V_ASN1_OCTET_STRING);
300
301         if (!msig)
302                 {
303                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NO_MSGSIGDIGEST);
304                 goto err;
305                 }
306
307         if (!cms_msgSigDigest(osi, dig, &diglen))
308                 {
309                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_MSGSIGDIGEST_ERROR);
310                 goto err;
311                 }
312
313         if (diglen != (unsigned int)msig->length)
314                         {
315                         CMSerr(CMS_F_CMS_RECEIPT_VERIFY,
316                                 CMS_R_MSGSIGDIGEST_WRONG_LENGTH);
317                         goto err;
318                         }
319
320         if (memcmp(dig, msig->data, diglen))
321                         {
322                         CMSerr(CMS_F_CMS_RECEIPT_VERIFY,
323                                 CMS_R_MSGSIGDIGEST_VERIFICATION_FAILURE);
324                         goto err;
325                         }
326
327         /* Compare content types */
328
329         octype = CMS_signed_get0_data_by_OBJ(osi,
330                                 OBJ_nid2obj(NID_pkcs9_contentType),
331                                         -3, V_ASN1_OBJECT);
332         if (!octype)
333                 {
334                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NO_CONTENT_TYPE);
335                 goto err;
336                 }
337
338         /* Compare details in receipt request */
339
340         if (OBJ_cmp(octype, rct->contentType))
341                 {
342                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_CONTENT_TYPE_MISMATCH);
343                 goto err;
344                 }
345
346         /* Get original receipt request details */
347
348         if (!CMS_get1_ReceiptRequest(osi, &rr))
349                 {
350                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NO_RECEIPT_REQUEST);
351                 goto err;
352                 }
353
354         if (ASN1_STRING_cmp(rr->signedContentIdentifier,
355                                         rct->signedContentIdentifier))
356                 {
357                 CMSerr(CMS_F_CMS_RECEIPT_VERIFY,
358                                         CMS_R_CONTENTIDENTIFIER_MISMATCH);
359                 goto err;
360                 }
361
362         r = 1;
363
364         err:
365         if (rr)
366                 CMS_ReceiptRequest_free(rr);
367         if (rct)
368                 M_ASN1_free_of(rct, CMS_Receipt);
369
370         return r;
371
372         }
373
374 /* Encode a Receipt into an OCTET STRING read for including into content of
375  * a SignedData ContentInfo.
376  */
377
378 ASN1_OCTET_STRING *cms_encode_Receipt(CMS_SignerInfo *si)
379         {
380         CMS_Receipt rct;
381         CMS_ReceiptRequest *rr = NULL;
382         ASN1_OBJECT *ctype;
383         ASN1_OCTET_STRING *os = NULL;
384
385         /* Get original receipt request */
386
387         /* Get original receipt request details */
388
389         if (!CMS_get1_ReceiptRequest(si, &rr))
390                 {
391                 CMSerr(CMS_F_CMS_ENCODE_RECEIPT, CMS_R_NO_RECEIPT_REQUEST);
392                 goto err;
393                 }
394
395         /* Get original content type */
396
397         ctype = CMS_signed_get0_data_by_OBJ(si,
398                                 OBJ_nid2obj(NID_pkcs9_contentType),
399                                         -3, V_ASN1_OBJECT);
400         if (!ctype)
401                 {
402                 CMSerr(CMS_F_CMS_ENCODE_RECEIPT, CMS_R_NO_CONTENT_TYPE);
403                 goto err;
404                 }
405
406         rct.version = 1;
407         rct.contentType = ctype;
408         rct.signedContentIdentifier = rr->signedContentIdentifier;
409         rct.originatorSignatureValue = si->signature;
410
411         os = ASN1_item_pack(&rct, ASN1_ITEM_rptr(CMS_Receipt), NULL);
412
413         err:
414         if (rr)
415                 CMS_ReceiptRequest_free(rr);
416
417         return os;
418
419         }
420
421