3 * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted only as authorized by the OpenLDAP
8 * Public License. A copy of this license is available at
9 * http://www.OpenLDAP.org/license.html or in file LICENSE in the
10 * top-level directory of the distribution.
13 * Copyright (c) 1990 Regents of the University of Michigan.
14 * All rights reserved.
16 * Redistribution and use in source and binary forms are permitted
17 * provided that this notice is preserved and that due credit is given
18 * to the University of Michigan at Ann Arbor. The name of the University
19 * may not be used to endorse or promote products derived from this
20 * software without specific prior written permission. This software
21 * is provided ``as is'' without express or implied warranty.
27 #include <lber_types.h>
32 /* Overview of LBER tag construction
39 * 1 0 = CONTEXT-SPECIFIC
46 * | 5 ... 1 | TAG-NUMBER
49 /* BER classes and mask */
50 #define LBER_CLASS_UNIVERSAL ((ber_tag_t) 0x00U)
51 #define LBER_CLASS_APPLICATION ((ber_tag_t) 0x40U)
52 #define LBER_CLASS_CONTEXT ((ber_tag_t) 0x80U)
53 #define LBER_CLASS_PRIVATE ((ber_tag_t) 0xc0U)
54 #define LBER_CLASS_MASK ((ber_tag_t) 0xc0U)
56 /* BER encoding type and mask */
57 #define LBER_PRIMITIVE ((ber_tag_t) 0x00U)
58 #define LBER_CONSTRUCTED ((ber_tag_t) 0x20U)
59 #define LBER_ENCODING_MASK ((ber_tag_t) 0x20U)
61 #define LBER_BIG_TAG_MASK ((ber_tag_t) 0x1fU)
62 #define LBER_MORE_TAG_MASK ((ber_tag_t) 0x80U)
65 * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
66 * as valid BER tags, and so it is safe to use them to report errors. In
67 * fact, any tag for which the following is true is invalid:
69 #define LBER_INVALID(t) (((t) & (ber_tag_t) 0x080UL) \
70 && (((t) & (ber_tag_t) ~ 0x0FF))
72 #define LBER_ERROR ((ber_tag_t) -1)
73 #define LBER_DEFAULT ((ber_tag_t) -1)
75 /* general BER types we know about */
76 #define LBER_BOOLEAN ((ber_tag_t) 0x01UL)
77 #define LBER_INTEGER ((ber_tag_t) 0x02UL)
78 #define LBER_BITSTRING ((ber_tag_t) 0x03UL)
79 #define LBER_OCTETSTRING ((ber_tag_t) 0x04UL)
80 #define LBER_NULL ((ber_tag_t) 0x05UL)
81 #define LBER_ENUMERATED ((ber_tag_t) 0x0aUL)
82 #define LBER_SEQUENCE ((ber_tag_t) 0x30UL) /* constructed */
83 #define LBER_SET ((ber_tag_t) 0x31UL) /* constructed */
85 /* LBER BerElement options */
86 #define LBER_USE_DER 0x01
88 /* get/set options for BerElement */
89 #define LBER_OPT_BER_OPTIONS 0x01
90 #define LBER_OPT_BER_DEBUG 0x02
91 #define LBER_OPT_BER_REMAINING_BYTES 0x03
92 #define LBER_OPT_BER_TOTAL_BYTES 0x04
93 #define LBER_OPT_BER_BYTES_TO_WRITE 0x05
94 #define LBER_OPT_BER_MEMCTX 0x06
96 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG
97 #define LBER_OPT_REMAINING_BYTES LBER_OPT_BER_REMAINING_BYTES
98 #define LBER_OPT_TOTAL_BYTES LBER_OPT_BER_TOTAL_BYTES
99 #define LBER_OPT_BYTES_TO_WRITE LBER_OPT_BER_BYTES_TO_WRITE
101 #define LBER_OPT_LOG_PRINT_FN 0x8001
102 #define LBER_OPT_MEMORY_FNS 0x8002
103 #define LBER_OPT_ERROR_FN 0x8003
104 #define LBER_OPT_LOG_PRINT_FILE 0x8004
106 /* get/set Memory Debug options */
107 #define LBER_OPT_MEMORY_INUSE 0x8005 /* for memory debugging */
108 #define LBER_OPT_LOG_PROC 0x8006 /* for external logging function */
110 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
112 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf ));
114 typedef void* (BER_MEMALLOC_FN) LDAP_P(( ber_len_t size, void *ctx ));
115 typedef void* (BER_MEMCALLOC_FN) LDAP_P(( ber_len_t n, ber_len_t size, void *ctx ));
116 typedef void* (BER_MEMREALLOC_FN) LDAP_P(( void *p, ber_len_t size, void *ctx ));
117 typedef void (BER_MEMFREE_FN) LDAP_P(( void *p, void *ctx ));
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_IO options */
127 #define LBER_SB_OPT_GET_FD 1
128 #define LBER_SB_OPT_SET_FD 2
129 #define LBER_SB_OPT_HAS_IO 3
130 #define LBER_SB_OPT_SET_NONBLOCK 4
131 #define LBER_SB_OPT_GET_SSL 7
132 #define LBER_SB_OPT_DATA_READY 8
133 #define LBER_SB_OPT_SET_READAHEAD 9
134 #define LBER_SB_OPT_DRAIN 10
135 #define LBER_SB_OPT_NEEDS_READ 11
136 #define LBER_SB_OPT_NEEDS_WRITE 12
137 #define LBER_SB_OPT_GET_MAX_INCOMING 13
138 #define LBER_SB_OPT_SET_MAX_INCOMING 14
139 /* Largest option used by the library */
140 #define LBER_SB_OPT_OPT_MAX 14
142 /* LBER IO operations stacking levels */
143 #define LBER_SBIOD_LEVEL_PROVIDER 10
144 #define LBER_SBIOD_LEVEL_TRANSPORT 20
145 #define LBER_SBIOD_LEVEL_APPLICATION 30
147 /* get/set options for Sockbuf */
148 #define LBER_OPT_SOCKBUF_DESC 0x1000
149 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
150 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
153 extern char ber_pvt_opt_on;
154 #define LBER_OPT_ON ((void *) &ber_pvt_opt_on)
155 #define LBER_OPT_OFF ((void *) 0)
157 #define LBER_OPT_SUCCESS (0)
158 #define LBER_OPT_ERROR (-1)
160 #define LBER_ELEMENT_SIZEOF (256) /* must be >= sizeof(BerElement) */
161 typedef union ber_buffer_u {
162 char charbuf[LBER_ELEMENT_SIZEOF];
164 /* force alignment */
172 typedef struct berelement BerElement;
173 typedef struct sockbuf Sockbuf;
174 typedef struct seqorset Seqorset;
176 typedef struct sockbuf_io Sockbuf_IO;
178 /* Structure for LBER IO operarion descriptor */
179 typedef struct sockbuf_io_desc {
182 Sockbuf_IO *sbiod_io;
184 struct sockbuf_io_desc *sbiod_next;
187 /* Structure for LBER IO operation functions */
189 int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
190 int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
191 int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
193 ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
195 ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
198 int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
201 /* Helper macros for LBER IO functions */
202 #define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
203 ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
205 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
206 ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
208 #define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
209 ( (sbiod)->sbiod_next ? \
210 ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
211 (sbiod)->sbiod_next, opt, arg ) ) : 0 )
213 /* structure for returning a sequence of octet strings + length */
214 typedef struct berval {
219 typedef BerValue *BerVarray; /* To distinguish from a single bv */
221 /* this should be moved to lber-int.h */
227 ber_error_print LDAP_P((
228 LDAP_CONST char *data ));
232 LDAP_CONST char *data, ber_len_t len ));
236 BerElement *ber, int inout ));
239 ber_sos_dump LDAP_P((
245 typedef int (*BERDecodeCallback) LDAP_P((
255 ber_skip_tag LDAP_P((
260 ber_peek_tag LDAP_P((
270 ber_get_enum LDAP_P((
275 ber_get_stringb LDAP_P((
281 ber_get_stringbv LDAP_P((
287 ber_get_stringa LDAP_P((
292 ber_get_stringal LDAP_P((
294 struct berval **bv ));
297 ber_get_bitstringa LDAP_P((
303 ber_get_null LDAP_P((
307 ber_get_boolean LDAP_P((
309 ber_int_t *boolval ));
312 ber_first_element LDAP_P((
318 ber_next_element LDAP_P((
321 LDAP_CONST char *last ));
326 LDAP_CONST char *fmt,
332 typedef int (*BEREncodeCallback) LDAP_P((
337 ber_put_enum LDAP_P((
349 ber_put_ostring LDAP_P((
351 LDAP_CONST char *str,
356 ber_put_berval LDAP_P((
362 ber_put_string LDAP_P((
364 LDAP_CONST char *str,
368 ber_put_bitstring LDAP_P((
370 LDAP_CONST char *str,
375 ber_put_null LDAP_P((
380 ber_put_boolean LDAP_P((
386 ber_start_seq LDAP_P((
391 ber_start_set LDAP_P((
406 LDAP_CONST char *fmt,
423 LDAP_CONST char *buf,
433 ber_free_buf LDAP_P(( BerElement *ber ));
441 LBER_F( BerElement * )
442 ber_alloc LDAP_P(( void )); /* DEPRECATED */
444 LBER_F( BerElement * )
445 der_alloc LDAP_P(( void )); /* DEPRECATED */
447 LBER_F( BerElement * )
451 LBER_F( BerElement * )
456 ber_get_next LDAP_P((
468 ber_init_w_nullc LDAP_P(( /* DEPRECATED */
477 LBER_F( BerElement * )
479 struct berval *bv ));
484 struct berval **bvPtr ));
487 ber_flatten2 LDAP_P((
493 ber_remaining LDAP_P((
497 * LBER ber accessor functions
501 ber_get_option LDAP_P((
507 ber_set_option LDAP_P((
510 LDAP_CONST void *invalue));
517 ber_sockbuf_alloc LDAP_P((
521 ber_sockbuf_free LDAP_P((
525 ber_sockbuf_add_io LDAP_P((
532 ber_sockbuf_remove_io LDAP_P((
538 ber_sockbuf_ctrl LDAP_P((
543 LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp;
544 LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead;
545 LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd;
546 LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug;
547 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
553 ber_memalloc LDAP_P((
557 ber_memrealloc LDAP_P((
562 ber_memcalloc LDAP_P((
571 ber_memvfree LDAP_P((
576 struct berval *bv ));
579 ber_bvecfree LDAP_P((
580 struct berval **bv ));
584 struct berval ***bvec,
585 struct berval *bv ));
587 LBER_F( struct berval * )
589 struct berval *dst, struct berval *src ));
591 LBER_F( struct berval * )
593 struct berval *src ));
595 LBER_F( struct berval * )
597 LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
599 LBER_F( struct berval * )
601 LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
603 #define ber_bvstr(a) ber_str2bv(a, 0, 0, NULL)
604 #define ber_bvstrdup(a) ber_str2bv(a, 0, 1, NULL)
608 LDAP_CONST char * ));
611 ber_bvarray_free LDAP_P(( BerVarray p ));
614 ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv ));
616 #define ber_bvcmp(v1,v2) \
617 ((v1)->bv_len < (v2)->bv_len \
618 ? -1 : ((v1)->bv_len > (v2)->bv_len \
619 ? 1 : memcmp((v1)->bv_val, (v2)->bv_val, (v1)->bv_len) ))
624 LBER_F( int * ) ber_errno_addr LDAP_P((void));
625 #define ber_errno (*(ber_errno_addr)())
627 #define LBER_ERROR_NONE 0
628 #define LBER_ERROR_PARAM 0x1
629 #define LBER_ERROR_MEMORY 0x2