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

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