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