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) 0x080UL) \
  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    /* deprecated */
  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 #define LBER_OPT_LOG_PRINT_FILE         0x8004
 109
 110 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
 111
 112 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
 113
 114 typedef void* (*BER_MEMALLOC_FN)        LDAP_P(( ber_len_t size ));
 115 typedef void* (*BER_MEMCALLOC_FN)       LDAP_P(( ber_len_t n, ber_len_t size ));
 116 typedef void* (*BER_MEMREALLOC_FN)      LDAP_P(( void *p, ber_len_t size ));
 117 typedef void  (*BER_MEMFREE_FN)         LDAP_P(( void *p ));
 118
 119 typedef struct lber_memory_fns {
 120         BER_MEMALLOC_FN bmf_malloc;
 121         BER_MEMCALLOC_FN bmf_calloc;
 122         BER_MEMREALLOC_FN bmf_realloc;
 123         BER_MEMFREE_FN bmf_free;
 124 } BerMemoryFunctions;
 125
 126 /* LBER Sockbuf options */
 127 #define LBER_TO_FILE           0x01     /* to a file referenced by sb_fd   */
 128 #define LBER_TO_FILE_ONLY      0x02     /* only write to file, not network */
 129 #define LBER_MAX_INCOMING_SIZE 0x04     /* impose limit on incoming stuff  */
 130 #define LBER_NO_READ_AHEAD     0x08     /* read only as much as requested  */
 131
 132 /* get/set options for Sockbuf */
 133 #define LBER_OPT_SOCKBUF_DESC           0x1000
 134 #define LBER_OPT_SOCKBUF_OPTIONS        0x1001
 135 #define LBER_OPT_SOCKBUF_DEBUG          0x1002
 136
 137 /* on/off values */
 138 #define LBER_OPT_ON             ((void *) 1)
 139 #define LBER_OPT_OFF    ((void *) 0)
 140
 141 #define LBER_OPT_SUCCESS        (0)
 142 #define LBER_OPT_ERROR          (-1)
 143
 144 typedef struct berelement BerElement;
 145 typedef struct sockbuf Sockbuf;
 146 typedef struct seqorset Seqorset;
 147
 148 /* structure for returning a sequence of octet strings + length */
 149 typedef struct berval {
 150         ber_len_t       bv_len;
 151         char            *bv_val;
 152 } BerValue;
 153
 154 /* this should be moved to lber-int.h */
 155
 156 /*
 157  * in bprint.c:
 158  */
 159 LIBLBER_F( void )
 160 ber_print_error LDAP_P((
 161         LDAP_CONST char *data ));
 162
 163 LIBLBER_F( void )
 164 ber_bprint LDAP_P((
 165         LDAP_CONST char *data, ber_len_t len ));
 166
 167 LIBLBER_F( void )
 168 ber_dump LDAP_P((
 169         BerElement *ber, int inout ));
 170
 171 LIBLBER_F( void )
 172 ber_sos_dump LDAP_P((
 173         Seqorset *sos ));
 174
 175
 176 /*
 177  * in decode.c:
 178  */
 179 typedef int (*BERDecodeCallback) LDAP_P((
 180         BerElement *ber,
 181         void *data,
 182         int mode ));
 183
 184 LIBLBER_F( ber_tag_t )
 185 ber_get_tag LDAP_P((
 186         BerElement *ber ));
 187
 188 LIBLBER_F( ber_tag_t )
 189 ber_skip_tag LDAP_P((
 190         BerElement *ber,
 191         ber_len_t *len ));
 192
 193 LIBLBER_F( ber_tag_t )
 194 ber_peek_tag LDAP_P((
 195         BerElement *ber,
 196         ber_len_t *len ));
 197
 198 LIBLBER_F( ber_tag_t )
 199 ber_get_int LDAP_P((
 200         BerElement *ber,
 201         ber_int_t *num ));
 202
 203 LIBLBER_F( ber_tag_t )
 204 ber_get_stringb LDAP_P((
 205         BerElement *ber,
 206         char *buf,
 207         ber_len_t *len ));
 208
 209 LIBLBER_F( ber_tag_t )
 210 ber_get_stringa LDAP_P((
 211         BerElement *ber,
 212         char **buf ));
 213
 214 LIBLBER_F( ber_tag_t )
 215 ber_get_stringal LDAP_P((
 216         BerElement *ber,
 217         struct berval **bv ));
 218
 219 LIBLBER_F( ber_tag_t )
 220 ber_get_bitstringa LDAP_P((
 221         BerElement *ber,
 222         char **buf,
 223         ber_len_t *len ));
 224
 225 LIBLBER_F( ber_tag_t )
 226 ber_get_null LDAP_P((
 227         BerElement *ber ));
 228
 229 LIBLBER_F( ber_tag_t )
 230 ber_get_boolean LDAP_P((
 231         BerElement *ber,
 232         ber_int_t *boolval ));
 233
 234 LIBLBER_F( ber_tag_t )
 235 ber_first_element LDAP_P((
 236         BerElement *ber,
 237         ber_len_t *len,
 238         char **last ));
 239
 240 LIBLBER_F( ber_tag_t )
 241 ber_next_element LDAP_P((
 242         BerElement *ber,
 243         ber_len_t *len,
 244         LDAP_CONST char *last ));
 245
 246 LIBLBER_F( ber_tag_t )
 247 ber_scanf LDAP_P((
 248         BerElement *ber,
 249         LDAP_CONST char *fmt,
 250         ... ));
 251
 252 LIBLBER_F( void )
 253 ber_set_string_translators LDAP_P((
 254         BerElement *ber,
 255         BERTranslateProc encode_proc,
 256         BERTranslateProc decode_proc ));
 257
 258 /*
 259  * in encode.c
 260  */
 261 typedef int (*BEREncodeCallback) LDAP_P((
 262         BerElement *ber,
 263         void *data ));
 264
 265 LIBLBER_F( int )
 266 ber_put_enum LDAP_P((
 267         BerElement *ber,
 268         ber_int_t num,
 269         ber_tag_t tag ));
 270
 271 LIBLBER_F( int )
 272 ber_put_int LDAP_P((
 273         BerElement *ber,
 274         ber_int_t num,
 275         ber_tag_t tag ));
 276
 277 LIBLBER_F( int )
 278 ber_put_ostring LDAP_P((
 279         BerElement *ber,
 280         LDAP_CONST char *str,
 281         ber_len_t len,
 282         ber_tag_t tag ));
 283
 284 LIBLBER_F( int )
 285 ber_put_berval LDAP_P((
 286         BerElement *ber,
 287         LDAP_CONST struct berval *bv,
 288         ber_tag_t tag ));
 289
 290 LIBLBER_F( int )
 291 ber_put_string LDAP_P((
 292         BerElement *ber,
 293         LDAP_CONST char *str,
 294         ber_tag_t tag ));
 295
 296 LIBLBER_F( int )
 297 ber_put_bitstring LDAP_P((
 298         BerElement *ber,
 299         LDAP_CONST char *str,
 300         ber_len_t bitlen,
 301         ber_tag_t tag ));
 302
 303 LIBLBER_F( int )
 304 ber_put_null LDAP_P((
 305         BerElement *ber,
 306         ber_tag_t tag ));
 307
 308 LIBLBER_F( int )
 309 ber_put_boolean LDAP_P((
 310         BerElement *ber,
 311         ber_int_t boolval,
 312         ber_tag_t tag ));
 313
 314 LIBLBER_F( int )
 315 ber_start_seq LDAP_P((
 316         BerElement *ber,
 317         ber_tag_t tag ));
 318
 319 LIBLBER_F( int )
 320 ber_start_set LDAP_P((
 321         BerElement *ber,
 322         ber_tag_t tag ));
 323
 324 LIBLBER_F( int )
 325 ber_put_seq LDAP_P((
 326         BerElement *ber ));
 327
 328 LIBLBER_F( int )
 329 ber_put_set LDAP_P((
 330         BerElement *ber ));
 331
 332 LIBLBER_F( int )
 333 ber_printf LDAP_P((
 334         BerElement *ber,
 335         LDAP_CONST char *fmt,
 336         ... ));
 337
 338
 339 /*
 340  * in io.c:
 341  */
 342
 343 LIBLBER_F( ber_slen_t )
 344 ber_read LDAP_P((
 345         BerElement *ber,
 346         char *buf,
 347         ber_len_t len ));
 348
 349 LIBLBER_F( ber_slen_t )
 350 ber_write LDAP_P((
 351         BerElement *ber,
 352         LDAP_CONST char *buf,
 353         ber_len_t len,
 354         int nosos ));
 355
 356 LIBLBER_F( void )
 357 ber_free LDAP_P((
 358         BerElement *ber,
 359         int freebuf ));
 360
 361 LIBLBER_F( int )
 362 ber_flush LDAP_P((
 363         Sockbuf *sb,
 364         BerElement *ber,
 365         int freeit ));
 366
 367 LIBLBER_F( BerElement * )
 368 ber_alloc LDAP_P(( void )); /* DEPRECATED */
 369
 370 LIBLBER_F( BerElement * )
 371 der_alloc LDAP_P(( void )); /* DEPRECATED */
 372
 373 LIBLBER_F( BerElement * )
 374 ber_alloc_t LDAP_P((
 375         int beroptions ));
 376
 377 LIBLBER_F( BerElement * )
 378 ber_dup LDAP_P((
 379         BerElement *ber ));
 380
 381 LIBLBER_F( ber_tag_t )
 382 ber_get_next LDAP_P((
 383         Sockbuf *sb,
 384         ber_len_t *len,
 385         BerElement *ber ));
 386
 387 LIBLBER_F( void )
 388 ber_init_w_nullc LDAP_P((
 389         BerElement *ber,
 390         int options ));
 391
 392 LIBLBER_F( void )
 393 ber_reset LDAP_P((
 394         BerElement *ber,
 395         int was_writing ));
 396
 397 LIBLBER_F( BerElement * )
 398 ber_init LDAP_P((
 399         struct berval *bv ));
 400
 401 LIBLBER_F( int )
 402 ber_flatten LDAP_P((
 403         BerElement *ber,
 404         struct berval **bvPtr ));
 405
 406 /*
 407  * LBER ber accessor functions
 408  */
 409
 410 LIBLBER_F( int )
 411 ber_get_option LDAP_P((
 412         void *item,
 413         int option,
 414         void *outvalue));
 415
 416 LIBLBER_F( int )
 417 ber_set_option LDAP_P((
 418         void *item,
 419         int option,
 420         LDAP_CONST void *invalue));
 421
 422 /*
 423  * LBER sockbuf.c
 424  */
 425
 426 LIBLBER_F( Sockbuf * )
 427 ber_sockbuf_alloc( void );
 428
 429 LIBLBER_F( Sockbuf *  )
 430 ber_sockbuf_alloc_fd(
 431         ber_socket_t fd );
 432
 433 LIBLBER_F( void )
 434 ber_sockbuf_free(
 435         Sockbuf *sb );
 436
 437 /*
 438  * LBER memory.c
 439  */
 440 LIBLBER_F( void * )
 441 ber_memalloc LDAP_P((
 442         ber_len_t s ));
 443
 444 LIBLBER_F( void * )
 445 ber_memrealloc LDAP_P((
 446         void* p,
 447         ber_len_t s ));
 448
 449 LIBLBER_F( void * )
 450 ber_memcalloc LDAP_P((
 451         ber_len_t n,
 452         ber_len_t s ));
 453
 454 LIBLBER_F( void )
 455 ber_memfree LDAP_P((
 456         void* p ));
 457
 458 LIBLBER_F( void )
 459 ber_memvfree LDAP_P((
 460         void** vector ));
 461
 462 LIBLBER_F( void )
 463 ber_bvfree LDAP_P((
 464         struct berval *bv ));
 465
 466 LIBLBER_F( void )
 467 ber_bvecfree LDAP_P((
 468         struct berval **bv ));
 469
 470 LIBLBER_F( int )
 471 ber_bvecadd LDAP_P((
 472         struct berval ***bvec,
 473         struct berval *bv ));
 474
 475 LIBLBER_F( struct berval * )
 476 ber_bvdup LDAP_P((
 477         LDAP_CONST struct berval *bv ));
 478
 479 LIBLBER_F( struct berval * )
 480 ber_bvstr LDAP_P((
 481         LDAP_CONST char * ));
 482
 483 LIBLBER_F( struct berval * )
 484 ber_bvstrdup LDAP_P((
 485         LDAP_CONST char * ));
 486
 487 LIBLBER_F( char * )
 488 ber_strdup LDAP_P((
 489         LDAP_CONST char * ));
 490
 491 /*
 492  * error.c
 493  */
 494 LIBLBER_F( int * ) ber_errno_addr LDAP_P((void));
 495 #define ber_errno (*(ber_errno_addr)())
 496
 497 #define LBER_ERROR_NONE         0
 498 #define LBER_ERROR_PARAM        0x1
 499 #define LBER_ERROR_MEMORY       0x2
 500
 501 LDAP_END_DECL
 502
 503 #endif /* _LBER_H */