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.9  1995-06-19 12:38:26  quinn
  28  * Reorganized include-files. Added small features.
  29  *
  30  * Revision 1.8  1995/06/16  13:16:04  quinn
  31  * Fixed Defaultdiagformat.
  32  *
  33  * Revision 1.7  1995/05/29  08:11:32  quinn
  34  * Moved oid from odr/asn to util.
  35  *
  36  * Revision 1.6  1995/05/22  14:47:00  quinn
  37  * ODR_NULLVAL --> void
  38  *
  39  * Revision 1.5  1995/05/22  11:31:24  quinn
  40  * Added PDUs
  41  *
  42  * Revision 1.4  1995/05/16  08:50:33  quinn
  43  * License, documentation, and memory fixes
  44  *
  45  * Revision 1.3  1995/05/15  11:55:54  quinn
  46  * Work on asynchronous activity.
  47  *
  48  * Revision 1.2  1995/04/18  08:14:37  quinn
  49  * Added dynamic memory allocation on encoding
  50  *
  51  * Revision 1.1  1995/03/30  09:39:41  quinn
  52  * Moved .h files to include directory
  53  *
  54  * Revision 1.15  1995/03/29  15:39:57  quinn
  55  * Fixed bugs in the bitmask operations
  56  *
  57  * Revision 1.14  1995/03/27  08:33:15  quinn
  58  * Added more OID utilities.
  59  *
  60  * Revision 1.13  1995/03/17  10:17:44  quinn
  61  * Added memory management.
  62  *
  63  * Revision 1.12  1995/03/14  10:27:38  quinn
  64  * Modified makefile to use common lib
  65  * Beginning to add memory management to odr
  66  *
  67  * Revision 1.11  1995/03/10  11:44:41  quinn
  68  * Fixed serious stack-bug in odr_cons_begin
  69  *
  70  * Revision 1.10  1995/03/08  12:12:16  quinn
  71  * Added better error checking.
  72  *
  73  * Revision 1.9  1995/03/07  10:10:00  quinn
  74  * Added some headers for Adam.
  75  *
  76  * Revision 1.8  1995/03/07  09:23:16  quinn
  77  * Installing top-level API and documentation.
  78  *
  79  * Revision 1.7  1995/02/10  15:55:29  quinn
  80  * Bug fixes, mostly.
  81  *
  82  * Revision 1.6  1995/02/09  15:51:47  quinn
  83  * Works better now.
  84  *
  85  * Revision 1.5  1995/02/07  17:52:59  quinn
  86  * A damn mess, but now things work, I think.
  87  *
  88  * Revision 1.4  1995/02/06  16:45:03  quinn
  89  * Small mods.
  90  *
  91  * Revision 1.3  1995/02/03  17:04:36  quinn
  92  * *** empty log message ***
  93  *
  94  * Revision 1.2  1995/02/02  20:38:50  quinn
  95  * Updates.
  96  *
  97  * Revision 1.1  1995/02/02  16:21:53  quinn
  98  * First kick.
  99  *
 100  */
 101
 102 #ifndef ODR_H
 103 #define ODR_H
 104
 105 #include <stdio.h>
 106 #include <string.h>
 107
 108 #ifndef bool_t
 109 #define bool_t int
 110 #endif
 111
 112 /*
 113  * Tag modes
 114  */
 115 #define ODR_NONE -1
 116 #define ODR_IMPLICIT 0
 117 #define ODR_EXPLICIT 1
 118
 119 /*
 120  * Classes
 121  */
 122 #define ODR_UNIVERSAL   0
 123 #define ODR_APPLICATION 1
 124 #define ODR_CONTEXT     2
 125 #define ODR_PRIVATE     3
 126
 127 /*
 128  * UNIVERSAL tags
 129  */
 130 #define ODR_BOOLEAN     1
 131 #define ODR_INTEGER     2
 132 #define ODR_BITSTRING   3
 133 #define ODR_OCTETSTRING 4
 134 #define ODR_NULL        5
 135 #define ODR_OID         6
 136 #define ODR_ODESC       7
 137 #define ODR_EXTERNAL    8
 138 #define ODR_REAL        9
 139 #define ODR_ENUM        10
 140 #define ODR_SEQUENCE    16
 141 #define ODR_SET         17
 142 #define ODR_NUMERICSTRING   18
 143 #define ODR_PRINTABLESTRING 19
 144 #define ODR_GRAPHICSTRING   25
 145 #define ODR_VISIBLESTRING   26
 146 #define ODR_GENERALSTRING   27
 147
 148 /*
 149  * odr stream directions
 150  */
 151 #define ODR_DECODE      0
 152 #define ODR_ENCODE      1
 153 #define ODR_PRINT       2
 154
 155 typedef struct odr_oct
 156 {
 157     unsigned char *buf;
 158     int len;
 159     int size;
 160 } Odr_oct;
 161
 162 typedef void Odr_null;
 163 extern Odr_null *ODR_NULLVAL;
 164
 165 typedef Odr_oct Odr_any;
 166
 167 typedef struct odr_bitmask
 168 {
 169 #define ODR_BITMASK_SIZE 256
 170     unsigned char bits[ODR_BITMASK_SIZE];
 171     int top;
 172 } Odr_bitmask;
 173
 174 typedef int Odr_oid;   /* terminate by -1 */
 175
 176 typedef struct odr_constack
 177 {
 178     unsigned char *base;         /* starting point of data */
 179     int base_offset;
 180     int len;                     /* length of data, if known, else -1
 181                                         (decoding only) */
 182     unsigned char *lenb;         /* where to encode length */
 183     int len_offset;
 184     int lenlen;                  /* length of length-field */
 185 } odr_constack;
 186
 187 struct odr_memblock; /* defined in odr_mem.c */
 188 typedef struct odr_memblock *ODR_MEM;
 189
 190 #define ODR_S_SET     0
 191 #define ODR_S_CUR     1
 192 #define ODR_S_END     2
 193
 194 typedef struct odr_ecblock
 195 {
 196     int can_grow;         /* are we allowed to reallocate */
 197     unsigned char *buf;            /* memory handle */
 198     int pos;              /* current position */
 199     int top;              /* top of buffer */
 200     int size;             /* current buffer size */
 201 } odr_ecblock;
 202
 203
 204 typedef struct odr
 205 {
 206     int direction;       /* the direction of this stream */
 207
 208     int error;           /* current error state (0==OK) */
 209     unsigned char *buf;  /* for encoding or decoding */
 210     int buflen;          /* size of buffer for encoding, len for decoding */
 211     unsigned char *bp;   /* position in buffer */
 212     int left;            /* bytes remaining in buffer */
 213
 214     odr_ecblock ecb;     /* memory control block */
 215
 216     int t_class;         /* implicit tagging (-1==default tag) */
 217     int t_tag;
 218
 219     FILE *print;         /* output file for direction print */
 220     int indent;          /* current indent level for printing */
 221
 222     struct odr_memblock *mem;
 223
 224     /* stack for constructed types */
 225 #define ODR_MAX_STACK 50
 226     int stackp;          /* top of stack (-1 == initial state) */
 227     odr_constack stack[ODR_MAX_STACK];
 228 } *ODR;
 229
 230 typedef int (*Odr_fun)();
 231
 232 typedef struct odr_arm
 233 {
 234     int tagmode;
 235     int class;
 236     int tag;
 237     int which;
 238     Odr_fun fun;
 239 } Odr_arm;
 240
 241 /*
 242  * Error control.
 243  */
 244 #define ONONE           0
 245 #define OMEMORY         1
 246 #define OSYSERR         2
 247 #define OSPACE          3
 248 #define OREQUIRED       4
 249 #define OUNEXPECTED     5
 250 #define OOTHER          6
 251 #define OPROTO          7
 252 #define ODATA           8
 253 #define OSTACK          9
 254 #define OCONLEN        10
 255
 256 extern char *odr_errlist[];
 257
 258 int odr_geterror(ODR o);
 259 void odr_perror(ODR o, char *message);
 260 void odr_setprint(ODR o, FILE *file);
 261 ODR odr_createmem(int direction);
 262 void odr_reset(ODR o);
 263 void odr_destroy(ODR o);
 264 void odr_setbuf(ODR o, char *buf, int len, int can_grow);
 265 char *odr_getbuf(ODR o, int *len, int *size);
 266 void *odr_malloc(ODR o, int size);
 267 ODR_MEM odr_extract_mem(ODR o);
 268 void odr_release_mem(ODR_MEM p);
 269
 270 #define odr_implicit(o, t, p, cl, tg, opt)\
 271         (odr_implicit_settag((o), cl, tg), t ((o), (p), opt) )
 272
 273 #define odr_explicit(o, t, p, cl, tg, opt)\
 274         ((int) (odr_constructed_begin((o), (p), (cl), (tg)) ? \
 275         t ((o), (p), (opt)) &&\
 276         odr_constructed_end(o) : opt))
 277
 278 #define ODR_MASK_ZERO(mask)\
 279     ((void) (memset((mask)->bits, 0, ODR_BITMASK_SIZE),\
 280     (mask)->top = -1))
 281
 282 #define ODR_MASK_SET(mask, num)\
 283     (((mask)->bits[(num) >> 3] |= 0X80 >> ((num) & 0X07)),\
 284     (mask)->top < (num) >> 3 ? ((mask)->top = (num) >> 3) : 0)
 285
 286 #define ODR_MASK_CLEAR(mask, num)\
 287     ((mask)->bits[(num) >> 3] &= ~(0X80 >> ((num) & 0X07)))
 288
 289 #define ODR_MASK_GET(mask, num)  ( ((num) >> 3 <= (mask)->top) ? \
 290     ((mask)->bits[(num) >> 3] & (0X80 >> ((num) & 0X07)) ? 1 : 0) : 0)
 291
 292 /* Private macro.
 293  * write a single character at the current position - grow buffer if
 294  * necessary.
 295  * (no, we're not usually this anal about our macros, but this baby is
 296  *  next to unreadable without some indentation  :)
 297  */
 298 #define odr_putc(o, c) \
 299 ( \
 300     ( \
 301         (o)->ecb.pos < (o)->ecb.size ? \
 302         ( \
 303             (o)->ecb.buf[(o)->ecb.pos++] = (c), \
 304             0 \
 305         ) : \
 306         ( \
 307             odr_grow_block(&(o)->ecb, 1) == 0 ? \
 308             ( \
 309                 (o)->ecb.buf[(o)->ecb.pos++] = (c), \
 310                 0 \
 311             ) : \
 312             ( \
 313                 (o)->error = OSPACE, \
 314                 -1 \
 315             ) \
 316         ) \
 317     ) == 0 ? \
 318     ( \
 319         (o)->ecb.pos > (o)->ecb.top ? \
 320         ( \
 321             (o)->ecb.top = (o)->ecb.pos, \
 322             0 \
 323         ) : \
 324         0 \
 325     ) : \
 326         -1 \
 327 ) \
 328
 329 #define odr_tell(o) ((o)->ecb.pos)
 330 #define odr_ok(o) (!(o)->error)
 331
 332 #define ODR_MAXNAME 256
 333
 334 #include <prt.h>
 335 #include <dmalloc.h>
 336
 337 #endif