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