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
70 /* #define LBER_END_SEQORSET 0xfffffffeUL *//* not part of LDAP C-API */
72 /* general BER types we know about */
73 #define LBER_BOOLEAN 0x01UL
74 #define LBER_INTEGER 0x02UL
75 #define LBER_BITSTRING 0x03UL
76 #define LBER_OCTETSTRING 0x04UL
77 #define LBER_NULL 0x05UL
78 #define LBER_ENUMERATED 0x0aUL
79 #define LBER_SEQUENCE 0x30UL /* constructed */
80 #define LBER_SET 0x31UL /* constructed */
82 #define OLD_LBER_SEQUENCE 0x10UL /* w/o constructed bit - broken */
83 #define OLD_LBER_SET 0x11UL /* w/o constructed bit - broken */
85 typedef int (*BERTranslateProc) LDAP_P((
87 unsigned long *buflenp,
90 /* LBER BerElement options */
91 #define LBER_USE_DER 0x01
92 #define LBER_USE_INDEFINITE_LEN 0x02
93 #define LBER_TRANSLATE_STRINGS 0x04
95 /* get/set options for BerElement */
96 #define LBER_OPT_BER_OPTIONS 0x01
97 #define LBER_OPT_BER_DEBUG 0x02
99 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG
100 #define LBER_OPT_LOG_PRINT_FN 0x8001
102 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
104 /* LBER Sockbuf options */
105 #define LBER_TO_FILE 0x01 /* to a file referenced by sb_fd */
106 #define LBER_TO_FILE_ONLY 0x02 /* only write to file, not network */
107 #define LBER_MAX_INCOMING_SIZE 0x04 /* impose limit on incoming stuff */
108 #define LBER_NO_READ_AHEAD 0x08 /* read only as much as requested */
110 /* get/set options for Sockbuf */
111 #define LBER_OPT_SOCKBUF_DESC 0x1000
112 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
113 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
116 #define LBER_OPT_ON ((void *) 1)
117 #define LBER_OPT_OFF ((void *) 0)
119 #define LBER_OPT_SUCCESS 0
120 #define LBER_OPT_ERROR (-1)
122 typedef struct berelement BerElement;
123 typedef struct sockbuf Sockbuf;
124 typedef struct seqorset Seqorset;
126 /* structure for returning a sequence of octet strings + length */
127 typedef struct berval {
128 unsigned long bv_len;
136 ber_print_error LDAP_P((
137 LDAP_CONST char *data ));
141 LDAP_CONST char *data, int len ));
145 LDAP_CONST BerElement *ber, int inout ));
148 ber_sos_dump LDAP_P((
149 LDAP_CONST Seqorset *sos ));
155 typedef int (*BERDecodeCallback) LDAP_P((
160 LDAP_F( unsigned long )
164 LDAP_F( unsigned long )
165 ber_skip_tag LDAP_P((
167 unsigned long *len ));
169 LDAP_F( unsigned long )
170 ber_peek_tag LDAP_P((
171 LDAP_CONST BerElement *ber,
172 unsigned long *len ));
174 LDAP_F( unsigned long )
179 LDAP_F( unsigned long )
180 ber_get_stringb LDAP_P((
183 unsigned long *len ));
185 LDAP_F( unsigned long )
186 ber_get_stringa LDAP_P((
187 BerElement *ber, char **buf ));
189 LDAP_F( unsigned long )
190 ber_get_stringal LDAP_P((
192 struct berval **bv ));
194 LDAP_F( unsigned long )
195 ber_get_bitstringa LDAP_P((
198 unsigned long *len ));
200 LDAP_F( unsigned long )
201 ber_get_null LDAP_P((
204 LDAP_F( unsigned long )
205 ber_get_boolean LDAP_P((
209 LDAP_F( unsigned long )
210 ber_first_element LDAP_P((
215 LDAP_F( unsigned long )
216 ber_next_element LDAP_P((
221 LDAP_F( unsigned long )
224 LDAP_CONST char *fmt,
229 struct berval *bv ));
232 ber_bvecfree LDAP_P((
233 struct berval **bv ));
235 LDAP_F( struct berval * )
237 LDAP_CONST struct berval *bv ));
240 ber_set_string_translators LDAP_P((
242 BERTranslateProc encode_proc,
243 BERTranslateProc decode_proc ));
248 typedef int (*BEREncodeCallback) LDAP_P((
253 ber_put_enum LDAP_P((
256 unsigned long tag ));
262 unsigned long tag ));
265 ber_put_ostring LDAP_P((
267 LDAP_CONST char *str,
269 unsigned long tag ));
272 ber_put_berval LDAP_P((
274 LDAP_CONST struct berval *bv,
275 unsigned long tag ));
278 ber_put_string LDAP_P((
280 LDAP_CONST char *str,
281 unsigned long tag ));
284 ber_put_bitstring LDAP_P((
286 LDAP_CONST char *str,
287 unsigned long bitlen,
288 unsigned long tag ));
291 ber_put_null LDAP_P((
293 unsigned long tag ));
296 ber_put_boolean LDAP_P((
299 unsigned long tag ));
302 ber_start_seq LDAP_P((
304 unsigned long tag ));
307 ber_start_set LDAP_P((
309 unsigned long tag ));
322 LDAP_CONST char *fmt,
332 unsigned long len ));
337 LDAP_CONST char *buf,
353 Sockbuf *sb, BerElement *ber, int freeit ));
355 LDAP_F( BerElement * )
356 ber_alloc LDAP_P(( void )); /* DEPRECATED */
358 LDAP_F( BerElement * )
359 der_alloc LDAP_P(( void )); /* DEPRECATED */
361 LDAP_F( BerElement * )
365 LDAP_F( BerElement * )
367 LDAP_CONST BerElement *ber ));
369 LDAP_F( unsigned long )
370 ber_get_next LDAP_P((
376 ber_init_w_nullc LDAP_P((
386 * LBER draft-ietf-ldapext-ldap-c-api-01 routines
388 LDAP_F( BerElement * )
390 struct berval *bv ));
394 LDAP_CONST BerElement *ber,
395 struct berval **bvPtr ));
398 * LBER ber accessor functions
402 ber_get_option LDAP_P((
408 ber_set_option LDAP_P((
411 LDAP_CONST void *invalue));
418 ber_sockbuf_alloc( void );
421 ber_sockbuf_alloc_fd(