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 union ber_buffer_u {
 162         char charbuf[LBER_ELEMENT_SIZEOF];
 163
 164         /* force alignment */
 165         int intbuf;
 166         long longbuf;
 167         float floatbuf;
 168         double doublebuf;
 169         char* ptrbuf;
 170 } BerElementBuffer;
 171
 172 typedef struct berelement BerElement;
 173 typedef struct sockbuf Sockbuf;
 174 typedef struct seqorset Seqorset;
 175
 176 typedef struct sockbuf_io Sockbuf_IO;
 177
 178 /* Structure for LBER IO operarion descriptor */
 179 typedef struct sockbuf_io_desc {
 180         int                     sbiod_level;
 181         Sockbuf                 *sbiod_sb;
 182         Sockbuf_IO              *sbiod_io;
 183         void                    *sbiod_pvt;
 184         struct sockbuf_io_desc  *sbiod_next;
 185 } Sockbuf_IO_Desc;
 186
 187 /* Structure for LBER IO operation functions */
 188 struct sockbuf_io {
 189         int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
 190         int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
 191         int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
 192
 193         ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
 194                 ber_len_t len );
 195         ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
 196                 ber_len_t len );
 197
 198         int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
 199 };
 200
 201 /* Helper macros for LBER IO functions */
 202 #define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
 203         ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
 204                 buf, len ) )
 205 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
 206         ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
 207                 buf, len ) )
 208 #define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
 209         ( (sbiod)->sbiod_next ? \
 210                 ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
 211                 (sbiod)->sbiod_next, opt, arg ) ) : 0 )
 212
 213 /* structure for returning a sequence of octet strings + length */
 214 typedef struct berval {
 215         ber_len_t       bv_len;
 216         char            *bv_val;
 217 } BerValue;
 218
 219 typedef BerValue *BerVarray;    /* To distinguish from a single bv */
 220
 221 /* this should be moved to lber-int.h */
 222
 223 /*
 224  * in bprint.c:
 225  */
 226 LBER_F( void )
 227 ber_error_print LDAP_P((
 228         LDAP_CONST char *data ));
 229
 230 LBER_F( void )
 231 ber_bprint LDAP_P((
 232         LDAP_CONST char *data, ber_len_t len ));
 233
 234 LBER_F( void )
 235 ber_dump LDAP_P((
 236         BerElement *ber, int inout ));
 237
 238 LBER_F( void )
 239 ber_sos_dump LDAP_P((
 240         Seqorset *sos ));
 241
 242 /*
 243  * in decode.c:
 244  */
 245 typedef int (*BERDecodeCallback) LDAP_P((
 246         BerElement *ber,
 247         void *data,
 248         int mode ));
 249
 250 LBER_F( ber_tag_t )
 251 ber_get_tag LDAP_P((
 252         BerElement *ber ));
 253
 254 LBER_F( ber_tag_t )
 255 ber_skip_tag LDAP_P((
 256         BerElement *ber,
 257         ber_len_t *len ));
 258
 259 LBER_F( ber_tag_t )
 260 ber_peek_tag LDAP_P((
 261         BerElement *ber,
 262         ber_len_t *len ));
 263
 264 LBER_F( ber_tag_t )
 265 ber_get_int LDAP_P((
 266         BerElement *ber,
 267         ber_int_t *num ));
 268
 269 LBER_F( ber_tag_t )
 270 ber_get_enum LDAP_P((
 271         BerElement *ber,
 272         ber_int_t *num ));
 273
 274 LBER_F( ber_tag_t )
 275 ber_get_stringb LDAP_P((
 276         BerElement *ber,
 277         char *buf,
 278         ber_len_t *len ));
 279
 280 LBER_F( ber_tag_t )
 281 ber_get_stringbv LDAP_P((
 282         BerElement *ber,
 283         struct berval *bv,
 284         int alloc ));
 285
 286 LBER_F( ber_tag_t )
 287 ber_get_stringa LDAP_P((
 288         BerElement *ber,
 289         char **buf ));
 290
 291 LBER_F( ber_tag_t )
 292 ber_get_stringal LDAP_P((
 293         BerElement *ber,
 294         struct berval **bv ));
 295
 296 LBER_F( ber_tag_t )
 297 ber_get_bitstringa LDAP_P((
 298         BerElement *ber,
 299         char **buf,
 300         ber_len_t *len ));
 301
 302 LBER_F( ber_tag_t )
 303 ber_get_null LDAP_P((
 304         BerElement *ber ));
 305
 306 LBER_F( ber_tag_t )
 307 ber_get_boolean LDAP_P((
 308         BerElement *ber,
 309         ber_int_t *boolval ));
 310
 311 LBER_F( ber_tag_t )
 312 ber_first_element LDAP_P((
 313         BerElement *ber,
 314         ber_len_t *len,
 315         char **last ));
 316
 317 LBER_F( ber_tag_t )
 318 ber_next_element LDAP_P((
 319         BerElement *ber,
 320         ber_len_t *len,
 321         LDAP_CONST char *last ));
 322
 323 LBER_F( ber_tag_t )
 324 ber_scanf LDAP_P((
 325         BerElement *ber,
 326         LDAP_CONST char *fmt,
 327         ... ));
 328
 329 /*
 330  * in encode.c
 331  */
 332 typedef int (*BEREncodeCallback) LDAP_P((
 333         BerElement *ber,
 334         void *data ));
 335
 336 LBER_F( int )
 337 ber_put_enum LDAP_P((
 338         BerElement *ber,
 339         ber_int_t num,
 340         ber_tag_t tag ));
 341
 342 LBER_F( int )
 343 ber_put_int LDAP_P((
 344         BerElement *ber,
 345         ber_int_t num,
 346         ber_tag_t tag ));
 347
 348 LBER_F( int )
 349 ber_put_ostring LDAP_P((
 350         BerElement *ber,
 351         LDAP_CONST char *str,
 352         ber_len_t len,
 353         ber_tag_t tag ));
 354
 355 LBER_F( int )
 356 ber_put_berval LDAP_P((
 357         BerElement *ber,
 358         struct berval *bv,
 359         ber_tag_t tag ));
 360
 361 LBER_F( int )
 362 ber_put_string LDAP_P((
 363         BerElement *ber,
 364         LDAP_CONST char *str,
 365         ber_tag_t tag ));
 366
 367 LBER_F( int )
 368 ber_put_bitstring LDAP_P((
 369         BerElement *ber,
 370         LDAP_CONST char *str,
 371         ber_len_t bitlen,
 372         ber_tag_t tag ));
 373
 374 LBER_F( int )
 375 ber_put_null LDAP_P((
 376         BerElement *ber,
 377         ber_tag_t tag ));
 378
 379 LBER_F( int )
 380 ber_put_boolean LDAP_P((
 381         BerElement *ber,
 382         ber_int_t boolval,
 383         ber_tag_t tag ));
 384
 385 LBER_F( int )
 386 ber_start_seq LDAP_P((
 387         BerElement *ber,
 388         ber_tag_t tag ));
 389
 390 LBER_F( int )
 391 ber_start_set LDAP_P((
 392         BerElement *ber,
 393         ber_tag_t tag ));
 394
 395 LBER_F( int )
 396 ber_put_seq LDAP_P((
 397         BerElement *ber ));
 398
 399 LBER_F( int )
 400 ber_put_set LDAP_P((
 401         BerElement *ber ));
 402
 403 LBER_F( int )
 404 ber_printf LDAP_P((
 405         BerElement *ber,
 406         LDAP_CONST char *fmt,
 407         ... ));
 408
 409
 410 /*
 411  * in io.c:
 412  */
 413
 414 LBER_F( ber_slen_t )
 415 ber_read LDAP_P((
 416         BerElement *ber,
 417         char *buf,
 418         ber_len_t len ));
 419
 420 LBER_F( ber_slen_t )
 421 ber_write LDAP_P((
 422         BerElement *ber,
 423         LDAP_CONST char *buf,
 424         ber_len_t len,
 425         int nosos ));
 426
 427 LBER_F( void )
 428 ber_free LDAP_P((
 429         BerElement *ber,
 430         int freebuf ));
 431
 432 LBER_F( void )
 433 ber_free_buf LDAP_P(( BerElement *ber ));
 434
 435 LBER_F( int )
 436 ber_flush LDAP_P((
 437         Sockbuf *sb,
 438         BerElement *ber,
 439         int freeit ));
 440
 441 LBER_F( BerElement * )
 442 ber_alloc LDAP_P(( void )); /* DEPRECATED */
 443
 444 LBER_F( BerElement * )
 445 der_alloc LDAP_P(( void )); /* DEPRECATED */
 446
 447 LBER_F( BerElement * )
 448 ber_alloc_t LDAP_P((
 449         int beroptions ));
 450
 451 LBER_F( BerElement * )
 452 ber_dup LDAP_P((
 453         BerElement *ber ));
 454
 455 LBER_F( ber_tag_t )
 456 ber_get_next LDAP_P((
 457         Sockbuf *sb,
 458         ber_len_t *len,
 459         BerElement *ber ));
 460
 461 LBER_F( void )
 462 ber_init2 LDAP_P((
 463         BerElement *ber,
 464         struct berval *bv,
 465         int options ));
 466
 467 LBER_F( void )
 468 ber_init_w_nullc LDAP_P((       /* DEPRECATED */
 469         BerElement *ber,
 470         int options ));
 471
 472 LBER_F( void )
 473 ber_reset LDAP_P((
 474         BerElement *ber,
 475         int was_writing ));
 476
 477 LBER_F( BerElement * )
 478 ber_init LDAP_P((
 479         struct berval *bv ));
 480
 481 LBER_F( int )
 482 ber_flatten LDAP_P((
 483         BerElement *ber,
 484         struct berval **bvPtr ));
 485
 486 LBER_F( int )
 487 ber_flatten2 LDAP_P((
 488         BerElement *ber,
 489         struct berval *bv,
 490         int alloc ));
 491
 492 LBER_F( int )
 493 ber_remaining LDAP_P((
 494         BerElement *ber ));
 495
 496 /*
 497  * LBER ber accessor functions
 498  */
 499
 500 LBER_F( int )
 501 ber_get_option LDAP_P((
 502         void *item,
 503         int option,
 504         void *outvalue));
 505
 506 LBER_F( int )
 507 ber_set_option LDAP_P((
 508         void *item,
 509         int option,
 510         LDAP_CONST void *invalue));
 511
 512 /*
 513  * LBER sockbuf.c
 514  */
 515
 516 LBER_F( Sockbuf *  )
 517 ber_sockbuf_alloc LDAP_P((
 518         void ));
 519
 520 LBER_F( void )
 521 ber_sockbuf_free LDAP_P((
 522         Sockbuf *sb ));
 523
 524 LBER_F( int )
 525 ber_sockbuf_add_io LDAP_P((
 526         Sockbuf *sb,
 527         Sockbuf_IO *sbio,
 528         int layer,
 529         void *arg ));
 530
 531 LBER_F( int )
 532 ber_sockbuf_remove_io LDAP_P((
 533         Sockbuf *sb,
 534         Sockbuf_IO *sbio,
 535         int layer ));
 536
 537 LBER_F( int )
 538 ber_sockbuf_ctrl LDAP_P((
 539         Sockbuf *sb,
 540         int opt,
 541         void *arg ));
 542
 543 LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp;
 544 LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead;
 545 LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd;
 546 LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug;
 547 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
 548
 549 /*
 550  * LBER memory.c
 551  */
 552 LBER_F( void * )
 553 ber_memalloc LDAP_P((
 554         ber_len_t s ));
 555
 556 LBER_F( void * )
 557 ber_memrealloc LDAP_P((
 558         void* p,
 559         ber_len_t s ));
 560
 561 LBER_F( void * )
 562 ber_memcalloc LDAP_P((
 563         ber_len_t n,
 564         ber_len_t s ));
 565
 566 LBER_F( void )
 567 ber_memfree LDAP_P((
 568         void* p ));
 569
 570 LBER_F( void )
 571 ber_memvfree LDAP_P((
 572         void** vector ));
 573
 574 LBER_F( void )
 575 ber_bvfree LDAP_P((
 576         struct berval *bv ));
 577
 578 LBER_F( void )
 579 ber_bvecfree LDAP_P((
 580         struct berval **bv ));
 581
 582 LBER_F( int )
 583 ber_bvecadd LDAP_P((
 584         struct berval ***bvec,
 585         struct berval *bv ));
 586
 587 LBER_F( struct berval * )
 588 ber_dupbv LDAP_P((
 589         struct berval *dst, struct berval *src ));
 590
 591 LBER_F( struct berval * )
 592 ber_bvdup LDAP_P((
 593         struct berval *src ));
 594
 595 LBER_F( struct berval * )
 596 ber_str2bv LDAP_P((
 597         LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
 598
 599 LBER_F( struct berval * )
 600 ber_mem2bv LDAP_P((
 601         LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
 602
 603 #define ber_bvstr(a)    ber_str2bv(a, 0, 0, NULL)
 604 #define ber_bvstrdup(a) ber_str2bv(a, 0, 1, NULL)
 605
 606 LBER_F( char * )
 607 ber_strdup LDAP_P((
 608         LDAP_CONST char * ));
 609
 610 LBER_F( void )
 611 ber_bvarray_free LDAP_P(( BerVarray p ));
 612
 613 LBER_F( int )
 614 ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv ));
 615
 616 #define ber_bvcmp(v1,v2) \
 617         ((v1)->bv_len < (v2)->bv_len \
 618                 ? -1 : ((v1)->bv_len > (v2)->bv_len \
 619                         ? 1 : memcmp((v1)->bv_val, (v2)->bv_val, (v1)->bv_len) ))
 620
 621 /*
 622  * error.c
 623  */
 624 LBER_F( int * ) ber_errno_addr LDAP_P((void));
 625 #define ber_errno (*(ber_errno_addr)())
 626
 627 #define LBER_ERROR_NONE         0
 628 #define LBER_ERROR_PARAM        0x1
 629 #define LBER_ERROR_MEMORY       0x2
 630
 631 LDAP_END_DECL
 632
 633 #endif /* _LBER_H */