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 /* LBER BerElement options */
84 #define LBER_USE_DER 0x01
86 /* get/set options for BerElement */
87 #define LBER_OPT_BER_OPTIONS 0x01
88 #define LBER_OPT_BER_DEBUG 0x02
89 #define LBER_OPT_BER_REMAINING_BYTES 0x03
90 #define LBER_OPT_BER_TOTAL_BYTES 0x04
91 #define LBER_OPT_BER_BYTES_TO_WRITE 0x05
93 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG
94 #define LBER_OPT_REMAINING_BYTES LBER_OPT_BER_REMAINING_BYTES
95 #define LBER_OPT_TOTAL_BYTES LBER_OPT_BER_TOTAL_BYTES
96 #define LBER_OPT_BYTES_TO_WRITE LBER_OPT_BER_BYTES_TO_WRITE
98 #define LBER_OPT_LOG_PRINT_FN 0x8001
99 #define LBER_OPT_MEMORY_FNS 0x8002
100 #define LBER_OPT_ERROR_FN 0x8003
101 #define LBER_OPT_LOG_PRINT_FILE 0x8004
103 /* get/set Memory Debug options */
104 #define LBER_OPT_MEMORY_INUSE 0x8005 /* for memory debugging */
105 #define LBER_OPT_LOG_PROC 0x8006 /* for external logging function */
107 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
109 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf ));
111 typedef void* (*BER_MEMALLOC_FN) LDAP_P(( ber_len_t size ));
112 typedef void* (*BER_MEMCALLOC_FN) LDAP_P(( ber_len_t n, ber_len_t size ));
113 typedef void* (*BER_MEMREALLOC_FN) LDAP_P(( void *p, ber_len_t size ));
114 typedef void (*BER_MEMFREE_FN) LDAP_P(( void *p ));
116 typedef struct lber_memory_fns {
117 BER_MEMALLOC_FN bmf_malloc;
118 BER_MEMCALLOC_FN bmf_calloc;
119 BER_MEMREALLOC_FN bmf_realloc;
120 BER_MEMFREE_FN bmf_free;
121 } BerMemoryFunctions;
123 /* LBER Sockbuf_IO options */
124 #define LBER_SB_OPT_GET_FD 1
125 #define LBER_SB_OPT_SET_FD 2
126 #define LBER_SB_OPT_HAS_IO 3
127 #define LBER_SB_OPT_SET_NONBLOCK 4
128 #define LBER_SB_OPT_GET_SSL 7
129 #define LBER_SB_OPT_DATA_READY 8
130 #define LBER_SB_OPT_SET_READAHEAD 9
131 #define LBER_SB_OPT_DRAIN 10
132 #define LBER_SB_OPT_NEEDS_READ 11
133 #define LBER_SB_OPT_NEEDS_WRITE 12
134 #define LBER_SB_OPT_GET_MAX_INCOMING 13
135 #define LBER_SB_OPT_SET_MAX_INCOMING 14
136 /* Largest option used by the library */
137 #define LBER_SB_OPT_OPT_MAX 14
139 /* LBER IO operations stacking levels */
140 #define LBER_SBIOD_LEVEL_PROVIDER 10
141 #define LBER_SBIOD_LEVEL_TRANSPORT 20
142 #define LBER_SBIOD_LEVEL_APPLICATION 30
144 /* get/set options for Sockbuf */
145 #define LBER_OPT_SOCKBUF_DESC 0x1000
146 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
147 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
150 #define LBER_OPT_ON ((void *) 1)
151 #define LBER_OPT_OFF ((void *) 0)
153 #define LBER_OPT_SUCCESS (0)
154 #define LBER_OPT_ERROR (-1)
156 typedef struct berelement BerElement;
157 typedef struct sockbuf Sockbuf;
158 typedef struct seqorset Seqorset;
160 typedef struct sockbuf_io Sockbuf_IO;
162 /* Structure for LBER IO operarion descriptor */
163 typedef struct sockbuf_io_desc {
166 Sockbuf_IO *sbiod_io;
168 struct sockbuf_io_desc *sbiod_next;
171 /* Structure for LBER IO operation functions */
173 int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
174 int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
175 int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
177 ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
179 ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
182 int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
185 /* Helper macros for LBER IO functions */
186 #define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
187 ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
189 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
190 ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
192 #define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
193 ( (sbiod)->sbiod_next ? \
194 ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
195 (sbiod)->sbiod_next, opt, arg ) ) : 0 )
197 /* structure for returning a sequence of octet strings + length */
198 typedef struct berval {
203 /* this should be moved to lber-int.h */
209 ber_error_print LDAP_P((
210 LDAP_CONST char *data ));
214 LDAP_CONST char *data, ber_len_t len ));
218 BerElement *ber, int inout ));
221 ber_sos_dump LDAP_P((
227 typedef int (*BERDecodeCallback) LDAP_P((
237 ber_skip_tag LDAP_P((
242 ber_peek_tag LDAP_P((
252 ber_get_enum LDAP_P((
257 ber_get_stringb LDAP_P((
263 ber_get_stringa LDAP_P((
268 ber_get_stringal LDAP_P((
270 struct berval **bv ));
273 ber_get_bitstringa LDAP_P((
279 ber_get_null LDAP_P((
283 ber_get_boolean LDAP_P((
285 ber_int_t *boolval ));
288 ber_first_element LDAP_P((
294 ber_next_element LDAP_P((
297 LDAP_CONST char *last ));
302 LDAP_CONST char *fmt,
308 typedef int (*BEREncodeCallback) LDAP_P((
313 ber_put_enum LDAP_P((
325 ber_put_ostring LDAP_P((
327 LDAP_CONST char *str,
332 ber_put_berval LDAP_P((
334 LDAP_CONST struct berval *bv,
338 ber_put_string LDAP_P((
340 LDAP_CONST char *str,
344 ber_put_bitstring LDAP_P((
346 LDAP_CONST char *str,
351 ber_put_null LDAP_P((
356 ber_put_boolean LDAP_P((
362 ber_start_seq LDAP_P((
367 ber_start_set LDAP_P((
382 LDAP_CONST char *fmt,
399 LDAP_CONST char *buf,
414 LBER_F( BerElement * )
415 ber_alloc LDAP_P(( void )); /* DEPRECATED */
417 LBER_F( BerElement * )
418 der_alloc LDAP_P(( void )); /* DEPRECATED */
420 LBER_F( BerElement * )
424 LBER_F( BerElement * )
429 ber_get_next LDAP_P((
435 ber_init_w_nullc LDAP_P(( /* DEPRECATED */
444 LBER_F( BerElement * )
446 struct berval *bv ));
451 struct berval **bvPtr ));
454 * LBER ber accessor functions
458 ber_get_option LDAP_P((
464 ber_set_option LDAP_P((
467 LDAP_CONST void *invalue));
474 ber_sockbuf_alloc LDAP_P((
478 ber_sockbuf_free LDAP_P((
482 ber_sockbuf_add_io LDAP_P((
489 ber_sockbuf_remove_io LDAP_P((
495 ber_sockbuf_ctrl LDAP_P((
500 LBER_F( Sockbuf_IO ) ber_sockbuf_io_tcp;
501 LBER_F( Sockbuf_IO ) ber_sockbuf_io_readahead;
502 LBER_F( Sockbuf_IO ) ber_sockbuf_io_fd;
503 LBER_F( Sockbuf_IO ) ber_sockbuf_io_debug;
509 ber_memalloc LDAP_P((
513 ber_memrealloc LDAP_P((
518 ber_memcalloc LDAP_P((
527 ber_memvfree LDAP_P((
532 struct berval *bv ));
535 ber_bvecfree LDAP_P((
536 struct berval **bv ));
540 struct berval ***bvec,
541 struct berval *bv ));
543 LBER_F( struct berval * )
545 LDAP_CONST struct berval *bv ));
547 LBER_F( struct berval * )
549 LDAP_CONST char * ));
551 LBER_F( struct berval * )
552 ber_bvstrdup LDAP_P((
553 LDAP_CONST char * ));
557 LDAP_CONST char * ));
562 LBER_F( int * ) ber_errno_addr LDAP_P((void));
563 #define ber_errno (*(ber_errno_addr)())
565 #define LBER_ERROR_NONE 0
566 #define LBER_ERROR_PARAM 0x1
567 #define LBER_ERROR_MEMORY 0x2