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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted only as authorized by the OpenLDAP
   8  * Public License.  A copy of this license is available at
   9  * http://www.OpenLDAP.org/license.html or in file LICENSE in the
  10  * top-level directory of the distribution.
  11  */
  12 /* Portions
  13  * Copyright (c) 1990 Regents of the University of Michigan.
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms are permitted
  17  * provided that this notice is preserved and that due credit is given
  18  * to the University of Michigan at Ann Arbor. The name of the University
  19  * may not be used to endorse or promote products derived from this
  20  * software without specific prior written permission. This software
  21  * is provided ``as is'' without express or implied warranty.
  22  */
  23
  24 #ifndef _LBER_H
  25 #define _LBER_H
  26
  27 #include <lber_types.h>
  28
  29 LDAP_BEGIN_DECL
  30
  31 /* Overview of LBER tag construction
  32  *
  33  *      Bits
  34  *      ______
  35  *      8 7 | CLASS
  36  *      0 0 = UNIVERSAL
  37  *      0 1 = APPLICATION
  38  *      1 0 = CONTEXT-SPECIFIC
  39  *      1 1 = PRIVATE
  40  *              _____
  41  *              | 6 | DATA-TYPE
  42  *                0 = PRIMITIVE
  43  *                1 = CONSTRUCTED
  44  *                      ___________
  45  *                      | 5 ... 1 | TAG-NUMBER
  46  */
  47
  48 /* BER classes and mask */
  49 #define LBER_CLASS_UNIVERSAL    ((ber_tag_t) 0x00U)
  50 #define LBER_CLASS_APPLICATION  ((ber_tag_t) 0x40U)
  51 #define LBER_CLASS_CONTEXT              ((ber_tag_t) 0x80U)
  52 #define LBER_CLASS_PRIVATE              ((ber_tag_t) 0xc0U)
  53 #define LBER_CLASS_MASK                 ((ber_tag_t) 0xc0U)
  54
  55 /* BER encoding type and mask */
  56 #define LBER_PRIMITIVE                  ((ber_tag_t) 0x00U)
  57 #define LBER_CONSTRUCTED                ((ber_tag_t) 0x20U)
  58 #define LBER_ENCODING_MASK              ((ber_tag_t) 0x20U)
  59
  60 #define LBER_BIG_TAG_MASK               ((ber_tag_t) 0x1fU)
  61 #define LBER_MORE_TAG_MASK              ((ber_tag_t) 0x80U)
  62
  63 /*
  64  * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
  65  * as valid BER tags, and so it is safe to use them to report errors.  In
  66  * fact, any tag for which the following is true is invalid:
  67  */
  68 #define LBER_INVALID(t)     (((t) & (ber_tag_t) 0x080UL) \
  69         && (((t) & (ber_tag_t) ~ 0x0FF))
  70
  71 #define LBER_ERROR                      ((ber_tag_t) -1)
  72 #define LBER_DEFAULT            ((ber_tag_t) -1)
  73
  74 /* general BER types we know about */
  75 #define LBER_BOOLEAN            ((ber_tag_t) 0x01UL)
  76 #define LBER_INTEGER            ((ber_tag_t) 0x02UL)
  77 #define LBER_BITSTRING          ((ber_tag_t) 0x03UL)
  78 #define LBER_OCTETSTRING        ((ber_tag_t) 0x04UL)
  79 #define LBER_NULL                       ((ber_tag_t) 0x05UL)
  80 #define LBER_ENUMERATED         ((ber_tag_t) 0x0aUL)
  81 #define LBER_SEQUENCE           ((ber_tag_t) 0x30UL)    /* constructed */
  82 #define LBER_SET                        ((ber_tag_t) 0x31UL)    /* constructed */
  83
  84 /* LBER BerElement options */
  85 #define LBER_USE_DER            0x01
  86
  87 /* get/set options for BerElement */
  88 #define LBER_OPT_BER_OPTIONS                    0x01
  89 #define LBER_OPT_BER_DEBUG                              0x02
  90 #define LBER_OPT_BER_REMAINING_BYTES    0x03
  91 #define LBER_OPT_BER_TOTAL_BYTES                0x04
  92 #define LBER_OPT_BER_BYTES_TO_WRITE             0x05
  93
  94 #define LBER_OPT_DEBUG_LEVEL    LBER_OPT_BER_DEBUG
  95 #define LBER_OPT_REMAINING_BYTES        LBER_OPT_BER_REMAINING_BYTES
  96 #define LBER_OPT_TOTAL_BYTES            LBER_OPT_BER_TOTAL_BYTES
  97 #define LBER_OPT_BYTES_TO_WRITE         LBER_OPT_BER_BYTES_TO_WRITE
  98
  99 #define LBER_OPT_LOG_PRINT_FN   0x8001
 100 #define LBER_OPT_MEMORY_FNS             0x8002
 101 #define LBER_OPT_ERROR_FN               0x8003
 102 #define LBER_OPT_LOG_PRINT_FILE         0x8004
 103
 104 /* get/set Memory Debug options */
 105 #define LBER_OPT_MEMORY_INUSE           0x8005  /* for memory debugging */
 106 #define LBER_OPT_LOG_PROC           0x8006  /* for external logging function */
 107
 108 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
 109
 110 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf ));
 111
 112 typedef void* (*BER_MEMALLOC_FN)        LDAP_P(( ber_len_t size ));
 113 typedef void* (*BER_MEMCALLOC_FN)       LDAP_P(( ber_len_t n, ber_len_t size ));
 114 typedef void* (*BER_MEMREALLOC_FN)      LDAP_P(( void *p, ber_len_t size ));
 115 typedef void  (*BER_MEMFREE_FN)         LDAP_P(( void *p ));
 116
 117 typedef struct lber_memory_fns {
 118         BER_MEMALLOC_FN bmf_malloc;
 119         BER_MEMCALLOC_FN bmf_calloc;
 120         BER_MEMREALLOC_FN bmf_realloc;
 121         BER_MEMFREE_FN bmf_free;
 122 } BerMemoryFunctions;
 123
 124 /* LBER Sockbuf_IO options */
 125 #define LBER_SB_OPT_GET_FD              1
 126 #define LBER_SB_OPT_SET_FD              2
 127 #define LBER_SB_OPT_HAS_IO              3
 128 #define LBER_SB_OPT_SET_NONBLOCK        4
 129 #define LBER_SB_OPT_GET_SSL             7
 130 #define LBER_SB_OPT_DATA_READY          8
 131 #define LBER_SB_OPT_SET_READAHEAD       9
 132 #define LBER_SB_OPT_DRAIN               10
 133 #define LBER_SB_OPT_NEEDS_READ          11
 134 #define LBER_SB_OPT_NEEDS_WRITE         12
 135 #define LBER_SB_OPT_GET_MAX_INCOMING    13
 136 #define LBER_SB_OPT_SET_MAX_INCOMING    14
 137 /* Largest option used by the library */
 138 #define LBER_SB_OPT_OPT_MAX             14
 139
 140 /* LBER IO operations stacking levels */
 141 #define LBER_SBIOD_LEVEL_PROVIDER       10
 142 #define LBER_SBIOD_LEVEL_TRANSPORT      20
 143 #define LBER_SBIOD_LEVEL_APPLICATION    30
 144
 145 /* get/set options for Sockbuf */
 146 #define LBER_OPT_SOCKBUF_DESC           0x1000
 147 #define LBER_OPT_SOCKBUF_OPTIONS        0x1001
 148 #define LBER_OPT_SOCKBUF_DEBUG          0x1002
 149
 150 /* on/off values */
 151 #define LBER_OPT_ON             ((void *) 1)
 152 #define LBER_OPT_OFF    ((void *) 0)
 153
 154 #define LBER_OPT_SUCCESS        (0)
 155 #define LBER_OPT_ERROR          (-1)
 156
 157 #define LBER_ELEMENT_SIZEOF (256) /* must be >= sizeof(BerElement) */
 158 typedef struct berelement BerElement;
 159 typedef struct sockbuf Sockbuf;
 160 typedef struct seqorset Seqorset;
 161
 162 typedef struct sockbuf_io Sockbuf_IO;
 163
 164 /* Structure for LBER IO operarion descriptor */
 165 typedef struct sockbuf_io_desc {
 166         int                     sbiod_level;
 167         Sockbuf                 *sbiod_sb;
 168         Sockbuf_IO              *sbiod_io;
 169         void                    *sbiod_pvt;
 170         struct sockbuf_io_desc  *sbiod_next;
 171 } Sockbuf_IO_Desc;
 172
 173 /* Structure for LBER IO operation functions */
 174 struct sockbuf_io {
 175         int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
 176         int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
 177         int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
 178
 179         ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
 180                 ber_len_t len );
 181         ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
 182                 ber_len_t len );
 183
 184         int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
 185 };
 186
 187 /* Helper macros for LBER IO functions */
 188 #define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
 189         ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
 190                 buf, len ) )
 191 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
 192         ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
 193                 buf, len ) )
 194 #define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
 195         ( (sbiod)->sbiod_next ? \
 196                 ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
 197                 (sbiod)->sbiod_next, opt, arg ) ) : 0 )
 198
 199 /* structure for returning a sequence of octet strings + length */
 200 typedef struct berval {
 201         ber_len_t       bv_len;
 202         char            *bv_val;
 203 } BerValue;
 204
 205 typedef BerValue *BerVarray;    /* To distinguish from a single bv */
 206
 207 /* this should be moved to lber-int.h */
 208
 209 /*
 210  * in bprint.c:
 211  */
 212 LBER_F( void )
 213 ber_error_print LDAP_P((
 214         LDAP_CONST char *data ));
 215
 216 LBER_F( void )
 217 ber_bprint LDAP_P((
 218         LDAP_CONST char *data, ber_len_t len ));
 219
 220 LBER_F( void )
 221 ber_dump LDAP_P((
 222         BerElement *ber, int inout ));
 223
 224 LBER_F( void )
 225 ber_sos_dump LDAP_P((
 226         Seqorset *sos ));
 227
 228 /*
 229  * in decode.c:
 230  */
 231 typedef int (*BERDecodeCallback) LDAP_P((
 232         BerElement *ber,
 233         void *data,
 234         int mode ));
 235
 236 LBER_F( ber_tag_t )
 237 ber_get_tag LDAP_P((
 238         BerElement *ber ));
 239
 240 LBER_F( ber_tag_t )
 241 ber_skip_tag LDAP_P((
 242         BerElement *ber,
 243         ber_len_t *len ));
 244
 245 LBER_F( ber_tag_t )
 246 ber_peek_tag LDAP_P((
 247         BerElement *ber,
 248         ber_len_t *len ));
 249
 250 LBER_F( ber_tag_t )
 251 ber_get_int LDAP_P((
 252         BerElement *ber,
 253         ber_int_t *num ));
 254
 255 LBER_F( ber_tag_t )
 256 ber_get_enum LDAP_P((
 257         BerElement *ber,
 258         ber_int_t *num ));
 259
 260 LBER_F( ber_tag_t )
 261 ber_get_stringb LDAP_P((
 262         BerElement *ber,
 263         char *buf,
 264         ber_len_t *len ));
 265
 266 LBER_F( ber_tag_t )
 267 ber_get_stringbv LDAP_P((
 268         BerElement *ber,
 269         struct berval *bv,
 270         int alloc ));
 271
 272 LBER_F( ber_tag_t )
 273 ber_get_stringa LDAP_P((
 274         BerElement *ber,
 275         char **buf ));
 276
 277 LBER_F( ber_tag_t )
 278 ber_get_stringal LDAP_P((
 279         BerElement *ber,
 280         struct berval **bv ));
 281
 282 LBER_F( ber_tag_t )
 283 ber_get_bitstringa LDAP_P((
 284         BerElement *ber,
 285         char **buf,
 286         ber_len_t *len ));
 287
 288 LBER_F( ber_tag_t )
 289 ber_get_null LDAP_P((
 290         BerElement *ber ));
 291
 292 LBER_F( ber_tag_t )
 293 ber_get_boolean LDAP_P((
 294         BerElement *ber,
 295         ber_int_t *boolval ));
 296
 297 LBER_F( ber_tag_t )
 298 ber_first_element LDAP_P((
 299         BerElement *ber,
 300         ber_len_t *len,
 301         char **last ));
 302
 303 LBER_F( ber_tag_t )
 304 ber_next_element LDAP_P((
 305         BerElement *ber,
 306         ber_len_t *len,
 307         LDAP_CONST char *last ));
 308
 309 LBER_F( ber_tag_t )
 310 ber_scanf LDAP_P((
 311         BerElement *ber,
 312         LDAP_CONST char *fmt,
 313         ... ));
 314
 315 /*
 316  * in encode.c
 317  */
 318 typedef int (*BEREncodeCallback) LDAP_P((
 319         BerElement *ber,
 320         void *data ));
 321
 322 LBER_F( int )
 323 ber_put_enum LDAP_P((
 324         BerElement *ber,
 325         ber_int_t num,
 326         ber_tag_t tag ));
 327
 328 LBER_F( int )
 329 ber_put_int LDAP_P((
 330         BerElement *ber,
 331         ber_int_t num,
 332         ber_tag_t tag ));
 333
 334 LBER_F( int )
 335 ber_put_ostring LDAP_P((
 336         BerElement *ber,
 337         LDAP_CONST char *str,
 338         ber_len_t len,
 339         ber_tag_t tag ));
 340
 341 LBER_F( int )
 342 ber_put_berval LDAP_P((
 343         BerElement *ber,
 344         struct berval *bv,
 345         ber_tag_t tag ));
 346
 347 LBER_F( int )
 348 ber_put_string LDAP_P((
 349         BerElement *ber,
 350         LDAP_CONST char *str,
 351         ber_tag_t tag ));
 352
 353 LBER_F( int )
 354 ber_put_bitstring LDAP_P((
 355         BerElement *ber,
 356         LDAP_CONST char *str,
 357         ber_len_t bitlen,
 358         ber_tag_t tag ));
 359
 360 LBER_F( int )
 361 ber_put_null LDAP_P((
 362         BerElement *ber,
 363         ber_tag_t tag ));
 364
 365 LBER_F( int )
 366 ber_put_boolean LDAP_P((
 367         BerElement *ber,
 368         ber_int_t boolval,
 369         ber_tag_t tag ));
 370
 371 LBER_F( int )
 372 ber_start_seq LDAP_P((
 373         BerElement *ber,
 374         ber_tag_t tag ));
 375
 376 LBER_F( int )
 377 ber_start_set LDAP_P((
 378         BerElement *ber,
 379         ber_tag_t tag ));
 380
 381 LBER_F( int )
 382 ber_put_seq LDAP_P((
 383         BerElement *ber ));
 384
 385 LBER_F( int )
 386 ber_put_set LDAP_P((
 387         BerElement *ber ));
 388
 389 LBER_F( int )
 390 ber_printf LDAP_P((
 391         BerElement *ber,
 392         LDAP_CONST char *fmt,
 393         ... ));
 394
 395
 396 /*
 397  * in io.c:
 398  */
 399
 400 LBER_F( ber_slen_t )
 401 ber_read LDAP_P((
 402         BerElement *ber,
 403         char *buf,
 404         ber_len_t len ));
 405
 406 LBER_F( ber_slen_t )
 407 ber_write LDAP_P((
 408         BerElement *ber,
 409         LDAP_CONST char *buf,
 410         ber_len_t len,
 411         int nosos ));
 412
 413 LBER_F( void )
 414 ber_free LDAP_P((
 415         BerElement *ber,
 416         int freebuf ));
 417
 418 LBER_F( void )
 419 ber_free_buf LDAP_P(( BerElement *ber ));
 420
 421 LBER_F( int )
 422 ber_flush LDAP_P((
 423         Sockbuf *sb,
 424         BerElement *ber,
 425         int freeit ));
 426
 427 LBER_F( BerElement * )
 428 ber_alloc LDAP_P(( void )); /* DEPRECATED */
 429
 430 LBER_F( BerElement * )
 431 der_alloc LDAP_P(( void )); /* DEPRECATED */
 432
 433 LBER_F( BerElement * )
 434 ber_alloc_t LDAP_P((
 435         int beroptions ));
 436
 437 LBER_F( BerElement * )
 438 ber_dup LDAP_P((
 439         BerElement *ber ));
 440
 441 LBER_F( ber_tag_t )
 442 ber_get_next LDAP_P((
 443         Sockbuf *sb,
 444         ber_len_t *len,
 445         BerElement *ber ));
 446
 447 LBER_F( void )
 448 ber_init2 LDAP_P((
 449         BerElement *ber,
 450         struct berval *bv,
 451         int options ));
 452
 453 LBER_F( void )
 454 ber_init_w_nullc LDAP_P((       /* DEPRECATED */
 455         BerElement *ber,
 456         int options ));
 457
 458 LBER_F( void )
 459 ber_reset LDAP_P((
 460         BerElement *ber,
 461         int was_writing ));
 462
 463 LBER_F( BerElement * )
 464 ber_init LDAP_P((
 465         struct berval *bv ));
 466
 467 LBER_F( int )
 468 ber_flatten LDAP_P((
 469         BerElement *ber,
 470         struct berval **bvPtr ));
 471
 472 LBER_F( int )
 473 ber_flatten2 LDAP_P((
 474         BerElement *ber,
 475         struct berval *bv,
 476         int alloc ));
 477
 478 /*
 479  * LBER ber accessor functions
 480  */
 481
 482 LBER_F( int )
 483 ber_get_option LDAP_P((
 484         void *item,
 485         int option,
 486         void *outvalue));
 487
 488 LBER_F( int )
 489 ber_set_option LDAP_P((
 490         void *item,
 491         int option,
 492         LDAP_CONST void *invalue));
 493
 494 /*
 495  * LBER sockbuf.c
 496  */
 497
 498 LBER_F( Sockbuf *  )
 499 ber_sockbuf_alloc LDAP_P((
 500         void ));
 501
 502 LBER_F( void )
 503 ber_sockbuf_free LDAP_P((
 504         Sockbuf *sb ));
 505
 506 LBER_F( int )
 507 ber_sockbuf_add_io LDAP_P((
 508         Sockbuf *sb,
 509         Sockbuf_IO *sbio,
 510         int layer,
 511         void *arg ));
 512
 513 LBER_F( int )
 514 ber_sockbuf_remove_io LDAP_P((
 515         Sockbuf *sb,
 516         Sockbuf_IO *sbio,
 517         int layer ));
 518
 519 LBER_F( int )
 520 ber_sockbuf_ctrl LDAP_P((
 521         Sockbuf *sb,
 522         int opt,
 523         void *arg ));
 524
 525 LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp;
 526 LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead;
 527 LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd;
 528 LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug;
 529 #ifdef LDAP_CONNECTIONLESS
 530 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
 531 #endif
 532
 533 /*
 534  * LBER memory.c
 535  */
 536 LBER_F( void * )
 537 ber_memalloc LDAP_P((
 538         ber_len_t s ));
 539
 540 LBER_F( void * )
 541 ber_memrealloc LDAP_P((
 542         void* p,
 543         ber_len_t s ));
 544
 545 LBER_F( void * )
 546 ber_memcalloc LDAP_P((
 547         ber_len_t n,
 548         ber_len_t s ));
 549
 550 LBER_F( void )
 551 ber_memfree LDAP_P((
 552         void* p ));
 553
 554 LBER_F( void )
 555 ber_memvfree LDAP_P((
 556         void** vector ));
 557
 558 LBER_F( void )
 559 ber_bvfree LDAP_P((
 560         struct berval *bv ));
 561
 562 LBER_F( void )
 563 ber_bvecfree LDAP_P((
 564         struct berval **bv ));
 565
 566 LBER_F( int )
 567 ber_bvecadd LDAP_P((
 568         struct berval ***bvec,
 569         struct berval *bv ));
 570
 571 LBER_F( struct berval * )
 572 ber_dupbv LDAP_P((
 573         struct berval *dst, struct berval *src ));
 574
 575 LBER_F( struct berval * )
 576 ber_bvdup LDAP_P((
 577         struct berval *src ));
 578
 579 LBER_F( struct berval * )
 580 ber_str2bv LDAP_P((
 581         LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
 582
 583 LBER_F( struct berval * )
 584 ber_mem2bv LDAP_P((
 585         LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
 586
 587 #define ber_bvstr(a)    ber_str2bv(a, 0, 0, NULL)
 588 #define ber_bvstrdup(a) ber_str2bv(a, 0, 1, NULL)
 589
 590 LBER_F( char * )
 591 ber_strdup LDAP_P((
 592         LDAP_CONST char * ));
 593
 594 LBER_F( void )
 595 ber_bvarray_free LDAP_P(( BerVarray p ));
 596
 597 LBER_F( int )
 598 ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv ));
 599
 600 #define ber_bvcmp(v1,v2) \
 601         ((v1)->bv_len < (v2)->bv_len \
 602                 ? -1 : ((v1)->bv_len > (v2)->bv_len \
 603                         ? 1 : memcmp((v1)->bv_val, (v2)->bv_val, (v1)->bv_len) ))
 604
 605 /*
 606  * error.c
 607  */
 608 LBER_F( int * ) ber_errno_addr LDAP_P((void));
 609 #define ber_errno (*(ber_errno_addr)())
 610
 611 #define LBER_ERROR_NONE         0
 612 #define LBER_ERROR_PARAM        0x1
 613 #define LBER_ERROR_MEMORY       0x2
 614
 615 LDAP_END_DECL
 616
 617 #endif /* _LBER_H */