git.sur5r.net Git - openldap/blob - include/lber.h

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms are permitted only
   7  * as authorized by the OpenLDAP Public License.  A copy of this
   8  * license is available at http://www.OpenLDAP.org/license.html or
   9  * in file LICENSE in the top-level directory of the distribution.
  10  */
  11 /* Portions
  12  * Copyright (c) 1990 Regents of the University of Michigan.
  13  * All rights reserved.
  14  *
  15  * Redistribution and use in source and binary forms are permitted
  16  * provided that this notice is preserved and that due credit is given
  17  * to the University of Michigan at Ann Arbor. The name of the University
  18  * may not be used to endorse or promote products derived from this
  19  * software without specific prior written permission. This software
  20  * is provided ``as is'' without express or implied warranty.
  21  */
  22
  23 #ifndef _LBER_H
  24 #define _LBER_H
  25
  26 #include <lber_types.h>
  27
  28 LDAP_BEGIN_DECL
  29
  30 /* Overview of LBER tag construction
  31  *
  32  *      Bits
  33  *      ______
  34  *      8 7 | CLASS
  35  *      0 0 = UNIVERSAL
  36  *      0 1 = APPLICATION
  37  *      1 0 = CONTEXT-SPECIFIC
  38  *      1 1 = PRIVATE
  39  *              _____
  40  *              | 6 | DATA-TYPE
  41  *                0 = PRIMITIVE
  42  *                1 = CONSTRUCTED
  43  *                      ___________
  44  *                      | 5 ... 1 | TAG-NUMBER
  45  */
  46
  47 /* BER classes and mask */
  48 #define LBER_CLASS_UNIVERSAL    ((ber_tag_t) 0x00U)
  49 #define LBER_CLASS_APPLICATION  ((ber_tag_t) 0x40U)
  50 #define LBER_CLASS_CONTEXT              ((ber_tag_t) 0x80U)
  51 #define LBER_CLASS_PRIVATE              ((ber_tag_t) 0xc0U)
  52 #define LBER_CLASS_MASK                 ((ber_tag_t) 0xc0U)
  53
  54 /* BER encoding type and mask */
  55 #define LBER_PRIMITIVE                  ((ber_tag_t) 0x00U)
  56 #define LBER_CONSTRUCTED                ((ber_tag_t) 0x20U)
  57 #define LBER_ENCODING_MASK              ((ber_tag_t) 0x20U)
  58
  59 #define LBER_BIG_TAG_MASK               ((ber_tag_t) 0x1fU)
  60 #define LBER_MORE_TAG_MASK              ((ber_tag_t) 0x80U)
  61
  62 /*
  63  * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
  64  * as valid BER tags, and so it is safe to use them to report errors.  In
  65  * fact, any tag for which the following is true is invalid:
  66  */
  67 #define LBER_INVALID(t)     (((t) & (ber_tag_t) 0x080) \
  68         && (((t) & (ber_tag_t) ~ 0x0FF))
  69
  70 #define LBER_ERROR                      ((ber_tag_t) -1)
  71 #define LBER_DEFAULT            ((ber_tag_t) -1)
  72
  73 /* general BER types we know about */
  74 #define LBER_BOOLEAN            ((ber_tag_t) 0x01UL)
  75 #define LBER_INTEGER            ((ber_tag_t) 0x02UL)
  76 #define LBER_BITSTRING          ((ber_tag_t) 0x03UL)
  77 #define LBER_OCTETSTRING        ((ber_tag_t) 0x04UL)
  78 #define LBER_NULL                       ((ber_tag_t) 0x05UL)
  79 #define LBER_ENUMERATED         ((ber_tag_t) 0x0aUL)
  80 #define LBER_SEQUENCE           ((ber_tag_t) 0x30UL)    /* constructed */
  81 #define LBER_SET                        ((ber_tag_t) 0x31UL)    /* constructed */
  82
  83 typedef int (*BERTranslateProc) LDAP_P((
  84         char **bufp,
  85         ber_len_t *buflenp,
  86         int free_input ));
  87
  88 /* LBER BerElement options */
  89 #define LBER_USE_DER            0x01
  90 #define LBER_USE_INDEFINITE_LEN 0x02
  91 #define LBER_TRANSLATE_STRINGS  0x04
  92
  93 /* get/set options for BerElement */
  94 #define LBER_OPT_BER_OPTIONS                    0x01
  95 #define LBER_OPT_BER_DEBUG                              0x02
  96 #define LBER_OPT_BER_REMAINING_BYTES    0x03
  97 #define LBER_OPT_BER_TOTAL_BYTES                0x04
  98 #define LBER_OPT_BER_BYTES_TO_WRITE             0x05
  99
 100 #define LBER_OPT_DEBUG_LEVEL    LBER_OPT_BER_DEBUG
 101 #define LBER_OPT_REMAINING_BYTES        LBER_OPT_BER_REMAINING_BYTES
 102 #define LBER_OPT_TOTAL_BYTES            LBER_OPT_BER_TOTAL_BYTES
 103 #define LBER_OPT_BYTES_TO_WRITE         LBER_OPT_BER_BYTES_TO_WRITE
 104
 105 #define LBER_OPT_LOG_PRINT_FN   0x8001
 106 #define LBER_OPT_MEMORY_FNS             0x8002
 107 #define LBER_OPT_ERROR_FN               0x8003
 108
 109 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
 110
 111 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
 112
 113 typedef void* (*BER_MEMALLOC_FN)        LDAP_P(( ber_len_t size ));
 114 typedef void* (*BER_MEMCALLOC_FN)       LDAP_P(( ber_len_t n, ber_len_t size ));
 115 typedef void* (*BER_MEMREALLOC_FN)      LDAP_P(( void *p, ber_len_t size ));
 116 typedef void  (*BER_MEMFREE_FN)         LDAP_P(( void *p ));
 117
 118 typedef struct lber_memory_fns {
 119         BER_MEMALLOC_FN bmf_malloc;
 120         BER_MEMCALLOC_FN bmf_calloc;
 121         BER_MEMREALLOC_FN bmf_realloc;
 122         BER_MEMFREE_FN bmf_free;
 123 } BerMemoryFunctions;
 124
 125 /* LBER Sockbuf options */
 126 #define LBER_TO_FILE           0x01     /* to a file referenced by sb_fd   */
 127 #define LBER_TO_FILE_ONLY      0x02     /* only write to file, not network */
 128 #define LBER_MAX_INCOMING_SIZE 0x04     /* impose limit on incoming stuff  */
 129 #define LBER_NO_READ_AHEAD     0x08     /* read only as much as requested  */
 130
 131 /* get/set options for Sockbuf */
 132 #define LBER_OPT_SOCKBUF_DESC           0x1000
 133 #define LBER_OPT_SOCKBUF_OPTIONS        0x1001
 134 #define LBER_OPT_SOCKBUF_DEBUG          0x1002
 135
 136 /* on/off values */
 137 #define LBER_OPT_ON             ((void *) 1)
 138 #define LBER_OPT_OFF    ((void *) 0)
 139
 140 #define LBER_OPT_SUCCESS        (0)
 141 #define LBER_OPT_ERROR          (-1)
 142
 143 typedef struct berelement BerElement;
 144 typedef struct sockbuf Sockbuf;
 145 typedef struct seqorset Seqorset;
 146
 147 /* structure for returning a sequence of octet strings + length */
 148 typedef struct berval {
 149         ber_len_t       bv_len;
 150         char            *bv_val;
 151 } BerValue;
 152
 153 /* this should be moved to lber-int.h */
 154 #ifdef __MINGW32__
 155 #   undef LDAP_F_PRE
 156 #   ifdef LIBLBER_DECL
 157 #       define LDAP_F_PRE       extern __declspec(LIBLBER_DECL)
 158 #   else
 159 #       define LDAP_F_PRE       extern
 160 #   endif
 161 #endif
 162
 163 /*
 164  * in bprint.c:
 165  */
 166 LDAP_F( void )
 167 ber_print_error LDAP_P((
 168         LDAP_CONST char *data ));
 169
 170 LDAP_F( void )
 171 ber_bprint LDAP_P((
 172         LDAP_CONST char *data, ber_len_t len ));
 173
 174 LDAP_F( void )
 175 ber_dump LDAP_P((
 176         BerElement *ber, int inout ));
 177
 178 LDAP_F( void )
 179 ber_sos_dump LDAP_P((
 180         Seqorset *sos ));
 181
 182
 183 /*
 184  * in decode.c:
 185  */
 186 typedef int (*BERDecodeCallback) LDAP_P((
 187         BerElement *ber,
 188         void *data,
 189         int mode ));
 190
 191 LDAP_F( ber_tag_t )
 192 ber_get_tag LDAP_P((
 193         BerElement *ber ));
 194
 195 LDAP_F( ber_tag_t )
 196 ber_skip_tag LDAP_P((
 197         BerElement *ber,
 198         ber_len_t *len ));
 199
 200 LDAP_F( ber_tag_t )
 201 ber_peek_tag LDAP_P((
 202         BerElement *ber,
 203         ber_len_t *len ));
 204
 205 LDAP_F( ber_tag_t )
 206 ber_get_int LDAP_P((
 207         BerElement *ber,
 208         ber_int_t *num ));
 209
 210 LDAP_F( ber_tag_t )
 211 ber_get_stringb LDAP_P((
 212         BerElement *ber,
 213         char *buf,
 214         ber_len_t *len ));
 215
 216 LDAP_F( ber_tag_t )
 217 ber_get_stringa LDAP_P((
 218         BerElement *ber,
 219         char **buf ));
 220
 221 LDAP_F( ber_tag_t )
 222 ber_get_stringal LDAP_P((
 223         BerElement *ber,
 224         struct berval **bv ));
 225
 226 LDAP_F( ber_tag_t )
 227 ber_get_bitstringa LDAP_P((
 228         BerElement *ber,
 229         char **buf,
 230         ber_len_t *len ));
 231
 232 LDAP_F( ber_tag_t )
 233 ber_get_null LDAP_P((
 234         BerElement *ber ));
 235
 236 LDAP_F( ber_tag_t )
 237 ber_get_boolean LDAP_P((
 238         BerElement *ber,
 239         ber_int_t *boolval ));
 240
 241 LDAP_F( ber_tag_t )
 242 ber_first_element LDAP_P((
 243         BerElement *ber,
 244         ber_len_t *len,
 245         char **last ));
 246
 247 LDAP_F( ber_tag_t )
 248 ber_next_element LDAP_P((
 249         BerElement *ber,
 250         ber_len_t *len,
 251         LDAP_CONST char *last ));
 252
 253 LDAP_F( ber_tag_t )
 254 ber_scanf LDAP_P((
 255         BerElement *ber,
 256         LDAP_CONST char *fmt,
 257         ... ));
 258
 259 LDAP_F( void )
 260 ber_set_string_translators LDAP_P((
 261         BerElement *ber,
 262         BERTranslateProc encode_proc,
 263         BERTranslateProc decode_proc ));
 264
 265 /*
 266  * in encode.c
 267  */
 268 typedef int (*BEREncodeCallback) LDAP_P((
 269         BerElement *ber,
 270         void *data ));
 271
 272 LDAP_F( int )
 273 ber_put_enum LDAP_P((
 274         BerElement *ber,
 275         ber_int_t num,
 276         ber_tag_t tag ));
 277
 278 LDAP_F( int )
 279 ber_put_int LDAP_P((
 280         BerElement *ber,
 281         ber_int_t num,
 282         ber_tag_t tag ));
 283
 284 LDAP_F( int )
 285 ber_put_ostring LDAP_P((
 286         BerElement *ber,
 287         LDAP_CONST char *str,
 288         ber_len_t len,
 289         ber_tag_t tag ));
 290
 291 LDAP_F( int )
 292 ber_put_berval LDAP_P((
 293         BerElement *ber,
 294         LDAP_CONST struct berval *bv,
 295         ber_tag_t tag ));
 296
 297 LDAP_F( int )
 298 ber_put_string LDAP_P((
 299         BerElement *ber,
 300         LDAP_CONST char *str,
 301         ber_tag_t tag ));
 302
 303 LDAP_F( int )
 304 ber_put_bitstring LDAP_P((
 305         BerElement *ber,
 306         LDAP_CONST char *str,
 307         ber_len_t bitlen,
 308         ber_tag_t tag ));
 309
 310 LDAP_F( int )
 311 ber_put_null LDAP_P((
 312         BerElement *ber,
 313         ber_tag_t tag ));
 314
 315 LDAP_F( int )
 316 ber_put_boolean LDAP_P((
 317         BerElement *ber,
 318         ber_int_t boolval,
 319         ber_tag_t tag ));
 320
 321 LDAP_F( int )
 322 ber_start_seq LDAP_P((
 323         BerElement *ber,
 324         ber_tag_t tag ));
 325
 326 LDAP_F( int )
 327 ber_start_set LDAP_P((
 328         BerElement *ber,
 329         ber_tag_t tag ));
 330
 331 LDAP_F( int )
 332 ber_put_seq LDAP_P((
 333         BerElement *ber ));
 334
 335 LDAP_F( int )
 336 ber_put_set LDAP_P((
 337         BerElement *ber ));
 338
 339 LDAP_F( int )
 340 ber_printf LDAP_P((
 341         BerElement *ber,
 342         LDAP_CONST char *fmt,
 343         ... ));
 344
 345
 346 /*
 347  * in io.c:
 348  */
 349
 350 LDAP_F( ber_slen_t )
 351 ber_read LDAP_P((
 352         BerElement *ber,
 353         char *buf,
 354         ber_len_t len ));
 355
 356 LDAP_F( ber_slen_t )
 357 ber_write LDAP_P((
 358         BerElement *ber,
 359         LDAP_CONST char *buf,
 360         ber_len_t len,
 361         int nosos ));
 362
 363 LDAP_F( void )
 364 ber_free LDAP_P((
 365         BerElement *ber,
 366         int freebuf ));
 367
 368 LDAP_F( int )
 369 ber_flush LDAP_P((
 370         Sockbuf *sb,
 371         BerElement *ber,
 372         int freeit ));
 373
 374 LDAP_F( BerElement * )
 375 ber_alloc LDAP_P(( void )); /* DEPRECATED */
 376
 377 LDAP_F( BerElement * )
 378 der_alloc LDAP_P(( void )); /* DEPRECATED */
 379
 380 LDAP_F( BerElement * )
 381 ber_alloc_t LDAP_P((
 382         int beroptions ));
 383
 384 LDAP_F( BerElement * )
 385 ber_dup LDAP_P((
 386         BerElement *ber ));
 387
 388 LDAP_F( ber_tag_t )
 389 ber_get_next LDAP_P((
 390         Sockbuf *sb,
 391         ber_len_t *len,
 392         BerElement *ber ));
 393
 394 LDAP_F( void )
 395 ber_init_w_nullc LDAP_P((
 396         BerElement *ber,
 397         int options ));
 398
 399 LDAP_F( void )
 400 ber_reset LDAP_P((
 401         BerElement *ber,
 402         int was_writing ));
 403
 404 LDAP_F( BerElement * )
 405 ber_init LDAP_P((
 406         struct berval *bv ));
 407
 408 LDAP_F( int )
 409 ber_flatten LDAP_P((
 410         BerElement *ber,
 411         struct berval **bvPtr ));
 412
 413 /*
 414  * LBER ber accessor functions
 415  */
 416
 417 LDAP_F( int )
 418 ber_get_option LDAP_P((
 419         void *item,
 420         int option,
 421         void *outvalue));
 422
 423 LDAP_F( int )
 424 ber_set_option LDAP_P((
 425         void *item,
 426         int option,
 427         LDAP_CONST void *invalue));
 428
 429 /*
 430  * LBER sockbuf.c
 431  */
 432
 433 LDAP_F( Sockbuf * )
 434 ber_sockbuf_alloc( void );
 435
 436 LDAP_F( Sockbuf *  )
 437 ber_sockbuf_alloc_fd(
 438         ber_socket_t fd );
 439
 440 LDAP_F( void )
 441 ber_sockbuf_free(
 442         Sockbuf *sb );
 443
 444 /*
 445  * LBER memory.c
 446  */
 447 LDAP_F( void * )
 448 ber_memalloc LDAP_P((
 449         ber_len_t s ));
 450
 451 LDAP_F( void * )
 452 ber_memrealloc LDAP_P((
 453         void* p,
 454         ber_len_t s ));
 455
 456 LDAP_F( void * )
 457 ber_memcalloc LDAP_P((
 458         ber_len_t n,
 459         ber_len_t s ));
 460
 461 LDAP_F( void )
 462 ber_memfree LDAP_P((
 463         void* p ));
 464
 465 LDAP_F( void )
 466 ber_memvfree LDAP_P((
 467         void** vector ));
 468
 469 LDAP_F( void )
 470 ber_bvfree LDAP_P((
 471         struct berval *bv ));
 472
 473 LDAP_F( void )
 474 ber_bvecfree LDAP_P((
 475         struct berval **bv ));
 476
 477 LDAP_F( struct berval * )
 478 ber_bvdup LDAP_P((
 479         LDAP_CONST struct berval *bv ));
 480
 481 LDAP_F( char * )
 482 ber_strdup LDAP_P((
 483         LDAP_CONST char * ));
 484
 485 /*
 486  * error.c
 487  */
 488 LDAP_F( int * ) ber_errno_addr LDAP_P((void));
 489 #define ber_errno (*(ber_errno_addr)())
 490
 491 #define LBER_ERROR_NONE         0
 492 #define LBER_ERROR_PARAM        0x1
 493 #define LBER_ERROR_MEMORY       0x2
 494
 495 LDAP_END_DECL
 496
 497 #endif /* _LBER_H */