3 * Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA
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.
12 * Copyright (c) 1990 Regents of the University of Michigan.
13 * All rights reserved.
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.
26 #include <lber_types.h>
30 /* Overview of LBER tag construction
37 * 1 0 = CONTEXT-SPECIFIC
44 * | 5 ... 1 | TAG-NUMBER
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)
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)
59 #define LBER_BIG_TAG_MASK ((ber_tag_t) 0x1fU)
60 #define LBER_MORE_TAG_MASK ((ber_tag_t) 0x80U)
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:
67 #define LBER_INVALID(t) (((t) & (ber_tag_t) 0x080UL) \
68 && (((t) & (ber_tag_t) ~ 0x0FF))
70 #define LBER_ERROR ((ber_tag_t) -1)
71 #define LBER_DEFAULT ((ber_tag_t) -1)
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 */
83 typedef int (*BERTranslateProc) LDAP_P((
88 /* LBER BerElement options */
89 #define LBER_USE_DER 0x01
90 #define LBER_USE_INDEFINITE_LEN 0x02
91 #define LBER_TRANSLATE_STRINGS 0x04 /* deprecated */
93 /* get/set options for BerElement */
94 #define LBER_OPT_BER_OPTIONS 0x01
95 #define LBER_OPT_BER_DEBUG 0x02
96 #define LBER_OPT_BER_REMAINING_BYTES 0x03
97 #define LBER_OPT_BER_TOTAL_BYTES 0x04
98 #define LBER_OPT_BER_BYTES_TO_WRITE 0x05
100 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG
101 #define LBER_OPT_REMAINING_BYTES LBER_OPT_BER_REMAINING_BYTES
102 #define LBER_OPT_TOTAL_BYTES LBER_OPT_BER_TOTAL_BYTES
103 #define LBER_OPT_BYTES_TO_WRITE LBER_OPT_BER_BYTES_TO_WRITE
105 #define LBER_OPT_LOG_PRINT_FN 0x8001
106 #define LBER_OPT_MEMORY_FNS 0x8002
107 #define LBER_OPT_ERROR_FN 0x8003
108 #define LBER_OPT_LOG_PRINT_FILE 0x8004
110 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
112 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
114 typedef void* (*BER_MEMALLOC_FN) LDAP_P(( ber_len_t size ));
115 typedef void* (*BER_MEMCALLOC_FN) LDAP_P(( ber_len_t n, ber_len_t size ));
116 typedef void* (*BER_MEMREALLOC_FN) LDAP_P(( void *p, ber_len_t size ));
117 typedef void (*BER_MEMFREE_FN) LDAP_P(( void *p ));
119 typedef struct lber_memory_fns {
120 BER_MEMALLOC_FN bmf_malloc;
121 BER_MEMCALLOC_FN bmf_calloc;
122 BER_MEMREALLOC_FN bmf_realloc;
123 BER_MEMFREE_FN bmf_free;
124 } BerMemoryFunctions;
126 /* LBER Sockbuf_IO options */
127 #define LBER_SB_OPT_GET_FD 1
128 #define LBER_SB_OPT_SET_FD 2
129 #define LBER_SB_OPT_HAS_IO 3
130 #define LBER_SB_OPT_SET_NONBLOCK 4
131 #define LBER_SB_OPT_UDP_GET_SRC 5
132 #define LBER_SB_OPT_UDP_SET_DST 6
133 #define LBER_SB_OPT_GET_SSL 7
134 #define LBER_SB_OPT_DATA_READY 8
135 #define LBER_SB_OPT_SET_READAHEAD 9
136 #define LBER_SB_OPT_DRAIN 10
137 #define LBER_SB_OPT_NEEDS_READ 11
138 #define LBER_SB_OPT_NEEDS_WRITE 12
139 /* Largest option used by the library */
140 #define LBER_SB_OPT_OPT_MAX 12
142 /* LBER IO operations stacking levels */
143 #define LBER_SBIOD_LEVEL_PROVIDER 10
144 #define LBER_SBIOD_LEVEL_TRANSPORT 20
145 #define LBER_SBIOD_LEVEL_APPLICATION 30
147 /* get/set options for Sockbuf */
148 #define LBER_OPT_SOCKBUF_DESC 0x1000
149 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
150 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
153 #define LBER_OPT_ON ((void *) 1)
154 #define LBER_OPT_OFF ((void *) 0)
156 #define LBER_OPT_SUCCESS (0)
157 #define LBER_OPT_ERROR (-1)
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 /* this should be moved to lber-int.h */
212 ber_print_error LDAP_P((
213 LDAP_CONST char *data ));
217 LDAP_CONST char *data, ber_len_t len ));
221 BerElement *ber, int inout ));
224 ber_sos_dump LDAP_P((
231 typedef int (*BERDecodeCallback) LDAP_P((
236 LIBLBER_F( ber_tag_t )
240 LIBLBER_F( ber_tag_t )
241 ber_skip_tag LDAP_P((
245 LIBLBER_F( ber_tag_t )
246 ber_peek_tag LDAP_P((
250 LIBLBER_F( ber_tag_t )
255 LIBLBER_F( ber_tag_t )
256 ber_get_enum LDAP_P((
260 LIBLBER_F( ber_tag_t )
261 ber_get_stringb LDAP_P((
266 LIBLBER_F( ber_tag_t )
267 ber_get_stringa LDAP_P((
271 LIBLBER_F( ber_tag_t )
272 ber_get_stringal LDAP_P((
274 struct berval **bv ));
276 LIBLBER_F( ber_tag_t )
277 ber_get_bitstringa LDAP_P((
282 LIBLBER_F( ber_tag_t )
283 ber_get_null LDAP_P((
286 LIBLBER_F( ber_tag_t )
287 ber_get_boolean LDAP_P((
289 ber_int_t *boolval ));
291 LIBLBER_F( ber_tag_t )
292 ber_first_element LDAP_P((
297 LIBLBER_F( ber_tag_t )
298 ber_next_element LDAP_P((
301 LDAP_CONST char *last ));
303 LIBLBER_F( ber_tag_t )
306 LDAP_CONST char *fmt,
310 ber_set_string_translators LDAP_P((
312 BERTranslateProc encode_proc,
313 BERTranslateProc decode_proc ));
318 typedef int (*BEREncodeCallback) LDAP_P((
323 ber_put_enum LDAP_P((
335 ber_put_ostring LDAP_P((
337 LDAP_CONST char *str,
342 ber_put_berval LDAP_P((
344 LDAP_CONST struct berval *bv,
348 ber_put_string LDAP_P((
350 LDAP_CONST char *str,
354 ber_put_bitstring LDAP_P((
356 LDAP_CONST char *str,
361 ber_put_null LDAP_P((
366 ber_put_boolean LDAP_P((
372 ber_start_seq LDAP_P((
377 ber_start_set LDAP_P((
392 LDAP_CONST char *fmt,
400 LIBLBER_F( ber_slen_t )
406 LIBLBER_F( ber_slen_t )
409 LDAP_CONST char *buf,
424 LIBLBER_F( BerElement * )
425 ber_alloc LDAP_P(( void )); /* DEPRECATED */
427 LIBLBER_F( BerElement * )
428 der_alloc LDAP_P(( void )); /* DEPRECATED */
430 LIBLBER_F( BerElement * )
434 LIBLBER_F( BerElement * )
438 LIBLBER_F( ber_tag_t )
439 ber_get_next LDAP_P((
445 ber_init_w_nullc LDAP_P((
454 LIBLBER_F( BerElement * )
456 struct berval *bv ));
461 struct berval **bvPtr ));
464 * LBER ber accessor functions
468 ber_get_option LDAP_P((
474 ber_set_option LDAP_P((
477 LDAP_CONST void *invalue));
483 LIBLBER_F( Sockbuf * )
484 ber_sockbuf_alloc LDAP_P((
488 ber_sockbuf_free LDAP_P((
492 ber_sockbuf_add_io LDAP_P((
499 ber_sockbuf_remove_io LDAP_P((
505 ber_sockbuf_ctrl LDAP_P((
510 LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_tcp;
511 LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_udp;
512 LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_readahead;
513 LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_fd;
514 LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_debug;
520 ber_memalloc LDAP_P((
524 ber_memrealloc LDAP_P((
529 ber_memcalloc LDAP_P((
538 ber_memvfree LDAP_P((
543 struct berval *bv ));
546 ber_bvecfree LDAP_P((
547 struct berval **bv ));
551 struct berval ***bvec,
552 struct berval *bv ));
554 LIBLBER_F( struct berval * )
556 LDAP_CONST struct berval *bv ));
558 LIBLBER_F( struct berval * )
560 LDAP_CONST char * ));
562 LIBLBER_F( struct berval * )
563 ber_bvstrdup LDAP_P((
564 LDAP_CONST char * ));
568 LDAP_CONST char * ));
573 LIBLBER_F( int * ) ber_errno_addr LDAP_P((void));
574 #define ber_errno (*(ber_errno_addr)())
576 #define LBER_ERROR_NONE 0
577 #define LBER_ERROR_PARAM 0x1
578 #define LBER_ERROR_MEMORY 0x2