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