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

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