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>
29 /* Overview of LBER tag construction
36 * 1 0 = CONTEXT-SPECIFIC
43 * | 5 ... 1 | TAG-NUMBER
46 /* BER classes and mask */
47 #define LBER_CLASS_UNIVERSAL 0x00UL
48 #define LBER_CLASS_APPLICATION 0x40UL
49 #define LBER_CLASS_CONTEXT 0x80UL
50 #define LBER_CLASS_PRIVATE 0xc0UL
51 #define LBER_CLASS_MASK 0xc0UL
53 /* BER encoding type and mask */
54 #define LBER_PRIMITIVE 0x00UL
55 #define LBER_CONSTRUCTED 0x20UL
56 #define LBER_ENCODING_MASK 0x20UL
58 #define LBER_BIG_TAG_MASK 0x1fUL
59 #define LBER_MORE_TAG_MASK 0x80UL
62 * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
63 * as valid BER tags, and so it is safe to use them to report errors. In
64 * fact, any tag for which the following is true is invalid:
65 * (( tag & 0x00000080 ) != 0 ) && (( tag & 0xFFFFFF00 ) != 0 )
67 #define LBER_INVALID(tag) ( ( (tag) & 0xFFFFFF80UL ) != 0 )
68 #define LBER_ERROR 0xffffffffUL
69 #define LBER_DEFAULT 0xffffffffUL
71 /* general BER types we know about */
72 #define LBER_BOOLEAN 0x01UL
73 #define LBER_INTEGER 0x02UL
74 #define LBER_BITSTRING 0x03UL
75 #define LBER_OCTETSTRING 0x04UL
76 #define LBER_NULL 0x05UL
77 #define LBER_ENUMERATED 0x0aUL
78 #define LBER_SEQUENCE 0x30UL /* constructed */
79 #define LBER_SET 0x31UL /* constructed */
81 #define OLD_LBER_SEQUENCE 0x10UL /* w/o constructed bit - broken */
82 #define OLD_LBER_SET 0x11UL /* w/o constructed bit - broken */
84 typedef int (*BERTranslateProc) LDAP_P((
86 unsigned long *buflenp,
89 /* LBER BerElement options */
90 #define LBER_USE_DER 0x01
91 #define LBER_USE_INDEFINITE_LEN 0x02
92 #define LBER_TRANSLATE_STRINGS 0x04
94 /* get/set options for BerElement */
95 #define LBER_OPT_BER_OPTIONS 0x01
96 #define LBER_OPT_BER_DEBUG 0x02
98 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG
99 #define LBER_OPT_LOG_PRINT_FN 0x8001
101 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
103 /* LBER Sockbuf options */
104 #define LBER_TO_FILE 0x01 /* to a file referenced by sb_fd */
105 #define LBER_TO_FILE_ONLY 0x02 /* only write to file, not network */
106 #define LBER_MAX_INCOMING_SIZE 0x04 /* impose limit on incoming stuff */
107 #define LBER_NO_READ_AHEAD 0x08 /* read only as much as requested */
109 /* get/set options for Sockbuf */
110 #define LBER_OPT_SOCKBUF_DESC 0x1000
111 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
112 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
115 #define LBER_OPT_ON ((void *) 1)
116 #define LBER_OPT_OFF ((void *) 0)
118 #define LBER_OPT_SUCCESS 0
119 #define LBER_OPT_ERROR (-1)
121 typedef struct berelement BerElement;
122 typedef struct sockbuf Sockbuf;
123 typedef struct seqorset Seqorset;
125 /* structure for returning a sequence of octet strings + length */
126 typedef struct berval {
127 unsigned long bv_len;
135 ber_print_error LDAP_P((
136 LDAP_CONST char *data ));
140 LDAP_CONST char *data, int len ));
144 LDAP_CONST BerElement *ber, int inout ));
147 ber_sos_dump LDAP_P((
148 LDAP_CONST Seqorset *sos ));
154 typedef int (*BERDecodeCallback) LDAP_P((
159 LDAP_F( unsigned long )
163 LDAP_F( unsigned long )
164 ber_skip_tag LDAP_P((
166 unsigned long *len ));
168 LDAP_F( unsigned long )
169 ber_peek_tag LDAP_P((
170 LDAP_CONST BerElement *ber,
171 unsigned long *len ));
173 LDAP_F( unsigned long )
178 LDAP_F( unsigned long )
179 ber_get_stringb LDAP_P((
182 unsigned long *len ));
184 LDAP_F( unsigned long )
185 ber_get_stringa LDAP_P((
186 BerElement *ber, char **buf ));
188 LDAP_F( unsigned long )
189 ber_get_stringal LDAP_P((
191 struct berval **bv ));
193 LDAP_F( unsigned long )
194 ber_get_bitstringa LDAP_P((
197 unsigned long *len ));
199 LDAP_F( unsigned long )
200 ber_get_null LDAP_P((
203 LDAP_F( unsigned long )
204 ber_get_boolean LDAP_P((
208 LDAP_F( unsigned long )
209 ber_first_element LDAP_P((
214 LDAP_F( unsigned long )
215 ber_next_element LDAP_P((
220 LDAP_F( unsigned long )
223 LDAP_CONST char *fmt,
228 struct berval *bv ));
231 ber_bvecfree LDAP_P((
232 struct berval **bv ));
234 LDAP_F( struct berval * )
236 LDAP_CONST struct berval *bv ));
239 ber_set_string_translators LDAP_P((
241 BERTranslateProc encode_proc,
242 BERTranslateProc decode_proc ));
247 typedef int (*BEREncodeCallback) LDAP_P((
252 ber_put_enum LDAP_P((
255 unsigned long tag ));
261 unsigned long tag ));
264 ber_put_ostring LDAP_P((
266 LDAP_CONST char *str,
268 unsigned long tag ));
271 ber_put_berval LDAP_P((
273 LDAP_CONST struct berval *bv,
274 unsigned long tag ));
277 ber_put_string LDAP_P((
279 LDAP_CONST char *str,
280 unsigned long tag ));
283 ber_put_bitstring LDAP_P((
285 LDAP_CONST char *str,
286 unsigned long bitlen,
287 unsigned long tag ));
290 ber_put_null LDAP_P((
292 unsigned long tag ));
295 ber_put_boolean LDAP_P((
298 unsigned long tag ));
301 ber_start_seq LDAP_P((
303 unsigned long tag ));
306 ber_start_set LDAP_P((
308 unsigned long tag ));
321 LDAP_CONST char *fmt,
331 unsigned long len ));
336 LDAP_CONST char *buf,
352 Sockbuf *sb, BerElement *ber, int freeit ));
354 LDAP_F( BerElement * )
355 ber_alloc LDAP_P(( void )); /* DEPRECATED */
357 LDAP_F( BerElement * )
358 der_alloc LDAP_P(( void )); /* DEPRECATED */
360 LDAP_F( BerElement * )
364 LDAP_F( BerElement * )
366 LDAP_CONST BerElement *ber ));
368 LDAP_F( unsigned long )
369 ber_get_next LDAP_P((
375 ber_init_w_nullc LDAP_P((
385 * LBER draft-ietf-ldapext-ldap-c-api-01 routines
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((
407 ber_set_option LDAP_P((
410 LDAP_CONST void *invalue));
417 ber_sockbuf_alloc( void );
420 ber_sockbuf_alloc_fd(