libsecurity_smime/lib/cmsattr.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 attributes.
  36  */
  37
  38 #include "cmslocal.h"
  39
  40 #include "secoid.h"
  41 #include "SecAsn1Item.h"
  42
  43 #include <security_asn1/secasn1.h>
  44 #include <security_asn1/secerr.h>
  45 #include <security_asn1/secport.h>
  46
  47 #include <Security/SecAsn1Templates.h>
  48
  49 /*
  50  * -------------------------------------------------------------------
  51  * XXX The following Attribute stuff really belongs elsewhere.
  52  * The Attribute type is *not* part of CMS but rather X.501.
  53  * But for now, since CMS is the only customer of attributes,
  54  * we define them here.  Once there is a use outside of CMS,
  55  * then change the attribute types and functions from internal
  56  * to external naming convention, and move them elsewhere!
  57  */
  58
  59
  60 /*
  61  * SecCmsAttributeCreate - create an attribute
  62  *
  63  * if value is NULL, the attribute won't have a value. It can be added later
  64  * with SecCmsAttributeAddValue.
  65  */
  66 SecCmsAttribute *
  67 SecCmsAttributeCreate(PRArenaPool *poolp, SECOidTag oidtag, SecAsn1Item * value, Boolean encoded)
  68 {
  69     SecCmsAttribute *attr;
  70     SecAsn1Item * copiedvalue;
  71     void *mark;
  72
  73     PORT_Assert (poolp != NULL);
  74
  75     mark = PORT_ArenaMark (poolp);
  76
  77     attr = (SecCmsAttribute *)PORT_ArenaZAlloc(poolp, sizeof(SecCmsAttribute));
  78     if (attr == NULL)
  79         goto loser;
  80
  81     attr->typeTag = SECOID_FindOIDByTag(oidtag);
  82     if (attr->typeTag == NULL)
  83         goto loser;
  84
  85     if (SECITEM_CopyItem(poolp, &(attr->type), &(attr->typeTag->oid)) != SECSuccess)
  86         goto loser;
  87
  88     if (value != NULL) {
  89         if ((copiedvalue = SECITEM_AllocItem(poolp, NULL, value->Length)) == NULL)
  90             goto loser;
  91
  92         if (SECITEM_CopyItem(poolp, copiedvalue, value) != SECSuccess)
  93             goto loser;
  94
  95         if (SecCmsArrayAdd(poolp, (void ***)&(attr->values), (void *)copiedvalue) != SECSuccess)
  96             goto loser;
  97     }
  98
  99     attr->encoded = encoded;
 100
 101     PORT_ArenaUnmark (poolp, mark);
 102
 103     return attr;
 104
 105 loser:
 106     PORT_Assert (mark != NULL);
 107     PORT_ArenaRelease (poolp, mark);
 108     return NULL;
 109 }
 110
 111 /*
 112  * SecCmsAttributeAddValue - add another value to an attribute
 113  */
 114 OSStatus
 115 SecCmsAttributeAddValue(PLArenaPool *poolp, SecCmsAttribute *attr, SecAsn1Item * value)
 116 {
 117     SecAsn1Item *copiedvalue;
 118     void *mark;
 119
 120     PORT_Assert (poolp != NULL);
 121
 122     mark = PORT_ArenaMark(poolp);
 123
 124     if (value != NULL) {
 125         if ((copiedvalue = SECITEM_AllocItem(poolp, NULL, value->Length)) == NULL)
 126             goto loser;
 127
 128         if (SECITEM_CopyItem(poolp, copiedvalue, value) != SECSuccess)
 129             goto loser;
 130
 131         if (SecCmsArrayAdd(poolp, (void ***)&(attr->values), (void *)copiedvalue) != SECSuccess)
 132             goto loser;
 133     }
 134
 135     PORT_ArenaUnmark(poolp, mark);
 136     return SECSuccess;
 137
 138 loser:
 139     PORT_Assert (mark != NULL);
 140     PORT_ArenaRelease (poolp, mark);
 141     return SECFailure;
 142 }
 143
 144 /*
 145  * SecCmsAttributeGetType - return the OID tag
 146  */
 147 SECOidTag
 148 SecCmsAttributeGetType(SecCmsAttribute *attr)
 149 {
 150     SECOidData *typetag;
 151
 152     typetag = SECOID_FindOID(&(attr->type));
 153     if (typetag == NULL)
 154         return SEC_OID_UNKNOWN;
 155
 156     return typetag->offset;
 157 }
 158
 159 /*
 160  * SecCmsAttributeGetValue - return the first attribute value
 161  *
 162  * We do some sanity checking first:
 163  * - Multiple values are *not* expected.
 164  * - Empty values are *not* expected.
 165  */
 166 SecAsn1Item *
 167 SecCmsAttributeGetValue(SecCmsAttribute *attr)
 168 {
 169     SecAsn1Item * value;
 170
 171     if (attr == NULL)
 172         return NULL;
 173
 174     value = attr->values[0];
 175
 176     if (value == NULL || value->Data == NULL || value->Length == 0)
 177         return NULL;
 178
 179     if (attr->values[1] != NULL)
 180         return NULL;
 181
 182     return value;
 183 }
 184
 185 /*
 186  * SecCmsAttributeCompareValue - compare the attribute's first value against data
 187  */
 188 Boolean
 189 SecCmsAttributeCompareValue(SecCmsAttribute *attr, SecAsn1Item * av)
 190 {
 191     SecAsn1Item * value;
 192
 193     if (attr == NULL)
 194         return PR_FALSE;
 195
 196     value = SecCmsAttributeGetValue(attr);
 197
 198     return (value != NULL && value->Length == av->Length &&
 199         PORT_Memcmp (value->Data, av->Data, value->Length) == 0);
 200 }
 201
 202 /*
 203  * templates and functions for separate ASN.1 encoding of attributes
 204  *
 205  * used in SecCmsAttributeArrayReorder
 206  */
 207
 208 /*
 209  * helper function for dynamic template determination of the attribute value
 210  */
 211 static const SecAsn1Template *
 212 cms_attr_choose_attr_value_template(void *src_or_dest, Boolean encoding, const char *buf, size_t len, void *dest)
 213 {
 214     const SecAsn1Template *theTemplate;
 215     SecCmsAttribute *attribute;
 216     SECOidData *oiddata;
 217     Boolean encoded;
 218
 219     PORT_Assert (src_or_dest != NULL);
 220     if (src_or_dest == NULL)
 221         return NULL;
 222
 223     attribute = (SecCmsAttribute *)src_or_dest;
 224
 225     if (encoding && attribute->encoded)
 226         /* we're encoding, and the attribute value is already encoded. */
 227         return SEC_ASN1_GET(kSecAsn1AnyTemplate);
 228
 229     /* get attribute's typeTag */
 230     oiddata = attribute->typeTag;
 231     if (oiddata == NULL) {
 232         oiddata = SECOID_FindOID(&attribute->type);
 233         attribute->typeTag = oiddata;
 234     }
 235
 236     if (oiddata == NULL) {
 237         /* still no OID tag? OID is unknown then. en/decode value as ANY. */
 238         encoded = PR_TRUE;
 239         theTemplate = SEC_ASN1_GET(kSecAsn1AnyTemplate);
 240     } else {
 241         switch (oiddata->offset) {
 242         case SEC_OID_PKCS9_SMIME_CAPABILITIES:
 243         case SEC_OID_SMIME_ENCRYPTION_KEY_PREFERENCE:
 244         case SEC_OID_APPLE_HASH_AGILITY_V2:
 245             /* these guys need to stay DER-encoded */
 246         default:
 247             /* same goes for OIDs that are not handled here */
 248             encoded = PR_TRUE;
 249             theTemplate = SEC_ASN1_GET(kSecAsn1AnyTemplate);
 250             break;
 251             /* otherwise choose proper template */
 252         case SEC_OID_PKCS9_EMAIL_ADDRESS:
 253         case SEC_OID_RFC1274_MAIL:
 254         case SEC_OID_PKCS9_UNSTRUCTURED_NAME:
 255             encoded = PR_FALSE;
 256             theTemplate = SEC_ASN1_GET(kSecAsn1IA5StringTemplate);
 257             break;
 258         case SEC_OID_PKCS9_CONTENT_TYPE:
 259             encoded = PR_FALSE;
 260             theTemplate = SEC_ASN1_GET(kSecAsn1ObjectIDTemplate);
 261             break;
 262         case SEC_OID_PKCS9_MESSAGE_DIGEST:
 263         case SEC_OID_APPLE_HASH_AGILITY:
 264             encoded = PR_FALSE;
 265             theTemplate = SEC_ASN1_GET(kSecAsn1OctetStringTemplate);
 266             break;
 267         case SEC_OID_PKCS9_SIGNING_TIME:
 268         case SEC_OID_APPLE_EXPIRATION_TIME:
 269             encoded = PR_FALSE;
 270             theTemplate = SEC_ASN1_GET(kSecAsn1UTCTimeTemplate); // @@@ This should be a choice between UTCTime and GeneralizedTime -- mb
 271             break;
 272           /* XXX Want other types here, too */
 273         }
 274     }
 275
 276     if (encoding) {
 277         /*
 278          * If we are encoding and we think we have an already-encoded value,
 279          * then the code which initialized this attribute should have set
 280          * the "encoded" property to true (and we would have returned early,
 281          * up above).  No devastating error, but that code should be fixed.
 282          * (It could indicate that the resulting encoded bytes are wrong.)
 283          */
 284         PORT_Assert (!encoded);
 285     } else {
 286         /*
 287          * We are decoding; record whether the resulting value is
 288          * still encoded or not.
 289          */
 290         attribute->encoded = encoded;
 291     }
 292     return theTemplate;
 293 }
 294
 295 static const SecAsn1TemplateChooserPtr cms_attr_chooser
 296         = cms_attr_choose_attr_value_template;
 297
 298 const SecAsn1Template nss_cms_attribute_template[] = {
 299     { SEC_ASN1_SEQUENCE,
 300           0, NULL, sizeof(SecCmsAttribute) },
 301     { SEC_ASN1_OBJECT_ID,
 302           offsetof(SecCmsAttribute,type) },
 303     { SEC_ASN1_DYNAMIC | SEC_ASN1_SET_OF,
 304           offsetof(SecCmsAttribute,values),
 305           &cms_attr_chooser },
 306     { 0 }
 307 };
 308
 309 const SecAsn1Template nss_cms_set_of_attribute_template[] = {
 310     { SEC_ASN1_SET_OF, 0, nss_cms_attribute_template }
 311 };
 312
 313 /* =============================================================================
 314  * Attribute Array methods
 315  */
 316
 317 /*
 318  * SecCmsAttributeArrayEncode - encode an Attribute array as SET OF Attributes
 319  *
 320  * If you are wondering why this routine does not reorder the attributes
 321  * first, and might be tempted to make it do so, see the comment by the
 322  * call to ReorderAttributes in cmsencode.c.  (Or, see who else calls this
 323  * and think long and hard about the implications of making it always
 324  * do the reordering.)
 325  */
 326 SecAsn1Item *
 327 SecCmsAttributeArrayEncode(PRArenaPool *poolp, SecCmsAttribute ***attrs, SecAsn1Item * dest)
 328 {
 329     return SEC_ASN1EncodeItem (poolp, dest, (void *)attrs, nss_cms_set_of_attribute_template);
 330 }
 331
 332 /*
 333  * SecCmsAttributeArrayReorder - sort attribute array by attribute's DER encoding
 334  *
 335  * make sure that the order of the attributes guarantees valid DER (which must be
 336  * in lexigraphically ascending order for a SET OF); if reordering is necessary it
 337  * will be done in place (in attrs).
 338  */
 339 OSStatus
 340 SecCmsAttributeArrayReorder(SecCmsAttribute **attrs)
 341 {
 342     return SecCmsArraySortByDER((void **)attrs, nss_cms_attribute_template, NULL);
 343 }
 344
 345 /*
 346  * SecCmsAttributeArrayFindAttrByOidTag - look through a set of attributes and
 347  * find one that matches the specified object ID.
 348  *
 349  * If "only" is true, then make sure that there is not more than one attribute
 350  * of the same type.  Otherwise, just return the first one found. (XXX Does
 351  * anybody really want that first-found behavior?  It was like that when I found it...)
 352  */
 353 SecCmsAttribute *
 354 SecCmsAttributeArrayFindAttrByOidTag(SecCmsAttribute **attrs, SECOidTag oidtag, Boolean only)
 355 {
 356     SECOidData *oid;
 357     SecCmsAttribute *attr1, *attr2;
 358
 359     if (attrs == NULL)
 360         return NULL;
 361
 362     oid = SECOID_FindOIDByTag(oidtag);
 363     if (oid == NULL)
 364         return NULL;
 365
 366     while ((attr1 = *attrs++) != NULL) {
 367         if (attr1->type.Length == oid->oid.Length && PORT_Memcmp (attr1->type.Data,
 368                                                             oid->oid.Data,
 369                                                             oid->oid.Length) == 0)
 370             break;
 371     }
 372
 373     if (attr1 == NULL)
 374         return NULL;
 375
 376     if (!only)
 377         return attr1;
 378
 379     while ((attr2 = *attrs++) != NULL) {
 380         if (attr2->type.Length == oid->oid.Length && PORT_Memcmp (attr2->type.Data,
 381                                                             oid->oid.Data,
 382                                                             oid->oid.Length) == 0)
 383             break;
 384     }
 385
 386     if (attr2 != NULL)
 387         return NULL;
 388
 389     return attr1;
 390 }
 391
 392 /*
 393  * SecCmsAttributeArrayAddAttr - add an attribute to an
 394  * array of attributes.
 395  */
 396 OSStatus
 397 SecCmsAttributeArrayAddAttr(PLArenaPool *poolp, SecCmsAttribute ***attrs, SecCmsAttribute *attr)
 398 {
 399     SecCmsAttribute *oattr;
 400     void *mark;
 401     SECOidTag type;
 402
 403     mark = PORT_ArenaMark(poolp);
 404
 405     /* find oidtag of attr */
 406     type = SecCmsAttributeGetType(attr);
 407
 408     /* see if we have one already */
 409     oattr = SecCmsAttributeArrayFindAttrByOidTag(*attrs, type, PR_FALSE);
 410     PORT_Assert (oattr == NULL);
 411     if (oattr != NULL)
 412         goto loser;     /* XXX or would it be better to replace it? */
 413
 414     /* no, shove it in */
 415     if (SecCmsArrayAdd(poolp, (void ***)attrs, (void *)attr) != SECSuccess)
 416         goto loser;
 417
 418     PORT_ArenaUnmark(poolp, mark);
 419     return SECSuccess;
 420
 421 loser:
 422     PORT_ArenaRelease(poolp, mark);
 423     return SECFailure;
 424 }
 425
 426 /*
 427  * SecCmsAttributeArraySetAttr - set an attribute's value in a set of attributes
 428  */
 429 OSStatus
 430 SecCmsAttributeArraySetAttr(PLArenaPool *poolp, SecCmsAttribute ***attrs, SECOidTag type, SecAsn1Item * value, Boolean encoded)
 431 {
 432     SecCmsAttribute *attr;
 433     void *mark;
 434
 435     mark = PORT_ArenaMark(poolp);
 436
 437     /* see if we have one already */
 438     attr = SecCmsAttributeArrayFindAttrByOidTag(*attrs, type, PR_FALSE);
 439     if (attr == NULL) {
 440         /* not found? create one! */
 441         attr = SecCmsAttributeCreate(poolp, type, value, encoded);
 442         if (attr == NULL)
 443             goto loser;
 444         /* and add it to the list */
 445         if (SecCmsArrayAdd(poolp, (void ***)attrs, (void *)attr) != SECSuccess)
 446             goto loser;
 447     } else {
 448         /* found, shove it in */
 449         /* XXX we need a decent memory model @#$#$!#!!! */
 450         attr->values[0] = value;
 451         attr->encoded = encoded;
 452     }
 453
 454     PORT_ArenaUnmark (poolp, mark);
 455     return SECSuccess;
 456
 457 loser:
 458     PORT_ArenaRelease (poolp, mark);
 459     return SECFailure;
 460 }
 461