2 * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
5 * Redistribution and use in source and binary forms are permitted only
6 * as authorized by the OpenLDAP Public License. A copy of this
7 * license is available at http://www.OpenLDAP.org/license.html or
8 * in file LICENSE in the top-level directory of the distribution.
11 * Copyright (c) 1990 Regents of the University of Michigan.
12 * All rights reserved.
14 * Redistribution and use in source and binary forms are permitted
15 * provided that this notice is preserved and that due credit is given
16 * to the University of Michigan at Ann Arbor. The name of the University
17 * may not be used to endorse or promote products derived from this
18 * software without specific prior written permission. This software
19 * is provided ``as is'' without express or implied warranty.
25 #include <ldap_cdefs.h>
27 #ifndef LBER_SIZE_T_DEFINED
33 /* Overview of LBER tag construction
40 * 1 0 = CONTEXT-SPECIFIC
47 * | 5 ... 1 | TAG-NUMBER
50 /* BER classes and mask */
51 #define LBER_CLASS_UNIVERSAL 0x00UL
52 #define LBER_CLASS_APPLICATION 0x40UL
53 #define LBER_CLASS_CONTEXT 0x80UL
54 #define LBER_CLASS_PRIVATE 0xc0UL
55 #define LBER_CLASS_MASK 0xc0UL
57 /* BER encoding type and mask */
58 #define LBER_PRIMITIVE 0x00UL
59 #define LBER_CONSTRUCTED 0x20UL
60 #define LBER_ENCODING_MASK 0x20UL
62 #define LBER_BIG_TAG_MASK 0x1fUL
63 #define LBER_MORE_TAG_MASK 0x80UL
66 * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
67 * as valid BER tags, and so it is safe to use them to report errors. In
68 * fact, any tag for which the following is true is invalid:
69 * (( tag & 0x00000080 ) != 0 ) && (( tag & 0xFFFFFF00 ) != 0 )
71 #define LBER_INVALID(tag) ( ( (tag) & 0xFFFFFF80UL ) != 0 )
72 #define LBER_ERROR 0xffffffffUL
73 #define LBER_DEFAULT 0xffffffffUL
75 /* general BER types we know about */
76 #define LBER_BOOLEAN 0x01UL
77 #define LBER_INTEGER 0x02UL
78 #define LBER_BITSTRING 0x03UL
79 #define LBER_OCTETSTRING 0x04UL
80 #define LBER_NULL 0x05UL
81 #define LBER_ENUMERATED 0x0aUL
82 #define LBER_SEQUENCE 0x30UL /* constructed */
83 #define LBER_SET 0x31UL /* constructed */
85 #define OLD_LBER_SEQUENCE 0x10UL /* w/o constructed bit - broken */
86 #define OLD_LBER_SET 0x11UL /* w/o constructed bit - broken */
88 typedef int (*BERTranslateProc) LDAP_P((
90 unsigned long *buflenp,
93 /* LBER BerElement options */
94 #define LBER_USE_DER 0x01
95 #define LBER_USE_INDEFINITE_LEN 0x02
96 #define LBER_TRANSLATE_STRINGS 0x04
98 /* get/set options for BerElement */
99 #define LBER_OPT_BER_OPTIONS 0x01
100 #define LBER_OPT_BER_DEBUG 0x02
102 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG
104 #define LBER_OPT_LOG_PRINT_FN 0x8001
105 #define LBER_OPT_MEMORY_FNS 0x8002
107 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
109 typedef void* (*BER_MEMALLOC_FN) LDAP_P(( size_t size ));
110 typedef void* (*BER_MEMCALLOC_FN) LDAP_P(( size_t n, size_t size ));
111 typedef void* (*BER_MEMREALLOC_FN) LDAP_P(( void *p, size_t size ));
112 typedef void (*BER_MEMFREE_FN) LDAP_P(( void *p ));
114 typedef struct lber_memory_fns {
115 BER_MEMALLOC_FN bmf_malloc;
116 BER_MEMCALLOC_FN bmf_calloc;
117 BER_MEMREALLOC_FN bmf_realloc;
118 BER_MEMFREE_FN bmf_free;
119 } BerMemoryFunctions;
121 /* LBER Sockbuf options */
122 #define LBER_TO_FILE 0x01 /* to a file referenced by sb_fd */
123 #define LBER_TO_FILE_ONLY 0x02 /* only write to file, not network */
124 #define LBER_MAX_INCOMING_SIZE 0x04 /* impose limit on incoming stuff */
125 #define LBER_NO_READ_AHEAD 0x08 /* read only as much as requested */
127 /* get/set options for Sockbuf */
128 #define LBER_OPT_SOCKBUF_DESC 0x1000
129 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
130 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
133 #define LBER_OPT_ON ((void *) 1)
134 #define LBER_OPT_OFF ((void *) 0)
136 #define LBER_OPT_SUCCESS 0
137 #define LBER_OPT_ERROR (-1)
139 typedef struct berelement BerElement;
140 typedef struct sockbuf Sockbuf;
141 typedef struct seqorset Seqorset;
143 /* structure for returning a sequence of octet strings + length */
144 typedef struct berval {
145 unsigned long bv_len;
153 ber_print_error LDAP_P((
154 LDAP_CONST char *data ));
158 LDAP_CONST char *data, int len ));
162 LDAP_CONST BerElement *ber, int inout ));
165 ber_sos_dump LDAP_P((
166 LDAP_CONST Seqorset *sos ));
172 typedef int (*BERDecodeCallback) LDAP_P((
177 LDAP_F( unsigned long )
181 LDAP_F( unsigned long )
182 ber_skip_tag LDAP_P((
184 unsigned long *len ));
186 LDAP_F( unsigned long )
187 ber_peek_tag LDAP_P((
188 LDAP_CONST BerElement *ber,
189 unsigned long *len ));
191 LDAP_F( unsigned long )
196 LDAP_F( unsigned long )
197 ber_get_stringb LDAP_P((
200 unsigned long *len ));
202 LDAP_F( unsigned long )
203 ber_get_stringa LDAP_P((
204 BerElement *ber, char **buf ));
206 LDAP_F( unsigned long )
207 ber_get_stringal LDAP_P((
209 struct berval **bv ));
211 LDAP_F( unsigned long )
212 ber_get_bitstringa LDAP_P((
215 unsigned long *len ));
217 LDAP_F( unsigned long )
218 ber_get_null LDAP_P((
221 LDAP_F( unsigned long )
222 ber_get_boolean LDAP_P((
226 LDAP_F( unsigned long )
227 ber_first_element LDAP_P((
232 LDAP_F( unsigned long )
233 ber_next_element LDAP_P((
238 LDAP_F( unsigned long )
241 LDAP_CONST char *fmt,
245 ber_set_string_translators LDAP_P((
247 BERTranslateProc encode_proc,
248 BERTranslateProc decode_proc ));
253 typedef int (*BEREncodeCallback) LDAP_P((
258 ber_put_enum LDAP_P((
261 unsigned long tag ));
267 unsigned long tag ));
270 ber_put_ostring LDAP_P((
272 LDAP_CONST char *str,
274 unsigned long tag ));
277 ber_put_berval LDAP_P((
279 LDAP_CONST struct berval *bv,
280 unsigned long tag ));
283 ber_put_string LDAP_P((
285 LDAP_CONST char *str,
286 unsigned long tag ));
289 ber_put_bitstring LDAP_P((
291 LDAP_CONST char *str,
292 unsigned long bitlen,
293 unsigned long tag ));
296 ber_put_null LDAP_P((
298 unsigned long tag ));
301 ber_put_boolean LDAP_P((
304 unsigned long tag ));
307 ber_start_seq LDAP_P((
309 unsigned long tag ));
312 ber_start_set LDAP_P((
314 unsigned long tag ));
327 LDAP_CONST char *fmt,
339 unsigned long len ));
344 LDAP_CONST char *buf,
355 Sockbuf *sb, BerElement *ber, int freeit ));
357 LDAP_F( BerElement * )
358 ber_alloc LDAP_P(( void )); /* DEPRECATED */
360 LDAP_F( BerElement * )
361 der_alloc LDAP_P(( void )); /* DEPRECATED */
363 LDAP_F( BerElement * )
367 LDAP_F( BerElement * )
369 LDAP_CONST BerElement *ber ));
371 LDAP_F( unsigned long )
372 ber_get_next LDAP_P((
378 ber_init_w_nullc LDAP_P((
387 LDAP_F( BerElement * )
389 struct berval *bv ));
393 LDAP_CONST BerElement *ber,
394 struct berval **bvPtr ));
397 * LBER ber accessor functions
401 ber_get_option LDAP_P((
402 LDAP_CONST void *item,
407 ber_set_option LDAP_P((
410 LDAP_CONST void *invalue));
417 ber_sockbuf_alloc( void );
420 ber_sockbuf_alloc_fd(
431 ber_memalloc LDAP_P((
435 ber_memrealloc LDAP_P((
440 ber_memcalloc LDAP_P((
449 ber_memvfree LDAP_P((
454 struct berval *bv ));
457 ber_bvecfree LDAP_P((
458 struct berval **bv ));
460 LDAP_F( struct berval * )
462 LDAP_CONST struct berval *bv ));
466 LDAP_CONST char * ));