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

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