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