cmsattr.c
上传用户:lyxiangda
上传日期:2007-01-12
资源大小:3042k
文件大小:12k
源码类别:

CA认证

开发平台:

WINDOWS

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