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(SecCmsSignedDataRef signedData, 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(signedData && messageImprint, xit);
 235
 236     SECAlgorithmID **digestAlgorithms = SecCmsSignedDataGetDigestAlgs(signedData);
 237     require(digestAlgorithms, xit);
 238
 239     SecCmsDigestContextRef digcx = SecCmsDigestContextStartMultiple(digestAlgorithms);
 240     require(digcx, xit);
 241     require(encDigest, xit);
 242
 243     SecCmsSignerInfoRef signerinfo = SecCmsSignedDataGetSignerInfo(signedData, 0);  // NB - assume 1 signer only!
 244     messageImprint->hashAlgorithm = signerinfo->digestAlg;
 245
 246     SecCmsDigestContextUpdate(digcx, encDigest->Data, encDigest->Length);
 247
 248     require_noerr(SecCmsDigestContextFinishSingle(digcx, (SecArenaPoolRef)signedData->cmsg->poolp,
 249         &messageImprint->hashedMessage), xit);
 250
 251     status = SECSuccess;
 252 xit:
 253     return status;
 254 }
 255
 256 #include <Security/SecAsn1Templates.h>
 257
 258 #ifndef NDEBUG
 259 static OSStatus decodeDERUTF8String(const CSSM_DATA_PTR content, char *statusstr, size_t strsz)
 260 {
 261     // The statusString should use kSecAsn1SequenceOfUTF8StringTemplate, but doesn't
 262     OSStatus status = SECFailure;
 263     SecAsn1CoderRef coder = NULL;
 264     CSSM_DATA statusString;
 265     size_t len = 0;
 266
 267     require(content && statusstr, xit);
 268
 269     require_noerr(SecAsn1CoderCreate(&coder), xit);
 270     require_noerr(SecAsn1Decode(coder, content->Data, content->Length, kSecAsn1UTF8StringTemplate, &statusString), xit);
 271     status = 0;
 272     len = (statusString.Length < strsz)?(int)statusString.Length:strsz;
 273     if (statusstr && statusString.Data)
 274         strncpy(statusstr, (const char *)statusString.Data, len);
 275
 276 xit:
 277     if (coder)
 278         SecAsn1CoderRelease(coder);
 279     return status;
 280 }
 281 #endif
 282
 283 static OSStatus validateTSAResponseAndAddTimeStamp(SecCmsSignerInfoRef signerinfo, CSSM_DATA_PTR tsaResponse,
 284     uint64_t expectedNonce)
 285 {
 286     OSStatus status = SECFailure;
 287     SecAsn1CoderRef coder = NULL;
 288     SecAsn1TimeStampRespDER respDER = {{{0}},};
 289     SecAsn1TSAPKIStatusInfo *tsastatus = NULL;
 290     int respstatus = -1;
 291 #ifndef NDEBUG
 292     int failinfo = -1;
 293 #endif
 294
 295     require_action(tsaResponse && tsaResponse->Data && tsaResponse->Length, xit, status = errSecTimestampMissing);
 296
 297     require_noerr(SecAsn1CoderCreate(&coder), xit);
 298     require_noerr(SecTSAResponseCopyDEREncoding(coder, tsaResponse, &respDER), xit);
 299
 300 #ifndef NDEBUG
 301     tsaWriteFileX("/tmp/tsa-timeStampToken.der", respDER.timeStampTokenDER.Data, respDER.timeStampTokenDER.Length);
 302 #endif
 303
 304     tsastatus = (SecAsn1TSAPKIStatusInfo *)&respDER.status;
 305     require_action(tsastatus->status.Data, xit, status = errSecTimestampBadDataFormat);
 306     respstatus = (int)tsaDER_ToInt(&tsastatus->status);
 307
 308 #ifndef NDEBUG
 309     char buf[80]={0,};
 310     if (tsastatus->failInfo.Data)   // e.g. FI_BadRequest
 311         failinfo = (int)tsaDER_ToInt(&tsastatus->failInfo);
 312
 313     if (tsastatus->statusString.Data && tsastatus->statusString.Length)
 314     {
 315         OSStatus strrx = decodeDERUTF8String(&tsastatus->statusString, buf, sizeof(buf));
 316         dprintf("decodeDERUTF8String status: %d\n", (int)strrx);
 317     }
 318
 319     dprintf("validateTSAResponse: status: %d, failinfo: %d, %s\n", respstatus, failinfo, buf);
 320 #endif
 321
 322     switch (respstatus)
 323     {
 324     case PKIS_Granted:
 325     case PKIS_GrantedWithMods:  // Success
 326         status = noErr;
 327         break;
 328     case PKIS_Rejection:
 329         status = errSecTimestampRejection;
 330         break;
 331     case PKIS_Waiting:
 332         status = errSecTimestampWaiting;
 333         break;
 334     case PKIS_RevocationWarning:
 335         status = errSecTimestampRevocationWarning;
 336         break;
 337     case PKIS_RevocationNotification:
 338         status = errSecTimestampRevocationNotification;
 339         break;
 340     default:
 341         status = errSecTimestampSystemFailure;
 342         break;
 343     }
 344     require_noerr(status, xit);
 345
 346     // If we succeeded, then we must have a TimeStampToken
 347
 348     require_action(respDER.timeStampTokenDER.Data && respDER.timeStampTokenDER.Length, xit, status = errSecTimestampBadDataFormat);
 349
 350     dprintf("timestamp full expected nonce: %lld\n", expectedNonce);
 351
 352     /*
 353         The bytes in respDER are a full CMS message, which we need to check now for validity.
 354         The code for this is essentially the same code taht is done during a timestamp
 355         verify, except that we also need to check the nonce.
 356     */
 357     require_noerr(status = decodeTimeStampToken(signerinfo, &respDER.timeStampTokenDER, NULL, expectedNonce), xit);
 358
 359     status = SecCmsSignerInfoAddTimeStamp(signerinfo, &respDER.timeStampTokenDER);
 360
 361 xit:
 362     if (coder)
 363         SecAsn1CoderRelease(coder);
 364     return status;
 365 }
 366
 367 static OSStatus getRandomNonce(uint64_t *nonce)
 368 {
 369     return nonce ? CCRandomCopyBytes(kCCRandomDevRandom, (void *)nonce, sizeof(*nonce)) : SECFailure;
 370 }
 371
 372 static OSStatus remapTimestampError(OSStatus inStatus)
 373 {
 374     /*
 375         Since communicating with the timestamp server is perhaps an unexpected
 376         dependency on the network, map unknown errors into something to indicate
 377         that signing without a timestamp may be a workaround. In particular, the
 378         private CFURL errors (see CFNetworkErrorsPriv.i)
 379
 380         kCFURLErrorTimedOut               = -1001,
 381         kCFURLErrorNotConnectedToInternet = -1009,
 382
 383         are remapped to errSecTimestampServiceNotAvailable.
 384     */
 385
 386     switch (inStatus)
 387     {
 388     case errSecTimestampMissing:
 389     case errSecTimestampInvalid:
 390     case errSecTimestampNotTrusted:
 391     case errSecTimestampServiceNotAvailable:
 392     case errSecTimestampBadAlg:
 393     case errSecTimestampBadRequest:
 394     case errSecTimestampBadDataFormat:
 395     case errSecTimestampTimeNotAvailable:
 396     case errSecTimestampUnacceptedPolicy:
 397     case errSecTimestampUnacceptedExtension:
 398     case errSecTimestampAddInfoNotAvailable:
 399     case errSecTimestampSystemFailure:
 400     case errSecSigningTimeMissing:
 401     case errSecTimestampRejection:
 402     case errSecTimestampWaiting:
 403     case errSecTimestampRevocationWarning:
 404     case errSecTimestampRevocationNotification:
 405         return inStatus;
 406     default:
 407         return errSecTimestampServiceNotAvailable;
 408     }
 409     return errSecTimestampServiceNotAvailable;
 410 }
 411
 412 /*
 413  * SecCmsSignedDataEncodeAfterData - do all the necessary things to a SignedData
 414  *     after all the encapsulated data was passed through the encoder.
 415  *
 416  * In detail:
 417  *  - create the signatures in all the SignerInfos
 418  *
 419  * Please note that nothing is done to the Certificates and CRLs in the message - this
 420  * is entirely the responsibility of our callers.
 421  */
 422 OSStatus
 423 SecCmsSignedDataEncodeAfterData(SecCmsSignedDataRef sigd)
 424 {
 425     SecCmsSignerInfoRef *signerinfos, signerinfo;
 426     SecCmsContentInfoRef cinfo;
 427     SECOidTag digestalgtag;
 428     OSStatus ret = SECFailure;
 429     OSStatus rv;
 430     CSSM_DATA_PTR contentType;
 431     int certcount;
 432     int i, ci, n, rci, si;
 433     PLArenaPool *poolp;
 434     CFArrayRef certlist;
 435     extern const SecAsn1Template SecCmsSignerInfoTemplate[];
 436
 437     poolp = sigd->cmsg->poolp;
 438     cinfo = &(sigd->contentInfo);
 439
 440     /* did we have digest calculation going on? */
 441     if (cinfo->digcx) {
 442         rv = SecCmsDigestContextFinishMultiple(cinfo->digcx, (SecArenaPoolRef)poolp, &(sigd->digests));
 443         if (rv != SECSuccess)
 444             goto loser;         /* error has been set by SecCmsDigestContextFinishMultiple */
 445         cinfo->digcx = NULL;
 446     }
 447
 448     signerinfos = sigd->signerInfos;
 449     certcount = 0;
 450
 451     /* prepare all the SignerInfos (there may be none) */
 452     for (i=0; i < SecCmsSignedDataSignerInfoCount(sigd); i++) {
 453         signerinfo = SecCmsSignedDataGetSignerInfo(sigd, i);
 454
 455         /* find correct digest for this signerinfo */
 456         digestalgtag = SecCmsSignerInfoGetDigestAlgTag(signerinfo);
 457         n = SecCmsAlgArrayGetIndexByAlgTag(sigd->digestAlgorithms, digestalgtag);
 458         if (n < 0 || sigd->digests == NULL || sigd->digests[n] == NULL) {
 459             /* oops - digest not found */
 460             PORT_SetError(SEC_ERROR_DIGEST_NOT_FOUND);
 461             goto loser;
 462         }
 463
 464         /* XXX if our content is anything else but data, we need to force the
 465          * presence of signed attributes (RFC2630 5.3 "signedAttributes is a
 466          * collection...") */
 467
 468         /* pass contentType here as we want a contentType attribute */
 469         if ((contentType = SecCmsContentInfoGetContentTypeOID(cinfo)) == NULL)
 470             goto loser;
 471
 472         /* sign the thing */
 473         rv = SecCmsSignerInfoSign(signerinfo, sigd->digests[n], contentType);
 474         if (rv != SECSuccess)
 475             goto loser;
 476
 477         /* while we're at it, count number of certs in certLists */
 478         certlist = SecCmsSignerInfoGetCertList(signerinfo);
 479         if (certlist)
 480             certcount += CFArrayGetCount(certlist);
 481     }
 482
 483     /* Now we can get a timestamp, since we have all the digests */
 484
 485     // We force the setting of a callback, since this is the most usual case
 486     if (!sigd->cmsg->tsaCallback)
 487         SecCmsMessageSetTSACallback(sigd->cmsg, (SecCmsTSACallback)SecCmsTSADefaultCallback);
 488
 489     if (sigd->cmsg->tsaCallback && sigd->cmsg->tsaContext)
 490     {
 491         CSSM_DATA tsaResponse = {0,};
 492         SecAsn1TSAMessageImprint messageImprint = {{{0},},{0,}};
 493         // <rdar://problem/11073466> Add nonce support for timestamping client
 494
 495         uint64_t nonce = 0;
 496
 497         require_noerr(getRandomNonce(&nonce), tsxit);
 498         dprintf("SecCmsSignedDataSignerInfoCount: %d\n", SecCmsSignedDataSignerInfoCount(sigd));
 499
 500         // Calculate hash of encDigest and put in messageImprint.hashedMessage
 501         SecCmsSignerInfoRef signerinfo = SecCmsSignedDataGetSignerInfo(sigd, 0);    // NB - assume 1 signer only!
 502         CSSM_DATA *encDigest = SecCmsSignerInfoGetEncDigest(signerinfo);
 503         require_noerr(createTSAMessageImprint(sigd, encDigest, &messageImprint), tsxit);
 504
 505         // Callback to fire up XPC service to talk to TimeStamping server, etc.
 506         require_noerr(rv =(*sigd->cmsg->tsaCallback)(sigd->cmsg->tsaContext, &messageImprint,
 507                                                      nonce, &tsaResponse), tsxit);
 508
 509         require_noerr(rv = validateTSAResponseAndAddTimeStamp(signerinfo, &tsaResponse, nonce), tsxit);
 510
 511         /*
 512             It is likely that every occurrence of "goto loser" in this file should
 513             also do a PORT_SetError. Since it is not clear what might depend on this
 514             behavior, we just do this in the timestamping case.
 515         */
 516 tsxit:
 517         if (rv)
 518         {
 519             dprintf("Original timestamp error: %d\n", (int)rv);
 520             rv = remapTimestampError(rv);
 521             PORT_SetError(rv);
 522             goto loser;
 523         }
 524     }
 525
 526     /* this is a SET OF, so we need to sort them guys */
 527     rv = SecCmsArraySortByDER((void **)signerinfos, SecCmsSignerInfoTemplate, NULL);
 528     if (rv != SECSuccess)
 529         goto loser;
 530
 531     /*
 532      * now prepare certs & crls
 533      */
 534
 535     /* count the rest of the certs */
 536     if (sigd->certs != NULL)
 537         certcount += CFArrayGetCount(sigd->certs);
 538
 539     if (certcount == 0) {
 540         sigd->rawCerts = NULL;
 541     } else {
 542         /*
 543          * Combine all of the certs and cert chains into rawcerts.
 544          * Note: certcount is an upper bound; we may not need that many slots
 545          * but we will allocate anyway to avoid having to do another pass.
 546          * (The temporary space saving is not worth it.)
 547          *
 548          * XXX ARGH - this NEEDS to be fixed. need to come up with a decent
 549          *  SetOfDERcertficates implementation
 550          */
 551         sigd->rawCerts = (CSSM_DATA_PTR *)PORT_ArenaAlloc(poolp, (certcount + 1) * sizeof(CSSM_DATA_PTR));
 552         if (sigd->rawCerts == NULL)
 553             return SECFailure;
 554
 555         /*
 556          * XXX Want to check for duplicates and not add *any* cert that is
 557          * already in the set.  This will be more important when we start
 558          * dealing with larger sets of certs, dual-key certs (signing and
 559          * encryption), etc.  For the time being we can slide by...
 560          *
 561          * XXX ARGH - this NEEDS to be fixed. need to come up with a decent
 562          *  SetOfDERcertficates implementation
 563          */
 564         rci = 0;
 565         if (signerinfos != NULL) {
 566             for (si = 0; signerinfos[si] != NULL; si++) {
 567                 signerinfo = signerinfos[si];
 568                 for (ci = 0; ci < CFArrayGetCount(signerinfo->certList); ci++) {
 569                     sigd->rawCerts[rci] = PORT_ArenaZAlloc(poolp, sizeof(CSSM_DATA));
 570                     SecCertificateRef cert = (SecCertificateRef)CFArrayGetValueAtIndex(signerinfo->certList, ci);
 571                     SecCertificateGetData(cert, sigd->rawCerts[rci++]);
 572                 }
 573             }
 574         }
 575
 576         if (sigd->certs != NULL) {
 577             for (ci = 0; ci < CFArrayGetCount(sigd->certs); ci++) {
 578                 sigd->rawCerts[rci] = PORT_ArenaZAlloc(poolp, sizeof(CSSM_DATA));
 579                 SecCertificateRef cert = (SecCertificateRef)CFArrayGetValueAtIndex(sigd->certs, ci);
 580                 SecCertificateGetData(cert, sigd->rawCerts[rci++]);
 581             }
 582         }
 583
 584         sigd->rawCerts[rci] = NULL;
 585
 586         /* this is a SET OF, so we need to sort them guys - we have the DER already, though */
 587         SecCmsArraySort((void **)sigd->rawCerts, SecCmsUtilDERCompare, NULL, NULL);
 588     }
 589
 590     ret = SECSuccess;
 591
 592 loser:
 593
 594     dprintf("SecCmsSignedDataEncodeAfterData: ret: %ld, rv: %ld\n", (long)ret, (long)rv);
 595     return ret;
 596 }
 597
 598 OSStatus
 599 SecCmsSignedDataDecodeBeforeData(SecCmsSignedDataRef sigd)
 600 {
 601     /* set up the digests */
 602     if (sigd->digestAlgorithms != NULL && sigd->digests == NULL) {
 603         /* if digests are already there, do nothing */
 604         sigd->contentInfo.digcx = SecCmsDigestContextStartMultiple(sigd->digestAlgorithms);
 605         if (sigd->contentInfo.digcx == NULL)
 606             return SECFailure;
 607     }
 608     return SECSuccess;
 609 }
 610
 611 /*
 612  * SecCmsSignedDataDecodeAfterData - do all the necessary things to a SignedData
 613  *     after all the encapsulated data was passed through the decoder.
 614  */
 615 OSStatus
 616 SecCmsSignedDataDecodeAfterData(SecCmsSignedDataRef sigd)
 617 {
 618     /* did we have digest calculation going on? */
 619     if (sigd->contentInfo.digcx) {
 620         if (SecCmsDigestContextFinishMultiple(sigd->contentInfo.digcx, (SecArenaPoolRef)sigd->cmsg->poolp, &(sigd->digests)) != SECSuccess)
 621             return SECFailure;  /* error has been set by SecCmsDigestContextFinishMultiple */
 622         sigd->contentInfo.digcx = NULL;
 623     }
 624     return SECSuccess;
 625 }
 626
 627 /*
 628  * SecCmsSignedDataDecodeAfterEnd - do all the necessary things to a SignedData
 629  *     after all decoding is finished.
 630  */
 631 OSStatus
 632 SecCmsSignedDataDecodeAfterEnd(SecCmsSignedDataRef sigd)
 633 {
 634     SecCmsSignerInfoRef *signerinfos;
 635     int i;
 636
 637     if (!sigd) {
 638         return SECFailure;
 639     }
 640
 641     signerinfos = sigd->signerInfos;
 642
 643     /* set cmsg and sigd backpointers for all the signerinfos */
 644     if (signerinfos) {
 645         for (i = 0; signerinfos[i] != NULL; i++) {
 646             signerinfos[i]->cmsg = sigd->cmsg;
 647             signerinfos[i]->sigd = sigd;
 648         }
 649     }
 650
 651     return SECSuccess;
 652 }
 653
 654 /*
 655  * SecCmsSignedDataGetSignerInfos - retrieve the SignedData's signer list
 656  */
 657 SecCmsSignerInfoRef *
 658 SecCmsSignedDataGetSignerInfos(SecCmsSignedDataRef sigd)
 659 {
 660     return sigd->signerInfos;
 661 }
 662
 663 int
 664 SecCmsSignedDataSignerInfoCount(SecCmsSignedDataRef sigd)
 665 {
 666     return SecCmsArrayCount((void **)sigd->signerInfos);
 667 }
 668
 669 SecCmsSignerInfoRef
 670 SecCmsSignedDataGetSignerInfo(SecCmsSignedDataRef sigd, int i)
 671 {
 672     return sigd->signerInfos[i];
 673 }
 674
 675 /*
 676  * SecCmsSignedDataGetDigestAlgs - retrieve the SignedData's digest algorithm list
 677  */
 678 SECAlgorithmID **
 679 SecCmsSignedDataGetDigestAlgs(SecCmsSignedDataRef sigd)
 680 {
 681     return sigd->digestAlgorithms;
 682 }
 683
 684 /*
 685  * SecCmsSignedDataGetContentInfo - return pointer to this signedData's contentinfo
 686  */
 687 SecCmsContentInfoRef
 688 SecCmsSignedDataGetContentInfo(SecCmsSignedDataRef sigd)
 689 {
 690     return &(sigd->contentInfo);
 691 }
 692
 693 /*
 694  * SecCmsSignedDataGetCertificateList - retrieve the SignedData's certificate list
 695  */
 696 CSSM_DATA_PTR *
 697 SecCmsSignedDataGetCertificateList(SecCmsSignedDataRef sigd)
 698 {
 699     return sigd->rawCerts;
 700 }
 701
 702 OSStatus
 703 SecCmsSignedDataImportCerts(SecCmsSignedDataRef sigd, SecKeychainRef keychain,
 704                                 SECCertUsage certusage, Boolean keepcerts)
 705 {
 706     int certcount;
 707     OSStatus rv;
 708     int i;
 709
 710     certcount = SecCmsArrayCount((void **)sigd->rawCerts);
 711
 712     rv = CERT_ImportCerts(keychain, certusage, certcount, sigd->rawCerts, NULL,
 713                           keepcerts, PR_FALSE, NULL);
 714
 715     /* XXX CRL handling */
 716
 717     if (sigd->signerInfos != NULL) {
 718         /* fill in all signerinfo's certs */
 719         for (i = 0; sigd->signerInfos[i] != NULL; i++)
 720             (void)SecCmsSignerInfoGetSigningCertificate(sigd->signerInfos[i], keychain);
 721     }
 722
 723     return rv;
 724 }
 725
 726 /*
 727  * XXX the digests need to be passed in BETWEEN the decoding and the verification in case
 728  *     of external signatures!
 729  */
 730
 731 /*
 732  * SecCmsSignedDataVerifySignerInfo - check the signatures.
 733  *
 734  * The digests were either calculated during decoding (and are stored in the
 735  * signedData itself) or set after decoding using SecCmsSignedDataSetDigests.
 736  *
 737  * The verification checks if the signing cert is valid and has a trusted chain
 738  * for the purpose specified by "policies".
 739  *
 740  * If trustRef is NULL the cert chain is verified and the VerificationStatus is set accordingly.
 741  * Otherwise a SecTrust object is returned for the caller to evaluate using SecTrustEvaluate().
 742  */
 743 OSStatus
 744 SecCmsSignedDataVerifySignerInfo(SecCmsSignedDataRef sigd, int i,
 745                             SecKeychainRef keychainOrArray, CFTypeRef policies, SecTrustRef *trustRef)
 746 {
 747     SecCmsSignerInfoRef signerinfo;
 748     SecCmsContentInfoRef cinfo;
 749     SECOidData *algiddata;
 750     CSSM_DATA_PTR contentType, digest;
 751     OSStatus status, status2;
 752
 753     cinfo = &(sigd->contentInfo);
 754
 755     signerinfo = sigd->signerInfos[i];
 756
 757     /* Signature or digest level verificationStatus errors should supercede
 758        certificate level errors, so check the digest and signature first.  */
 759
 760     /* Find digest and contentType for signerinfo */
 761     algiddata = SecCmsSignerInfoGetDigestAlg(signerinfo);
 762     if (algiddata == NULL) {
 763         return errSecInternalError; // shouldn't have happened, this is likely due to corrupted data
 764     }
 765
 766     digest = SecCmsSignedDataGetDigestByAlgTag(sigd, algiddata->offset);
 767         if(digest == NULL) {
 768                 /*
 769                  * No digests; this probably had detached content the caller has to
 770                  * deal with.
 771                  * FIXME: need some error return for this (as well as many
 772                  * other places in this library).
 773                  */
 774                 return errSecDataNotAvailable;
 775         }
 776     contentType = SecCmsContentInfoGetContentTypeOID(cinfo);
 777
 778     /* verify signature */
 779     CFTypeRef timeStampPolicies=SecPolicyCreateAppleTimeStampingAndRevocationPolicies(policies);
 780     status = SecCmsSignerInfoVerifyWithPolicy(signerinfo, timeStampPolicies, digest, contentType);
 781     CFReleaseSafe(timeStampPolicies);
 782
 783     /* Now verify the certificate.  We do this even if the signature failed to verify so we can
 784        return a trustRef to the caller for display purposes.  */
 785     status2 = SecCmsSignerInfoVerifyCertificate(signerinfo, keychainOrArray,
 786         policies, trustRef);
 787     dprintf("SecCmsSignedDataVerifySignerInfo: status %d status2 %d\n", (int) status, (int)status2);
 788     /* The error from SecCmsSignerInfoVerify() supercedes error from SecCmsSignerInfoVerifyCertificate(). */
 789     if (status)
 790         return status;
 791
 792     return status2;
 793 }
 794
 795 /*
 796  * SecCmsSignedDataVerifyCertsOnly - verify the certs in a certs-only message
 797  */
 798 OSStatus
 799 SecCmsSignedDataVerifyCertsOnly(SecCmsSignedDataRef sigd,
 800                                   SecKeychainRef keychainOrArray,
 801                                   CFTypeRef policies)
 802 {
 803     SecCertificateRef cert;
 804     OSStatus rv = SECSuccess;
 805     int i;
 806     int count;
 807
 808     if (!sigd || !keychainOrArray || !sigd->rawCerts) {
 809         PORT_SetError(SEC_ERROR_INVALID_ARGS);
 810         return SECFailure;
 811     }
 812
 813     count = SecCmsArrayCount((void**)sigd->rawCerts);
 814     for (i=0; i < count; i++) {
 815         if (sigd->certs && CFArrayGetCount(sigd->certs) > i) {
 816             cert = (SecCertificateRef)CFArrayGetValueAtIndex(sigd->certs, i);
 817             CFRetain(cert);
 818         } else {
 819             cert = CERT_FindCertByDERCert(keychainOrArray, sigd->rawCerts[i]);
 820             if (!cert) {
 821                 rv = SECFailure;
 822                 break;
 823             }
 824         }
 825         rv |= CERT_VerifyCert(keychainOrArray, cert, sigd->rawCerts,
 826             policies, CFAbsoluteTimeGetCurrent(), NULL);
 827         CFRelease(cert);
 828     }
 829
 830     return rv;
 831 }
 832
 833 /*
 834  * SecCmsSignedDataHasDigests - see if we have digests in place
 835  */
 836 Boolean
 837 SecCmsSignedDataHasDigests(SecCmsSignedDataRef sigd)
 838 {
 839     return (sigd->digests != NULL);
 840 }
 841
 842 OSStatus
 843 SecCmsSignedDataAddCertList(SecCmsSignedDataRef sigd, CFArrayRef certlist)
 844 {
 845     PORT_Assert(certlist != NULL);
 846
 847     if (certlist == NULL)
 848         return SECFailure;
 849
 850     if (!sigd->certs)
 851         sigd->certs = CFArrayCreateMutableCopy(NULL, 0, certlist);
 852     else
 853     {
 854         CFRange certlistRange = { 0, CFArrayGetCount(certlist) };
 855         CFArrayAppendArray(sigd->certs, certlist, certlistRange);
 856     }
 857
 858     return SECSuccess;
 859 }
 860
 861 /*
 862  * SecCmsSignedDataAddCertChain - add cert and its entire chain to the set of certs
 863  */
 864 OSStatus
 865 SecCmsSignedDataAddCertChain(SecCmsSignedDataRef sigd, SecCertificateRef cert)
 866 {
 867     CFArrayRef certlist;
 868     SECCertUsage usage;
 869     OSStatus rv;
 870
 871     usage = certUsageEmailSigner;
 872
 873     /* do not include root */
 874     certlist = CERT_CertChainFromCert(cert, usage, PR_FALSE);
 875     if (certlist == NULL)
 876         return SECFailure;
 877
 878     rv = SecCmsSignedDataAddCertList(sigd, certlist);
 879     CFRelease(certlist);
 880
 881     return rv;
 882 }
 883
 884 OSStatus
 885 SecCmsSignedDataAddCertificate(SecCmsSignedDataRef sigd, SecCertificateRef cert)
 886 {
 887     PORT_Assert(cert != NULL);
 888
 889     if (cert == NULL)
 890         return SECFailure;
 891
 892     if (!sigd->certs)
 893         sigd->certs = CFArrayCreateMutable(NULL, 0, &kCFTypeArrayCallBacks);
 894
 895     CFArrayAppendValue(sigd->certs, cert);
 896
 897     return SECSuccess;
 898 }
 899
 900 Boolean
 901 SecCmsSignedDataContainsCertsOrCrls(SecCmsSignedDataRef sigd)
 902 {
 903     if (sigd->rawCerts != NULL && sigd->rawCerts[0] != NULL)
 904         return PR_TRUE;
 905     else if (sigd->rawCrls != NULL && sigd->rawCrls[0] != NULL)
 906         return PR_TRUE;
 907     else
 908         return PR_FALSE;
 909 }
 910
 911 OSStatus
 912 SecCmsSignedDataAddSignerInfo(SecCmsSignedDataRef sigd,
 913                                 SecCmsSignerInfoRef signerinfo)
 914 {
 915     void *mark;
 916     OSStatus rv;
 917     SECOidTag digestalgtag;
 918     PLArenaPool *poolp;
 919
 920     poolp = sigd->cmsg->poolp;
 921
 922     mark = PORT_ArenaMark(poolp);
 923
 924     /* add signerinfo */
 925     rv = SecCmsArrayAdd(poolp, (void ***)&(sigd->signerInfos), (void *)signerinfo);
 926     if (rv != SECSuccess)
 927         goto loser;
 928
 929     signerinfo->sigd = sigd;
 930
 931     /*
 932      * add empty digest
 933      * Empty because we don't have it yet. Either it gets created during encoding
 934      * (if the data is present) or has to be set externally.
 935      * XXX maybe pass it in optionally?
 936      */
 937     digestalgtag = SecCmsSignerInfoGetDigestAlgTag(signerinfo);
 938     rv = SecCmsSignedDataSetDigestValue(sigd, digestalgtag, NULL);
 939     if (rv != SECSuccess)
 940         goto loser;
 941
 942     /*
 943      * The last thing to get consistency would be adding the digest.
 944      */
 945
 946     PORT_ArenaUnmark(poolp, mark);
 947     return SECSuccess;
 948
 949 loser:
 950     PORT_ArenaRelease (poolp, mark);
 951     return SECFailure;
 952 }
 953
 954 CSSM_DATA_PTR
 955 SecCmsSignedDataGetDigestByAlgTag(SecCmsSignedDataRef sigd, SECOidTag algtag)
 956 {
 957     int idx;
 958
 959         if(sigd->digests == NULL) {
 960                 return NULL;
 961         }
 962     idx = SecCmsAlgArrayGetIndexByAlgTag(sigd->digestAlgorithms, algtag);
 963     return (idx >= 0) ? sigd->digests[idx] : NULL;
 964 }
 965
 966 /*
 967  * SecCmsSignedDataSetDigests - set a signedData's digests member
 968  *
 969  * "digestalgs" - array of digest algorithm IDs
 970  * "digests"    - array of digests corresponding to the digest algorithms
 971  */
 972 OSStatus
 973 SecCmsSignedDataSetDigests(SecCmsSignedDataRef sigd,
 974                                 SECAlgorithmID **digestalgs,
 975                                 CSSM_DATA_PTR *digests)
 976 {
 977     int cnt, i, idx;
 978
 979     if (sigd->digestAlgorithms == 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