3 * Copyright 1998,1999 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 options */
127 #define LBER_TO_FILE 0x01 /* to a file referenced by sb_fd */
128 #define LBER_TO_FILE_ONLY 0x02 /* only write to file, not network */
129 #define LBER_MAX_INCOMING_SIZE 0x04 /* impose limit on incoming stuff */
130 #define LBER_NO_READ_AHEAD 0x08 /* read only as much as requested */
132 /* get/set options for Sockbuf */
133 #define LBER_OPT_SOCKBUF_DESC 0x1000
134 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
135 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
138 #define LBER_OPT_ON ((void *) 1)
139 #define LBER_OPT_OFF ((void *) 0)
141 #define LBER_OPT_SUCCESS (0)
142 #define LBER_OPT_ERROR (-1)
144 typedef struct berelement BerElement;
145 typedef struct sockbuf Sockbuf;
146 typedef struct seqorset Seqorset;
148 /* structure for returning a sequence of octet strings + length */
149 typedef struct berval {
154 /* this should be moved to lber-int.h */
160 ber_print_error LDAP_P((
161 LDAP_CONST char *data ));
165 LDAP_CONST char *data, ber_len_t len ));
169 BerElement *ber, int inout ));
172 ber_sos_dump LDAP_P((
179 typedef int (*BERDecodeCallback) LDAP_P((
184 LIBLBER_F( ber_tag_t )
188 LIBLBER_F( ber_tag_t )
189 ber_skip_tag LDAP_P((
193 LIBLBER_F( ber_tag_t )
194 ber_peek_tag LDAP_P((
198 LIBLBER_F( ber_tag_t )
203 LIBLBER_F( ber_tag_t )
204 ber_get_stringb LDAP_P((
209 LIBLBER_F( ber_tag_t )
210 ber_get_stringa LDAP_P((
214 LIBLBER_F( ber_tag_t )
215 ber_get_stringal LDAP_P((
217 struct berval **bv ));
219 LIBLBER_F( ber_tag_t )
220 ber_get_bitstringa LDAP_P((
225 LIBLBER_F( ber_tag_t )
226 ber_get_null LDAP_P((
229 LIBLBER_F( ber_tag_t )
230 ber_get_boolean LDAP_P((
232 ber_int_t *boolval ));
234 LIBLBER_F( ber_tag_t )
235 ber_first_element LDAP_P((
240 LIBLBER_F( ber_tag_t )
241 ber_next_element LDAP_P((
244 LDAP_CONST char *last ));
246 LIBLBER_F( ber_tag_t )
249 LDAP_CONST char *fmt,
253 ber_set_string_translators LDAP_P((
255 BERTranslateProc encode_proc,
256 BERTranslateProc decode_proc ));
261 typedef int (*BEREncodeCallback) LDAP_P((
266 ber_put_enum LDAP_P((
278 ber_put_ostring LDAP_P((
280 LDAP_CONST char *str,
285 ber_put_berval LDAP_P((
287 LDAP_CONST struct berval *bv,
291 ber_put_string LDAP_P((
293 LDAP_CONST char *str,
297 ber_put_bitstring LDAP_P((
299 LDAP_CONST char *str,
304 ber_put_null LDAP_P((
309 ber_put_boolean LDAP_P((
315 ber_start_seq LDAP_P((
320 ber_start_set LDAP_P((
335 LDAP_CONST char *fmt,
343 LIBLBER_F( ber_slen_t )
349 LIBLBER_F( ber_slen_t )
352 LDAP_CONST char *buf,
367 LIBLBER_F( BerElement * )
368 ber_alloc LDAP_P(( void )); /* DEPRECATED */
370 LIBLBER_F( BerElement * )
371 der_alloc LDAP_P(( void )); /* DEPRECATED */
373 LIBLBER_F( BerElement * )
377 LIBLBER_F( BerElement * )
381 LIBLBER_F( ber_tag_t )
382 ber_get_next LDAP_P((
388 ber_init_w_nullc LDAP_P((
397 LIBLBER_F( BerElement * )
399 struct berval *bv ));
404 struct berval **bvPtr ));
407 * LBER ber accessor functions
411 ber_get_option LDAP_P((
417 ber_set_option LDAP_P((
420 LDAP_CONST void *invalue));
426 LIBLBER_F( Sockbuf * )
427 ber_sockbuf_alloc( void );
429 LIBLBER_F( Sockbuf * )
430 ber_sockbuf_alloc_fd(
441 ber_memalloc LDAP_P((
445 ber_memrealloc LDAP_P((
450 ber_memcalloc LDAP_P((
459 ber_memvfree LDAP_P((
464 struct berval *bv ));
467 ber_bvecfree LDAP_P((
468 struct berval **bv ));
472 struct berval ***bvec,
473 struct berval *bv ));
475 LIBLBER_F( struct berval * )
477 LDAP_CONST struct berval *bv ));
479 LIBLBER_F( struct berval * )
481 LDAP_CONST char * ));
483 LIBLBER_F( struct berval * )
484 ber_bvstrdup LDAP_P((
485 LDAP_CONST char * ));
489 LDAP_CONST char * ));
494 LIBLBER_F( int * ) ber_errno_addr LDAP_P((void));
495 #define ber_errno (*(ber_errno_addr)())
497 #define LBER_ERROR_NONE 0
498 #define LBER_ERROR_PARAM 0x1
499 #define LBER_ERROR_MEMORY 0x2