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 #define LBER_USE_INDEFINITE_LEN 0x02
  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 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
 105
 106 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf ));
 107
 108 typedef void* (*BER_MEMALLOC_FN)        LDAP_P(( ber_len_t size ));
 109 typedef void* (*BER_MEMCALLOC_FN)       LDAP_P(( ber_len_t n, ber_len_t size ));
 110 typedef void* (*BER_MEMREALLOC_FN)      LDAP_P(( void *p, ber_len_t size ));
 111 typedef void  (*BER_MEMFREE_FN)         LDAP_P(( void *p ));
 112
 113 typedef struct lber_memory_fns {
 114         BER_MEMALLOC_FN bmf_malloc;
 115         BER_MEMCALLOC_FN bmf_calloc;
 116         BER_MEMREALLOC_FN bmf_realloc;
 117         BER_MEMFREE_FN bmf_free;
 118 } BerMemoryFunctions;
 119
 120 /* LBER Sockbuf_IO options */
 121 #define LBER_SB_OPT_GET_FD              1
 122 #define LBER_SB_OPT_SET_FD              2
 123 #define LBER_SB_OPT_HAS_IO              3
 124 #define LBER_SB_OPT_SET_NONBLOCK        4
 125 #define LBER_SB_OPT_UDP_GET_SRC         5
 126 #define LBER_SB_OPT_UDP_SET_DST         6
 127 #define LBER_SB_OPT_GET_SSL             7
 128 #define LBER_SB_OPT_DATA_READY          8
 129 #define LBER_SB_OPT_SET_READAHEAD       9
 130 #define LBER_SB_OPT_DRAIN               10
 131 #define LBER_SB_OPT_NEEDS_READ          11
 132 #define LBER_SB_OPT_NEEDS_WRITE         12
 133 /* Largest option used by the library */
 134 #define LBER_SB_OPT_OPT_MAX             12
 135
 136 /* LBER IO operations stacking levels */
 137 #define LBER_SBIOD_LEVEL_PROVIDER       10
 138 #define LBER_SBIOD_LEVEL_TRANSPORT      20
 139 #define LBER_SBIOD_LEVEL_APPLICATION    30
 140
 141 /* get/set options for Sockbuf */
 142 #define LBER_OPT_SOCKBUF_DESC           0x1000
 143 #define LBER_OPT_SOCKBUF_OPTIONS        0x1001
 144 #define LBER_OPT_SOCKBUF_DEBUG          0x1002
 145
 146 /* on/off values */
 147 #define LBER_OPT_ON             ((void *) 1)
 148 #define LBER_OPT_OFF    ((void *) 0)
 149
 150 #define LBER_OPT_SUCCESS        (0)
 151 #define LBER_OPT_ERROR          (-1)
 152
 153 typedef struct berelement BerElement;
 154 typedef struct sockbuf Sockbuf;
 155 typedef struct seqorset Seqorset;
 156
 157 typedef struct sockbuf_io Sockbuf_IO;
 158
 159 /* Structure for LBER IO operarion descriptor */
 160 typedef struct sockbuf_io_desc {
 161         int                     sbiod_level;
 162         Sockbuf                 *sbiod_sb;
 163         Sockbuf_IO              *sbiod_io;
 164         void                    *sbiod_pvt;
 165         struct sockbuf_io_desc  *sbiod_next;
 166 } Sockbuf_IO_Desc;
 167
 168 /* Structure for LBER IO operation functions */
 169 struct sockbuf_io {
 170         int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
 171         int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
 172         int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
 173
 174         ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
 175                 ber_len_t len );
 176         ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
 177                 ber_len_t len );
 178
 179         int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
 180 };
 181
 182 /* Helper macros for LBER IO functions */
 183 #define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
 184         ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
 185                 buf, len ) )
 186 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
 187         ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
 188                 buf, len ) )
 189 #define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
 190         ( (sbiod)->sbiod_next ? \
 191                 ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
 192                 (sbiod)->sbiod_next, opt, arg ) ) : 0 )
 193
 194 /* structure for returning a sequence of octet strings + length */
 195 typedef struct berval {
 196         ber_len_t       bv_len;
 197         char            *bv_val;
 198 } BerValue;
 199
 200 /* this should be moved to lber-int.h */
 201
 202 /*
 203  * in bprint.c:
 204  */
 205 LIBLBER_F( void )
 206 ber_error_print LDAP_P((
 207         LDAP_CONST char *data ));
 208
 209 LIBLBER_F( void )
 210 ber_bprint LDAP_P((
 211         LDAP_CONST char *data, ber_len_t len ));
 212
 213 LIBLBER_F( void )
 214 ber_dump LDAP_P((
 215         BerElement *ber, int inout ));
 216
 217 LIBLBER_F( void )
 218 ber_sos_dump LDAP_P((
 219         Seqorset *sos ));
 220
 221
 222 /*
 223  * in decode.c:
 224  */
 225 typedef int (*BERDecodeCallback) LDAP_P((
 226         BerElement *ber,
 227         void *data,
 228         int mode ));
 229
 230 LIBLBER_F( ber_tag_t )
 231 ber_get_tag LDAP_P((
 232         BerElement *ber ));
 233
 234 LIBLBER_F( ber_tag_t )
 235 ber_skip_tag LDAP_P((
 236         BerElement *ber,
 237         ber_len_t *len ));
 238
 239 LIBLBER_F( ber_tag_t )
 240 ber_peek_tag LDAP_P((
 241         BerElement *ber,
 242         ber_len_t *len ));
 243
 244 LIBLBER_F( ber_tag_t )
 245 ber_get_int LDAP_P((
 246         BerElement *ber,
 247         ber_int_t *num ));
 248
 249 LIBLBER_F( ber_tag_t )
 250 ber_get_enum LDAP_P((
 251         BerElement *ber,
 252         ber_int_t *num ));
 253
 254 LIBLBER_F( ber_tag_t )
 255 ber_get_stringb LDAP_P((
 256         BerElement *ber,
 257         char *buf,
 258         ber_len_t *len ));
 259
 260 LIBLBER_F( ber_tag_t )
 261 ber_get_stringa LDAP_P((
 262         BerElement *ber,
 263         char **buf ));
 264
 265 LIBLBER_F( ber_tag_t )
 266 ber_get_stringal LDAP_P((
 267         BerElement *ber,
 268         struct berval **bv ));
 269
 270 LIBLBER_F( ber_tag_t )
 271 ber_get_bitstringa LDAP_P((
 272         BerElement *ber,
 273         char **buf,
 274         ber_len_t *len ));
 275
 276 LIBLBER_F( ber_tag_t )
 277 ber_get_null LDAP_P((
 278         BerElement *ber ));
 279
 280 LIBLBER_F( ber_tag_t )
 281 ber_get_boolean LDAP_P((
 282         BerElement *ber,
 283         ber_int_t *boolval ));
 284
 285 LIBLBER_F( ber_tag_t )
 286 ber_first_element LDAP_P((
 287         BerElement *ber,
 288         ber_len_t *len,
 289         char **last ));
 290
 291 LIBLBER_F( ber_tag_t )
 292 ber_next_element LDAP_P((
 293         BerElement *ber,
 294         ber_len_t *len,
 295         LDAP_CONST char *last ));
 296
 297 LIBLBER_F( ber_tag_t )
 298 ber_scanf LDAP_P((
 299         BerElement *ber,
 300         LDAP_CONST char *fmt,
 301         ... ));
 302
 303 /*
 304  * in encode.c
 305  */
 306 typedef int (*BEREncodeCallback) LDAP_P((
 307         BerElement *ber,
 308         void *data ));
 309
 310 LIBLBER_F( int )
 311 ber_put_enum LDAP_P((
 312         BerElement *ber,
 313         ber_int_t num,
 314         ber_tag_t tag ));
 315
 316 LIBLBER_F( int )
 317 ber_put_int LDAP_P((
 318         BerElement *ber,
 319         ber_int_t num,
 320         ber_tag_t tag ));
 321
 322 LIBLBER_F( int )
 323 ber_put_ostring LDAP_P((
 324         BerElement *ber,
 325         LDAP_CONST char *str,
 326         ber_len_t len,
 327         ber_tag_t tag ));
 328
 329 LIBLBER_F( int )
 330 ber_put_berval LDAP_P((
 331         BerElement *ber,
 332         LDAP_CONST struct berval *bv,
 333         ber_tag_t tag ));
 334
 335 LIBLBER_F( int )
 336 ber_put_string LDAP_P((
 337         BerElement *ber,
 338         LDAP_CONST char *str,
 339         ber_tag_t tag ));
 340
 341 LIBLBER_F( int )
 342 ber_put_bitstring LDAP_P((
 343         BerElement *ber,
 344         LDAP_CONST char *str,
 345         ber_len_t bitlen,
 346         ber_tag_t tag ));
 347
 348 LIBLBER_F( int )
 349 ber_put_null LDAP_P((
 350         BerElement *ber,
 351         ber_tag_t tag ));
 352
 353 LIBLBER_F( int )
 354 ber_put_boolean LDAP_P((
 355         BerElement *ber,
 356         ber_int_t boolval,
 357         ber_tag_t tag ));
 358
 359 LIBLBER_F( int )
 360 ber_start_seq LDAP_P((
 361         BerElement *ber,
 362         ber_tag_t tag ));
 363
 364 LIBLBER_F( int )
 365 ber_start_set LDAP_P((
 366         BerElement *ber,
 367         ber_tag_t tag ));
 368
 369 LIBLBER_F( int )
 370 ber_put_seq LDAP_P((
 371         BerElement *ber ));
 372
 373 LIBLBER_F( int )
 374 ber_put_set LDAP_P((
 375         BerElement *ber ));
 376
 377 LIBLBER_F( int )
 378 ber_printf LDAP_P((
 379         BerElement *ber,
 380         LDAP_CONST char *fmt,
 381         ... ));
 382
 383
 384 /*
 385  * in io.c:
 386  */
 387
 388 LIBLBER_F( ber_slen_t )
 389 ber_read LDAP_P((
 390         BerElement *ber,
 391         char *buf,
 392         ber_len_t len ));
 393
 394 LIBLBER_F( ber_slen_t )
 395 ber_write LDAP_P((
 396         BerElement *ber,
 397         LDAP_CONST char *buf,
 398         ber_len_t len,
 399         int nosos ));
 400
 401 LIBLBER_F( void )
 402 ber_free LDAP_P((
 403         BerElement *ber,
 404         int freebuf ));
 405
 406 LIBLBER_F( int )
 407 ber_flush LDAP_P((
 408         Sockbuf *sb,
 409         BerElement *ber,
 410         int freeit ));
 411
 412 LIBLBER_F( BerElement * )
 413 ber_alloc LDAP_P(( void )); /* DEPRECATED */
 414
 415 LIBLBER_F( BerElement * )
 416 der_alloc LDAP_P(( void )); /* DEPRECATED */
 417
 418 LIBLBER_F( BerElement * )
 419 ber_alloc_t LDAP_P((
 420         int beroptions ));
 421
 422 LIBLBER_F( BerElement * )
 423 ber_dup LDAP_P((
 424         BerElement *ber ));
 425
 426 LIBLBER_F( ber_tag_t )
 427 ber_get_next LDAP_P((
 428         Sockbuf *sb,
 429         ber_len_t *len,
 430         BerElement *ber ));
 431
 432 LIBLBER_F( void )
 433 ber_init_w_nullc LDAP_P((
 434         BerElement *ber,
 435         int options ));
 436
 437 LIBLBER_F( void )
 438 ber_reset LDAP_P((
 439         BerElement *ber,
 440         int was_writing ));
 441
 442 LIBLBER_F( BerElement * )
 443 ber_init LDAP_P((
 444         struct berval *bv ));
 445
 446 LIBLBER_F( int )
 447 ber_flatten LDAP_P((
 448         BerElement *ber,
 449         struct berval **bvPtr ));
 450
 451 /*
 452  * LBER ber accessor functions
 453  */
 454
 455 LIBLBER_F( int )
 456 ber_get_option LDAP_P((
 457         void *item,
 458         int option,
 459         void *outvalue));
 460
 461 LIBLBER_F( int )
 462 ber_set_option LDAP_P((
 463         void *item,
 464         int option,
 465         LDAP_CONST void *invalue));
 466
 467 /*
 468  * LBER sockbuf.c
 469  */
 470
 471 LIBLBER_F( Sockbuf *  )
 472 ber_sockbuf_alloc LDAP_P((
 473         void ));
 474
 475 LIBLBER_F( void )
 476 ber_sockbuf_free LDAP_P((
 477         Sockbuf *sb ));
 478
 479 LIBLBER_F( int )
 480 ber_sockbuf_add_io LDAP_P((
 481         Sockbuf *sb,
 482         Sockbuf_IO *sbio,
 483         int layer,
 484         void *arg ));
 485
 486 LIBLBER_F( int )
 487 ber_sockbuf_remove_io LDAP_P((
 488         Sockbuf *sb,
 489         Sockbuf_IO *sbio,
 490         int layer ));
 491
 492 LIBLBER_F( int )
 493 ber_sockbuf_ctrl LDAP_P((
 494         Sockbuf *sb,
 495         int opt,
 496         void *arg ));
 497
 498 LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_tcp;
 499 LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_udp;
 500 LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_readahead;
 501 LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_fd;
 502 LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_debug;
 503
 504 /*
 505  * LBER memory.c
 506  */
 507 LIBLBER_F( void * )
 508 ber_memalloc LDAP_P((
 509         ber_len_t s ));
 510
 511 LIBLBER_F( void * )
 512 ber_memrealloc LDAP_P((
 513         void* p,
 514         ber_len_t s ));
 515
 516 LIBLBER_F( void * )
 517 ber_memcalloc LDAP_P((
 518         ber_len_t n,
 519         ber_len_t s ));
 520
 521 LIBLBER_F( void )
 522 ber_memfree LDAP_P((
 523         void* p ));
 524
 525 LIBLBER_F( void )
 526 ber_memvfree LDAP_P((
 527         void** vector ));
 528
 529 LIBLBER_F( void )
 530 ber_bvfree LDAP_P((
 531         struct berval *bv ));
 532
 533 LIBLBER_F( void )
 534 ber_bvecfree LDAP_P((
 535         struct berval **bv ));
 536
 537 LIBLBER_F( int )
 538 ber_bvecadd LDAP_P((
 539         struct berval ***bvec,
 540         struct berval *bv ));
 541
 542 LIBLBER_F( struct berval * )
 543 ber_bvdup LDAP_P((
 544         LDAP_CONST struct berval *bv ));
 545
 546 LIBLBER_F( struct berval * )
 547 ber_bvstr LDAP_P((
 548         LDAP_CONST char * ));
 549
 550 LIBLBER_F( struct berval * )
 551 ber_bvstrdup LDAP_P((
 552         LDAP_CONST char * ));
 553
 554 LIBLBER_F( char * )
 555 ber_strdup LDAP_P((
 556         LDAP_CONST char * ));
 557
 558 /*
 559  * error.c
 560  */
 561 LIBLBER_F( int * ) ber_errno_addr LDAP_P((void));
 562 #define ber_errno (*(ber_errno_addr)())
 563
 564 #define LBER_ERROR_NONE         0
 565 #define LBER_ERROR_PARAM        0x1
 566 #define LBER_ERROR_MEMORY       0x2
 567
 568 LDAP_END_DECL
 569
 570 #endif /* _LBER_H */