include/odr.h

   1 /*
   2  * Copyright (c) 1995, Index Data.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The name of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Log: odr.h,v $
  27  * Revision 1.17  1995-11-08 17:41:27  quinn
  28  * Smallish.
  29  *
  30  * Revision 1.16  1995/11/01  13:54:36  quinn
  31  * Minor adjustments
  32  *
  33  * Revision 1.15  1995/10/18  16:12:36  quinn
  34  * Better diagnostics.
  35  *
  36  * Revision 1.14  1995/09/29  17:12:04  quinn
  37  * Smallish
  38  *
  39  * Revision 1.13  1995/09/29  17:01:49  quinn
  40  * More Windows work
  41  *
  42  * Revision 1.12  1995/09/27  15:02:48  quinn
  43  * Modified function heads & prototypes.
  44  *
  45  * Revision 1.11  1995/08/15  12:00:09  quinn
  46  * Updated External
  47  *
  48  * Revision 1.10  1995/08/10  08:54:33  quinn
  49  * Added Explain.
  50  *
  51  * Revision 1.9  1995/06/19  12:38:26  quinn
  52  * Reorganized include-files. Added small features.
  53  *
  54  * Revision 1.8  1995/06/16  13:16:04  quinn
  55  * Fixed Defaultdiagformat.
  56  *
  57  * Revision 1.7  1995/05/29  08:11:32  quinn
  58  * Moved oid from odr/asn to util.
  59  *
  60  * Revision 1.6  1995/05/22  14:47:00  quinn
  61  * ODR_NULLVAL --> void
  62  *
  63  * Revision 1.5  1995/05/22  11:31:24  quinn
  64  * Added PDUs
  65  *
  66  * Revision 1.4  1995/05/16  08:50:33  quinn
  67  * License, documentation, and memory fixes
  68  *
  69  * Revision 1.3  1995/05/15  11:55:54  quinn
  70  * Work on asynchronous activity.
  71  *
  72  * Revision 1.2  1995/04/18  08:14:37  quinn
  73  * Added dynamic memory allocation on encoding
  74  *
  75  * Revision 1.1  1995/03/30  09:39:41  quinn
  76  * Moved .h files to include directory
  77  *
  78  * Revision 1.15  1995/03/29  15:39:57  quinn
  79  * Fixed bugs in the bitmask operations
  80  *
  81  * Revision 1.14  1995/03/27  08:33:15  quinn
  82  * Added more OID utilities.
  83  *
  84  * Revision 1.13  1995/03/17  10:17:44  quinn
  85  * Added memory management.
  86  *
  87  * Revision 1.12  1995/03/14  10:27:38  quinn
  88  * Modified makefile to use common lib
  89  * Beginning to add memory management to odr
  90  *
  91  * Revision 1.11  1995/03/10  11:44:41  quinn
  92  * Fixed serious stack-bug in odr_cons_begin
  93  *
  94  * Revision 1.10  1995/03/08  12:12:16  quinn
  95  * Added better error checking.
  96  *
  97  * Revision 1.9  1995/03/07  10:10:00  quinn
  98  * Added some headers for Adam.
  99  *
 100  * Revision 1.8  1995/03/07  09:23:16  quinn
 101  * Installing top-level API and documentation.
 102  *
 103  * Revision 1.7  1995/02/10  15:55:29  quinn
 104  * Bug fixes, mostly.
 105  *
 106  * Revision 1.6  1995/02/09  15:51:47  quinn
 107  * Works better now.
 108  *
 109  * Revision 1.5  1995/02/07  17:52:59  quinn
 110  * A damn mess, but now things work, I think.
 111  *
 112  * Revision 1.4  1995/02/06  16:45:03  quinn
 113  * Small mods.
 114  *
 115  * Revision 1.3  1995/02/03  17:04:36  quinn
 116  * *** empty log message ***
 117  *
 118  * Revision 1.2  1995/02/02  20:38:50  quinn
 119  * Updates.
 120  *
 121  * Revision 1.1  1995/02/02  16:21:53  quinn
 122  * First kick.
 123  *
 124  */
 125
 126 #ifndef ODR_H
 127 #define ODR_H
 128
 129 #include <stdio.h>
 130 #include <string.h>
 131
 132 #include <nmem.h>
 133 #include <yconfig.h>
 134
 135 #ifndef bool_t
 136 #define bool_t int
 137 #endif
 138
 139 /*
 140  * Tag modes
 141  */
 142 #define ODR_NONE -1
 143 #define ODR_IMPLICIT 0
 144 #define ODR_EXPLICIT 1
 145
 146 /*
 147  * Classes
 148  */
 149 #define ODR_UNIVERSAL   0
 150 #define ODR_APPLICATION 1
 151 #define ODR_CONTEXT     2
 152 #define ODR_PRIVATE     3
 153
 154 /*
 155  * UNIVERSAL tags
 156  */
 157 #define ODR_BOOLEAN     1
 158 #define ODR_INTEGER     2
 159 #define ODR_BITSTRING   3
 160 #define ODR_OCTETSTRING 4
 161 #define ODR_NULL        5
 162 #define ODR_OID         6
 163 #define ODR_ODESC       7
 164 #define ODR_EXTERNAL    8
 165 #define ODR_REAL        9
 166 #define ODR_ENUM        10
 167 #define ODR_SEQUENCE    16
 168 #define ODR_SET         17
 169 #define ODR_NUMERICSTRING   18
 170 #define ODR_PRINTABLESTRING 19
 171 #define ODR_GENERALIZEDTIME 24
 172 #define ODR_GRAPHICSTRING   25
 173 #define ODR_VISIBLESTRING   26
 174 #define ODR_GENERALSTRING   27
 175
 176 /*
 177  * odr stream directions
 178  */
 179 #define ODR_DECODE      0
 180 #define ODR_ENCODE      1
 181 #define ODR_PRINT       2
 182
 183 typedef struct odr_oct
 184 {
 185     unsigned char *buf;
 186     int len;
 187     int size;
 188 } Odr_oct;
 189
 190 typedef void Odr_null;
 191 extern Odr_null *ODR_NULLVAL;
 192
 193 typedef Odr_oct Odr_any;
 194
 195 typedef struct odr_bitmask
 196 {
 197 #define ODR_BITMASK_SIZE 256
 198     unsigned char bits[ODR_BITMASK_SIZE];
 199     int top;
 200 } Odr_bitmask;
 201
 202 typedef int Odr_oid;   /* terminate by -1 */
 203
 204 typedef struct odr_constack
 205 {
 206     unsigned char *base;         /* starting point of data */
 207     int base_offset;
 208     int len;                     /* length of data, if known, else -1
 209                                         (decoding only) */
 210     unsigned char *lenb;         /* where to encode length */
 211     int len_offset;
 212     int lenlen;                  /* length of length-field */
 213 } odr_constack;
 214
 215 struct odr_memblock; /* defined in odr_mem.c */
 216 typedef struct odr_memblock *ODR_MEM;
 217
 218 #define ODR_S_SET     0
 219 #define ODR_S_CUR     1
 220 #define ODR_S_END     2
 221
 222 typedef struct odr_ecblock
 223 {
 224     int can_grow;         /* are we allowed to reallocate */
 225     unsigned char *buf;            /* memory handle */
 226     int pos;              /* current position */
 227     int top;              /* top of buffer */
 228     int size;             /* current buffer size */
 229 } odr_ecblock;
 230
 231
 232 typedef struct odr
 233 {
 234     int direction;       /* the direction of this stream */
 235
 236     int error;           /* current error state (0==OK) */
 237     unsigned char *buf;  /* for encoding or decoding */
 238     int buflen;          /* size of buffer for encoding, len for decoding */
 239     unsigned char *bp;   /* position in buffer */
 240     int left;            /* bytes remaining in buffer */
 241
 242     odr_ecblock ecb;     /* memory control block */
 243
 244     int t_class;         /* implicit tagging (-1==default tag) */
 245     int t_tag;
 246
 247     int choice_bias;     /* force choice */
 248
 249     FILE *print;         /* output file for direction print */
 250     int indent;          /* current indent level for printing */
 251
 252     NMEM mem;            /* memory handle for decoding (primarily) */
 253
 254     /* stack for constructed types */
 255 #define ODR_MAX_STACK 50
 256     int stackp;          /* top of stack (-1 == initial state) */
 257     odr_constack stack[ODR_MAX_STACK];
 258 } *ODR;
 259
 260 typedef int (*Odr_fun)();
 261
 262 typedef struct odr_arm
 263 {
 264     int tagmode;
 265     int class;
 266     int tag;
 267     int which;
 268     Odr_fun fun;
 269 } Odr_arm;
 270
 271 /*
 272  * Error control.
 273  */
 274 #define ONONE           0
 275 #define OMEMORY         1
 276 #define OSYSERR         2
 277 #define OSPACE          3
 278 #define OREQUIRED       4
 279 #define OUNEXPECTED     5
 280 #define OOTHER          6
 281 #define OPROTO          7
 282 #define ODATA           8
 283 #define OSTACK          9
 284 #define OCONLEN        10
 285
 286 extern char *odr_errlist[];
 287
 288 int odr_geterror(ODR o);
 289 void odr_perror(ODR o, char *message);
 290 void odr_setprint(ODR o, FILE *file);
 291 ODR odr_createmem(int direction);
 292 void odr_reset(ODR o);
 293 void odr_destroy(ODR o);
 294 void odr_setbuf(ODR o, char *buf, int len, int can_grow);
 295 char *odr_getbuf(ODR o, int *len, int *size);
 296 void *odr_malloc(ODR o, int size);
 297 NMEM odr_extract_mem(ODR o);
 298 #define odr_release_mem(m) nmem_destroy(m)
 299 #define ODR_MEM NMEM
 300
 301 #define odr_implicit(o, t, p, cl, tg, opt)\
 302         (odr_implicit_settag((o), cl, tg), t ((o), (p), opt) )
 303
 304 #define odr_explicit(o, t, p, cl, tg, opt)\
 305         ((int) (odr_constructed_begin((o), (p), (cl), (tg)) ? \
 306         t ((o), (p), (opt)) &&\
 307         odr_constructed_end(o) : opt))
 308
 309 #define ODR_MASK_ZERO(mask)\
 310     ((void) (memset((mask)->bits, 0, ODR_BITMASK_SIZE),\
 311     (mask)->top = -1))
 312
 313 #define ODR_MASK_SET(mask, num)\
 314     (((mask)->bits[(num) >> 3] |= 0X80 >> ((num) & 0X07)),\
 315     (mask)->top < (num) >> 3 ? ((mask)->top = (num) >> 3) : 0)
 316
 317 #define ODR_MASK_CLEAR(mask, num)\
 318     ((mask)->bits[(num) >> 3] &= ~(0X80 >> ((num) & 0X07)))
 319
 320 #define ODR_MASK_GET(mask, num)  ( ((num) >> 3 <= (mask)->top) ? \
 321     ((mask)->bits[(num) >> 3] & (0X80 >> ((num) & 0X07)) ? 1 : 0) : 0)
 322
 323 /* Private macro.
 324  * write a single character at the current position - grow buffer if
 325  * necessary.
 326  * (no, we're not usually this anal about our macros, but this baby is
 327  *  next to unreadable without some indentation  :)
 328  */
 329 #define odr_putc(o, c) \
 330 ( \
 331     ( \
 332         (o)->ecb.pos < (o)->ecb.size ? \
 333         ( \
 334             (o)->ecb.buf[(o)->ecb.pos++] = (c), \
 335             0 \
 336         ) : \
 337         ( \
 338             odr_grow_block(&(o)->ecb, 1) == 0 ? \
 339             ( \
 340                 (o)->ecb.buf[(o)->ecb.pos++] = (c), \
 341                 0 \
 342             ) : \
 343             ( \
 344                 (o)->error = OSPACE, \
 345                 -1 \
 346             ) \
 347         ) \
 348     ) == 0 ? \
 349     ( \
 350         (o)->ecb.pos > (o)->ecb.top ? \
 351         ( \
 352             (o)->ecb.top = (o)->ecb.pos, \
 353             0 \
 354         ) : \
 355         0 \
 356     ) : \
 357         -1 \
 358 ) \
 359
 360 #define odr_tell(o) ((o)->ecb.pos)
 361 #define odr_offset(o) ((o)->bp - (o)->buf)
 362 #define odr_ok(o) (!(o)->error)
 363 #define odr_getmem(o) ((o)->mem)
 364 #define odr_setmem(o, v) ((o)->mem = (v))
 365
 366 #define ODR_MAXNAME 256
 367
 368 #include <prt.h>
 369 #include <xmalloc.h>
 370
 371 #endif