3 * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
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.
13 * Copyright (c) 1990 Regents of the University of Michigan.
14 * All rights reserved.
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.
27 #include <lber_types.h>
31 /* Overview of LBER tag construction
38 * 1 0 = CONTEXT-SPECIFIC
45 * | 5 ... 1 | TAG-NUMBER
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)
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)
60 #define LBER_BIG_TAG_MASK ((ber_tag_t) 0x1fU)
61 #define LBER_MORE_TAG_MASK ((ber_tag_t) 0x80U)
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:
68 #define LBER_INVALID(t) (((t) & (ber_tag_t) 0x080UL) \
69 && (((t) & (ber_tag_t) ~ 0x0FF))
71 #define LBER_ERROR ((ber_tag_t) -1)
72 #define LBER_DEFAULT ((ber_tag_t) -1)
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 */
84 /* LBER BerElement options */
85 #define LBER_USE_DER 0x01
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 #define LBER_OPT_BER_MEMCTX 0x06
95 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG
96 #define LBER_OPT_REMAINING_BYTES LBER_OPT_BER_REMAINING_BYTES
97 #define LBER_OPT_TOTAL_BYTES LBER_OPT_BER_TOTAL_BYTES
98 #define LBER_OPT_BYTES_TO_WRITE LBER_OPT_BER_BYTES_TO_WRITE
100 #define LBER_OPT_LOG_PRINT_FN 0x8001
101 #define LBER_OPT_MEMORY_FNS 0x8002
102 #define LBER_OPT_ERROR_FN 0x8003
103 #define LBER_OPT_LOG_PRINT_FILE 0x8004
105 /* get/set Memory Debug options */
106 #define LBER_OPT_MEMORY_INUSE 0x8005 /* for memory debugging */
107 #define LBER_OPT_LOG_PROC 0x8006 /* for external logging function */
109 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
111 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf ));
113 typedef void* (BER_MEMALLOC_FN) LDAP_P(( ber_len_t size, void *ctx ));
114 typedef void* (BER_MEMCALLOC_FN) LDAP_P(( ber_len_t n, ber_len_t size, void *ctx ));
115 typedef void* (BER_MEMREALLOC_FN) LDAP_P(( void *p, ber_len_t size, void *ctx ));
116 typedef void (BER_MEMFREE_FN) LDAP_P(( void *p, void *ctx ));
118 typedef struct lber_memory_fns {
119 BER_MEMALLOC_FN *bmf_malloc;
120 BER_MEMCALLOC_FN *bmf_calloc;
121 BER_MEMREALLOC_FN *bmf_realloc;
122 BER_MEMFREE_FN *bmf_free;
123 } BerMemoryFunctions;
125 /* LBER Sockbuf_IO options */
126 #define LBER_SB_OPT_GET_FD 1
127 #define LBER_SB_OPT_SET_FD 2
128 #define LBER_SB_OPT_HAS_IO 3
129 #define LBER_SB_OPT_SET_NONBLOCK 4
130 #define LBER_SB_OPT_GET_SSL 7
131 #define LBER_SB_OPT_DATA_READY 8
132 #define LBER_SB_OPT_SET_READAHEAD 9
133 #define LBER_SB_OPT_DRAIN 10
134 #define LBER_SB_OPT_NEEDS_READ 11
135 #define LBER_SB_OPT_NEEDS_WRITE 12
136 #define LBER_SB_OPT_GET_MAX_INCOMING 13
137 #define LBER_SB_OPT_SET_MAX_INCOMING 14
138 /* Largest option used by the library */
139 #define LBER_SB_OPT_OPT_MAX 14
141 /* LBER IO operations stacking levels */
142 #define LBER_SBIOD_LEVEL_PROVIDER 10
143 #define LBER_SBIOD_LEVEL_TRANSPORT 20
144 #define LBER_SBIOD_LEVEL_APPLICATION 30
146 /* get/set options for Sockbuf */
147 #define LBER_OPT_SOCKBUF_DESC 0x1000
148 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
149 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
152 #define LBER_OPT_ON ((void *) 1)
153 #define LBER_OPT_OFF ((void *) 0)
155 #define LBER_OPT_SUCCESS (0)
156 #define LBER_OPT_ERROR (-1)
158 #define LBER_ELEMENT_SIZEOF (256) /* must be >= sizeof(BerElement) */
159 typedef struct berelement BerElement;
160 typedef struct sockbuf Sockbuf;
161 typedef struct seqorset Seqorset;
163 typedef struct sockbuf_io Sockbuf_IO;
165 /* Structure for LBER IO operarion descriptor */
166 typedef struct sockbuf_io_desc {
169 Sockbuf_IO *sbiod_io;
171 struct sockbuf_io_desc *sbiod_next;
174 /* Structure for LBER IO operation functions */
176 int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
177 int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
178 int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
180 ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
182 ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
185 int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
188 /* Helper macros for LBER IO functions */
189 #define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
190 ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
192 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
193 ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
195 #define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
196 ( (sbiod)->sbiod_next ? \
197 ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
198 (sbiod)->sbiod_next, opt, arg ) ) : 0 )
200 /* structure for returning a sequence of octet strings + length */
201 typedef struct berval {
206 typedef BerValue *BerVarray; /* To distinguish from a single bv */
208 /* this should be moved to lber-int.h */
214 ber_error_print LDAP_P((
215 LDAP_CONST char *data ));
219 LDAP_CONST char *data, ber_len_t len ));
223 BerElement *ber, int inout ));
226 ber_sos_dump LDAP_P((
232 typedef int (*BERDecodeCallback) LDAP_P((
242 ber_skip_tag LDAP_P((
247 ber_peek_tag LDAP_P((
257 ber_get_enum LDAP_P((
262 ber_get_stringb LDAP_P((
268 ber_get_stringbv LDAP_P((
274 ber_get_stringa LDAP_P((
279 ber_get_stringal LDAP_P((
281 struct berval **bv ));
284 ber_get_bitstringa LDAP_P((
290 ber_get_null LDAP_P((
294 ber_get_boolean LDAP_P((
296 ber_int_t *boolval ));
299 ber_first_element LDAP_P((
305 ber_next_element LDAP_P((
308 LDAP_CONST char *last ));
313 LDAP_CONST char *fmt,
319 typedef int (*BEREncodeCallback) LDAP_P((
324 ber_put_enum LDAP_P((
336 ber_put_ostring LDAP_P((
338 LDAP_CONST char *str,
343 ber_put_berval LDAP_P((
349 ber_put_string LDAP_P((
351 LDAP_CONST char *str,
355 ber_put_bitstring LDAP_P((
357 LDAP_CONST char *str,
362 ber_put_null LDAP_P((
367 ber_put_boolean LDAP_P((
373 ber_start_seq LDAP_P((
378 ber_start_set LDAP_P((
393 LDAP_CONST char *fmt,
410 LDAP_CONST char *buf,
420 ber_free_buf LDAP_P(( BerElement *ber ));
428 LBER_F( BerElement * )
429 ber_alloc LDAP_P(( void )); /* DEPRECATED */
431 LBER_F( BerElement * )
432 der_alloc LDAP_P(( void )); /* DEPRECATED */
434 LBER_F( BerElement * )
438 LBER_F( BerElement * )
443 ber_get_next LDAP_P((
455 ber_init_w_nullc LDAP_P(( /* DEPRECATED */
464 LBER_F( BerElement * )
466 struct berval *bv ));
471 struct berval **bvPtr ));
474 ber_flatten2 LDAP_P((
480 ber_remaining LDAP_P((
484 * LBER ber accessor functions
488 ber_get_option LDAP_P((
494 ber_set_option LDAP_P((
497 LDAP_CONST void *invalue));
504 ber_sockbuf_alloc LDAP_P((
508 ber_sockbuf_free LDAP_P((
512 ber_sockbuf_add_io LDAP_P((
519 ber_sockbuf_remove_io LDAP_P((
525 ber_sockbuf_ctrl LDAP_P((
530 LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp;
531 LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead;
532 LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd;
533 LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug;
534 #ifdef LDAP_CONNECTIONLESS
535 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
542 ber_memalloc LDAP_P((
546 ber_memrealloc LDAP_P((
551 ber_memcalloc LDAP_P((
560 ber_memvfree LDAP_P((
565 struct berval *bv ));
568 ber_bvecfree LDAP_P((
569 struct berval **bv ));
573 struct berval ***bvec,
574 struct berval *bv ));
576 LBER_F( struct berval * )
578 struct berval *dst, struct berval *src ));
580 LBER_F( struct berval * )
582 struct berval *src ));
584 LBER_F( struct berval * )
586 LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
588 LBER_F( struct berval * )
590 LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
592 #define ber_bvstr(a) ber_str2bv(a, 0, 0, NULL)
593 #define ber_bvstrdup(a) ber_str2bv(a, 0, 1, NULL)
597 LDAP_CONST char * ));
600 ber_bvarray_free LDAP_P(( BerVarray p ));
603 ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv ));
605 #define ber_bvcmp(v1,v2) \
606 ((v1)->bv_len < (v2)->bv_len \
607 ? -1 : ((v1)->bv_len > (v2)->bv_len \
608 ? 1 : memcmp((v1)->bv_val, (v2)->bv_val, (v1)->bv_len) ))
613 LBER_F( int * ) ber_errno_addr LDAP_P((void));
614 #define ber_errno (*(ber_errno_addr)())
616 #define LBER_ERROR_NONE 0
617 #define LBER_ERROR_PARAM 0x1
618 #define LBER_ERROR_MEMORY 0x2