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