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

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.  * Support for DEcoding ASN.1 data based on BER/DER (Basic/Distinguished
  35.  * Encoding Rules).
  36.  *
  37.  * $Id: secasn1d.c,v 1.4 2000/06/20 13:24:01 chrisk%netscape.com Exp $
  38.  */
  39. #include "secasn1.h"
  40. #include "secerr.h"
  41. typedef enum {
  42.     beforeIdentifier,
  43.     duringIdentifier,
  44.     afterIdentifier,
  45.     beforeLength,
  46.     duringLength,
  47.     afterLength,
  48.     beforeBitString,
  49.     duringBitString,
  50.     duringConstructedString,
  51.     duringGroup,
  52.     duringLeaf,
  53.     duringSaveEncoding,
  54.     duringSequence,
  55.     afterConstructedString,
  56.     afterGroup,
  57.     afterExplicit,
  58.     afterImplicit,
  59.     afterInline,
  60.     afterPointer,
  61.     afterSaveEncoding,
  62.     beforeEndOfContents,
  63.     duringEndOfContents,
  64.     afterEndOfContents,
  65.     beforeChoice,
  66.     duringChoice,
  67.     afterChoice,
  68.     notInUse
  69. } sec_asn1d_parse_place;
  70. #ifdef DEBUG_ASN1D_STATES
  71. static const char *place_names[] = {
  72.     "beforeIdentifier",
  73.     "duringIdentifier",
  74.     "afterIdentifier",
  75.     "beforeLength",
  76.     "duringLength",
  77.     "afterLength",
  78.     "beforeBitString",
  79.     "duringBitString",
  80.     "duringConstructedString",
  81.     "duringGroup",
  82.     "duringLeaf",
  83.     "duringSaveEncoding",
  84.     "duringSequence",
  85.     "afterConstructedString",
  86.     "afterGroup",
  87.     "afterExplicit",
  88.     "afterImplicit",
  89.     "afterInline",
  90.     "afterPointer",
  91.     "afterSaveEncoding",
  92.     "beforeEndOfContents",
  93.     "duringEndOfContents",
  94.     "afterEndOfContents",
  95.     "beforeChoice",
  96.     "duringChoice",
  97.     "afterChoice",
  98.     "notInUse"
  99. };
  100. #endif /* DEBUG_ASN1D_STATES */
  101. typedef enum {
  102.     allDone,
  103.     decodeError,
  104.     keepGoing,
  105.     needBytes
  106. } sec_asn1d_parse_status;
  107. struct subitem {
  108.     const void *data;
  109.     unsigned long len; /* only used for substrings */
  110.     struct subitem *next;
  111. };
  112. typedef struct sec_asn1d_state_struct {
  113.     SEC_ASN1DecoderContext *top;
  114.     const SEC_ASN1Template *theTemplate;
  115.     void *dest;
  116.     void *our_mark; /* free on completion */
  117.     struct sec_asn1d_state_struct *parent; /* aka prev */
  118.     struct sec_asn1d_state_struct *child; /* aka next */
  119.     sec_asn1d_parse_place place;
  120.     /*
  121.      * XXX explain the next fields as clearly as possible...
  122.      */
  123.     unsigned char found_tag_modifiers;
  124.     unsigned char expect_tag_modifiers;
  125.     unsigned long check_tag_mask;
  126.     unsigned long found_tag_number;
  127.     unsigned long expect_tag_number;
  128.     unsigned long underlying_kind;
  129.     unsigned long contents_length;
  130.     unsigned long pending;
  131.     unsigned long consumed;
  132.     int depth;
  133.     /*
  134.      * Bit strings have their length adjusted -- the first octet of the
  135.      * contents contains a value between 0 and 7 which says how many bits
  136.      * at the end of the octets are not actually part of the bit string;
  137.      * when parsing bit strings we put that value here because we need it
  138.      * later, for adjustment of the length (when the whole string is done).
  139.      */
  140.     unsigned int bit_string_unused_bits;
  141.     /*
  142.      * The following are used for indefinite-length constructed strings.
  143.      */
  144.     struct subitem *subitems_head;
  145.     struct subitem *subitems_tail;
  146.     PRPackedBool
  147. allocate, /* when true, need to allocate the destination */
  148. endofcontents, /* this state ended up parsing end-of-contents octets */
  149. explicit, /* we are handling an explicit header */
  150. indefinite, /* the current item has indefinite-length encoding */
  151. missing, /* an optional field that was not present */
  152. optional, /* the template says this field may be omitted */
  153. substring; /* this is a substring of a constructed string */
  154. } sec_asn1d_state;
  155. #define IS_HIGH_TAG_NUMBER(n) ((n) == SEC_ASN1_HIGH_TAG_NUMBER)
  156. #define LAST_TAG_NUMBER_BYTE(b) (((b) & 0x80) == 0)
  157. #define TAG_NUMBER_BITS 7
  158. #define TAG_NUMBER_MASK 0x7f
  159. #define LENGTH_IS_SHORT_FORM(b) (((b) & 0x80) == 0)
  160. #define LONG_FORM_LENGTH(b) ((b) & 0x7f)
  161. #define HIGH_BITS(field,cnt) ((field) >> ((sizeof(field) * 8) - (cnt)))
  162. /*
  163.  * An "outsider" will have an opaque pointer to this, created by calling
  164.  * SEC_ASN1DecoderStart().  It will be passed back in to all subsequent
  165.  * calls to SEC_ASN1DecoderUpdate(), and when done it is passed to
  166.  * SEC_ASN1DecoderFinish().
  167.  */
  168. struct sec_DecoderContext_struct {
  169.     PRArenaPool *our_pool; /* for our internal allocs */
  170.     PRArenaPool *their_pool; /* for destination structure allocs */
  171. #ifdef SEC_ASN1D_FREE_ON_ERROR /*
  172.  * XXX see comment below (by same
  173.  * ifdef) that explains why this
  174.  * does not work (need more smarts
  175.  * in order to free back to mark)
  176.  */
  177.     /*
  178.      * XXX how to make their_mark work in the case where they do NOT
  179.      * give us a pool pointer?
  180.      */
  181.     void *their_mark; /* free on error */
  182. #endif
  183.     sec_asn1d_state *current;
  184.     sec_asn1d_parse_status status;
  185.     SEC_ASN1NotifyProc notify_proc; /* call before/after handling field */
  186.     void *notify_arg; /* argument to notify_proc */
  187.     PRBool during_notify; /* true during call to notify_proc */
  188.     SEC_ASN1WriteProc filter_proc; /* pass field bytes to this  */
  189.     void *filter_arg; /* argument to that function */
  190.     PRBool filter_only; /* do not allocate/store fields */
  191. };
  192. /*
  193.  * XXX this is a fairly generic function that may belong elsewhere
  194.  */
  195. static void *
  196. sec_asn1d_alloc (PRArenaPool *poolp, unsigned long len)
  197. {
  198.     void *thing;
  199.     if (poolp != NULL) {
  200. /*
  201.  * Allocate from the pool.
  202.  */
  203. thing = PORT_ArenaAlloc (poolp, len);
  204.     } else {
  205. /*
  206.  * Allocate generically.
  207.  */
  208. thing = PORT_Alloc (len);
  209.     }
  210.     return thing;
  211. }
  212. /*
  213.  * XXX this is a fairly generic function that may belong elsewhere
  214.  */
  215. static void *
  216. sec_asn1d_zalloc (PRArenaPool *poolp, unsigned long len)
  217. {
  218.     void *thing;
  219.     thing = sec_asn1d_alloc (poolp, len);
  220.     if (thing != NULL)
  221. PORT_Memset (thing, 0, len);
  222.     return thing;
  223. }
  224. static sec_asn1d_state *
  225. sec_asn1d_push_state (SEC_ASN1DecoderContext *cx,
  226.       const SEC_ASN1Template *theTemplate,
  227.       void *dest, PRBool new_depth)
  228. {
  229.     sec_asn1d_state *state, *new_state;
  230.     state = cx->current;
  231.     PORT_Assert (state == NULL || state->child == NULL);
  232.     if (state != NULL) {
  233. PORT_Assert (state->our_mark == NULL);
  234. state->our_mark = PORT_ArenaMark (cx->our_pool);
  235.     }
  236.     new_state = (sec_asn1d_state*)sec_asn1d_zalloc (cx->our_pool, 
  237.     sizeof(*new_state));
  238.     if (new_state == NULL) {
  239. cx->status = decodeError;
  240. if (state != NULL) {
  241.     PORT_ArenaRelease(cx->our_pool, state->our_mark);
  242.     state->our_mark = NULL;
  243. }
  244. return NULL;
  245.     }
  246.     new_state->top         = cx;
  247.     new_state->parent      = state;
  248.     new_state->theTemplate = theTemplate;
  249.     new_state->place       = notInUse;
  250.     if (dest != NULL)
  251. new_state->dest = (char *)dest + theTemplate->offset;
  252.     if (state != NULL) {
  253. new_state->depth = state->depth;
  254. if (new_depth)
  255.     new_state->depth++;
  256. state->child = new_state;
  257.     }
  258.     cx->current = new_state;
  259.     return new_state;
  260. }
  261. static void
  262. sec_asn1d_scrub_state (sec_asn1d_state *state)
  263. {
  264.     /*
  265.      * Some default "scrubbing".
  266.      * XXX right set of initializations?
  267.      */
  268.     state->place = beforeIdentifier;
  269.     state->endofcontents = PR_FALSE;
  270.     state->indefinite = PR_FALSE;
  271.     state->missing = PR_FALSE;
  272.     PORT_Assert (state->consumed == 0);
  273. }
  274. static void
  275. sec_asn1d_notify_before (SEC_ASN1DecoderContext *cx, void *dest, int depth)
  276. {
  277.     if (cx->notify_proc == NULL)
  278. return;
  279.     cx->during_notify = PR_TRUE;
  280.     (* cx->notify_proc) (cx->notify_arg, PR_TRUE, dest, depth);
  281.     cx->during_notify = PR_FALSE;
  282. }
  283. static void
  284. sec_asn1d_notify_after (SEC_ASN1DecoderContext *cx, void *dest, int depth)
  285. {
  286.     if (cx->notify_proc == NULL)
  287. return;
  288.     cx->during_notify = PR_TRUE;
  289.     (* cx->notify_proc) (cx->notify_arg, PR_FALSE, dest, depth);
  290.     cx->during_notify = PR_FALSE;
  291. }
  292. static sec_asn1d_state *
  293. sec_asn1d_init_state_based_on_template (sec_asn1d_state *state)
  294. {
  295.     PRBool explicit, optional, universal;
  296.     unsigned char expect_tag_modifiers;
  297.     unsigned long encode_kind, under_kind;
  298.     unsigned long check_tag_mask, expect_tag_number;
  299.     /* XXX Check that both of these tests are really needed/appropriate. */
  300.     if (state == NULL || state->top->status == decodeError)
  301. return state;
  302.     encode_kind = state->theTemplate->kind;
  303.     if (encode_kind & SEC_ASN1_SAVE) {
  304. /*
  305.  * This is a "magic" field that saves away all bytes, allowing
  306.  * the immediately following field to still be decoded from this
  307.  * same spot -- sort of a fork.
  308.  */
  309. /* check that there are no extraneous bits */
  310. PORT_Assert (encode_kind == SEC_ASN1_SAVE);
  311. if (state->top->filter_only) {
  312.     /*
  313.      * If we are not storing, then we do not do the SAVE field
  314.      * at all.  Just move ahead to the "real" field instead,
  315.      * doing the appropriate notify calls before and after.
  316.      */
  317.     sec_asn1d_notify_after (state->top, state->dest, state->depth);
  318.     /*
  319.      * Since we are not storing, allow for our current dest value
  320.      * to be NULL.  (This might not actually occur, but right now I
  321.      * cannot convince myself one way or the other.)  If it is NULL,
  322.      * assume that our parent dest can help us out.
  323.      */
  324.     if (state->dest == NULL)
  325. state->dest = state->parent->dest;
  326.     else
  327. state->dest = (char *)state->dest - state->theTemplate->offset;
  328.     state->theTemplate++;
  329.     if (state->dest != NULL)
  330. state->dest = (char *)state->dest + state->theTemplate->offset;
  331.     sec_asn1d_notify_before (state->top, state->dest, state->depth);
  332.     encode_kind = state->theTemplate->kind;
  333.     PORT_Assert ((encode_kind & SEC_ASN1_SAVE) == 0);
  334. } else {
  335.     sec_asn1d_scrub_state (state);
  336.     state->place = duringSaveEncoding;
  337.     state = sec_asn1d_push_state (state->top, SEC_AnyTemplate,
  338.   state->dest, PR_FALSE);
  339.     if (state != NULL)
  340. state = sec_asn1d_init_state_based_on_template (state);
  341.     return state;
  342. }
  343.     }
  344.     universal = ((encode_kind & SEC_ASN1_CLASS_MASK) == SEC_ASN1_UNIVERSAL)
  345. ? PR_TRUE : PR_FALSE;
  346.     explicit = (encode_kind & SEC_ASN1_EXPLICIT) ? PR_TRUE : PR_FALSE;
  347.     encode_kind &= ~SEC_ASN1_EXPLICIT;
  348.     optional = (encode_kind & SEC_ASN1_OPTIONAL) ? PR_TRUE : PR_FALSE;
  349.     encode_kind &= ~SEC_ASN1_OPTIONAL;
  350.     PORT_Assert (!(explicit && universal)); /* bad templates */
  351.     encode_kind &= ~SEC_ASN1_DYNAMIC;
  352.     encode_kind &= ~SEC_ASN1_MAY_STREAM;
  353.     if( encode_kind & SEC_ASN1_CHOICE ) {
  354. #if 0 /* XXX remove? */
  355.       sec_asn1d_state *child = sec_asn1d_push_state(state->top, state->theTemplate, state->dest, PR_FALSE);
  356.       if( (sec_asn1d_state *)NULL == child ) {
  357.         return (sec_asn1d_state *)NULL;
  358.       }
  359.       child->allocate = state->allocate;
  360.       child->place = beforeChoice;
  361.       return child;
  362. #else
  363.       state->place = beforeChoice;
  364.       return state;
  365. #endif
  366.     }
  367.     if ((encode_kind & (SEC_ASN1_POINTER | SEC_ASN1_INLINE)) || (!universal
  368.       && !explicit)) {
  369. const SEC_ASN1Template *subt;
  370. void *dest;
  371. PRBool child_allocate;
  372. PORT_Assert ((encode_kind & (SEC_ASN1_ANY | SEC_ASN1_SKIP)) == 0);
  373. sec_asn1d_scrub_state (state);
  374. child_allocate = PR_FALSE;
  375. if (encode_kind & SEC_ASN1_POINTER) {
  376.     /*
  377.      * A POINTER means we need to allocate the destination for
  378.      * this field.  But, since it may also be an optional field,
  379.      * we defer the allocation until later; we just record that
  380.      * it needs to be done.
  381.      *
  382.      * There are two possible scenarios here -- one is just a
  383.      * plain POINTER (kind of like INLINE, except with allocation)
  384.      * and the other is an implicitly-tagged POINTER.  We don't
  385.      * need to do anything special here for the two cases, but
  386.      * since the template definition can be tricky, we do check
  387.      * that there are no extraneous bits set in encode_kind.
  388.      *
  389.      * XXX The same conditions which assert should set an error.
  390.      */
  391.     if (universal) {
  392. /*
  393.  * "universal" means this entry is a standalone POINTER;
  394.  * there should be no other bits set in encode_kind.
  395.  */
  396. PORT_Assert (encode_kind == SEC_ASN1_POINTER);
  397.     } else {
  398. /*
  399.  * If we get here we have an implicitly-tagged field
  400.  * that needs to be put into a POINTER.  The subtemplate
  401.  * will determine how to decode the field, but encode_kind
  402.  * describes the (implicit) tag we are looking for.
  403.  * The non-tag bits of encode_kind will be ignored by
  404.  * the code below; none of them should be set, however,
  405.  * except for the POINTER bit itself -- so check that.
  406.  */
  407. PORT_Assert ((encode_kind & ~SEC_ASN1_TAG_MASK)
  408.      == SEC_ASN1_POINTER);
  409.     }
  410.     if (!state->top->filter_only)
  411. child_allocate = PR_TRUE;
  412.     dest = NULL;
  413.     state->place = afterPointer;
  414. } else {
  415.     dest = state->dest;
  416.     if (encode_kind & SEC_ASN1_INLINE) {
  417. /* check that there are no extraneous bits */
  418. PORT_Assert (encode_kind == SEC_ASN1_INLINE && !optional);
  419. state->place = afterInline;
  420.     } else {
  421. state->place = afterImplicit;
  422.     }
  423. }
  424. state->optional = optional;
  425. subt = SEC_ASN1GetSubtemplate (state->theTemplate, state->dest, PR_FALSE);
  426. state = sec_asn1d_push_state (state->top, subt, dest, PR_FALSE);
  427. if (state == NULL)
  428.     return NULL;
  429. state->allocate = child_allocate;
  430. if (universal) {
  431.     state = sec_asn1d_init_state_based_on_template (state);
  432.     if (state != NULL) {
  433. /*
  434.  * If this field is optional, we need to record that on
  435.  * the pushed child so it won't fail if the field isn't
  436.  * found.  I can't think of a way that this new state
  437.  * could already have optional set (which we would wipe
  438.  * out below if our local optional is not set) -- but
  439.  * just to be sure, assert that it isn't set.
  440.  */
  441. PORT_Assert (!state->optional);
  442. state->optional = optional;
  443.     }
  444.     return state;
  445. }
  446. under_kind = state->theTemplate->kind;
  447. under_kind &= ~SEC_ASN1_MAY_STREAM;
  448.     } else if (explicit) {
  449. /*
  450.  * For explicit, we only need to match the encoding tag next,
  451.  * then we will push another state to handle the entire inner
  452.  * part.  In this case, there is no underlying kind which plays
  453.  * any part in the determination of the outer, explicit tag.
  454.  * So we just set under_kind to 0, which is not a valid tag,
  455.  * and the rest of the tag matching stuff should be okay.
  456.  */
  457. under_kind = 0;
  458.     } else {
  459. /*
  460.  * Nothing special; the underlying kind and the given encoding
  461.  * information are the same.
  462.  */
  463. under_kind = encode_kind;
  464.     }
  465.     /* XXX is this the right set of bits to test here? */
  466.     PORT_Assert ((under_kind & (SEC_ASN1_EXPLICIT | SEC_ASN1_OPTIONAL
  467. | SEC_ASN1_DYNAMIC | SEC_ASN1_MAY_STREAM
  468. | SEC_ASN1_INLINE | SEC_ASN1_POINTER)) == 0);
  469.     if (encode_kind & (SEC_ASN1_ANY | SEC_ASN1_SKIP)) {
  470. PORT_Assert (encode_kind == under_kind);
  471. if (encode_kind & SEC_ASN1_SKIP) {
  472.     PORT_Assert (!optional);
  473.     PORT_Assert (encode_kind == SEC_ASN1_SKIP);
  474.     state->dest = NULL;
  475. }
  476. check_tag_mask = 0;
  477. expect_tag_modifiers = 0;
  478. expect_tag_number = 0;
  479.     } else {
  480. check_tag_mask = SEC_ASN1_TAG_MASK;
  481. expect_tag_modifiers = encode_kind & SEC_ASN1_TAG_MASK
  482. & ~SEC_ASN1_TAGNUM_MASK;
  483. /*
  484.  * XXX This assumes only single-octet identifiers.  To handle
  485.  * the HIGH TAG form we would need to do some more work, especially
  486.  * in how to specify them in the template, because right now we
  487.  * do not provide a way to specify more *tag* bits in encode_kind.
  488.  */
  489. expect_tag_number = encode_kind & SEC_ASN1_TAGNUM_MASK;
  490. switch (under_kind & SEC_ASN1_TAGNUM_MASK) {
  491.   case SEC_ASN1_SET:
  492.     /*
  493.      * XXX A plain old SET (as opposed to a SET OF) is not implemented.
  494.      * If it ever is, remove this assert...
  495.      */
  496.     PORT_Assert ((under_kind & SEC_ASN1_GROUP) != 0);
  497.     /* fallthru */
  498.   case SEC_ASN1_SEQUENCE:
  499.     expect_tag_modifiers |= SEC_ASN1_CONSTRUCTED;
  500.     break;
  501.   case SEC_ASN1_BIT_STRING:
  502.   case SEC_ASN1_BMP_STRING:
  503.   case SEC_ASN1_GENERALIZED_TIME:
  504.   case SEC_ASN1_IA5_STRING:
  505.   case SEC_ASN1_OCTET_STRING:
  506.   case SEC_ASN1_PRINTABLE_STRING:
  507.   case SEC_ASN1_T61_STRING:
  508.   case SEC_ASN1_UNIVERSAL_STRING:
  509.   case SEC_ASN1_UTC_TIME:
  510.   case SEC_ASN1_UTF8_STRING:
  511.   case SEC_ASN1_VISIBLE_STRING:
  512.     check_tag_mask &= ~SEC_ASN1_CONSTRUCTED;
  513.     break;
  514. }
  515.     }
  516.     state->check_tag_mask = check_tag_mask;
  517.     state->expect_tag_modifiers = expect_tag_modifiers;
  518.     state->expect_tag_number = expect_tag_number;
  519.     state->underlying_kind = under_kind;
  520.     state->explicit = explicit;
  521.     state->optional = optional;
  522.     sec_asn1d_scrub_state (state);
  523.     return state;
  524. }
  525. static unsigned long
  526. sec_asn1d_parse_identifier (sec_asn1d_state *state,
  527.     const char *buf, unsigned long len)
  528. {
  529.     unsigned char byte;
  530.     unsigned char tag_number;
  531.     PORT_Assert (state->place == beforeIdentifier);
  532.     if (len == 0) {
  533. state->top->status = needBytes;
  534. return 0;
  535.     }
  536.     byte = (unsigned char) *buf;
  537.     tag_number = byte & SEC_ASN1_TAGNUM_MASK;
  538.     if (IS_HIGH_TAG_NUMBER (tag_number)) {
  539. state->place = duringIdentifier;
  540. state->found_tag_number = 0;
  541. /*
  542.  * Actually, we have no idea how many bytes are pending, but we
  543.  * do know that it is at least 1.  That is all we know; we have
  544.  * to look at each byte to know if there is another, etc.
  545.  */
  546. state->pending = 1;
  547.     } else {
  548. if (byte == 0 && state->parent != NULL &&
  549.     (state->parent->indefinite ||
  550. (
  551.     (state->parent->place == afterImplicit ||
  552.      state->parent->place == afterPointer)
  553.     && state->parent->parent != NULL && state->parent->parent->indefinite
  554. )
  555.     )
  556.     ) {
  557.     /*
  558.      * Our parent has indefinite-length encoding, and the
  559.      * entire tag found is 0, so it seems that we have hit the
  560.      * end-of-contents octets.  To handle this, we just change
  561.      * our state to that which expects to get the bytes of the
  562.      * end-of-contents octets and let that code re-read this byte
  563.      * so that our categorization of field types is correct.
  564.      * After that, our parent will then deal with everything else.
  565.      */
  566.     state->place = duringEndOfContents;
  567.     state->pending = 2;
  568.     state->found_tag_number = 0;
  569.     state->found_tag_modifiers = 0;
  570.     /*
  571.      * We might be an optional field that is, as we now find out,
  572.      * missing.  Give our parent a clue that this happened.
  573.      */
  574.     if (state->optional)
  575. state->missing = PR_TRUE;
  576.     return 0;
  577. }
  578. state->place = afterIdentifier;
  579. state->found_tag_number = tag_number;
  580.     }
  581.     state->found_tag_modifiers = byte & ~SEC_ASN1_TAGNUM_MASK;
  582.     return 1;
  583. }
  584. static unsigned long
  585. sec_asn1d_parse_more_identifier (sec_asn1d_state *state,
  586.  const char *buf, unsigned long len)
  587. {
  588.     unsigned char byte;
  589.     int count;
  590.     PORT_Assert (state->pending == 1);
  591.     PORT_Assert (state->place == duringIdentifier);
  592.     if (len == 0) {
  593. state->top->status = needBytes;
  594. return 0;
  595.     }
  596.     count = 0;
  597.     while (len && state->pending) {
  598. if (HIGH_BITS (state->found_tag_number, TAG_NUMBER_BITS) != 0) {
  599.     /*
  600.      * The given high tag number overflows our container;
  601.      * just give up.  This is not likely to *ever* happen.
  602.      */
  603.     PORT_SetError (SEC_ERROR_BAD_DER);
  604.     state->top->status = decodeError;
  605.     return 0;
  606. }
  607. state->found_tag_number <<= TAG_NUMBER_BITS;
  608. byte = (unsigned char) buf[count++];
  609. state->found_tag_number |= (byte & TAG_NUMBER_MASK);
  610. len--;
  611. if (LAST_TAG_NUMBER_BYTE (byte))
  612.     state->pending = 0;
  613.     }
  614.     if (state->pending == 0)
  615. state->place = afterIdentifier;
  616.     return count;
  617. }
  618. static void
  619. sec_asn1d_confirm_identifier (sec_asn1d_state *state)
  620. {
  621.     PRBool match;
  622.     PORT_Assert (state->place == afterIdentifier);
  623.     match = (PRBool)(((state->found_tag_modifiers & state->check_tag_mask)
  624.      == state->expect_tag_modifiers)
  625.     && ((state->found_tag_number & state->check_tag_mask)
  626. == state->expect_tag_number));
  627.     if (match) {
  628. state->place = beforeLength;
  629.     } else {
  630. if (state->optional) {
  631.     state->missing = PR_TRUE;
  632.     state->place = afterEndOfContents;
  633. } else {
  634.     PORT_SetError (SEC_ERROR_BAD_DER);
  635.     state->top->status = decodeError;
  636. }
  637.     }
  638. }
  639. static unsigned long
  640. sec_asn1d_parse_length (sec_asn1d_state *state,
  641. const char *buf, unsigned long len)
  642. {
  643.     unsigned char byte;
  644.     PORT_Assert (state->place == beforeLength);
  645.     if (len == 0) {
  646. state->top->status = needBytes;
  647. return 0;
  648.     }
  649.     /*
  650.      * The default/likely outcome.  It may get adjusted below.
  651.      */
  652.     state->place = afterLength;
  653.     byte = (unsigned char) *buf;
  654.     if (LENGTH_IS_SHORT_FORM (byte)) {
  655. state->contents_length = byte;
  656.     } else {
  657. state->contents_length = 0;
  658. state->pending = LONG_FORM_LENGTH (byte);
  659. if (state->pending == 0) {
  660.     state->indefinite = PR_TRUE;
  661. } else {
  662.     state->place = duringLength;
  663. }
  664.     }
  665.     return 1;
  666. }
  667. static unsigned long
  668. sec_asn1d_parse_more_length (sec_asn1d_state *state,
  669.      const char *buf, unsigned long len)
  670. {
  671.     int count;
  672.     PORT_Assert (state->pending > 0);
  673.     PORT_Assert (state->place == duringLength);
  674.     if (len == 0) {
  675. state->top->status = needBytes;
  676. return 0;
  677.     }
  678.     count = 0;
  679.     while (len && state->pending) {
  680. if (HIGH_BITS (state->contents_length, 8) != 0) {
  681.     /*
  682.      * The given full content length overflows our container;
  683.      * just give up.
  684.      */
  685.     PORT_SetError (SEC_ERROR_BAD_DER);
  686.     state->top->status = decodeError;
  687.     return 0;
  688. }
  689. state->contents_length <<= 8;
  690. state->contents_length |= (unsigned char) buf[count++];
  691. len--;
  692. state->pending--;
  693.     }
  694.     if (state->pending == 0)
  695. state->place = afterLength;
  696.     return count;
  697. }
  698. static void
  699. sec_asn1d_prepare_for_contents (sec_asn1d_state *state)
  700. {
  701.     SECItem *item;
  702.     PRArenaPool *poolp;
  703.     unsigned long alloc_len;
  704.     /*
  705.      * XXX I cannot decide if this allocation should exclude the case
  706.      *     where state->endofcontents is true -- figure it out!
  707.      */
  708.     if (state->allocate) {
  709. void *dest;
  710. PORT_Assert (state->dest == NULL);
  711. /*
  712.  * We are handling a POINTER or a member of a GROUP, and need to
  713.  * allocate for the data structure.
  714.  */
  715. dest = sec_asn1d_zalloc (state->top->their_pool,
  716.  state->theTemplate->size);
  717. if (dest == NULL) {
  718.     state->top->status = decodeError;
  719.     return;
  720. }
  721. state->dest = (char *)dest + state->theTemplate->offset;
  722. /*
  723.  * For a member of a GROUP, our parent will later put the
  724.  * pointer wherever it belongs.  But for a POINTER, we need
  725.  * to record the destination now, in case notify or filter
  726.  * procs need access to it -- they cannot find it otherwise,
  727.  * until it is too late (for one-pass processing).
  728.  */
  729. if (state->parent->place == afterPointer) {
  730.     void **placep;
  731.     placep = state->parent->dest;
  732.     *placep = dest;
  733. }
  734.     }
  735.     /*
  736.      * Remember, length may be indefinite here!  In that case,
  737.      * both contents_length and pending will be zero.
  738.      */
  739.     state->pending = state->contents_length;
  740.     /*
  741.      * An EXPLICIT is nothing but an outer header, which we have
  742.      * already parsed and accepted.  Now we need to do the inner
  743.      * header and its contents.
  744.      */
  745.     if (state->explicit) {
  746. state->place = afterExplicit;
  747. state = sec_asn1d_push_state (state->top,
  748.       SEC_ASN1GetSubtemplate(state->theTemplate,
  749.      state->dest,
  750.      PR_FALSE),
  751.       state->dest, PR_TRUE);
  752. if (state != NULL)
  753.     state = sec_asn1d_init_state_based_on_template (state);
  754. return;
  755.     }
  756.     /*
  757.      * For GROUP (SET OF, SEQUENCE OF), even if we know the length here
  758.      * we cannot tell how many items we will end up with ... so push a
  759.      * state that can keep track of "children" (the individual members
  760.      * of the group; we will allocate as we go and put them all together
  761.      * at the end.
  762.      */
  763.     if (state->underlying_kind & SEC_ASN1_GROUP) {
  764. /* XXX If this assertion holds (should be able to confirm it via
  765.  * inspection, too) then move this code into the switch statement
  766.  * below under cases SET_OF and SEQUENCE_OF; it will be cleaner.
  767.  */
  768. PORT_Assert (state->underlying_kind == SEC_ASN1_SET_OF
  769.      || state->underlying_kind == SEC_ASN1_SEQUENCE_OF);
  770. if (state->contents_length != 0 || state->indefinite) {
  771.     const SEC_ASN1Template *subt;
  772.     state->place = duringGroup;
  773.     subt = SEC_ASN1GetSubtemplate (state->theTemplate, state->dest,
  774.    PR_FALSE);
  775.     state = sec_asn1d_push_state (state->top, subt, NULL, PR_TRUE);
  776.     if (state != NULL) {
  777. if (!state->top->filter_only)
  778.     state->allocate = PR_TRUE; /* XXX propogate this? */
  779. /*
  780.  * Do the "before" field notification for next in group.
  781.  */
  782. sec_asn1d_notify_before (state->top, state->dest, state->depth);
  783. state = sec_asn1d_init_state_based_on_template (state);
  784.     }
  785. } else {
  786.     /*
  787.      * A group of zero; we are done.
  788.      * XXX Should we store a NULL here?  Or set state to
  789.      * afterGroup and let that code do it?
  790.      */
  791.     state->place = afterEndOfContents;
  792. }
  793. return;
  794.     }
  795.     switch (state->underlying_kind) {
  796.       case SEC_ASN1_SEQUENCE:
  797. /*
  798.  * We need to push a child to handle the individual fields.
  799.  */
  800. state->place = duringSequence;
  801. state = sec_asn1d_push_state (state->top, state->theTemplate + 1,
  802.       state->dest, PR_TRUE);
  803. if (state != NULL) {
  804.     /*
  805.      * Do the "before" field notification.
  806.      */
  807.     sec_asn1d_notify_before (state->top, state->dest, state->depth);
  808.     state = sec_asn1d_init_state_based_on_template (state);
  809. }
  810. break;
  811.       case SEC_ASN1_SET: /* XXX SET is not really implemented */
  812. /*
  813.  * XXX A plain SET requires special handling; scanning of a
  814.  * template to see where a field should go (because by definition,
  815.  * they are not in any particular order, and you have to look at
  816.  * each tag to disambiguate what the field is).  We may never
  817.  * implement this because in practice, it seems to be unused.
  818.  */
  819. PORT_Assert(0);
  820. state->top->status = decodeError;
  821. break;
  822.       case SEC_ASN1_NULL:
  823. /*
  824.  * The NULL type, by definition, is "nothing", content length of zero.
  825.  * An indefinite-length encoding is not alloweed.
  826.  */
  827. if (state->contents_length || state->indefinite) {
  828.     state->top->status = decodeError;
  829.     break;
  830. }
  831. if (state->dest != NULL) {
  832.     item = (SECItem *)(state->dest);
  833.     item->data = NULL;
  834.     item->len = 0;
  835. }
  836. state->place = afterEndOfContents;
  837. break;
  838.       case SEC_ASN1_BMP_STRING:
  839. /* Error if length is not divisable by 2 */
  840. if (state->contents_length % 2) {
  841.    state->top->status = decodeError;
  842.    break;
  843. }   
  844. /* otherwise, handle as other string types */
  845. goto regular_string_type;
  846.       case SEC_ASN1_UNIVERSAL_STRING:
  847. /* Error if length is not divisable by 4 */
  848. if (state->contents_length % 4) {
  849.    state->top->status = decodeError;
  850.    break;
  851. }   
  852. /* otherwise, handle as other string types */
  853. goto regular_string_type;
  854.       case SEC_ASN1_SKIP:
  855.       case SEC_ASN1_ANY:
  856.       case SEC_ASN1_ANY_CONTENTS:
  857. /*
  858.  * These are not (necessarily) strings, but they need nearly
  859.  * identical handling (especially when we need to deal with
  860.  * constructed sub-pieces), so we pretend they are.
  861.  */
  862. /* fallthru */
  863. regular_string_type:
  864.       case SEC_ASN1_BIT_STRING:
  865.       case SEC_ASN1_IA5_STRING:
  866.       case SEC_ASN1_OCTET_STRING:
  867.       case SEC_ASN1_PRINTABLE_STRING:
  868.       case SEC_ASN1_T61_STRING:
  869.       case SEC_ASN1_UTC_TIME:
  870.       case SEC_ASN1_UTF8_STRING:
  871.       case SEC_ASN1_VISIBLE_STRING:
  872. /*
  873.  * We are allocating for a primitive or a constructed string.
  874.  * If it is a constructed string, it may also be indefinite-length.
  875.  * If it is primitive, the length can (legally) be zero.
  876.  * Our first order of business is to allocate the memory for
  877.  * the string, if we can (if we know the length).
  878.  */
  879. item = (SECItem *)(state->dest);
  880. /*
  881.  * If the item is a definite-length constructed string, then
  882.  * the contents_length is actually larger than what we need
  883.  * (because it also counts each intermediate header which we
  884.  * will be throwing away as we go), but it is a perfectly good
  885.  * upper bound that we just allocate anyway, and then concat
  886.  * as we go; we end up wasting a few extra bytes but save a
  887.  * whole other copy.
  888.  */
  889. alloc_len = state->contents_length;
  890. poolp = NULL; /* quiet compiler warnings about unused... */
  891. if (item == NULL || state->top->filter_only) {
  892.     if (item != NULL) {
  893. item->data = NULL;
  894. item->len = 0;
  895.     }
  896.     alloc_len = 0;
  897. } else if (state->substring) {
  898.     /*
  899.      * If we are a substring of a constructed string, then we may
  900.      * not have to allocate anything (because our parent, the
  901.      * actual constructed string, did it for us).  If we are a
  902.      * substring and we *do* have to allocate, that means our
  903.      * parent is an indefinite-length, so we allocate from our pool;
  904.      * later our parent will copy our string into the aggregated
  905.      * whole and free our pool allocation.
  906.      */
  907.     if (item->data == NULL) {
  908. PORT_Assert (item->len == 0);
  909. poolp = state->top->our_pool;
  910.     } else {
  911. alloc_len = 0;
  912.     }
  913. } else {
  914.     item->len = 0;
  915.     item->data = NULL;
  916.     poolp = state->top->their_pool;
  917. }
  918. if (alloc_len || ((! state->indefinite)
  919.   && (state->subitems_head != NULL))) {
  920.     struct subitem *subitem;
  921.     int len;
  922.     PORT_Assert (item->len == 0 && item->data == NULL);
  923.     /*
  924.      * Check for and handle an ANY which has stashed aside the
  925.      * header (identifier and length) bytes for us to include
  926.      * in the saved contents.
  927.      */
  928.     if (state->subitems_head != NULL) {
  929. PORT_Assert (state->underlying_kind == SEC_ASN1_ANY);
  930. for (subitem = state->subitems_head;
  931.      subitem != NULL; subitem = subitem->next)
  932.     alloc_len += subitem->len;
  933.     }
  934.     item->data = (unsigned char*)sec_asn1d_zalloc (poolp, alloc_len);
  935.     if (item->data == NULL) {
  936. state->top->status = decodeError;
  937. break;
  938.     }
  939.     len = 0;
  940.     for (subitem = state->subitems_head;
  941.  subitem != NULL; subitem = subitem->next) {
  942. PORT_Memcpy (item->data + len, subitem->data, subitem->len);
  943. len += subitem->len;
  944.     }
  945.     item->len = len;
  946.     /*
  947.      * Because we use arenas and have a mark set, we later free
  948.      * everything we have allocated, so this does *not* present
  949.      * a memory leak (it is just temporarily left dangling).
  950.      */
  951.     state->subitems_head = state->subitems_tail = NULL;
  952. }
  953. if (state->contents_length == 0 && (! state->indefinite)) {
  954.     /*
  955.      * A zero-length simple or constructed string; we are done.
  956.      */
  957.     state->place = afterEndOfContents;
  958. } else if (state->found_tag_modifiers & SEC_ASN1_CONSTRUCTED) {
  959.     const SEC_ASN1Template *sub;
  960.     switch (state->underlying_kind) {
  961.       case SEC_ASN1_ANY:
  962.       case SEC_ASN1_ANY_CONTENTS:
  963. sub = SEC_AnyTemplate;
  964. break;
  965.       case SEC_ASN1_BIT_STRING:
  966. sub = SEC_BitStringTemplate;
  967. break;
  968.       case SEC_ASN1_BMP_STRING:
  969. sub = SEC_BMPStringTemplate;
  970. break;
  971.       case SEC_ASN1_GENERALIZED_TIME:
  972. sub = SEC_GeneralizedTimeTemplate;
  973. break;
  974.       case SEC_ASN1_IA5_STRING:
  975. sub = SEC_IA5StringTemplate;
  976. break;
  977.       case SEC_ASN1_OCTET_STRING:
  978. sub = SEC_OctetStringTemplate;
  979. break;
  980.       case SEC_ASN1_PRINTABLE_STRING:
  981. sub = SEC_PrintableStringTemplate;
  982. break;
  983.       case SEC_ASN1_T61_STRING:
  984. sub = SEC_T61StringTemplate;
  985. break;
  986.       case SEC_ASN1_UNIVERSAL_STRING:
  987. sub = SEC_UniversalStringTemplate;
  988. break;
  989.       case SEC_ASN1_UTC_TIME:
  990. sub = SEC_UTCTimeTemplate;
  991. break;
  992.       case SEC_ASN1_UTF8_STRING:
  993. sub = SEC_UTF8StringTemplate;
  994. break;
  995.       case SEC_ASN1_VISIBLE_STRING:
  996. sub = SEC_VisibleStringTemplate;
  997. break;
  998.       case SEC_ASN1_SKIP:
  999. sub = SEC_SkipTemplate;
  1000. break;
  1001.       default: /* redundant given outer switch cases, but */
  1002. PORT_Assert(0); /* the compiler does not seem to know that, */
  1003. sub = NULL; /* so just do enough to quiet it. */
  1004. break;
  1005.     }
  1006.     state->place = duringConstructedString;
  1007.     state = sec_asn1d_push_state (state->top, sub, item, PR_TRUE);
  1008.     if (state != NULL) {
  1009. state->substring = PR_TRUE; /* XXX propogate? */
  1010. state = sec_asn1d_init_state_based_on_template (state);
  1011.     }
  1012. } else if (state->indefinite) {
  1013.     /*
  1014.      * An indefinite-length string *must* be constructed!
  1015.      */
  1016.     PORT_SetError (SEC_ERROR_BAD_DER);
  1017.     state->top->status = decodeError;
  1018. } else {
  1019.     /*
  1020.      * A non-zero-length simple string.
  1021.      */
  1022.     if (state->underlying_kind == SEC_ASN1_BIT_STRING)
  1023. state->place = beforeBitString;
  1024.     else
  1025. state->place = duringLeaf;
  1026. }
  1027. break;
  1028.       default:
  1029. /*
  1030.  * We are allocating for a simple leaf item.
  1031.  */
  1032. if (state->contents_length) {
  1033.     if (state->dest != NULL) {
  1034. item = (SECItem *)(state->dest);
  1035. item->len = 0;
  1036. if (state->top->filter_only) {
  1037.     item->data = NULL;
  1038. } else {
  1039.     item->data = (unsigned char*)
  1040.                   sec_asn1d_zalloc (state->top->their_pool,
  1041.    state->contents_length);
  1042.     if (item->data == NULL) {
  1043. state->top->status = decodeError;
  1044. return;
  1045.     }
  1046. }
  1047.     }
  1048.     state->place = duringLeaf;
  1049. } else {
  1050.     /*
  1051.      * An indefinite-length or zero-length item is not allowed.
  1052.      * (All legal cases of such were handled above.)
  1053.      */
  1054.     PORT_SetError (SEC_ERROR_BAD_DER);
  1055.     state->top->status = decodeError;
  1056. }
  1057.     }
  1058. }
  1059. static void
  1060. sec_asn1d_free_child (sec_asn1d_state *state, PRBool error)
  1061. {
  1062.     if (state->child != NULL) {
  1063. PORT_Assert (error || state->child->consumed == 0);
  1064. PORT_Assert (state->our_mark != NULL);
  1065. PORT_ArenaRelease (state->top->our_pool, state->our_mark);
  1066. if (error && state->top->their_pool == NULL) {
  1067.     /*
  1068.      * XXX We need to free anything allocated.
  1069.      */
  1070.     PORT_Assert (0);
  1071. }
  1072. state->child = NULL;
  1073. state->our_mark = NULL;
  1074.     } else {
  1075. /*
  1076.  * It is important that we do not leave a mark unreleased/unmarked.
  1077.  * But I do not think we should ever have one set in this case, only
  1078.  * if we had a child (handled above).  So check for that.  If this
  1079.  * assertion should ever get hit, then we probably need to add code
  1080.  * here to release back to our_mark (and then set our_mark to NULL).
  1081.  */
  1082. PORT_Assert (state->our_mark == NULL);
  1083.     }
  1084.     state->place = beforeEndOfContents;
  1085. }
  1086. static void
  1087. sec_asn1d_reuse_encoding (sec_asn1d_state *state)
  1088. {
  1089.     sec_asn1d_state *child;
  1090.     unsigned long consumed;
  1091.     SECItem *item;
  1092.     void *dest;
  1093.     child = state->child;
  1094.     PORT_Assert (child != NULL);
  1095.     consumed = child->consumed;
  1096.     child->consumed = 0;
  1097.     item = (SECItem *)(state->dest);
  1098.     PORT_Assert (item != NULL);
  1099.     PORT_Assert (item->len == consumed);
  1100.     /*
  1101.      * Free any grandchild.
  1102.      */
  1103.     sec_asn1d_free_child (child, PR_FALSE);
  1104.     /*
  1105.      * Notify after the SAVE field.
  1106.      */
  1107.     sec_asn1d_notify_after (state->top, state->dest, state->depth);
  1108.     /*
  1109.      * Adjust to get new dest and move forward.
  1110.      */
  1111.     dest = (char *)state->dest - state->theTemplate->offset;
  1112.     state->theTemplate++;
  1113.     child->dest = (char *)dest + state->theTemplate->offset;
  1114.     child->theTemplate = state->theTemplate;
  1115.     /*
  1116.      * Notify before the "real" field.
  1117.      */
  1118.     PORT_Assert (state->depth == child->depth);
  1119.     sec_asn1d_notify_before (state->top, child->dest, child->depth);
  1120.     /*
  1121.      * This will tell DecoderUpdate to return when it is done.
  1122.      */
  1123.     state->place = afterSaveEncoding;
  1124.     /*
  1125.      * We already have a child; "push" it by making it current.
  1126.      */
  1127.     state->top->current = child;
  1128.     /*
  1129.      * And initialize it so it is ready to parse.
  1130.      */
  1131.     (void) sec_asn1d_init_state_based_on_template(child);
  1132.     /*
  1133.      * Now parse that out of our data.
  1134.      */
  1135.     if (SEC_ASN1DecoderUpdate (state->top,
  1136.        (char *) item->data, item->len) != SECSuccess)
  1137. return;
  1138.     PORT_Assert (state->top->current == state);
  1139.     PORT_Assert (state->child == child);
  1140.     /*
  1141.      * That should have consumed what we consumed before.
  1142.      */
  1143.     PORT_Assert (consumed == child->consumed);
  1144.     child->consumed = 0;
  1145.     /*
  1146.      * Done.
  1147.      */
  1148.     state->consumed += consumed;
  1149.     child->place = notInUse;
  1150.     state->place = afterEndOfContents;
  1151. }
  1152. static unsigned long
  1153. sec_asn1d_parse_leaf (sec_asn1d_state *state,
  1154.       const char *buf, unsigned long len)
  1155. {
  1156.     SECItem *item;
  1157.     if (len == 0) {
  1158. state->top->status = needBytes;
  1159. return 0;
  1160.     }
  1161.     if (state->pending < len)
  1162. len = state->pending;
  1163.     item = (SECItem *)(state->dest);
  1164.     if (item != NULL && item->data != NULL) {
  1165. PORT_Memcpy (item->data + item->len, buf, len);
  1166. item->len += len;
  1167.     }
  1168.     state->pending -= len;
  1169.     if (state->pending == 0)
  1170. state->place = beforeEndOfContents;
  1171.     return len;
  1172. }
  1173. static unsigned long
  1174. sec_asn1d_parse_bit_string (sec_asn1d_state *state,
  1175.     const char *buf, unsigned long len)
  1176. {
  1177.     unsigned char byte;
  1178.     PORT_Assert (state->pending > 0);
  1179.     PORT_Assert (state->place == beforeBitString);
  1180.     if (len == 0) {
  1181. state->top->status = needBytes;
  1182. return 0;
  1183.     }
  1184.     byte = (unsigned char) *buf;
  1185.     if (byte > 7) {
  1186. PORT_SetError (SEC_ERROR_BAD_DER);
  1187. state->top->status = decodeError;
  1188. return 0;
  1189.     }
  1190.     state->bit_string_unused_bits = byte;
  1191.     state->place = duringBitString;
  1192.     state->pending -= 1;
  1193.     return 1;
  1194. }
  1195. static unsigned long
  1196. sec_asn1d_parse_more_bit_string (sec_asn1d_state *state,
  1197.  const char *buf, unsigned long len)
  1198. {
  1199.     PORT_Assert (state->pending > 0);
  1200.     PORT_Assert (state->place == duringBitString);
  1201.     len = sec_asn1d_parse_leaf (state, buf, len);
  1202.     if (state->place == beforeEndOfContents && state->dest != NULL) {
  1203. SECItem *item;
  1204. item = (SECItem *)(state->dest);
  1205. if (item->len)
  1206.     item->len = (item->len << 3) - state->bit_string_unused_bits;
  1207.     }
  1208.     return len;
  1209. }
  1210. /*
  1211.  * XXX All callers should be looking at return value to detect
  1212.  * out-of-memory errors (and stop!).
  1213.  */
  1214. static struct subitem *
  1215. sec_asn1d_add_to_subitems (sec_asn1d_state *state,
  1216.    const void *data, unsigned long len,
  1217.    PRBool copy_data)
  1218. {
  1219.     struct subitem *thing;
  1220.     thing = (struct subitem*)sec_asn1d_zalloc (state->top->our_pool,
  1221. sizeof (struct subitem));
  1222.     if (thing == NULL) {
  1223. state->top->status = decodeError;
  1224. return NULL;
  1225.     }
  1226.     if (copy_data) {
  1227. void *copy;
  1228. copy = sec_asn1d_alloc (state->top->our_pool, len);
  1229. if (copy == NULL) {
  1230.     state->top->status = decodeError;
  1231.     return NULL;
  1232. }
  1233. PORT_Memcpy (copy, data, len);
  1234. thing->data = copy;
  1235.     } else {
  1236. thing->data = data;
  1237.     }
  1238.     thing->len = len;
  1239.     thing->next = NULL;
  1240.     if (state->subitems_head == NULL) {
  1241. PORT_Assert (state->subitems_tail == NULL);
  1242. state->subitems_head = state->subitems_tail = thing;
  1243.     } else {
  1244. state->subitems_tail->next = thing;
  1245. state->subitems_tail = thing;
  1246.     }
  1247.     return thing;
  1248. }
  1249. static void
  1250. sec_asn1d_record_any_header (sec_asn1d_state *state,
  1251.      const char *buf,
  1252.      unsigned long len)
  1253. {
  1254.     SECItem *item;
  1255.     item = (SECItem *)(state->dest);
  1256.     if (item != NULL && item->data != NULL) {
  1257. PORT_Assert (state->substring);
  1258. PORT_Memcpy (item->data + item->len, buf, len);
  1259. item->len += len;
  1260.     } else {
  1261. sec_asn1d_add_to_subitems (state, buf, len, PR_TRUE);
  1262.     }
  1263. }
  1264. /*
  1265.  * We are moving along through the substrings of a constructed string,
  1266.  * and have just finished parsing one -- we need to save our child data
  1267.  * (if the child was not already writing directly into the destination)
  1268.  * and then move forward by one.
  1269.  *
  1270.  * We also have to detect when we are done:
  1271.  * - a definite-length encoding stops when our pending value hits 0
  1272.  * - an indefinite-length encoding stops when our child is empty
  1273.  *   (which means it was the end-of-contents octets)
  1274.  */
  1275. static void
  1276. sec_asn1d_next_substring (sec_asn1d_state *state)
  1277. {
  1278.     sec_asn1d_state *child;
  1279.     SECItem *item;
  1280.     unsigned long child_consumed;
  1281.     PRBool done;
  1282.     PORT_Assert (state->place == duringConstructedString);
  1283.     PORT_Assert (state->child != NULL);
  1284.     child = state->child;
  1285.     child_consumed = child->consumed;
  1286.     child->consumed = 0;
  1287.     state->consumed += child_consumed;
  1288.     done = PR_FALSE;
  1289.     if (state->pending) {
  1290. PORT_Assert (!state->indefinite);
  1291. PORT_Assert (child_consumed <= state->pending);
  1292. state->pending -= child_consumed;
  1293. if (state->pending == 0)
  1294.     done = PR_TRUE;
  1295.     } else {
  1296. PORT_Assert (state->indefinite);
  1297. item = (SECItem *)(child->dest);
  1298. if (item != NULL && item->data != NULL) {
  1299.     /*
  1300.      * Save the string away for later concatenation.
  1301.      */
  1302.     PORT_Assert (item->data != NULL);
  1303.     sec_asn1d_add_to_subitems (state, item->data, item->len, PR_FALSE);
  1304.     /*
  1305.      * Clear the child item for the next round.
  1306.      */
  1307.     item->data = NULL;
  1308.     item->len = 0;
  1309. }
  1310. /*
  1311.  * If our child was just our end-of-contents octets, we are done.
  1312.  */
  1313. if (child->endofcontents)
  1314.     done = PR_TRUE;
  1315.     }
  1316.     /*
  1317.      * Stop or do the next one.
  1318.      */
  1319.     if (done) {
  1320. child->place = notInUse;
  1321. state->place = afterConstructedString;
  1322.     } else {
  1323. sec_asn1d_scrub_state (child);
  1324. state->top->current = child;
  1325.     }
  1326. }
  1327. /*
  1328.  * We are doing a SET OF or SEQUENCE OF, and have just finished an item.
  1329.  */
  1330. static void
  1331. sec_asn1d_next_in_group (sec_asn1d_state *state)
  1332. {
  1333.     sec_asn1d_state *child;
  1334.     unsigned long child_consumed;
  1335.     PORT_Assert (state->place == duringGroup);
  1336.     PORT_Assert (state->child != NULL);
  1337.     child = state->child;
  1338.     child_consumed = child->consumed;
  1339.     child->consumed = 0;
  1340.     state->consumed += child_consumed;
  1341.     /*
  1342.      * If our child was just our end-of-contents octets, we are done.
  1343.      */
  1344.     if (child->endofcontents) {
  1345. /* XXX I removed the PORT_Assert (child->dest == NULL) because there
  1346.  * was a bug in that a template that was a sequence of which also had
  1347.  * a child of a sequence of, in an indefinite group was not working 
  1348.  * properly.  This fix seems to work, (added the if statement below),
  1349.  * and nothing appears broken, but I am putting this note here just
  1350.  * in case. */
  1351. /*
  1352.  * XXX No matter how many times I read that comment,
  1353.  * I cannot figure out what case he was fixing.  I believe what he
  1354.  * did was deliberate, so I am loathe to touch it.  I need to
  1355.  * understand how it could ever be that child->dest != NULL but
  1356.  * child->endofcontents is true, and why it is important to check
  1357.  * that state->subitems_head is NULL.  This really needs to be
  1358.  * figured out, as I am not sure if the following code should be
  1359.  * compensating for "offset", as is done a little farther below
  1360.  * in the more normal case.
  1361.  */
  1362. PORT_Assert (state->indefinite);
  1363. PORT_Assert (state->pending == 0);
  1364. if(child->dest && !state->subitems_head) {
  1365.     sec_asn1d_add_to_subitems (state, child->dest, 0, PR_FALSE);
  1366.     child->dest = NULL;
  1367. }
  1368. child->place = notInUse;
  1369. state->place = afterGroup;
  1370. return;
  1371.     }
  1372.     /* 
  1373.      * Do the "after" field notification for next in group.
  1374.      */
  1375.     sec_asn1d_notify_after (state->top, child->dest, child->depth);
  1376.     /*
  1377.      * Save it away (unless we are not storing).
  1378.      */
  1379.     if (child->dest != NULL) {
  1380. void *dest;
  1381. dest = child->dest;
  1382. dest = (char *)dest - child->theTemplate->offset;
  1383. sec_asn1d_add_to_subitems (state, dest, 0, PR_FALSE);
  1384. child->dest = NULL;
  1385.     }
  1386.     /*
  1387.      * Account for those bytes; see if we are done.
  1388.      */
  1389.     if (state->pending) {
  1390. PORT_Assert (!state->indefinite);
  1391. PORT_Assert (child_consumed <= state->pending);
  1392. state->pending -= child_consumed;
  1393. if (state->pending == 0) {
  1394.     child->place = notInUse;
  1395.     state->place = afterGroup;
  1396.     return;
  1397. }
  1398.     }
  1399.     /*
  1400.      * Do the "before" field notification for next item in group.
  1401.      */
  1402.     sec_asn1d_notify_before (state->top, child->dest, child->depth);
  1403.     /*
  1404.      * Now we do the next one.
  1405.      */
  1406.     sec_asn1d_scrub_state (child);
  1407.     state->top->current = child;
  1408. }
  1409. /*
  1410.  * We are moving along through a sequence; move forward by one,
  1411.  * (detecting end-of-sequence when it happens).
  1412.  * XXX The handling of "missing" is ugly.  Fix it.
  1413.  */
  1414. static void
  1415. sec_asn1d_next_in_sequence (sec_asn1d_state *state)
  1416. {
  1417.     sec_asn1d_state *child;
  1418.     unsigned long child_consumed;
  1419.     PRBool child_missing;
  1420.     PORT_Assert (state->place == duringSequence);
  1421.     PORT_Assert (state->child != NULL);
  1422.     child = state->child;
  1423.     /*
  1424.      * Do the "after" field notification.
  1425.      */
  1426.     sec_asn1d_notify_after (state->top, child->dest, child->depth);
  1427.     child_missing = (PRBool) child->missing;
  1428.     child_consumed = child->consumed;
  1429.     child->consumed = 0;
  1430.     /*
  1431.      * Take care of accounting.
  1432.      */
  1433.     if (child_missing) {
  1434. PORT_Assert (child->optional);
  1435.     } else {
  1436. state->consumed += child_consumed;
  1437. /*
  1438.  * Free any grandchild.
  1439.  */
  1440. sec_asn1d_free_child (child, PR_FALSE);
  1441. if (state->pending) {
  1442.     PORT_Assert (!state->indefinite);
  1443.     PORT_Assert (child_consumed <= state->pending);
  1444.     state->pending -= child_consumed;
  1445.     if (state->pending == 0) {
  1446. child->theTemplate++;
  1447. while (child->theTemplate->kind != 0) {
  1448.     if ((child->theTemplate->kind & SEC_ASN1_OPTIONAL) == 0) {
  1449. PORT_SetError (SEC_ERROR_BAD_DER);
  1450. state->top->status = decodeError;
  1451. return;
  1452.     }
  1453.     child->theTemplate++;
  1454. }
  1455. child->place = notInUse;
  1456. state->place = afterEndOfContents;
  1457. return;
  1458.     }
  1459. }
  1460.     }
  1461.     /*
  1462.      * Move forward.
  1463.      */
  1464.     child->theTemplate++;
  1465.     if (child->theTemplate->kind == 0) {
  1466. /*
  1467.  * We are done with this sequence.
  1468.  */
  1469. child->place = notInUse;
  1470. if (state->pending) {
  1471.     PORT_SetError (SEC_ERROR_BAD_DER);
  1472.     state->top->status = decodeError;
  1473. } else if (child_missing) {
  1474.     /*
  1475.      * We got to the end, but have a child that started parsing
  1476.      * and ended up "missing".  The only legitimate reason for
  1477.      * this is that we had one or more optional fields at the
  1478.      * end of our sequence, and we were encoded indefinite-length,
  1479.      * so when we went looking for those optional fields we
  1480.      * found our end-of-contents octets instead.
  1481.      * (Yes, this is ugly; dunno a better way to handle it.)
  1482.      * So, first confirm the situation, and then mark that we
  1483.      * are done.
  1484.      */
  1485.     if (state->indefinite && child->endofcontents) {
  1486. PORT_Assert (child_consumed == 2);
  1487. state->consumed += child_consumed;
  1488. state->place = afterEndOfContents;
  1489.     } else {
  1490. PORT_SetError (SEC_ERROR_BAD_DER);
  1491. state->top->status = decodeError;
  1492.     }
  1493. } else {
  1494.     /*
  1495.      * We have to finish out, maybe reading end-of-contents octets;
  1496.      * let the normal logic do the right thing.
  1497.      */
  1498.     state->place = beforeEndOfContents;
  1499. }
  1500.     } else {
  1501. unsigned char child_found_tag_modifiers = 0;
  1502. unsigned long child_found_tag_number = 0;
  1503. /*
  1504.  * Reset state and push.
  1505.  */
  1506. if (state->dest != NULL)
  1507.     child->dest = (char *)state->dest + child->theTemplate->offset;
  1508. /*
  1509.  * Do the "before" field notification.
  1510.  */
  1511. sec_asn1d_notify_before (state->top, child->dest, child->depth);
  1512. if (child_missing) { /* if previous child was missing, copy the tag data we already have */
  1513.     child_found_tag_modifiers = child->found_tag_modifiers;
  1514.     child_found_tag_number = child->found_tag_number;
  1515. }
  1516. state->top->current = child;
  1517. child = sec_asn1d_init_state_based_on_template (child);
  1518. if (child_missing) {
  1519.     child->place = afterIdentifier;
  1520.     child->found_tag_modifiers = child_found_tag_modifiers;
  1521.     child->found_tag_number = child_found_tag_number;
  1522.     child->consumed = child_consumed;
  1523.     if (child->underlying_kind == SEC_ASN1_ANY
  1524. && !child->top->filter_only) {
  1525. /*
  1526.  * If the new field is an ANY, and we are storing, then
  1527.  * we need to save the tag out.  We would have done this
  1528.  * already in the normal case, but since we were looking
  1529.  * for an optional field, and we did not find it, we only
  1530.  * now realize we need to save the tag.
  1531.  */
  1532. unsigned char identifier;
  1533. /*
  1534.  * Check that we did not end up with a high tag; for that
  1535.  * we need to re-encode the tag into multiple bytes in order
  1536.  * to store it back to look like what we parsed originally.
  1537.  * In practice this does not happen, but for completeness
  1538.  * sake it should probably be made to work at some point.
  1539.  */
  1540. PORT_Assert (child_found_tag_number < SEC_ASN1_HIGH_TAG_NUMBER);
  1541. identifier = child_found_tag_modifiers | child_found_tag_number;
  1542. sec_asn1d_record_any_header (child, (char *) &identifier, 1);
  1543.     }
  1544. }
  1545.     }
  1546. }
  1547. static void
  1548. sec_asn1d_concat_substrings (sec_asn1d_state *state)
  1549. {
  1550.     PORT_Assert (state->place == afterConstructedString);
  1551.     if (state->subitems_head != NULL) {
  1552. struct subitem *substring;
  1553. unsigned long alloc_len, item_len;
  1554. unsigned char *where;
  1555. SECItem *item;
  1556. PRBool is_bit_string;
  1557. item_len = 0;
  1558. is_bit_string = (state->underlying_kind == SEC_ASN1_BIT_STRING)
  1559. ? PR_TRUE : PR_FALSE;
  1560. substring = state->subitems_head;
  1561. while (substring != NULL) {
  1562.     /*
  1563.      * All bit-string substrings except the last one should be
  1564.      * a clean multiple of 8 bits.
  1565.      */
  1566.     if (is_bit_string && (substring->next == NULL)
  1567.       && (substring->len & 0x7)) {
  1568. PORT_SetError (SEC_ERROR_BAD_DER);
  1569. state->top->status = decodeError;
  1570. return;
  1571.     }
  1572.     item_len += substring->len;
  1573.     substring = substring->next;
  1574. }
  1575. if (is_bit_string) {
  1576. #ifdef XP_WIN16 /* win16 compiler gets an internal error otherwise */
  1577.     alloc_len = (((long)item_len + 7) / 8);
  1578. #else
  1579.     alloc_len = ((item_len + 7) >> 3);
  1580. #endif
  1581. } else {
  1582.     /*
  1583.      * Add 2 for the end-of-contents octets of an indefinite-length
  1584.      * ANY that is *not* also an INNER.  Because we zero-allocate
  1585.      * below, all we need to do is increase the length here.
  1586.      */
  1587.     if (state->underlying_kind == SEC_ASN1_ANY && state->indefinite)
  1588. item_len += 2; 
  1589.     alloc_len = item_len;
  1590. }
  1591. item = (SECItem *)(state->dest);
  1592. PORT_Assert (item != NULL);
  1593. PORT_Assert (item->data == NULL);
  1594. item->data = (unsigned char*)sec_asn1d_zalloc (state->top->their_pool, 
  1595.        alloc_len);
  1596. if (item->data == NULL) {
  1597.     state->top->status = decodeError;
  1598.     return;
  1599. }
  1600. item->len = item_len;
  1601. where = item->data;
  1602. substring = state->subitems_head;
  1603. while (substring != NULL) {
  1604.     if (is_bit_string)
  1605. item_len = (substring->len + 7) >> 3;
  1606.     else
  1607. item_len = substring->len;
  1608.     PORT_Memcpy (where, substring->data, item_len);
  1609.     where += item_len;
  1610.     substring = substring->next;
  1611. }
  1612. /*
  1613.  * Because we use arenas and have a mark set, we later free
  1614.  * everything we have allocated, so this does *not* present
  1615.  * a memory leak (it is just temporarily left dangling).
  1616.  */
  1617. state->subitems_head = state->subitems_tail = NULL;
  1618.     }
  1619.     state->place = afterEndOfContents;
  1620. }
  1621. static void
  1622. sec_asn1d_concat_group (sec_asn1d_state *state)
  1623. {
  1624.     const void ***placep;
  1625.     PORT_Assert (state->place == afterGroup);
  1626.     placep = (const void***)state->dest;
  1627.     if (state->subitems_head != NULL) {
  1628. struct subitem *item;
  1629. const void **group;
  1630. int count;
  1631. count = 0;
  1632. item = state->subitems_head;
  1633. while (item != NULL) {
  1634.     PORT_Assert (item->next != NULL || item == state->subitems_tail);
  1635.     count++;
  1636.     item = item->next;
  1637. }
  1638. group = (const void**)sec_asn1d_zalloc (state->top->their_pool,
  1639.   (count + 1) * (sizeof(void *)));
  1640. if (group == NULL) {
  1641.     state->top->status = decodeError;
  1642.     return;
  1643. }
  1644. PORT_Assert (placep != NULL);
  1645. *placep = group;
  1646. item = state->subitems_head;
  1647. while (item != NULL) {
  1648.     *group++ = item->data;
  1649.     item = item->next;
  1650. }
  1651. *group = NULL;
  1652. /*
  1653.  * Because we use arenas and have a mark set, we later free
  1654.  * everything we have allocated, so this does *not* present
  1655.  * a memory leak (it is just temporarily left dangling).
  1656.  */
  1657. state->subitems_head = state->subitems_tail = NULL;
  1658.     } else if (placep != NULL) {
  1659. *placep = NULL;
  1660.     }
  1661.     state->place = afterEndOfContents;
  1662. }
  1663. /*
  1664.  * For those states that push a child to handle a subtemplate,
  1665.  * "absorb" that child (transfer necessary information).
  1666.  */
  1667. static void
  1668. sec_asn1d_absorb_child (sec_asn1d_state *state)
  1669. {
  1670.     /*
  1671.      * There is absolutely supposed to be a child there.
  1672.      */
  1673.     PORT_Assert (state->child != NULL);
  1674.     /*
  1675.      * Inherit the missing status of our child, and do the ugly
  1676.      * backing-up if necessary.
  1677.      * (Only IMPLICIT or POINTER should encounter such; all other cases
  1678.      * should have confirmed a tag *before* pushing a child.)
  1679.      */
  1680.     state->missing = state->child->missing;
  1681.     if (state->missing) {
  1682. PORT_Assert (state->place == afterImplicit
  1683.      || state->place == afterPointer);
  1684. state->found_tag_number = state->child->found_tag_number;
  1685. state->found_tag_modifiers = state->child->found_tag_modifiers;
  1686. state->endofcontents = state->child->endofcontents;
  1687.     }
  1688.     /*
  1689.      * Add in number of bytes consumed by child.
  1690.      * (Only EXPLICIT should have already consumed bytes itself.)
  1691.      */
  1692.     PORT_Assert (state->place == afterExplicit || state->consumed == 0);
  1693.     state->consumed += state->child->consumed;
  1694.     /*
  1695.      * Subtract from bytes pending; this only applies to a definite-length
  1696.      * EXPLICIT field.
  1697.      */
  1698.     if (state->pending) {
  1699. PORT_Assert (!state->indefinite);
  1700. PORT_Assert (state->place == afterExplicit);
  1701. /*
  1702.  * If we had a definite-length explicit, then what the child
  1703.  * consumed should be what was left pending.
  1704.  */
  1705. if (state->pending != state->child->consumed) {
  1706.     if (state->pending < state->child->consumed) {
  1707. PORT_SetError (SEC_ERROR_BAD_DER);
  1708. state->top->status = decodeError;
  1709. return;
  1710.     }
  1711.     /*
  1712.      * Okay, this is a hack.  It *should* be an error whether
  1713.      * pending is too big or too small, but it turns out that
  1714.      * we had a bug in our *old* DER encoder that ended up
  1715.      * counting an explicit header twice in the case where
  1716.      * the underlying type was an ANY.  So, because we cannot
  1717.      * prevent receiving these (our own certificate server can
  1718.      * send them to us), we need to be lenient and accept them.
  1719.      * To do so, we need to pretend as if we read all of the
  1720.      * bytes that the header said we would find, even though
  1721.      * we actually came up short.
  1722.      */
  1723.     state->consumed += (state->pending - state->child->consumed);
  1724. }
  1725. state->pending = 0;
  1726.     }
  1727.     /*
  1728.      * Indicate that we are done with child.
  1729.      */
  1730.     state->child->consumed = 0;
  1731.     /*
  1732.      * And move on to final state.
  1733.      * (Technically everybody could move to afterEndOfContents except
  1734.      * for an indefinite-length EXPLICIT; for simplicity though we assert
  1735.      * that but let the end-of-contents code do the real determination.)
  1736.      */
  1737.     PORT_Assert (state->place == afterExplicit || (! state->indefinite));
  1738.     state->place = beforeEndOfContents;
  1739. }
  1740. static void
  1741. sec_asn1d_prepare_for_end_of_contents (sec_asn1d_state *state)
  1742. {
  1743.     PORT_Assert (state->place == beforeEndOfContents);
  1744.     if (state->indefinite) {
  1745. state->place = duringEndOfContents;
  1746. state->pending = 2;
  1747.     } else {
  1748. state->place = afterEndOfContents;
  1749.     }
  1750. }
  1751. static unsigned long
  1752. sec_asn1d_parse_end_of_contents (sec_asn1d_state *state,
  1753.  const char *buf, unsigned long len)
  1754. {
  1755.     int i;
  1756.     PORT_Assert (state->pending <= 2);
  1757.     PORT_Assert (state->place == duringEndOfContents);
  1758.     if (len == 0) {
  1759. state->top->status = needBytes;
  1760. return 0;
  1761.     }
  1762.     if (state->pending < len)
  1763. len = state->pending;
  1764.     for (i = 0; i < len; i++) {
  1765. if (buf[i] != 0) {
  1766.     /*
  1767.      * We expect to find only zeros; if not, just give up.
  1768.      */
  1769.     PORT_SetError (SEC_ERROR_BAD_DER);
  1770.     state->top->status = decodeError;
  1771.     return 0;
  1772. }
  1773.     }
  1774.     state->pending -= len;
  1775.     if (state->pending == 0) {
  1776. state->place = afterEndOfContents;
  1777. state->endofcontents = PR_TRUE;
  1778.     }
  1779.     return len;
  1780. }
  1781. static void
  1782. sec_asn1d_pop_state (sec_asn1d_state *state)
  1783. {
  1784. #if 0 /* XXX I think this should always be handled explicitly by parent? */
  1785.     /*
  1786.      * Account for our child.
  1787.      */
  1788.     if (state->child != NULL) {
  1789. state->consumed += state->child->consumed;
  1790. if (state->pending) {
  1791.     PORT_Assert (!state->indefinite);
  1792.     PORT_Assert (state->child->consumed <= state->pending);
  1793.     state->pending -= state->child->consumed;
  1794. }
  1795. state->child->consumed = 0;
  1796.     }
  1797. #endif /* XXX */
  1798.     /*
  1799.      * Free our child.
  1800.      */
  1801.     sec_asn1d_free_child (state, PR_FALSE);
  1802.     /*
  1803.      * Just make my parent be the current state.  It will then clean
  1804.      * up after me and free me (or reuse me).
  1805.      */
  1806.     state->top->current = state->parent;
  1807. }
  1808. static sec_asn1d_state *
  1809. sec_asn1d_before_choice
  1810. (
  1811.   sec_asn1d_state *state
  1812. )
  1813. {
  1814.   sec_asn1d_state *child;
  1815.   if( state->allocate ) {
  1816.     void *dest;
  1817.     dest = sec_asn1d_zalloc(state->top->their_pool, state->theTemplate->size);
  1818.     if( (void *)NULL == dest ) {
  1819.       state->top->status = decodeError;
  1820.       return (sec_asn1d_state *)NULL;
  1821.     }
  1822.     state->dest = (char *)dest + state->theTemplate->offset;
  1823.   }
  1824.   child = sec_asn1d_push_state(state->top, state->theTemplate + 1, 
  1825.                                state->dest, PR_FALSE);
  1826.   if( (sec_asn1d_state *)NULL == child ) {
  1827.     return (sec_asn1d_state *)NULL;
  1828.   }
  1829.   sec_asn1d_scrub_state(child);
  1830.   child = sec_asn1d_init_state_based_on_template(child);
  1831.   if( (sec_asn1d_state *)NULL == child ) {
  1832.     return (sec_asn1d_state *)NULL;
  1833.   }
  1834.   child->optional = PR_TRUE;
  1835.   state->place = duringChoice;
  1836.   return child;
  1837. }
  1838. static sec_asn1d_state *
  1839. sec_asn1d_during_choice
  1840. (
  1841.   sec_asn1d_state *state
  1842. )
  1843. {
  1844.   sec_asn1d_state *child = state->child;
  1845.   
  1846.   PORT_Assert((sec_asn1d_state *)NULL != child);
  1847.   if( child->missing ) {
  1848.     unsigned char child_found_tag_modifiers = 0;
  1849.     unsigned long child_found_tag_number = 0;
  1850.     child->theTemplate++;
  1851.     if( 0 == child->theTemplate->kind ) {
  1852.       /* Ran out of choices */
  1853.       PORT_SetError(SEC_ERROR_BAD_DER);
  1854.       state->top->status = decodeError;
  1855.       return (sec_asn1d_state *)NULL;
  1856.     }
  1857.     state->consumed += child->consumed;
  1858.     /* cargo'd from next_in_sequence innards */
  1859.     if( state->pending ) {
  1860.       PORT_Assert(!state->indefinite);
  1861.       PORT_Assert(child->consumed <= state->pending);
  1862.       state->pending -= child->consumed;
  1863.       if( 0 == state->pending ) {
  1864.         /* XXX uh.. not sure if I should have stopped this
  1865.          * from happening before. */
  1866.         PORT_Assert(0);
  1867.         PORT_SetError(SEC_ERROR_BAD_DER);
  1868.         state->top->status = decodeError;
  1869.         return (sec_asn1d_state *)NULL;
  1870.       }
  1871.     }
  1872.     child->consumed = 0;
  1873.     sec_asn1d_scrub_state(child);
  1874.     /* move it on top again */
  1875.     state->top->current = child;
  1876.     child_found_tag_modifiers = child->found_tag_modifiers;
  1877.     child_found_tag_number = child->found_tag_number;
  1878.     child = sec_asn1d_init_state_based_on_template(child);
  1879.     if( (sec_asn1d_state *)NULL == child ) {
  1880.       return (sec_asn1d_state *)NULL;
  1881.     }
  1882.     /* copy our findings to the new top */
  1883.     child->found_tag_modifiers = child_found_tag_modifiers;
  1884.     child->found_tag_number = child_found_tag_number;
  1885.     child->optional = PR_TRUE;
  1886.     child->place = afterIdentifier;
  1887.     return child;
  1888.   } else {
  1889.     if( (void *)NULL != state->dest ) {
  1890.       /* Store the enum */
  1891.       int *which = (int *)((char *)state->dest + state->theTemplate->offset);
  1892.       *which = (int)child->theTemplate->size;
  1893.     }
  1894.     child->place = notInUse;
  1895.     state->place = afterChoice;
  1896.     return state;
  1897.   }
  1898. }
  1899. static void
  1900. sec_asn1d_after_choice
  1901. (
  1902.   sec_asn1d_state *state
  1903. )
  1904. {
  1905.   state->consumed += state->child->consumed;
  1906.   state->child->consumed = 0;
  1907.   state->place = afterEndOfContents;
  1908.   sec_asn1d_pop_state(state);
  1909. }
  1910. unsigned long
  1911. sec_asn1d_uinteger(SECItem *src)
  1912. {
  1913.     unsigned long value;
  1914.     int len;
  1915.     if (src->len > 5 || (src->len > 4 && src->data[0] == 0))
  1916. return 0;
  1917.     value = 0;
  1918.     len = src->len;
  1919.     while (len) {
  1920. value <<= 8;
  1921. value |= src->data[--len];
  1922.     }
  1923.     return value;
  1924. }
  1925. SECStatus
  1926. SEC_ASN1DecodeInteger(SECItem *src, unsigned long *value)
  1927. {
  1928.     unsigned long v;
  1929.     int i;
  1930.     
  1931.     if (src->len > sizeof(unsigned long))
  1932. return SECFailure;
  1933.     if (src->data[0] & 0x80)
  1934. v = -1; /* signed and negative - start with all 1's */
  1935.     else
  1936. v = 0;
  1937.     for (i= 0; i < src->len; i++) {
  1938. /* shift in next byte */
  1939. v <<= 8;
  1940. v |= src->data[i];
  1941.     }
  1942.     *value = v;
  1943.     return SECSuccess;
  1944. }
  1945. #ifdef DEBUG_ASN1D_STATES
  1946. static void
  1947. dump_states
  1948. (
  1949.   SEC_ASN1DecoderContext *cx
  1950. )
  1951. {
  1952.   sec_asn1d_state *state;
  1953.   for( state = cx->current; state->parent; state = state->parent ) {
  1954.     ;
  1955.   }
  1956.   for( ; state; state = state->child ) {
  1957.     int i;
  1958.     for( i = 0; i < state->depth; i++ ) {
  1959.       printf("  ");
  1960.     }
  1961.     printf("%s: template[0]->kind = 0x%02x, expect tag number = 0x%02xn",
  1962.            (state == cx->current) ? "STATE" : "State",
  1963.            state->theTemplate->kind, state->expect_tag_number);
  1964.   }
  1965.   return;
  1966. }
  1967. #endif /* DEBUG_ASN1D_STATES */
  1968. SECStatus
  1969. SEC_ASN1DecoderUpdate (SEC_ASN1DecoderContext *cx,
  1970.        const char *buf, unsigned long len)
  1971. {
  1972.     sec_asn1d_state *state = NULL;
  1973.     unsigned long consumed;
  1974.     SEC_ASN1EncodingPart what;
  1975.     if (cx->status == needBytes)
  1976. cx->status = keepGoing;
  1977.     while (cx->status == keepGoing) {
  1978. state = cx->current;
  1979. what = SEC_ASN1_Contents;
  1980. consumed = 0;
  1981. #ifdef DEBUG_ASN1D_STATES
  1982.         printf("nPLACE = %s, next byte = 0x%02xn",
  1983.                (state->place >= 0 && state->place <= notInUse) ?
  1984.                place_names[ state->place ] : "(undefined)",
  1985.                (unsigned int)((unsigned char *)buf)[ consumed ]);
  1986.         dump_states(cx);
  1987. #endif /* DEBUG_ASN1D_STATES */
  1988. switch (state->place) {
  1989.   case beforeIdentifier:
  1990.     consumed = sec_asn1d_parse_identifier (state, buf, len);
  1991.     what = SEC_ASN1_Identifier;
  1992.     break;
  1993.   case duringIdentifier:
  1994.     consumed = sec_asn1d_parse_more_identifier (state, buf, len);
  1995.     what = SEC_ASN1_Identifier;
  1996.     break;
  1997.   case afterIdentifier:
  1998.     sec_asn1d_confirm_identifier (state);
  1999.     break;
  2000.   case beforeLength:
  2001.     consumed = sec_asn1d_parse_length (state, buf, len);
  2002.     what = SEC_ASN1_Length;
  2003.     break;
  2004.   case duringLength:
  2005.     consumed = sec_asn1d_parse_more_length (state, buf, len);
  2006.     what = SEC_ASN1_Length;
  2007.     break;
  2008.   case afterLength:
  2009.     sec_asn1d_prepare_for_contents (state);
  2010.     break;
  2011.   case beforeBitString:
  2012.     consumed = sec_asn1d_parse_bit_string (state, buf, len);
  2013.     break;
  2014.   case duringBitString:
  2015.     consumed = sec_asn1d_parse_more_bit_string (state, buf, len);
  2016.     break;
  2017.   case duringConstructedString:
  2018.     sec_asn1d_next_substring (state);
  2019.     break;
  2020.   case duringGroup:
  2021.     sec_asn1d_next_in_group (state);
  2022.     break;
  2023.   case duringLeaf:
  2024.     consumed = sec_asn1d_parse_leaf (state, buf, len);
  2025.     break;
  2026.   case duringSaveEncoding:
  2027.     sec_asn1d_reuse_encoding (state);
  2028.     break;
  2029.   case duringSequence:
  2030.     sec_asn1d_next_in_sequence (state);
  2031.     break;
  2032.   case afterConstructedString:
  2033.     sec_asn1d_concat_substrings (state);
  2034.     break;
  2035.   case afterExplicit:
  2036.   case afterImplicit:
  2037.   case afterInline:
  2038.   case afterPointer:
  2039.     sec_asn1d_absorb_child (state);
  2040.     break;
  2041.   case afterGroup:
  2042.     sec_asn1d_concat_group (state);
  2043.     break;
  2044.   case afterSaveEncoding:
  2045.     /* XXX comment! */
  2046.     return SECSuccess;
  2047.   case beforeEndOfContents:
  2048.     sec_asn1d_prepare_for_end_of_contents (state);
  2049.     break;
  2050.   case duringEndOfContents:
  2051.     consumed = sec_asn1d_parse_end_of_contents (state, buf, len);
  2052.     what = SEC_ASN1_EndOfContents;
  2053.     break;
  2054.   case afterEndOfContents:
  2055.     sec_asn1d_pop_state (state);
  2056.     break;
  2057.           case beforeChoice:
  2058.             state = sec_asn1d_before_choice(state);
  2059.             break;
  2060.           case duringChoice:
  2061.             state = sec_asn1d_during_choice(state);
  2062.             break;
  2063.           case afterChoice:
  2064.             sec_asn1d_after_choice(state);
  2065.             break;
  2066.   case notInUse:
  2067.   default:
  2068.     /* This is not an error, but rather a plain old BUG! */
  2069.     PORT_Assert (0);
  2070.     PORT_SetError (SEC_ERROR_BAD_DER);
  2071.     cx->status = decodeError;
  2072.     break;
  2073. }
  2074. if (cx->status == decodeError)
  2075.     break;
  2076. /* We should not consume more than we have.  */
  2077. PORT_Assert (consumed <= len);
  2078. /* It might have changed, so we have to update our local copy.  */
  2079. state = cx->current;
  2080. /* If it is NULL, we have popped all the way to the top.  */
  2081. if (state == NULL) {
  2082.     PORT_Assert (consumed == 0);
  2083. #if 0 /* XXX I want this here, but it seems that we have situations (like
  2084.  * downloading a pkcs7 cert chain from some issuers) that give us a
  2085.  * length which is greater than the entire encoding.  So, we cannot
  2086.  * have this be an error.
  2087.  */
  2088.     if (len > 0)
  2089. cx->status = decodeError;
  2090.     else
  2091. #endif
  2092. cx->status = allDone;
  2093.     break;
  2094. }
  2095. else if (state->theTemplate->kind == SEC_ASN1_SKIP_REST) {
  2096.     cx->status = allDone;
  2097.     break;
  2098. }
  2099.   
  2100. if (consumed == 0)
  2101.     continue;
  2102. /*
  2103.  * The following check is specifically looking for an ANY
  2104.  * that is *not* also an INNER, because we need to save aside
  2105.  * all bytes in that case -- the contents parts will get
  2106.  * handled like all other contents, and the end-of-contents
  2107.  * bytes are added by the concat code, but the outer header
  2108.  * bytes need to get saved too, so we do them explicitly here.
  2109.  */
  2110. if (state->underlying_kind == SEC_ASN1_ANY
  2111.     && !cx->filter_only && (what == SEC_ASN1_Identifier
  2112.     || what == SEC_ASN1_Length)) {
  2113.     sec_asn1d_record_any_header (state, buf, consumed);
  2114. }
  2115. /*
  2116.  * We had some number of good, accepted bytes.  If the caller
  2117.  * has registered to see them, pass them along.
  2118.  */
  2119. if (state->top->filter_proc != NULL) {
  2120.     int depth;
  2121.     depth = state->depth;
  2122.     if (what == SEC_ASN1_EndOfContents && !state->indefinite) {
  2123. PORT_Assert (state->parent != NULL
  2124.      && state->parent->indefinite);
  2125. depth--;
  2126. PORT_Assert (depth == state->parent->depth);
  2127.     }
  2128.     (* state->top->filter_proc) (state->top->filter_arg,
  2129.  buf, consumed, depth, what);
  2130. }
  2131. state->consumed += consumed;
  2132. buf += consumed;
  2133. len -= consumed;
  2134.     }
  2135.     if (cx->status == decodeError) {
  2136. while (state != NULL) {
  2137.     sec_asn1d_free_child (state, PR_TRUE);
  2138.     state = state->parent;
  2139. }
  2140. #ifdef SEC_ASN1D_FREE_ON_ERROR /*
  2141.  * XXX This does not work because we can
  2142.  * end up leaving behind dangling pointers
  2143.  * to stuff that was allocated.  In order
  2144.  * to make this really work (which would
  2145.  * be a good thing, I think), we need to
  2146.  * keep track of every place/pointer that
  2147.  * was allocated and make sure to NULL it
  2148.  * out before we then free back to the mark.
  2149.  */
  2150. if (cx->their_pool != NULL) {
  2151.     PORT_Assert (cx->their_mark != NULL);
  2152.     PORT_ArenaRelease (cx->their_pool, cx->their_mark);
  2153. }
  2154. #endif
  2155. return SECFailure;
  2156.     }
  2157. #if 0 /* XXX This is what I want, but cannot have because it seems we
  2158.  * have situations (like when downloading a pkcs7 cert chain from
  2159.  * some issuers) that give us a total length which is greater than
  2160.  * the entire encoding.  So, we have to allow allDone to have a
  2161.  * remaining length greater than zero.  I wanted to catch internal
  2162.  * bugs with this, noticing when we do not have the right length.
  2163.  * Oh well.
  2164.  */
  2165.     PORT_Assert (len == 0
  2166.  && (cx->status == needBytes || cx->status == allDone));
  2167. #else
  2168.     PORT_Assert ((len == 0 && cx->status == needBytes)
  2169.  || cx->status == allDone);
  2170. #endif
  2171.     return SECSuccess;
  2172. }
  2173. SECStatus
  2174. SEC_ASN1DecoderFinish (SEC_ASN1DecoderContext *cx)
  2175. {
  2176.     SECStatus rv;
  2177.     if (cx->status == needBytes) {
  2178. PORT_SetError (SEC_ERROR_BAD_DER);
  2179. rv = SECFailure;
  2180.     } else {
  2181. rv = SECSuccess;
  2182.     }
  2183.     /*
  2184.      * XXX anything else that needs to be finished?
  2185.      */
  2186.     PORT_FreeArena (cx->our_pool, PR_FALSE);
  2187.     return rv;
  2188. }
  2189. SEC_ASN1DecoderContext *
  2190. SEC_ASN1DecoderStart (PRArenaPool *their_pool, void *dest,
  2191.       const SEC_ASN1Template *theTemplate)
  2192. {
  2193.     PRArenaPool *our_pool;
  2194.     SEC_ASN1DecoderContext *cx;
  2195.     our_pool = PORT_NewArena (SEC_ASN1_DEFAULT_ARENA_SIZE);
  2196.     if (our_pool == NULL)
  2197. return NULL;
  2198.     cx = (SEC_ASN1DecoderContext*)PORT_ArenaZAlloc (our_pool, sizeof(*cx));
  2199.     if (cx == NULL) {
  2200. PORT_FreeArena (our_pool, PR_FALSE);
  2201. return NULL;
  2202.     }
  2203.     cx->our_pool = our_pool;
  2204.     if (their_pool != NULL) {
  2205. cx->their_pool = their_pool;
  2206. #ifdef SEC_ASN1D_FREE_ON_ERROR
  2207. cx->their_mark = PORT_ArenaMark (their_pool);
  2208. #endif
  2209.     }
  2210.     cx->status = needBytes;
  2211.     if (sec_asn1d_push_state(cx, theTemplate, dest, PR_FALSE) == NULL
  2212. || sec_asn1d_init_state_based_on_template (cx->current) == NULL) {
  2213. /*
  2214.  * Trouble initializing (probably due to failed allocations)
  2215.  * requires that we just give up.
  2216.  */
  2217. PORT_FreeArena (our_pool, PR_FALSE);
  2218. return NULL;
  2219.     }
  2220.     return cx;
  2221. }
  2222. void
  2223. SEC_ASN1DecoderSetFilterProc (SEC_ASN1DecoderContext *cx,
  2224.       SEC_ASN1WriteProc fn, void *arg,
  2225.       PRBool only)
  2226. {
  2227.     /* check that we are "between" fields here */
  2228.     PORT_Assert (cx->during_notify);
  2229.     cx->filter_proc = fn;
  2230.     cx->filter_arg = arg;
  2231.     cx->filter_only = only;
  2232. }
  2233. void
  2234. SEC_ASN1DecoderClearFilterProc (SEC_ASN1DecoderContext *cx)
  2235. {
  2236.     /* check that we are "between" fields here */
  2237.     PORT_Assert (cx->during_notify);
  2238.     cx->filter_proc = NULL;
  2239.     cx->filter_arg = NULL;
  2240.     cx->filter_only = PR_FALSE;
  2241. }
  2242. void
  2243. SEC_ASN1DecoderSetNotifyProc (SEC_ASN1DecoderContext *cx,
  2244.       SEC_ASN1NotifyProc fn, void *arg)
  2245. {
  2246.     cx->notify_proc = fn;
  2247.     cx->notify_arg = arg;
  2248. }
  2249. void
  2250. SEC_ASN1DecoderClearNotifyProc (SEC_ASN1DecoderContext *cx)
  2251. {
  2252.     cx->notify_proc = NULL;
  2253.     cx->notify_arg = NULL; /* not necessary; just being clean */
  2254. }
  2255. SECStatus
  2256. SEC_ASN1Decode (PRArenaPool *poolp, void *dest,
  2257. const SEC_ASN1Template *theTemplate,
  2258. const char *buf, long len)
  2259. {
  2260.     SEC_ASN1DecoderContext *dcx;
  2261.     SECStatus urv, frv;
  2262.     dcx = SEC_ASN1DecoderStart (poolp, dest, theTemplate);
  2263.     if (dcx == NULL)
  2264. return SECFailure;
  2265.     urv = SEC_ASN1DecoderUpdate (dcx, buf, len);
  2266.     frv = SEC_ASN1DecoderFinish (dcx);
  2267.     if (urv != SECSuccess)
  2268. return urv;
  2269.     return frv;
  2270. }
  2271. SECStatus
  2272. SEC_ASN1DecodeItem (PRArenaPool *poolp, void *dest,
  2273.     const SEC_ASN1Template *theTemplate,
  2274.     SECItem *item)
  2275. {
  2276.     return SEC_ASN1Decode (poolp, dest, theTemplate,
  2277.    (char *) item->data, item->len);
  2278. }
  2279. /*
  2280.  * Generic templates for individual/simple items and pointers to
  2281.  * and sets of same.
  2282.  *
  2283.  * If you need to add a new one, please note the following:
  2284.  *  - For each new basic type you should add *four* templates:
  2285.  * one plain, one PointerTo, one SequenceOf and one SetOf.
  2286.  *  - If the new type can be constructed (meaning, it is a
  2287.  * *string* type according to BER/DER rules), then you should
  2288.  * or-in SEC_ASN1_MAY_STREAM to the type in the basic template.
  2289.  * See the definition of the OctetString template for an example.
  2290.  *  - It may not be obvious, but these are in *alphabetical*
  2291.  * order based on the SEC_ASN1_XXX name; so put new ones in
  2292.  * the appropriate place.
  2293.  */
  2294. const SEC_ASN1Template SEC_AnyTemplate[] = {
  2295.     { SEC_ASN1_ANY | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem) }
  2296. };
  2297. const SEC_ASN1Template SEC_PointerToAnyTemplate[] = {
  2298.     { SEC_ASN1_POINTER, 0, SEC_AnyTemplate }
  2299. };
  2300. const SEC_ASN1Template SEC_SequenceOfAnyTemplate[] = {
  2301.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_AnyTemplate }
  2302. };
  2303. const SEC_ASN1Template SEC_SetOfAnyTemplate[] = {
  2304.     { SEC_ASN1_SET_OF, 0, SEC_AnyTemplate }
  2305. };
  2306. const SEC_ASN1Template SEC_BitStringTemplate[] = {
  2307.     { SEC_ASN1_BIT_STRING | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem) }
  2308. };
  2309. const SEC_ASN1Template SEC_PointerToBitStringTemplate[] = {
  2310.     { SEC_ASN1_POINTER, 0, SEC_BitStringTemplate }
  2311. };
  2312. const SEC_ASN1Template SEC_SequenceOfBitStringTemplate[] = {
  2313.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_BitStringTemplate }
  2314. };
  2315. const SEC_ASN1Template SEC_SetOfBitStringTemplate[] = {
  2316.     { SEC_ASN1_SET_OF, 0, SEC_BitStringTemplate }
  2317. };
  2318. const SEC_ASN1Template SEC_BMPStringTemplate[] = {
  2319.     { SEC_ASN1_BMP_STRING | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem) }
  2320. };
  2321. const SEC_ASN1Template SEC_PointerToBMPStringTemplate[] = {
  2322.     { SEC_ASN1_POINTER, 0, SEC_BMPStringTemplate }
  2323. };
  2324. const SEC_ASN1Template SEC_SequenceOfBMPStringTemplate[] = {
  2325.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_BMPStringTemplate }
  2326. };
  2327. const SEC_ASN1Template SEC_SetOfBMPStringTemplate[] = {
  2328.     { SEC_ASN1_SET_OF, 0, SEC_BMPStringTemplate }
  2329. };
  2330. const SEC_ASN1Template SEC_BooleanTemplate[] = {
  2331.     { SEC_ASN1_BOOLEAN, 0, NULL, sizeof(SECItem) }
  2332. };
  2333. const SEC_ASN1Template SEC_PointerToBooleanTemplate[] = {
  2334.     { SEC_ASN1_POINTER, 0, SEC_BooleanTemplate }
  2335. };
  2336. const SEC_ASN1Template SEC_SequenceOfBooleanTemplate[] = {
  2337.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_BooleanTemplate }
  2338. };
  2339. const SEC_ASN1Template SEC_SetOfBooleanTemplate[] = {
  2340.     { SEC_ASN1_SET_OF, 0, SEC_BooleanTemplate }
  2341. };
  2342. const SEC_ASN1Template SEC_EnumeratedTemplate[] = {
  2343.     { SEC_ASN1_ENUMERATED, 0, NULL, sizeof(SECItem) }
  2344. };
  2345. const SEC_ASN1Template SEC_PointerToEnumeratedTemplate[] = {
  2346.     { SEC_ASN1_POINTER, 0, SEC_EnumeratedTemplate }
  2347. };
  2348. const SEC_ASN1Template SEC_SequenceOfEnumeratedTemplate[] = {
  2349.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_EnumeratedTemplate }
  2350. };
  2351. const SEC_ASN1Template SEC_SetOfEnumeratedTemplate[] = {
  2352.     { SEC_ASN1_SET_OF, 0, SEC_EnumeratedTemplate }
  2353. };
  2354. const SEC_ASN1Template SEC_GeneralizedTimeTemplate[] = {
  2355.     { SEC_ASN1_GENERALIZED_TIME | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem)}
  2356. };
  2357. const SEC_ASN1Template SEC_PointerToGeneralizedTimeTemplate[] = {
  2358.     { SEC_ASN1_POINTER, 0, SEC_GeneralizedTimeTemplate }
  2359. };
  2360. const SEC_ASN1Template SEC_SequenceOfGeneralizedTimeTemplate[] = {
  2361.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_GeneralizedTimeTemplate }
  2362. };
  2363. const SEC_ASN1Template SEC_SetOfGeneralizedTimeTemplate[] = {
  2364.     { SEC_ASN1_SET_OF, 0, SEC_GeneralizedTimeTemplate }
  2365. };
  2366. const SEC_ASN1Template SEC_IA5StringTemplate[] = {
  2367.     { SEC_ASN1_IA5_STRING | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem) }
  2368. };
  2369. const SEC_ASN1Template SEC_PointerToIA5StringTemplate[] = {
  2370.     { SEC_ASN1_POINTER, 0, SEC_IA5StringTemplate }
  2371. };
  2372. const SEC_ASN1Template SEC_SequenceOfIA5StringTemplate[] = {
  2373.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_IA5StringTemplate }
  2374. };
  2375. const SEC_ASN1Template SEC_SetOfIA5StringTemplate[] = {
  2376.     { SEC_ASN1_SET_OF, 0, SEC_IA5StringTemplate }
  2377. };
  2378. const SEC_ASN1Template SEC_IntegerTemplate[] = {
  2379.     { SEC_ASN1_INTEGER, 0, NULL, sizeof(SECItem) }
  2380. };
  2381. const SEC_ASN1Template SEC_PointerToIntegerTemplate[] = {
  2382.     { SEC_ASN1_POINTER, 0, SEC_IntegerTemplate }
  2383. };
  2384. const SEC_ASN1Template SEC_SequenceOfIntegerTemplate[] = {
  2385.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_IntegerTemplate }
  2386. };
  2387. const SEC_ASN1Template SEC_SetOfIntegerTemplate[] = {
  2388.     { SEC_ASN1_SET_OF, 0, SEC_IntegerTemplate }
  2389. };
  2390. const SEC_ASN1Template SEC_NullTemplate[] = {
  2391.     { SEC_ASN1_NULL, 0, NULL, sizeof(SECItem) }
  2392. };
  2393. const SEC_ASN1Template SEC_PointerToNullTemplate[] = {
  2394.     { SEC_ASN1_POINTER, 0, SEC_NullTemplate }
  2395. };
  2396. const SEC_ASN1Template SEC_SequenceOfNullTemplate[] = {
  2397.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_NullTemplate }
  2398. };
  2399. const SEC_ASN1Template SEC_SetOfNullTemplate[] = {
  2400.     { SEC_ASN1_SET_OF, 0, SEC_NullTemplate }
  2401. };
  2402. const SEC_ASN1Template SEC_ObjectIDTemplate[] = {
  2403.     { SEC_ASN1_OBJECT_ID, 0, NULL, sizeof(SECItem) }
  2404. };
  2405. const SEC_ASN1Template SEC_PointerToObjectIDTemplate[] = {
  2406.     { SEC_ASN1_POINTER, 0, SEC_ObjectIDTemplate }
  2407. };
  2408. const SEC_ASN1Template SEC_SequenceOfObjectIDTemplate[] = {
  2409.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_ObjectIDTemplate }
  2410. };
  2411. const SEC_ASN1Template SEC_SetOfObjectIDTemplate[] = {
  2412.     { SEC_ASN1_SET_OF, 0, SEC_ObjectIDTemplate }
  2413. };
  2414. const SEC_ASN1Template SEC_OctetStringTemplate[] = {
  2415.     { SEC_ASN1_OCTET_STRING | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem) }
  2416. };
  2417. const SEC_ASN1Template SEC_PointerToOctetStringTemplate[] = {
  2418.     { SEC_ASN1_POINTER | SEC_ASN1_MAY_STREAM, 0, SEC_OctetStringTemplate }
  2419. };
  2420. const SEC_ASN1Template SEC_SequenceOfOctetStringTemplate[] = {
  2421.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_OctetStringTemplate }
  2422. };
  2423. const SEC_ASN1Template SEC_SetOfOctetStringTemplate[] = {
  2424.     { SEC_ASN1_SET_OF, 0, SEC_OctetStringTemplate }
  2425. };
  2426. const SEC_ASN1Template SEC_PrintableStringTemplate[] = {
  2427.     { SEC_ASN1_PRINTABLE_STRING | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem)}
  2428. };
  2429. const SEC_ASN1Template SEC_PointerToPrintableStringTemplate[] = {
  2430.     { SEC_ASN1_POINTER, 0, SEC_PrintableStringTemplate }
  2431. };
  2432. const SEC_ASN1Template SEC_SequenceOfPrintableStringTemplate[] = {
  2433.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_PrintableStringTemplate }
  2434. };
  2435. const SEC_ASN1Template SEC_SetOfPrintableStringTemplate[] = {
  2436.     { SEC_ASN1_SET_OF, 0, SEC_PrintableStringTemplate }
  2437. };
  2438. const SEC_ASN1Template SEC_T61StringTemplate[] = {
  2439.     { SEC_ASN1_T61_STRING | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem) }
  2440. };
  2441. const SEC_ASN1Template SEC_PointerToT61StringTemplate[] = {
  2442.     { SEC_ASN1_POINTER, 0, SEC_T61StringTemplate }
  2443. };
  2444. const SEC_ASN1Template SEC_SequenceOfT61StringTemplate[] = {
  2445.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_T61StringTemplate }
  2446. };
  2447. const SEC_ASN1Template SEC_SetOfT61StringTemplate[] = {
  2448.     { SEC_ASN1_SET_OF, 0, SEC_T61StringTemplate }
  2449. };
  2450. const SEC_ASN1Template SEC_UniversalStringTemplate[] = {
  2451.     { SEC_ASN1_UNIVERSAL_STRING | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem)}
  2452. };
  2453. const SEC_ASN1Template SEC_PointerToUniversalStringTemplate[] = {
  2454.     { SEC_ASN1_POINTER, 0, SEC_UniversalStringTemplate }
  2455. };
  2456. const SEC_ASN1Template SEC_SequenceOfUniversalStringTemplate[] = {
  2457.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_UniversalStringTemplate }
  2458. };
  2459. const SEC_ASN1Template SEC_SetOfUniversalStringTemplate[] = {
  2460.     { SEC_ASN1_SET_OF, 0, SEC_UniversalStringTemplate }
  2461. };
  2462. const SEC_ASN1Template SEC_UTCTimeTemplate[] = {
  2463.     { SEC_ASN1_UTC_TIME | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem) }
  2464. };
  2465. const SEC_ASN1Template SEC_PointerToUTCTimeTemplate[] = {
  2466.     { SEC_ASN1_POINTER, 0, SEC_UTCTimeTemplate }
  2467. };
  2468. const SEC_ASN1Template SEC_SequenceOfUTCTimeTemplate[] = {
  2469.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_UTCTimeTemplate }
  2470. };
  2471. const SEC_ASN1Template SEC_SetOfUTCTimeTemplate[] = {
  2472.     { SEC_ASN1_SET_OF, 0, SEC_UTCTimeTemplate }
  2473. };
  2474. const SEC_ASN1Template SEC_UTF8StringTemplate[] = {
  2475.     { SEC_ASN1_UTF8_STRING | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem)}
  2476. };
  2477. const SEC_ASN1Template SEC_PointerToUTF8StringTemplate[] = {
  2478.     { SEC_ASN1_POINTER, 0, SEC_UTF8StringTemplate }
  2479. };
  2480. const SEC_ASN1Template SEC_SequenceOfUTF8StringTemplate[] = {
  2481.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_UTF8StringTemplate }
  2482. };
  2483. const SEC_ASN1Template SEC_SetOfUTF8StringTemplate[] = {
  2484.     { SEC_ASN1_SET_OF, 0, SEC_UTF8StringTemplate }
  2485. };
  2486. const SEC_ASN1Template SEC_VisibleStringTemplate[] = {
  2487.     { SEC_ASN1_VISIBLE_STRING | SEC_ASN1_MAY_STREAM, 0, NULL, sizeof(SECItem) }
  2488. };
  2489. const SEC_ASN1Template SEC_PointerToVisibleStringTemplate[] = {
  2490.     { SEC_ASN1_POINTER, 0, SEC_VisibleStringTemplate }
  2491. };
  2492. const SEC_ASN1Template SEC_SequenceOfVisibleStringTemplate[] = {
  2493.     { SEC_ASN1_SEQUENCE_OF, 0, SEC_VisibleStringTemplate }
  2494. };
  2495. const SEC_ASN1Template SEC_SetOfVisibleStringTemplate[] = {
  2496.     { SEC_ASN1_SET_OF, 0, SEC_VisibleStringTemplate }
  2497. };
  2498. /*
  2499.  * Template for skipping a subitem.
  2500.  *
  2501.  * Note that it only makes sense to use this for decoding (when you want
  2502.  * to decode something where you are only interested in one or two of
  2503.  * the fields); you cannot encode a SKIP!
  2504.  */
  2505. const SEC_ASN1Template SEC_SkipTemplate[] = {
  2506.     { SEC_ASN1_SKIP }
  2507. };