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 *BVarray;      /* 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
 270 LBER_F( ber_tag_t )
 271 ber_get_stringa LDAP_P((
 272         BerElement *ber,
 273         char **buf ));
 274
 275 LBER_F( ber_tag_t )
 276 ber_get_stringal LDAP_P((
 277         BerElement *ber,
 278         struct berval **bv ));
 279
 280 LBER_F( ber_tag_t )
 281 ber_get_bitstringa LDAP_P((
 282         BerElement *ber,
 283         char **buf,
 284         ber_len_t *len ));
 285
 286 LBER_F( ber_tag_t )
 287 ber_get_null LDAP_P((
 288         BerElement *ber ));
 289
 290 LBER_F( ber_tag_t )
 291 ber_get_boolean LDAP_P((
 292         BerElement *ber,
 293         ber_int_t *boolval ));
 294
 295 LBER_F( ber_tag_t )
 296 ber_first_element LDAP_P((
 297         BerElement *ber,
 298         ber_len_t *len,
 299         char **last ));
 300
 301 LBER_F( ber_tag_t )
 302 ber_next_element LDAP_P((
 303         BerElement *ber,
 304         ber_len_t *len,
 305         LDAP_CONST char *last ));
 306
 307 LBER_F( ber_tag_t )
 308 ber_scanf LDAP_P((
 309         BerElement *ber,
 310         LDAP_CONST char *fmt,
 311         ... ));
 312
 313 /*
 314  * in encode.c
 315  */
 316 typedef int (*BEREncodeCallback) LDAP_P((
 317         BerElement *ber,
 318         void *data ));
 319
 320 LBER_F( int )
 321 ber_put_enum LDAP_P((
 322         BerElement *ber,
 323         ber_int_t num,
 324         ber_tag_t tag ));
 325
 326 LBER_F( int )
 327 ber_put_int LDAP_P((
 328         BerElement *ber,
 329         ber_int_t num,
 330         ber_tag_t tag ));
 331
 332 LBER_F( int )
 333 ber_put_ostring LDAP_P((
 334         BerElement *ber,
 335         LDAP_CONST char *str,
 336         ber_len_t len,
 337         ber_tag_t tag ));
 338
 339 LBER_F( int )
 340 ber_put_berval LDAP_P((
 341         BerElement *ber,
 342         LDAP_CONST struct berval *bv,
 343         ber_tag_t tag ));
 344
 345 LBER_F( int )
 346 ber_put_string LDAP_P((
 347         BerElement *ber,
 348         LDAP_CONST char *str,
 349         ber_tag_t tag ));
 350
 351 LBER_F( int )
 352 ber_put_bitstring LDAP_P((
 353         BerElement *ber,
 354         LDAP_CONST char *str,
 355         ber_len_t bitlen,
 356         ber_tag_t tag ));
 357
 358 LBER_F( int )
 359 ber_put_null LDAP_P((
 360         BerElement *ber,
 361         ber_tag_t tag ));
 362
 363 LBER_F( int )
 364 ber_put_boolean LDAP_P((
 365         BerElement *ber,
 366         ber_int_t boolval,
 367         ber_tag_t tag ));
 368
 369 LBER_F( int )
 370 ber_start_seq LDAP_P((
 371         BerElement *ber,
 372         ber_tag_t tag ));
 373
 374 LBER_F( int )
 375 ber_start_set LDAP_P((
 376         BerElement *ber,
 377         ber_tag_t tag ));
 378
 379 LBER_F( int )
 380 ber_put_seq LDAP_P((
 381         BerElement *ber ));
 382
 383 LBER_F( int )
 384 ber_put_set LDAP_P((
 385         BerElement *ber ));
 386
 387 LBER_F( int )
 388 ber_printf LDAP_P((
 389         BerElement *ber,
 390         LDAP_CONST char *fmt,
 391         ... ));
 392
 393
 394 /*
 395  * in io.c:
 396  */
 397
 398 LBER_F( ber_slen_t )
 399 ber_read LDAP_P((
 400         BerElement *ber,
 401         char *buf,
 402         ber_len_t len ));
 403
 404 LBER_F( ber_slen_t )
 405 ber_write LDAP_P((
 406         BerElement *ber,
 407         LDAP_CONST char *buf,
 408         ber_len_t len,
 409         int nosos ));
 410
 411 LBER_F( void )
 412 ber_free LDAP_P((
 413         BerElement *ber,
 414         int freebuf ));
 415
 416 LBER_F( void )
 417 ber_free_buf LDAP_P(( BerElement *ber ));
 418
 419 LBER_F( int )
 420 ber_flush LDAP_P((
 421         Sockbuf *sb,
 422         BerElement *ber,
 423         int freeit ));
 424
 425 LBER_F( BerElement * )
 426 ber_alloc LDAP_P(( void )); /* DEPRECATED */
 427
 428 LBER_F( BerElement * )
 429 der_alloc LDAP_P(( void )); /* DEPRECATED */
 430
 431 LBER_F( BerElement * )
 432 ber_alloc_t LDAP_P((
 433         int beroptions ));
 434
 435 LBER_F( BerElement * )
 436 ber_dup LDAP_P((
 437         BerElement *ber ));
 438
 439 LBER_F( ber_tag_t )
 440 ber_get_next LDAP_P((
 441         Sockbuf *sb,
 442         ber_len_t *len,
 443         BerElement *ber ));
 444
 445 LBER_F( void )
 446 ber_init_w_nullc LDAP_P((       /* DEPRECATED */
 447         BerElement *ber,
 448         int options ));
 449
 450 LBER_F( void )
 451 ber_reset LDAP_P((
 452         BerElement *ber,
 453         int was_writing ));
 454
 455 LBER_F( BerElement * )
 456 ber_init LDAP_P((
 457         struct berval *bv ));
 458
 459 LBER_F( int )
 460 ber_flatten LDAP_P((
 461         BerElement *ber,
 462         struct berval **bvPtr ));
 463
 464 /*
 465  * LBER ber accessor functions
 466  */
 467
 468 LBER_F( int )
 469 ber_get_option LDAP_P((
 470         void *item,
 471         int option,
 472         void *outvalue));
 473
 474 LBER_F( int )
 475 ber_set_option LDAP_P((
 476         void *item,
 477         int option,
 478         LDAP_CONST void *invalue));
 479
 480 /*
 481  * LBER sockbuf.c
 482  */
 483
 484 LBER_F( Sockbuf *  )
 485 ber_sockbuf_alloc LDAP_P((
 486         void ));
 487
 488 LBER_F( void )
 489 ber_sockbuf_free LDAP_P((
 490         Sockbuf *sb ));
 491
 492 LBER_F( int )
 493 ber_sockbuf_add_io LDAP_P((
 494         Sockbuf *sb,
 495         Sockbuf_IO *sbio,
 496         int layer,
 497         void *arg ));
 498
 499 LBER_F( int )
 500 ber_sockbuf_remove_io LDAP_P((
 501         Sockbuf *sb,
 502         Sockbuf_IO *sbio,
 503         int layer ));
 504
 505 LBER_F( int )
 506 ber_sockbuf_ctrl LDAP_P((
 507         Sockbuf *sb,
 508         int opt,
 509         void *arg ));
 510
 511 LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp;
 512 LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead;
 513 LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd;
 514 LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug;
 515 #ifdef LDAP_CONNECTIONLESS
 516 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
 517 #endif
 518
 519 /*
 520  * LBER memory.c
 521  */
 522 LBER_F( void * )
 523 ber_memalloc LDAP_P((
 524         ber_len_t s ));
 525
 526 LBER_F( void * )
 527 ber_memrealloc LDAP_P((
 528         void* p,
 529         ber_len_t s ));
 530
 531 LBER_F( void * )
 532 ber_memcalloc LDAP_P((
 533         ber_len_t n,
 534         ber_len_t s ));
 535
 536 LBER_F( void )
 537 ber_memfree LDAP_P((
 538         void* p ));
 539
 540 LBER_F( void )
 541 ber_memvfree LDAP_P((
 542         void** vector ));
 543
 544 LBER_F( void )
 545 ber_bvfree LDAP_P((
 546         struct berval *bv ));
 547
 548 LBER_F( void )
 549 ber_bvecfree LDAP_P((
 550         struct berval **bv ));
 551
 552 LBER_F( int )
 553 ber_bvecadd LDAP_P((
 554         struct berval ***bvec,
 555         struct berval *bv ));
 556
 557 LBER_F( struct berval * )
 558 ber_dupbv LDAP_P((
 559         struct berval *dst, LDAP_CONST struct berval *src ));
 560
 561 LBER_F( struct berval * )
 562 ber_bvdup LDAP_P((
 563         LDAP_CONST struct berval *src ));
 564
 565 LBER_F( struct berval * )
 566 ber_str2bv LDAP_P((
 567         LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
 568
 569 #define ber_bvstr(a)    ber_str2bv(a, 0, 0, NULL)
 570 #define ber_bvstrdup(a) ber_str2bv(a, 0, 1, NULL)
 571
 572 LBER_F( char * )
 573 ber_strdup LDAP_P((
 574         LDAP_CONST char * ));
 575
 576 /*
 577  * error.c
 578  */
 579 LBER_F( int * ) ber_errno_addr LDAP_P((void));
 580 #define ber_errno (*(ber_errno_addr)())
 581
 582 #define LBER_ERROR_NONE         0
 583 #define LBER_ERROR_PARAM        0x1
 584 #define LBER_ERROR_MEMORY       0x2
 585
 586 LDAP_END_DECL
 587
 588 #endif /* _LBER_H */