3 * Copyright 1998-2002 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>
31 /* Overview of LBER tag construction
38 * 1 0 = CONTEXT-SPECIFIC
45 * | 5 ... 1 | TAG-NUMBER
48 /* BER classes and mask */
49 #define LBER_CLASS_UNIVERSAL ((ber_tag_t) 0x00U)
50 #define LBER_CLASS_APPLICATION ((ber_tag_t) 0x40U)
51 #define LBER_CLASS_CONTEXT ((ber_tag_t) 0x80U)
52 #define LBER_CLASS_PRIVATE ((ber_tag_t) 0xc0U)
53 #define LBER_CLASS_MASK ((ber_tag_t) 0xc0U)
55 /* BER encoding type and mask */
56 #define LBER_PRIMITIVE ((ber_tag_t) 0x00U)
57 #define LBER_CONSTRUCTED ((ber_tag_t) 0x20U)
58 #define LBER_ENCODING_MASK ((ber_tag_t) 0x20U)
60 #define LBER_BIG_TAG_MASK ((ber_tag_t) 0x1fU)
61 #define LBER_MORE_TAG_MASK ((ber_tag_t) 0x80U)
64 * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
65 * as valid BER tags, and so it is safe to use them to report errors. In
66 * fact, any tag for which the following is true is invalid:
68 #define LBER_INVALID(t) (((t) & (ber_tag_t) 0x080UL) \
69 && (((t) & (ber_tag_t) ~ 0x0FF))
71 #define LBER_ERROR ((ber_tag_t) -1)
72 #define LBER_DEFAULT ((ber_tag_t) -1)
74 /* general BER types we know about */
75 #define LBER_BOOLEAN ((ber_tag_t) 0x01UL)
76 #define LBER_INTEGER ((ber_tag_t) 0x02UL)
77 #define LBER_BITSTRING ((ber_tag_t) 0x03UL)
78 #define LBER_OCTETSTRING ((ber_tag_t) 0x04UL)
79 #define LBER_NULL ((ber_tag_t) 0x05UL)
80 #define LBER_ENUMERATED ((ber_tag_t) 0x0aUL)
81 #define LBER_SEQUENCE ((ber_tag_t) 0x30UL) /* constructed */
82 #define LBER_SET ((ber_tag_t) 0x31UL) /* constructed */
84 /* LBER BerElement options */
85 #define LBER_USE_DER 0x01
87 /* get/set options for BerElement */
88 #define LBER_OPT_BER_OPTIONS 0x01
89 #define LBER_OPT_BER_DEBUG 0x02
90 #define LBER_OPT_BER_REMAINING_BYTES 0x03
91 #define LBER_OPT_BER_TOTAL_BYTES 0x04
92 #define LBER_OPT_BER_BYTES_TO_WRITE 0x05
94 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG
95 #define LBER_OPT_REMAINING_BYTES LBER_OPT_BER_REMAINING_BYTES
96 #define LBER_OPT_TOTAL_BYTES LBER_OPT_BER_TOTAL_BYTES
97 #define LBER_OPT_BYTES_TO_WRITE LBER_OPT_BER_BYTES_TO_WRITE
99 #define LBER_OPT_LOG_PRINT_FN 0x8001
100 #define LBER_OPT_MEMORY_FNS 0x8002
101 #define LBER_OPT_ERROR_FN 0x8003
102 #define LBER_OPT_LOG_PRINT_FILE 0x8004
104 /* get/set Memory Debug options */
105 #define LBER_OPT_MEMORY_INUSE 0x8005 /* for memory debugging */
106 #define LBER_OPT_LOG_PROC 0x8006 /* for external logging function */
108 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
110 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf ));
112 typedef void* (*BER_MEMALLOC_FN) LDAP_P(( ber_len_t size ));
113 typedef void* (*BER_MEMCALLOC_FN) LDAP_P(( ber_len_t n, ber_len_t size ));
114 typedef void* (*BER_MEMREALLOC_FN) LDAP_P(( void *p, ber_len_t size ));
115 typedef void (*BER_MEMFREE_FN) LDAP_P(( void *p ));
117 typedef struct lber_memory_fns {
118 BER_MEMALLOC_FN bmf_malloc;
119 BER_MEMCALLOC_FN bmf_calloc;
120 BER_MEMREALLOC_FN bmf_realloc;
121 BER_MEMFREE_FN bmf_free;
122 } BerMemoryFunctions;
124 /* LBER Sockbuf_IO options */
125 #define LBER_SB_OPT_GET_FD 1
126 #define LBER_SB_OPT_SET_FD 2
127 #define LBER_SB_OPT_HAS_IO 3
128 #define LBER_SB_OPT_SET_NONBLOCK 4
129 #define LBER_SB_OPT_GET_SSL 7
130 #define LBER_SB_OPT_DATA_READY 8
131 #define LBER_SB_OPT_SET_READAHEAD 9
132 #define LBER_SB_OPT_DRAIN 10
133 #define LBER_SB_OPT_NEEDS_READ 11
134 #define LBER_SB_OPT_NEEDS_WRITE 12
135 #define LBER_SB_OPT_GET_MAX_INCOMING 13
136 #define LBER_SB_OPT_SET_MAX_INCOMING 14
137 /* Largest option used by the library */
138 #define LBER_SB_OPT_OPT_MAX 14
140 /* LBER IO operations stacking levels */
141 #define LBER_SBIOD_LEVEL_PROVIDER 10
142 #define LBER_SBIOD_LEVEL_TRANSPORT 20
143 #define LBER_SBIOD_LEVEL_APPLICATION 30
145 /* get/set options for Sockbuf */
146 #define LBER_OPT_SOCKBUF_DESC 0x1000
147 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
148 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
151 #define LBER_OPT_ON ((void *) 1)
152 #define LBER_OPT_OFF ((void *) 0)
154 #define LBER_OPT_SUCCESS (0)
155 #define LBER_OPT_ERROR (-1)
157 typedef struct berelement BerElement;
158 typedef struct sockbuf Sockbuf;
159 typedef struct seqorset Seqorset;
161 typedef struct sockbuf_io Sockbuf_IO;
163 /* Structure for LBER IO operarion descriptor */
164 typedef struct sockbuf_io_desc {
167 Sockbuf_IO *sbiod_io;
169 struct sockbuf_io_desc *sbiod_next;
172 /* Structure for LBER IO operation functions */
174 int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
175 int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
176 int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
178 ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
180 ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
183 int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
186 /* Helper macros for LBER IO functions */
187 #define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
188 ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
190 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
191 ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
193 #define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
194 ( (sbiod)->sbiod_next ? \
195 ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
196 (sbiod)->sbiod_next, opt, arg ) ) : 0 )
198 /* structure for returning a sequence of octet strings + length */
199 typedef struct berval {
204 typedef BerValue *BerVarray; /* To distinguish from a single bv */
206 /* this should be moved to lber-int.h */
212 ber_error_print LDAP_P((
213 LDAP_CONST char *data ));
217 LDAP_CONST char *data, ber_len_t len ));
221 BerElement *ber, int inout ));
224 ber_sos_dump LDAP_P((
230 typedef int (*BERDecodeCallback) LDAP_P((
240 ber_skip_tag LDAP_P((
245 ber_peek_tag LDAP_P((
255 ber_get_enum LDAP_P((
260 ber_get_stringb LDAP_P((
266 ber_get_stringbv LDAP_P((
272 ber_get_stringa LDAP_P((
277 ber_get_stringal LDAP_P((
279 struct berval **bv ));
282 ber_get_bitstringa LDAP_P((
288 ber_get_null LDAP_P((
292 ber_get_boolean LDAP_P((
294 ber_int_t *boolval ));
297 ber_first_element LDAP_P((
303 ber_next_element LDAP_P((
306 LDAP_CONST char *last ));
311 LDAP_CONST char *fmt,
317 typedef int (*BEREncodeCallback) LDAP_P((
322 ber_put_enum LDAP_P((
334 ber_put_ostring LDAP_P((
336 LDAP_CONST char *str,
341 ber_put_berval LDAP_P((
347 ber_put_string LDAP_P((
349 LDAP_CONST char *str,
353 ber_put_bitstring LDAP_P((
355 LDAP_CONST char *str,
360 ber_put_null LDAP_P((
365 ber_put_boolean LDAP_P((
371 ber_start_seq LDAP_P((
376 ber_start_set LDAP_P((
391 LDAP_CONST char *fmt,
408 LDAP_CONST char *buf,
418 ber_free_buf LDAP_P(( BerElement *ber ));
426 LBER_F( BerElement * )
427 ber_alloc LDAP_P(( void )); /* DEPRECATED */
429 LBER_F( BerElement * )
430 der_alloc LDAP_P(( void )); /* DEPRECATED */
432 LBER_F( BerElement * )
436 LBER_F( BerElement * )
441 ber_get_next LDAP_P((
447 ber_init_w_nullc LDAP_P(( /* DEPRECATED */
456 LBER_F( BerElement * )
458 struct berval *bv ));
463 struct berval **bvPtr ));
466 * LBER ber accessor functions
470 ber_get_option LDAP_P((
476 ber_set_option LDAP_P((
479 LDAP_CONST void *invalue));
486 ber_sockbuf_alloc LDAP_P((
490 ber_sockbuf_free LDAP_P((
494 ber_sockbuf_add_io LDAP_P((
501 ber_sockbuf_remove_io LDAP_P((
507 ber_sockbuf_ctrl LDAP_P((
512 LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp;
513 LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead;
514 LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd;
515 LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug;
516 #ifdef LDAP_CONNECTIONLESS
517 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
524 ber_memalloc LDAP_P((
528 ber_memrealloc LDAP_P((
533 ber_memcalloc LDAP_P((
542 ber_memvfree LDAP_P((
547 struct berval *bv ));
550 ber_bvecfree LDAP_P((
551 struct berval **bv ));
555 struct berval ***bvec,
556 struct berval *bv ));
558 LBER_F( struct berval * )
560 struct berval *dst, struct berval *src ));
562 LBER_F( struct berval * )
564 struct berval *src ));
566 LBER_F( struct berval * )
568 LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
570 #define ber_bvstr(a) ber_str2bv(a, 0, 0, NULL)
571 #define ber_bvstrdup(a) ber_str2bv(a, 0, 1, NULL)
575 LDAP_CONST char * ));
578 ber_bvarray_free LDAP_P(( BerVarray p ));
581 ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv ));
583 #define ber_bvcmp(v1,v2) \
584 ((v1)->bv_len < (v2)->bv_len \
585 ? -1 : ((v1)->bv_len > (v2)->bv_len \
586 ? 1 : memcmp((v1)->bv_val, (v2)->bv_val, (v1)->bv_len) ))
591 LBER_F( int * ) ber_errno_addr LDAP_P((void));
592 #define ber_errno (*(ber_errno_addr)())
594 #define LBER_ERROR_NONE 0
595 #define LBER_ERROR_PARAM 0x1
596 #define LBER_ERROR_MEMORY 0x2