]> git.saurik.com Git - apple/security.git/blob - OSX/libsecurity_smime/lib/cmssigdata.c
Security-58286.200.222.tar.gz
[apple/security.git] / OSX / libsecurity_smime / lib / cmssigdata.c
1 /*
2 * The contents of this file are subject to the Mozilla Public
3 * License Version 1.1 (the "License"); you may not use this file
4 * except in compliance with the License. You may obtain a copy of
5 * the License at http://www.mozilla.org/MPL/
6 *
7 * Software distributed under the License is distributed on an "AS
8 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
9 * implied. See the License for the specific language governing
10 * rights and limitations under the License.
11 *
12 * The Original Code is the Netscape security libraries.
13 *
14 * The Initial Developer of the Original Code is Netscape
15 * Communications Corporation. Portions created by Netscape are
16 * Copyright (C) 1994-2000 Netscape Communications Corporation. All
17 * Rights Reserved.
18 *
19 * Contributor(s):
20 *
21 * Alternatively, the contents of this file may be used under the
22 * terms of the GNU General Public License Version 2 or later (the
23 * "GPL"), in which case the provisions of the GPL are applicable
24 * instead of those above. If you wish to allow use of your
25 * version of this file only under the terms of the GPL and not to
26 * allow others to use your version of this file under the MPL,
27 * indicate your decision by deleting the provisions above and
28 * replace them with the notice and other provisions required by
29 * the GPL. If you do not delete the provisions above, a recipient
30 * may use your version of this file under either the MPL or the
31 * GPL.
32 */
33
34 /*
35 * CMS signedData methods.
36 */
37
38 #include <Security/SecCmsSignedData.h>
39
40 #include <Security/SecCmsContentInfo.h>
41 #include <Security/SecCmsDigestContext.h>
42 #include <Security/SecCmsSignerInfo.h>
43
44 #include "cmslocal.h"
45
46 #include "cert.h"
47 #include "secitem.h"
48 #include "secoid.h"
49 #include "tsaTemplates.h"
50
51 #include <security_asn1/secasn1.h>
52 #include <security_asn1/secerr.h>
53 #include <Security/SecBase.h>
54 #include <CommonCrypto/CommonRandomSPI.h>
55 #include <Security/SecPolicy.h>
56 #include <Security/SecPolicyPriv.h>
57 #include <utilities/SecCFWrappers.h>
58 #include <syslog.h>
59
60 #ifndef NDEBUG
61 #define SIGDATA_DEBUG 1
62 #endif
63
64 #if SIGDATA_DEBUG
65 #define dprintf(args...) fprintf(stderr, args)
66 #else
67 #define dprintf(args...)
68 #endif
69
70 SecCmsSignedDataRef
71 SecCmsSignedDataCreate(SecCmsMessageRef cmsg)
72 {
73 void *mark;
74 SecCmsSignedDataRef sigd;
75 PLArenaPool *poolp;
76
77 poolp = cmsg->poolp;
78
79 mark = PORT_ArenaMark(poolp);
80
81 sigd = (SecCmsSignedDataRef)PORT_ArenaZAlloc (poolp, sizeof(SecCmsSignedData));
82 if (sigd == NULL)
83 goto loser;
84
85 sigd->cmsg = cmsg;
86
87 /* signerInfos, certs, certlists, crls are all empty */
88 /* version is set in SecCmsSignedDataFinalize() */
89
90 PORT_ArenaUnmark(poolp, mark);
91 return sigd;
92
93 loser:
94 PORT_ArenaRelease(poolp, mark);
95 return NULL;
96 }
97
98 void
99 SecCmsSignedDataDestroy(SecCmsSignedDataRef sigd)
100 {
101 SecCmsSignerInfoRef *signerinfos, si;
102
103 if (sigd == NULL)
104 return;
105
106 if (sigd->certs != NULL)
107 CFRelease(sigd->certs);
108
109 signerinfos = sigd->signerInfos;
110 if (signerinfos != NULL) {
111 while ((si = *signerinfos++) != NULL)
112 SecCmsSignerInfoDestroy(si);
113 }
114
115 /* everything's in a pool, so don't worry about the storage */
116 SecCmsContentInfoDestroy(&(sigd->contentInfo));
117 }
118
119 /*
120 * SecCmsSignedDataEncodeBeforeStart - do all the necessary things to a SignedData
121 * before start of encoding.
122 *
123 * In detail:
124 * - find out about the right value to put into sigd->version
125 * - come up with a list of digestAlgorithms (which should be the union of the algorithms
126 * in the signerinfos).
127 * If we happen to have a pre-set list of algorithms (and digest values!), we
128 * check if we have all the signerinfos' algorithms. If not, this is an error.
129 */
130 OSStatus
131 SecCmsSignedDataEncodeBeforeStart(SecCmsSignedDataRef sigd)
132 {
133 SecCmsSignerInfoRef signerinfo;
134 SECOidTag digestalgtag;
135 CSSM_DATA_PTR dummy;
136 int version;
137 OSStatus rv;
138 Boolean haveDigests = PR_FALSE;
139 int n, i;
140 PLArenaPool *poolp;
141
142 poolp = sigd->cmsg->poolp;
143
144 /* we assume that we have precomputed digests if there is a list of algorithms, and */
145 /* a chunk of data for each of those algorithms */
146 if (sigd->digestAlgorithms != NULL && sigd->digests != NULL) {
147 for (i=0; sigd->digestAlgorithms[i] != NULL; i++) {
148 if (sigd->digests[i] == NULL)
149 break;
150 }
151 if (sigd->digestAlgorithms[i] == NULL) /* reached the end of the array? */
152 haveDigests = PR_TRUE; /* yes: we must have all the digests */
153 }
154
155 version = SEC_CMS_SIGNED_DATA_VERSION_BASIC;
156
157 /* RFC2630 5.1 "version is the syntax version number..." */
158 if (SecCmsContentInfoGetContentTypeTag(&(sigd->contentInfo)) != SEC_OID_PKCS7_DATA)
159 version = SEC_CMS_SIGNED_DATA_VERSION_EXT;
160
161 /* prepare all the SignerInfos (there may be none) */
162 for (i=0; i < SecCmsSignedDataSignerInfoCount(sigd); i++) {
163 signerinfo = SecCmsSignedDataGetSignerInfo(sigd, i);
164
165 /* RFC2630 5.1 "version is the syntax version number..." */
166 if (SecCmsSignerInfoGetVersion(signerinfo) != SEC_CMS_SIGNER_INFO_VERSION_ISSUERSN)
167 version = SEC_CMS_SIGNED_DATA_VERSION_EXT;
168
169 /* collect digestAlgorithms from SignerInfos */
170 /* (we need to know which algorithms we have when the content comes in) */
171 /* do not overwrite any existing digestAlgorithms (and digest) */
172 digestalgtag = SecCmsSignerInfoGetDigestAlgTag(signerinfo);
173
174 n = SecCmsAlgArrayGetIndexByAlgTag(sigd->digestAlgorithms, digestalgtag);
175 if (n < 0 && haveDigests) {
176 /* oops, there is a digestalg we do not have a digest for */
177 /* but we were supposed to have all the digests already... */
178 goto loser;
179 } else if (n < 0) {
180 /* add the digestAlgorithm & a NULL digest */
181 rv = SecCmsSignedDataAddDigest((SecArenaPoolRef)poolp, sigd, digestalgtag, NULL);
182 if (rv != SECSuccess)
183 goto loser;
184 } else {
185 /* found it, nothing to do */
186 }
187 }
188
189 dummy = SEC_ASN1EncodeInteger(poolp, &(sigd->version), (long)version);
190 if (dummy == NULL)
191 return SECFailure;
192
193 /* this is a SET OF, so we need to sort them guys */
194 rv = SecCmsArraySortByDER((void **)sigd->digestAlgorithms,
195 SEC_ASN1_GET(SECOID_AlgorithmIDTemplate),
196 (void **)sigd->digests);
197 if (rv != SECSuccess)
198 return SECFailure;
199
200 return SECSuccess;
201
202 loser:
203 return SECFailure;
204 }
205
206 OSStatus
207 SecCmsSignedDataEncodeBeforeData(SecCmsSignedDataRef sigd)
208 {
209 /* set up the digests */
210 if (sigd->digestAlgorithms != NULL) {
211 sigd->contentInfo.digcx = SecCmsDigestContextStartMultiple(sigd->digestAlgorithms);
212 if (sigd->contentInfo.digcx == NULL)
213 return SECFailure;
214 }
215 return SECSuccess;
216 }
217
218 #include <AssertMacros.h>
219 #include "tsaSupport.h"
220 #include "tsaSupportPriv.h"
221 #include "tsaTemplates.h"
222 #include <security_keychain/tsaDERUtilities.h>
223
224 extern const SecAsn1Template kSecAsn1TSATSTInfoTemplate;
225
226 OSStatus createTSAMessageImprint(SecCmsSignerInfoRef signerInfo, SECAlgorithmID *digestAlg, CSSM_DATA_PTR encDigest,
227 SecAsn1TSAMessageImprint *messageImprint)
228 {
229 // Calculate hash of encDigest and put in messageImprint.hashedMessage
230 // We pass in encDigest, since in the verification case, it comes from a different signedData
231
232 OSStatus status = SECFailure;
233
234 require(signerInfo && digestAlg && messageImprint, xit);
235
236 SecCmsDigestContextRef digcx = SecCmsDigestContextStartSingle(digestAlg);
237 require(digcx, xit);
238 require(encDigest, xit);
239
240 messageImprint->hashAlgorithm = *digestAlg;
241
242 SecCmsDigestContextUpdate(digcx, encDigest->Data, encDigest->Length);
243
244 require_noerr(SecCmsDigestContextFinishSingle(digcx, (SecArenaPoolRef)signerInfo->cmsg->poolp,
245 &messageImprint->hashedMessage), xit);
246
247 status = SECSuccess;
248 xit:
249 return status;
250 }
251
252 #include <Security/SecAsn1Templates.h>
253
254 #ifndef NDEBUG
255 static OSStatus decodeDERUTF8String(const CSSM_DATA_PTR content, char *statusstr, size_t strsz)
256 {
257 // The statusString should use kSecAsn1SequenceOfUTF8StringTemplate, but doesn't
258 OSStatus status = SECFailure;
259 SecAsn1CoderRef coder = NULL;
260 CSSM_DATA statusString;
261 size_t len = 0;
262
263 require(content && statusstr, xit);
264
265 require_noerr(SecAsn1CoderCreate(&coder), xit);
266 require_noerr(SecAsn1Decode(coder, content->Data, content->Length, kSecAsn1UTF8StringTemplate, &statusString), xit);
267 status = 0;
268 len = (statusString.Length < strsz)?(int)statusString.Length:strsz;
269 if (statusstr && statusString.Data)
270 strncpy(statusstr, (const char *)statusString.Data, len);
271
272 xit:
273 if (coder)
274 SecAsn1CoderRelease(coder);
275 return status;
276 }
277 #endif
278
279 static OSStatus validateTSAResponseAndAddTimeStamp(SecCmsSignerInfoRef signerinfo, CSSM_DATA_PTR tsaResponse,
280 uint64_t expectedNonce)
281 {
282 OSStatus status = SECFailure;
283 SecAsn1CoderRef coder = NULL;
284 SecAsn1TimeStampRespDER respDER = {{{0}},};
285 SecAsn1TSAPKIStatusInfo *tsastatus = NULL;
286 int respstatus = -1;
287 #ifndef NDEBUG
288 int failinfo = -1;
289 #endif
290
291 require_action(tsaResponse && tsaResponse->Data && tsaResponse->Length, xit, status = errSecTimestampMissing);
292
293 require_noerr(SecAsn1CoderCreate(&coder), xit);
294 require_noerr(SecTSAResponseCopyDEREncoding(coder, tsaResponse, &respDER), xit);
295
296 #ifndef NDEBUG
297 tsaWriteFileX("/tmp/tsa-timeStampToken.der", respDER.timeStampTokenDER.Data, respDER.timeStampTokenDER.Length);
298 #endif
299
300 tsastatus = (SecAsn1TSAPKIStatusInfo *)&respDER.status;
301 require_action(tsastatus->status.Data, xit, status = errSecTimestampBadDataFormat);
302 respstatus = (int)tsaDER_ToInt(&tsastatus->status);
303
304 #ifndef NDEBUG
305 char buf[80]={0,};
306 if (tsastatus->failInfo.Data) // e.g. FI_BadRequest
307 failinfo = (int)tsaDER_ToInt(&tsastatus->failInfo);
308
309 if (tsastatus->statusString.Data && tsastatus->statusString.Length)
310 {
311 OSStatus strrx = decodeDERUTF8String(&tsastatus->statusString, buf, sizeof(buf));
312 dprintf("decodeDERUTF8String status: %d\n", (int)strrx);
313 }
314
315 dprintf("validateTSAResponse: status: %d, failinfo: %d, %s\n", respstatus, failinfo, buf);
316 #endif
317
318 switch (respstatus)
319 {
320 case PKIS_Granted:
321 case PKIS_GrantedWithMods: // Success
322 status = noErr;
323 break;
324 case PKIS_Rejection:
325 status = errSecTimestampRejection;
326 break;
327 case PKIS_Waiting:
328 status = errSecTimestampWaiting;
329 break;
330 case PKIS_RevocationWarning:
331 status = errSecTimestampRevocationWarning;
332 break;
333 case PKIS_RevocationNotification:
334 status = errSecTimestampRevocationNotification;
335 break;
336 default:
337 status = errSecTimestampSystemFailure;
338 break;
339 }
340 require_noerr(status, xit);
341
342 // If we succeeded, then we must have a TimeStampToken
343
344 require_action(respDER.timeStampTokenDER.Data && respDER.timeStampTokenDER.Length, xit, status = errSecTimestampBadDataFormat);
345
346 dprintf("timestamp full expected nonce: %lld\n", expectedNonce);
347
348 /*
349 The bytes in respDER are a full CMS message, which we need to check now for validity.
350 The code for this is essentially the same code taht is done during a timestamp
351 verify, except that we also need to check the nonce.
352 */
353 CSSM_DATA *encDigest = SecCmsSignerInfoGetEncDigest(signerinfo);
354 require_noerr(status = decodeTimeStampToken(signerinfo, &respDER.timeStampTokenDER, encDigest, expectedNonce), xit);
355
356 status = SecCmsSignerInfoAddTimeStamp(signerinfo, &respDER.timeStampTokenDER);
357
358 xit:
359 if (coder)
360 SecAsn1CoderRelease(coder);
361 return status;
362 }
363
364 static OSStatus getRandomNonce(uint64_t *nonce)
365 {
366 return nonce ? CCRandomCopyBytes(kCCRandomDevRandom, (void *)nonce, sizeof(*nonce)) : SECFailure;
367 }
368
369 static OSStatus remapTimestampError(OSStatus inStatus)
370 {
371 /*
372 Since communicating with the timestamp server is perhaps an unexpected
373 dependency on the network, map unknown errors into something to indicate
374 that signing without a timestamp may be a workaround. In particular, the
375 private CFURL errors (see CFNetworkErrorsPriv.i)
376
377 kCFURLErrorTimedOut = -1001,
378 kCFURLErrorNotConnectedToInternet = -1009,
379
380 are remapped to errSecTimestampServiceNotAvailable.
381 */
382
383 switch (inStatus)
384 {
385 case errSecTimestampMissing:
386 case errSecTimestampInvalid:
387 case errSecTimestampNotTrusted:
388 case errSecTimestampServiceNotAvailable:
389 case errSecTimestampBadAlg:
390 case errSecTimestampBadRequest:
391 case errSecTimestampBadDataFormat:
392 case errSecTimestampTimeNotAvailable:
393 case errSecTimestampUnacceptedPolicy:
394 case errSecTimestampUnacceptedExtension:
395 case errSecTimestampAddInfoNotAvailable:
396 case errSecTimestampSystemFailure:
397 case errSecSigningTimeMissing:
398 case errSecTimestampRejection:
399 case errSecTimestampWaiting:
400 case errSecTimestampRevocationWarning:
401 case errSecTimestampRevocationNotification:
402 return inStatus;
403 default:
404 return errSecTimestampServiceNotAvailable;
405 }
406 return errSecTimestampServiceNotAvailable;
407 }
408
409 /*
410 * SecCmsSignedDataEncodeAfterData - do all the necessary things to a SignedData
411 * after all the encapsulated data was passed through the encoder.
412 *
413 * In detail:
414 * - create the signatures in all the SignerInfos
415 *
416 * Please note that nothing is done to the Certificates and CRLs in the message - this
417 * is entirely the responsibility of our callers.
418 */
419 OSStatus
420 SecCmsSignedDataEncodeAfterData(SecCmsSignedDataRef sigd)
421 {
422 SecCmsSignerInfoRef *signerinfos, signerinfo;
423 SecCmsContentInfoRef cinfo;
424 SECOidTag digestalgtag;
425 OSStatus ret = SECFailure;
426 OSStatus rv;
427 CSSM_DATA_PTR contentType;
428 int certcount;
429 int i, ci, n, rci, si;
430 PLArenaPool *poolp;
431 CFArrayRef certlist;
432 extern const SecAsn1Template SecCmsSignerInfoTemplate[];
433
434 poolp = sigd->cmsg->poolp;
435 cinfo = &(sigd->contentInfo);
436
437 /* did we have digest calculation going on? */
438 if (cinfo->digcx) {
439 rv = SecCmsDigestContextFinishMultiple(cinfo->digcx, (SecArenaPoolRef)poolp, &(sigd->digests));
440 cinfo->digcx = NULL;
441 if (rv != SECSuccess)
442 goto loser; /* error has been set by SecCmsDigestContextFinishMultiple */
443 }
444
445 signerinfos = sigd->signerInfos;
446 certcount = 0;
447
448 /* prepare all the SignerInfos (there may be none) */
449 for (i=0; i < SecCmsSignedDataSignerInfoCount(sigd); i++) {
450 signerinfo = SecCmsSignedDataGetSignerInfo(sigd, i);
451
452 /* find correct digest for this signerinfo */
453 digestalgtag = SecCmsSignerInfoGetDigestAlgTag(signerinfo);
454 n = SecCmsAlgArrayGetIndexByAlgTag(sigd->digestAlgorithms, digestalgtag);
455 if (n < 0 || sigd->digests == NULL || sigd->digests[n] == NULL) {
456 /* oops - digest not found */
457 PORT_SetError(SEC_ERROR_DIGEST_NOT_FOUND);
458 goto loser;
459 }
460
461 /* XXX if our content is anything else but data, we need to force the
462 * presence of signed attributes (RFC2630 5.3 "signedAttributes is a
463 * collection...") */
464
465 /* pass contentType here as we want a contentType attribute */
466 if ((contentType = SecCmsContentInfoGetContentTypeOID(cinfo)) == NULL)
467 goto loser;
468
469 /* sign the thing */
470 rv = SecCmsSignerInfoSign(signerinfo, sigd->digests[n], contentType);
471 if (rv != SECSuccess)
472 goto loser;
473
474 /* while we're at it, count number of certs in certLists */
475 certlist = SecCmsSignerInfoGetCertList(signerinfo);
476 if (certlist)
477 certcount += CFArrayGetCount(certlist);
478 }
479
480 /* Now we can get a timestamp, since we have all the digests */
481
482 // We force the setting of a callback, since this is the most usual case
483 if (!sigd->cmsg->tsaCallback)
484 SecCmsMessageSetTSACallback(sigd->cmsg, (SecCmsTSACallback)SecCmsTSADefaultCallback);
485
486 if (sigd->cmsg->tsaCallback && sigd->cmsg->tsaContext)
487 {
488 CSSM_DATA tsaResponse = {0,};
489 SecAsn1TSAMessageImprint messageImprint = {{{0},},{0,}};
490 // <rdar://problem/11073466> Add nonce support for timestamping client
491
492 uint64_t nonce = 0;
493
494 require_noerr(getRandomNonce(&nonce), tsxit);
495 dprintf("SecCmsSignedDataSignerInfoCount: %d\n", SecCmsSignedDataSignerInfoCount(sigd));
496
497 // Calculate hash of encDigest and put in messageImprint.hashedMessage
498 SecCmsSignerInfoRef signerinfo = SecCmsSignedDataGetSignerInfo(sigd, 0); // NB - assume 1 signer only!
499 CSSM_DATA *encDigest = SecCmsSignerInfoGetEncDigest(signerinfo);
500 require_noerr(createTSAMessageImprint(signerinfo, &signerinfo->digestAlg, encDigest, &messageImprint), tsxit);
501
502 // Callback to fire up XPC service to talk to TimeStamping server, etc.
503 require_noerr(rv =(*sigd->cmsg->tsaCallback)(sigd->cmsg->tsaContext, &messageImprint,
504 nonce, &tsaResponse), tsxit);
505
506 require_noerr(rv = validateTSAResponseAndAddTimeStamp(signerinfo, &tsaResponse, nonce), tsxit);
507
508 /*
509 It is likely that every occurrence of "goto loser" in this file should
510 also do a PORT_SetError. Since it is not clear what might depend on this
511 behavior, we just do this in the timestamping case.
512 */
513 tsxit:
514 if (rv)
515 {
516 dprintf("Original timestamp error: %d\n", (int)rv);
517 rv = remapTimestampError(rv);
518 PORT_SetError(rv);
519 goto loser;
520 }
521 }
522
523 /* this is a SET OF, so we need to sort them guys */
524 rv = SecCmsArraySortByDER((void **)signerinfos, SecCmsSignerInfoTemplate, NULL);
525 if (rv != SECSuccess)
526 goto loser;
527
528 /*
529 * now prepare certs & crls
530 */
531
532 /* count the rest of the certs */
533 if (sigd->certs != NULL)
534 certcount += CFArrayGetCount(sigd->certs);
535
536 if (certcount == 0) {
537 sigd->rawCerts = NULL;
538 } else {
539 /*
540 * Combine all of the certs and cert chains into rawcerts.
541 * Note: certcount is an upper bound; we may not need that many slots
542 * but we will allocate anyway to avoid having to do another pass.
543 * (The temporary space saving is not worth it.)
544 *
545 * XXX ARGH - this NEEDS to be fixed. need to come up with a decent
546 * SetOfDERcertficates implementation
547 */
548 sigd->rawCerts = (CSSM_DATA_PTR *)PORT_ArenaAlloc(poolp, (certcount + 1) * sizeof(CSSM_DATA_PTR));
549 if (sigd->rawCerts == NULL)
550 return SECFailure;
551
552 /*
553 * XXX Want to check for duplicates and not add *any* cert that is
554 * already in the set. This will be more important when we start
555 * dealing with larger sets of certs, dual-key certs (signing and
556 * encryption), etc. For the time being we can slide by...
557 *
558 * XXX ARGH - this NEEDS to be fixed. need to come up with a decent
559 * SetOfDERcertficates implementation
560 */
561 rci = 0;
562 if (signerinfos != NULL) {
563 for (si = 0; signerinfos[si] != NULL; si++) {
564 signerinfo = signerinfos[si];
565 for (ci = 0; ci < CFArrayGetCount(signerinfo->certList); ci++) {
566 sigd->rawCerts[rci] = PORT_ArenaZAlloc(poolp, sizeof(CSSM_DATA));
567 SecCertificateRef cert = (SecCertificateRef)CFArrayGetValueAtIndex(signerinfo->certList, ci);
568 SecCertificateGetData(cert, sigd->rawCerts[rci++]);
569 }
570 }
571 }
572
573 if (sigd->certs != NULL) {
574 for (ci = 0; ci < CFArrayGetCount(sigd->certs); ci++) {
575 sigd->rawCerts[rci] = PORT_ArenaZAlloc(poolp, sizeof(CSSM_DATA));
576 SecCertificateRef cert = (SecCertificateRef)CFArrayGetValueAtIndex(sigd->certs, ci);
577 SecCertificateGetData(cert, sigd->rawCerts[rci++]);
578 }
579 }
580
581 sigd->rawCerts[rci] = NULL;
582
583 /* this is a SET OF, so we need to sort them guys - we have the DER already, though */
584 SecCmsArraySort((void **)sigd->rawCerts, SecCmsUtilDERCompare, NULL, NULL);
585 }
586
587 ret = SECSuccess;
588
589 loser:
590
591 dprintf("SecCmsSignedDataEncodeAfterData: ret: %ld, rv: %ld\n", (long)ret, (long)rv);
592 return ret;
593 }
594
595 OSStatus
596 SecCmsSignedDataDecodeBeforeData(SecCmsSignedDataRef sigd)
597 {
598 /* set up the digests */
599 if (sigd->digestAlgorithms != NULL && sigd->digests == NULL) {
600 /* if digests are already there, do nothing */
601 sigd->contentInfo.digcx = SecCmsDigestContextStartMultiple(sigd->digestAlgorithms);
602 if (sigd->contentInfo.digcx == NULL)
603 return SECFailure;
604 }
605 return SECSuccess;
606 }
607
608 /*
609 * SecCmsSignedDataDecodeAfterData - do all the necessary things to a SignedData
610 * after all the encapsulated data was passed through the decoder.
611 */
612 OSStatus
613 SecCmsSignedDataDecodeAfterData(SecCmsSignedDataRef sigd)
614 {
615 /* did we have digest calculation going on? */
616 if (sigd->contentInfo.digcx) {
617 if (SecCmsDigestContextFinishMultiple(sigd->contentInfo.digcx, (SecArenaPoolRef)sigd->cmsg->poolp, &(sigd->digests)) != SECSuccess) {
618 sigd->contentInfo.digcx = NULL;
619 return SECFailure; /* error has been set by SecCmsDigestContextFinishMultiple */
620 }
621 sigd->contentInfo.digcx = NULL;
622 }
623 return SECSuccess;
624 }
625
626 /*
627 * SecCmsSignedDataDecodeAfterEnd - do all the necessary things to a SignedData
628 * after all decoding is finished.
629 */
630 OSStatus
631 SecCmsSignedDataDecodeAfterEnd(SecCmsSignedDataRef sigd)
632 {
633 SecCmsSignerInfoRef *signerinfos;
634 int i;
635
636 if (!sigd) {
637 return SECFailure;
638 }
639
640 signerinfos = sigd->signerInfos;
641
642 /* set cmsg and sigd backpointers for all the signerinfos */
643 if (signerinfos) {
644 for (i = 0; signerinfos[i] != NULL; i++) {
645 signerinfos[i]->cmsg = sigd->cmsg;
646 signerinfos[i]->sigd = sigd;
647 }
648 }
649
650 return SECSuccess;
651 }
652
653 /*
654 * SecCmsSignedDataGetSignerInfos - retrieve the SignedData's signer list
655 */
656 SecCmsSignerInfoRef *
657 SecCmsSignedDataGetSignerInfos(SecCmsSignedDataRef sigd)
658 {
659 return sigd->signerInfos;
660 }
661
662 int
663 SecCmsSignedDataSignerInfoCount(SecCmsSignedDataRef sigd)
664 {
665 return SecCmsArrayCount((void **)sigd->signerInfos);
666 }
667
668 SecCmsSignerInfoRef
669 SecCmsSignedDataGetSignerInfo(SecCmsSignedDataRef sigd, int i)
670 {
671 return sigd->signerInfos[i];
672 }
673
674 /*
675 * SecCmsSignedDataGetDigestAlgs - retrieve the SignedData's digest algorithm list
676 */
677 SECAlgorithmID **
678 SecCmsSignedDataGetDigestAlgs(SecCmsSignedDataRef sigd)
679 {
680 return sigd->digestAlgorithms;
681 }
682
683 /*
684 * SecCmsSignedDataGetContentInfo - return pointer to this signedData's contentinfo
685 */
686 SecCmsContentInfoRef
687 SecCmsSignedDataGetContentInfo(SecCmsSignedDataRef sigd)
688 {
689 return &(sigd->contentInfo);
690 }
691
692 /*
693 * SecCmsSignedDataGetCertificateList - retrieve the SignedData's certificate list
694 */
695 CSSM_DATA_PTR *
696 SecCmsSignedDataGetCertificateList(SecCmsSignedDataRef sigd)
697 {
698 return sigd->rawCerts;
699 }
700
701 OSStatus
702 SecCmsSignedDataImportCerts(SecCmsSignedDataRef sigd, SecKeychainRef keychain,
703 SECCertUsage certusage, Boolean keepcerts)
704 {
705 int certcount;
706 OSStatus rv;
707 int i;
708
709 certcount = SecCmsArrayCount((void **)sigd->rawCerts);
710
711 rv = CERT_ImportCerts(keychain, certusage, certcount, sigd->rawCerts, NULL,
712 keepcerts, PR_FALSE, NULL);
713
714 /* XXX CRL handling */
715
716 if (sigd->signerInfos != NULL) {
717 /* fill in all signerinfo's certs */
718 for (i = 0; sigd->signerInfos[i] != NULL; i++)
719 (void)SecCmsSignerInfoGetSigningCertificate(sigd->signerInfos[i], keychain);
720 }
721
722 return rv;
723 }
724
725 /*
726 * XXX the digests need to be passed in BETWEEN the decoding and the verification in case
727 * of external signatures!
728 */
729
730 /*
731 * SecCmsSignedDataVerifySignerInfo - check the signatures.
732 *
733 * The digests were either calculated during decoding (and are stored in the
734 * signedData itself) or set after decoding using SecCmsSignedDataSetDigests.
735 *
736 * The verification checks if the signing cert is valid and has a trusted chain
737 * for the purpose specified by "policies".
738 *
739 * If trustRef is NULL the cert chain is verified and the VerificationStatus is set accordingly.
740 * Otherwise a SecTrust object is returned for the caller to evaluate using SecTrustEvaluate().
741 */
742 OSStatus
743 SecCmsSignedDataVerifySignerInfo(SecCmsSignedDataRef sigd, int i,
744 SecKeychainRef keychainOrArray, CFTypeRef policies, SecTrustRef *trustRef)
745 {
746 SecCmsSignerInfoRef signerinfo;
747 SecCmsContentInfoRef cinfo;
748 SECOidData *algiddata;
749 CSSM_DATA_PTR contentType, digest;
750 OSStatus status, status2;
751
752 cinfo = &(sigd->contentInfo);
753
754 signerinfo = sigd->signerInfos[i];
755
756 /* Signature or digest level verificationStatus errors should supercede
757 certificate level errors, so check the digest and signature first. */
758
759 /* Find digest and contentType for signerinfo */
760 algiddata = SecCmsSignerInfoGetDigestAlg(signerinfo);
761 if (algiddata == NULL) {
762 return errSecInternalError; // shouldn't have happened, this is likely due to corrupted data
763 }
764
765 digest = SecCmsSignedDataGetDigestByAlgTag(sigd, algiddata->offset);
766 if(digest == NULL) {
767 /*
768 * No digests; this probably had detached content the caller has to
769 * deal with.
770 * FIXME: need some error return for this (as well as many
771 * other places in this library).
772 */
773 return errSecDataNotAvailable;
774 }
775 contentType = SecCmsContentInfoGetContentTypeOID(cinfo);
776
777 /* verify signature */
778 CFTypeRef timeStampPolicies=SecPolicyCreateAppleTimeStampingAndRevocationPolicies(policies);
779 status = SecCmsSignerInfoVerifyWithPolicy(signerinfo, timeStampPolicies, digest, contentType);
780 CFReleaseSafe(timeStampPolicies);
781
782 /* Now verify the certificate. We do this even if the signature failed to verify so we can
783 return a trustRef to the caller for display purposes. */
784 status2 = SecCmsSignerInfoVerifyCertificate(signerinfo, keychainOrArray,
785 policies, trustRef);
786 dprintf("SecCmsSignedDataVerifySignerInfo: status %d status2 %d\n", (int) status, (int)status2);
787 /* The error from SecCmsSignerInfoVerify() supercedes error from SecCmsSignerInfoVerifyCertificate(). */
788 if (status)
789 return status;
790
791 return status2;
792 }
793
794 /*
795 * SecCmsSignedDataVerifyCertsOnly - verify the certs in a certs-only message
796 */
797 OSStatus
798 SecCmsSignedDataVerifyCertsOnly(SecCmsSignedDataRef sigd,
799 SecKeychainRef keychainOrArray,
800 CFTypeRef policies)
801 {
802 SecCertificateRef cert;
803 OSStatus rv = SECSuccess;
804 int i;
805 int count;
806
807 if (!sigd || !keychainOrArray || !sigd->rawCerts) {
808 PORT_SetError(SEC_ERROR_INVALID_ARGS);
809 return SECFailure;
810 }
811
812 count = SecCmsArrayCount((void**)sigd->rawCerts);
813 for (i=0; i < count; i++) {
814 if (sigd->certs && CFArrayGetCount(sigd->certs) > i) {
815 cert = (SecCertificateRef)CFArrayGetValueAtIndex(sigd->certs, i);
816 CFRetain(cert);
817 } else {
818 cert = CERT_FindCertByDERCert(keychainOrArray, sigd->rawCerts[i]);
819 if (!cert) {
820 rv = SECFailure;
821 break;
822 }
823 }
824 rv |= CERT_VerifyCert(keychainOrArray, cert, sigd->rawCerts,
825 policies, CFAbsoluteTimeGetCurrent(), NULL);
826 CFRelease(cert);
827 }
828
829 return rv;
830 }
831
832 /*
833 * SecCmsSignedDataHasDigests - see if we have digests in place
834 */
835 Boolean
836 SecCmsSignedDataHasDigests(SecCmsSignedDataRef sigd)
837 {
838 return (sigd->digests != NULL);
839 }
840
841 OSStatus
842 SecCmsSignedDataAddCertList(SecCmsSignedDataRef sigd, CFArrayRef certlist)
843 {
844 PORT_Assert(certlist != NULL);
845
846 if (certlist == NULL)
847 return SECFailure;
848
849 if (!sigd->certs)
850 sigd->certs = CFArrayCreateMutableCopy(NULL, 0, certlist);
851 else
852 {
853 CFRange certlistRange = { 0, CFArrayGetCount(certlist) };
854 CFArrayAppendArray(sigd->certs, certlist, certlistRange);
855 }
856
857 return SECSuccess;
858 }
859
860 /*
861 * SecCmsSignedDataAddCertChain - add cert and its entire chain to the set of certs
862 */
863 OSStatus
864 SecCmsSignedDataAddCertChain(SecCmsSignedDataRef sigd, SecCertificateRef cert)
865 {
866 CFArrayRef certlist;
867 SECCertUsage usage;
868 OSStatus rv;
869
870 usage = certUsageEmailSigner;
871
872 /* do not include root */
873 certlist = CERT_CertChainFromCert(cert, usage, PR_FALSE);
874 if (certlist == NULL)
875 return SECFailure;
876
877 rv = SecCmsSignedDataAddCertList(sigd, certlist);
878 CFRelease(certlist);
879
880 return rv;
881 }
882
883 OSStatus
884 SecCmsSignedDataAddCertificate(SecCmsSignedDataRef sigd, SecCertificateRef cert)
885 {
886 PORT_Assert(cert != NULL);
887
888 if (cert == NULL)
889 return SECFailure;
890
891 if (!sigd->certs)
892 sigd->certs = CFArrayCreateMutable(NULL, 0, &kCFTypeArrayCallBacks);
893
894 CFArrayAppendValue(sigd->certs, cert);
895
896 return SECSuccess;
897 }
898
899 Boolean
900 SecCmsSignedDataContainsCertsOrCrls(SecCmsSignedDataRef sigd)
901 {
902 if (sigd->rawCerts != NULL && sigd->rawCerts[0] != NULL)
903 return PR_TRUE;
904 else if (sigd->rawCrls != NULL && sigd->rawCrls[0] != NULL)
905 return PR_TRUE;
906 else
907 return PR_FALSE;
908 }
909
910 OSStatus
911 SecCmsSignedDataAddSignerInfo(SecCmsSignedDataRef sigd,
912 SecCmsSignerInfoRef signerinfo)
913 {
914 void *mark;
915 OSStatus rv;
916 SECOidTag digestalgtag;
917 PLArenaPool *poolp;
918
919 poolp = sigd->cmsg->poolp;
920
921 mark = PORT_ArenaMark(poolp);
922
923 /* add signerinfo */
924 rv = SecCmsArrayAdd(poolp, (void ***)&(sigd->signerInfos), (void *)signerinfo);
925 if (rv != SECSuccess)
926 goto loser;
927
928 signerinfo->sigd = sigd;
929
930 /*
931 * add empty digest
932 * Empty because we don't have it yet. Either it gets created during encoding
933 * (if the data is present) or has to be set externally.
934 * XXX maybe pass it in optionally?
935 */
936 digestalgtag = SecCmsSignerInfoGetDigestAlgTag(signerinfo);
937 rv = SecCmsSignedDataSetDigestValue(sigd, digestalgtag, NULL);
938 if (rv != SECSuccess)
939 goto loser;
940
941 /*
942 * The last thing to get consistency would be adding the digest.
943 */
944
945 PORT_ArenaUnmark(poolp, mark);
946 return SECSuccess;
947
948 loser:
949 PORT_ArenaRelease (poolp, mark);
950 return SECFailure;
951 }
952
953 CSSM_DATA_PTR
954 SecCmsSignedDataGetDigestByAlgTag(SecCmsSignedDataRef sigd, SECOidTag algtag)
955 {
956 int idx;
957
958 if(sigd == NULL || sigd->digests == NULL) {
959 return NULL;
960 }
961 idx = SecCmsAlgArrayGetIndexByAlgTag(sigd->digestAlgorithms, algtag);
962 return (idx >= 0) ? sigd->digests[idx] : NULL;
963 }
964
965 /*
966 * SecCmsSignedDataSetDigests - set a signedData's digests member
967 *
968 * "digestalgs" - array of digest algorithm IDs
969 * "digests" - array of digests corresponding to the digest algorithms
970 */
971 OSStatus
972 SecCmsSignedDataSetDigests(SecCmsSignedDataRef sigd,
973 SECAlgorithmID **digestalgs,
974 CSSM_DATA_PTR *digests)
975 {
976 int cnt, i, idx;
977
978 /* Check input structure and items in structure */
979 if (sigd == NULL || sigd->digestAlgorithms == NULL || sigd->cmsg == NULL || sigd->cmsg->poolp == NULL) {
980 PORT_SetError(SEC_ERROR_INVALID_ARGS);
981 return SECFailure;
982 }
983
984 /* we assume that the digests array is just not there yet */
985 PORT_Assert(sigd->digests == NULL);
986 if (sigd->digests != NULL) {
987 PORT_SetError(SEC_ERROR_LIBRARY_FAILURE);
988 return SECFailure;
989 }
990
991 /* now allocate one (same size as digestAlgorithms) */
992 cnt = SecCmsArrayCount((void **)sigd->digestAlgorithms);
993 sigd->digests = PORT_ArenaZAlloc(sigd->cmsg->poolp, (cnt + 1) * sizeof(CSSM_DATA_PTR));
994 if (sigd->digests == NULL) {
995 PORT_SetError(SEC_ERROR_NO_MEMORY);
996 return SECFailure;
997 }
998
999 for (i = 0; sigd->digestAlgorithms[i] != NULL; i++) {
1000 /* try to find the sigd's i'th digest algorithm in the array we passed in */
1001 idx = SecCmsAlgArrayGetIndexByAlgID(digestalgs, sigd->digestAlgorithms[i]);
1002 if (idx < 0) {
1003 PORT_SetError(SEC_ERROR_DIGEST_NOT_FOUND);
1004 return SECFailure;
1005 }
1006
1007 /* found it - now set it */
1008 if ((sigd->digests[i] = SECITEM_AllocItem(sigd->cmsg->poolp, NULL, 0)) == NULL ||
1009 SECITEM_CopyItem(sigd->cmsg->poolp, sigd->digests[i], digests[idx]) != SECSuccess)
1010 {
1011 PORT_SetError(SEC_ERROR_NO_MEMORY);
1012 return SECFailure;
1013 }
1014 }
1015 return SECSuccess;
1016 }
1017
1018 OSStatus
1019 SecCmsSignedDataSetDigestValue(SecCmsSignedDataRef sigd,
1020 SECOidTag digestalgtag,
1021 CSSM_DATA_PTR digestdata)
1022 {
1023 CSSM_DATA_PTR digest = NULL;
1024 PLArenaPool *poolp;
1025 void *mark;
1026 int n, cnt;
1027
1028 poolp = sigd->cmsg->poolp;
1029
1030 mark = PORT_ArenaMark(poolp);
1031
1032
1033 if (digestdata) {
1034 digest = (CSSM_DATA_PTR) PORT_ArenaZAlloc(poolp,sizeof(CSSM_DATA));
1035
1036 /* copy digestdata item to arena (in case we have it and are not only making room) */
1037 if (SECITEM_CopyItem(poolp, digest, digestdata) != SECSuccess)
1038 goto loser;
1039 }
1040
1041 /* now allocate one (same size as digestAlgorithms) */
1042 if (sigd->digests == NULL) {
1043 cnt = SecCmsArrayCount((void **)sigd->digestAlgorithms);
1044 sigd->digests = PORT_ArenaZAlloc(sigd->cmsg->poolp, (cnt + 1) * sizeof(CSSM_DATA_PTR));
1045 if (sigd->digests == NULL) {
1046 PORT_SetError(SEC_ERROR_NO_MEMORY);
1047 return SECFailure;
1048 }
1049 }
1050
1051 n = -1;
1052 if (sigd->digestAlgorithms != NULL)
1053 n = SecCmsAlgArrayGetIndexByAlgTag(sigd->digestAlgorithms, digestalgtag);
1054
1055 /* if not found, add a digest */
1056 if (n < 0) {
1057 if (SecCmsSignedDataAddDigest((SecArenaPoolRef)poolp, sigd, digestalgtag, digest) != SECSuccess)
1058 goto loser;
1059 } else {
1060 /* replace NULL pointer with digest item (and leak previous value) */
1061 sigd->digests[n] = digest;
1062 }
1063
1064 PORT_ArenaUnmark(poolp, mark);
1065 return SECSuccess;
1066
1067 loser:
1068 PORT_ArenaRelease(poolp, mark);
1069 return SECFailure;
1070 }
1071
1072 OSStatus
1073 SecCmsSignedDataAddDigest(SecArenaPoolRef pool,
1074 SecCmsSignedDataRef sigd,
1075 SECOidTag digestalgtag,
1076 CSSM_DATA_PTR digest)
1077 {
1078 PRArenaPool *poolp = (PRArenaPool *)pool;
1079 SECAlgorithmID *digestalg;
1080 void *mark;
1081
1082 mark = PORT_ArenaMark(poolp);
1083
1084 digestalg = PORT_ArenaZAlloc(poolp, sizeof(SECAlgorithmID));
1085 if (digestalg == NULL)
1086 goto loser;
1087
1088 if (SECOID_SetAlgorithmID (poolp, digestalg, digestalgtag, NULL) != SECSuccess) /* no params */
1089 goto loser;
1090
1091 if (SecCmsArrayAdd(poolp, (void ***)&(sigd->digestAlgorithms), (void *)digestalg) != SECSuccess ||
1092 /* even if digest is NULL, add dummy to have same-size array */
1093 SecCmsArrayAdd(poolp, (void ***)&(sigd->digests), (void *)digest) != SECSuccess)
1094 {
1095 goto loser;
1096 }
1097
1098 PORT_ArenaUnmark(poolp, mark);
1099 return SECSuccess;
1100
1101 loser:
1102 PORT_ArenaRelease(poolp, mark);
1103 return SECFailure;
1104 }
1105
1106 CSSM_DATA_PTR
1107 SecCmsSignedDataGetDigestValue(SecCmsSignedDataRef sigd, SECOidTag digestalgtag)
1108 {
1109 int n;
1110
1111 if (sigd->digestAlgorithms == NULL)
1112 return NULL;
1113
1114 n = SecCmsAlgArrayGetIndexByAlgTag(sigd->digestAlgorithms, digestalgtag);
1115
1116 return (n < 0) ? NULL : sigd->digests[n];
1117 }
1118
1119 /* =============================================================================
1120 * Misc. utility functions
1121 */
1122
1123 /*
1124 * SecCmsSignedDataCreateCertsOnly - create a certs-only SignedData.
1125 *
1126 * cert - base certificates that will be included
1127 * include_chain - if true, include the complete cert chain for cert
1128 *
1129 * More certs and chains can be added via AddCertificate and AddCertChain.
1130 *
1131 * An error results in a return value of NULL and an error set.
1132 *
1133 * XXXX CRLs
1134 */
1135 SecCmsSignedDataRef
1136 SecCmsSignedDataCreateCertsOnly(SecCmsMessageRef cmsg, SecCertificateRef cert, Boolean include_chain)
1137 {
1138 SecCmsSignedDataRef sigd;
1139 void *mark;
1140 PLArenaPool *poolp;
1141 OSStatus rv;
1142
1143 poolp = cmsg->poolp;
1144 mark = PORT_ArenaMark(poolp);
1145
1146 sigd = SecCmsSignedDataCreate(cmsg);
1147 if (sigd == NULL)
1148 goto loser;
1149
1150 /* no signerinfos, thus no digestAlgorithms */
1151
1152 /* but certs */
1153 if (include_chain) {
1154 rv = SecCmsSignedDataAddCertChain(sigd, cert);
1155 } else {
1156 rv = SecCmsSignedDataAddCertificate(sigd, cert);
1157 }
1158 if (rv != SECSuccess)
1159 goto loser;
1160
1161 /* RFC2630 5.2 sez:
1162 * In the degenerate case where there are no signers, the
1163 * EncapsulatedContentInfo value being "signed" is irrelevant. In this
1164 * case, the content type within the EncapsulatedContentInfo value being
1165 * "signed" should be id-data (as defined in section 4), and the content
1166 * field of the EncapsulatedContentInfo value should be omitted.
1167 */
1168 rv = SecCmsContentInfoSetContentData(cmsg, &(sigd->contentInfo), NULL, PR_TRUE);
1169 if (rv != SECSuccess)
1170 goto loser;
1171
1172 PORT_ArenaUnmark(poolp, mark);
1173 return sigd;
1174
1175 loser:
1176 if (sigd)
1177 SecCmsSignedDataDestroy(sigd);
1178 PORT_ArenaRelease(poolp, mark);
1179 return NULL;
1180 }
1181
1182 /*
1183 * Get SecCmsSignedDataRawCerts - obtain raw certs as a NULL_terminated array
1184 * of pointers.
1185 */
1186 extern OSStatus SecCmsSignedDataRawCerts(SecCmsSignedDataRef sigd,
1187 CSSM_DATA_PTR **rawCerts)
1188 {
1189 *rawCerts = sigd->rawCerts;
1190 return noErr;
1191 }
1192
1193 /* TODO:
1194 * SecCmsSignerInfoGetReceiptRequest()
1195 * SecCmsSignedDataHasReceiptRequest()
1196 * easy way to iterate over signers
1197 */
1198