2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2009 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
16 * All rights reserved.
18 * Redistribution and use in source and binary forms are permitted
19 * provided that this notice is preserved and that due credit is given
20 * to the University of Michigan at Ann Arbor. The name of the University
21 * may not be used to endorse or promote products derived from this
22 * software without specific prior written permission. This software
23 * is provided ``as is'' without express or implied warranty.
29 #include <lber_types.h>
34 /* Overview of LBER tag construction
41 * 1 0 = CONTEXT-SPECIFIC
48 * | 5 ... 1 | TAG-NUMBER
51 /* BER classes and mask */
52 #define LBER_CLASS_UNIVERSAL ((ber_tag_t) 0x00U)
53 #define LBER_CLASS_APPLICATION ((ber_tag_t) 0x40U)
54 #define LBER_CLASS_CONTEXT ((ber_tag_t) 0x80U)
55 #define LBER_CLASS_PRIVATE ((ber_tag_t) 0xc0U)
56 #define LBER_CLASS_MASK ((ber_tag_t) 0xc0U)
58 /* BER encoding type and mask */
59 #define LBER_PRIMITIVE ((ber_tag_t) 0x00U)
60 #define LBER_CONSTRUCTED ((ber_tag_t) 0x20U)
61 #define LBER_ENCODING_MASK ((ber_tag_t) 0x20U)
63 #define LBER_BIG_TAG_MASK ((ber_tag_t) 0x1fU)
64 #define LBER_MORE_TAG_MASK ((ber_tag_t) 0x80U)
67 * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
68 * as valid BER tags, and so it is safe to use them to report errors. In
69 * fact, any tag for which the following is true is invalid:
71 #define LBER_INVALID(t) (((t) & (ber_tag_t) 0x080UL) \
72 && (((t) & (ber_tag_t) ~ 0x0FF))
74 #define LBER_ERROR ((ber_tag_t) -1)
75 #define LBER_DEFAULT ((ber_tag_t) -1)
77 /* general BER types we know about */
78 #define LBER_BOOLEAN ((ber_tag_t) 0x01UL)
79 #define LBER_INTEGER ((ber_tag_t) 0x02UL)
80 #define LBER_BITSTRING ((ber_tag_t) 0x03UL)
81 #define LBER_OCTETSTRING ((ber_tag_t) 0x04UL)
82 #define LBER_NULL ((ber_tag_t) 0x05UL)
83 #define LBER_ENUMERATED ((ber_tag_t) 0x0aUL)
84 #define LBER_SEQUENCE ((ber_tag_t) 0x30UL) /* constructed */
85 #define LBER_SET ((ber_tag_t) 0x31UL) /* constructed */
87 /* LBER BerElement options */
88 #define LBER_USE_DER 0x01
90 /* get/set options for BerElement */
91 #define LBER_OPT_BER_OPTIONS 0x01
92 #define LBER_OPT_BER_DEBUG 0x02
93 #define LBER_OPT_BER_REMAINING_BYTES 0x03
94 #define LBER_OPT_BER_TOTAL_BYTES 0x04
95 #define LBER_OPT_BER_BYTES_TO_WRITE 0x05
96 #define LBER_OPT_BER_MEMCTX 0x06
98 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG
99 #define LBER_OPT_REMAINING_BYTES LBER_OPT_BER_REMAINING_BYTES
100 #define LBER_OPT_TOTAL_BYTES LBER_OPT_BER_TOTAL_BYTES
101 #define LBER_OPT_BYTES_TO_WRITE LBER_OPT_BER_BYTES_TO_WRITE
103 #define LBER_OPT_LOG_PRINT_FN 0x8001
104 #define LBER_OPT_MEMORY_FNS 0x8002
105 #define LBER_OPT_ERROR_FN 0x8003
106 #define LBER_OPT_LOG_PRINT_FILE 0x8004
108 /* get/set Memory Debug options */
109 #define LBER_OPT_MEMORY_INUSE 0x8005 /* for memory debugging */
110 #define LBER_OPT_LOG_PROC 0x8006 /* for external logging function */
112 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
114 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf ));
116 typedef void* (BER_MEMALLOC_FN) LDAP_P(( ber_len_t size, void *ctx ));
117 typedef void* (BER_MEMCALLOC_FN) LDAP_P(( ber_len_t n, ber_len_t size, void *ctx ));
118 typedef void* (BER_MEMREALLOC_FN) LDAP_P(( void *p, ber_len_t size, void *ctx ));
119 typedef void (BER_MEMFREE_FN) LDAP_P(( void *p, void *ctx ));
121 typedef struct lber_memory_fns {
122 BER_MEMALLOC_FN *bmf_malloc;
123 BER_MEMCALLOC_FN *bmf_calloc;
124 BER_MEMREALLOC_FN *bmf_realloc;
125 BER_MEMFREE_FN *bmf_free;
126 } BerMemoryFunctions;
128 /* LBER Sockbuf_IO options */
129 #define LBER_SB_OPT_GET_FD 1
130 #define LBER_SB_OPT_SET_FD 2
131 #define LBER_SB_OPT_HAS_IO 3
132 #define LBER_SB_OPT_SET_NONBLOCK 4
133 #define LBER_SB_OPT_GET_SSL 7
134 #define LBER_SB_OPT_DATA_READY 8
135 #define LBER_SB_OPT_SET_READAHEAD 9
136 #define LBER_SB_OPT_DRAIN 10
137 #define LBER_SB_OPT_NEEDS_READ 11
138 #define LBER_SB_OPT_NEEDS_WRITE 12
139 #define LBER_SB_OPT_GET_MAX_INCOMING 13
140 #define LBER_SB_OPT_SET_MAX_INCOMING 14
142 /* Only meaningful ifdef LDAP_PF_LOCAL_SENDMSG */
143 #define LBER_SB_OPT_UNGET_BUF 15
145 /* Largest option used by the library */
146 #define LBER_SB_OPT_OPT_MAX 15
148 /* LBER IO operations stacking levels */
149 #define LBER_SBIOD_LEVEL_PROVIDER 10
150 #define LBER_SBIOD_LEVEL_TRANSPORT 20
151 #define LBER_SBIOD_LEVEL_APPLICATION 30
153 /* get/set options for Sockbuf */
154 #define LBER_OPT_SOCKBUF_DESC 0x1000
155 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
156 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
159 LBER_V( char ) ber_pvt_opt_on;
160 #define LBER_OPT_ON ((void *) &ber_pvt_opt_on)
161 #define LBER_OPT_OFF ((void *) 0)
163 #define LBER_OPT_SUCCESS (0)
164 #define LBER_OPT_ERROR (-1)
166 typedef struct berelement BerElement;
167 typedef struct sockbuf Sockbuf;
169 typedef struct sockbuf_io Sockbuf_IO;
171 /* Structure for LBER IO operarion descriptor */
172 typedef struct sockbuf_io_desc {
175 Sockbuf_IO *sbiod_io;
177 struct sockbuf_io_desc *sbiod_next;
180 /* Structure for LBER IO operation functions */
182 int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
183 int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
184 int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
186 ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
188 ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
191 int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
194 /* Helper macros for LBER IO functions */
195 #define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
196 ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
198 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
199 ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
201 #define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
202 ( (sbiod)->sbiod_next ? \
203 ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
204 (sbiod)->sbiod_next, opt, arg ) ) : 0 )
206 /* structure for returning a sequence of octet strings + length */
207 typedef struct berval {
212 typedef BerValue *BerVarray; /* To distinguish from a single bv */
214 /* this should be moved to lber-int.h */
220 ber_error_print LDAP_P((
221 LDAP_CONST char *data ));
225 LDAP_CONST char *data, ber_len_t len ));
229 BerElement *ber, int inout ));
234 typedef int (*BERDecodeCallback) LDAP_P((
244 ber_skip_tag LDAP_P((
249 ber_peek_tag LDAP_P((
254 ber_skip_element LDAP_P((
256 struct berval *bv ));
259 ber_peek_element LDAP_P((
260 LDAP_CONST BerElement *ber,
261 struct berval *bv ));
269 ber_get_enum LDAP_P((
274 ber_get_stringb LDAP_P((
279 #define LBER_BV_ALLOC 0x01 /* allocate/copy result, otherwise in-place */
280 #define LBER_BV_NOTERM 0x02 /* omit NUL-terminator if parsing in-place */
281 #define LBER_BV_STRING 0x04 /* fail if berval contains embedded \0 */
284 ber_get_stringbv LDAP_P((
290 ber_get_stringa LDAP_P((
295 ber_get_stringal LDAP_P((
297 struct berval **bv ));
300 ber_get_bitstringa LDAP_P((
306 ber_get_null LDAP_P((
310 ber_get_boolean LDAP_P((
312 ber_int_t *boolval ));
315 ber_first_element LDAP_P((
321 ber_next_element LDAP_P((
324 LDAP_CONST char *last ));
329 LDAP_CONST char *fmt,
333 ber_decode_oid LDAP_P((
335 struct berval *out ));
341 ber_encode_oid LDAP_P((
343 struct berval *out ));
345 typedef int (*BEREncodeCallback) LDAP_P((
350 ber_put_enum LDAP_P((
362 ber_put_ostring LDAP_P((
364 LDAP_CONST char *str,
369 ber_put_berval LDAP_P((
375 ber_put_string LDAP_P((
377 LDAP_CONST char *str,
381 ber_put_bitstring LDAP_P((
383 LDAP_CONST char *str,
388 ber_put_null LDAP_P((
393 ber_put_boolean LDAP_P((
399 ber_start_seq LDAP_P((
404 ber_start_set LDAP_P((
419 LDAP_CONST char *fmt,
428 ber_skip_data LDAP_P((
441 LDAP_CONST char *buf,
443 int zero )); /* nonzero is unsupported from OpenLDAP 2.4.18 */
451 ber_free_buf LDAP_P(( BerElement *ber ));
458 #define LBER_FLUSH_FREE_NEVER (0x0) /* traditional behavior */
459 #define LBER_FLUSH_FREE_ON_SUCCESS (0x1) /* traditional behavior */
460 #define LBER_FLUSH_FREE_ON_ERROR (0x2)
461 #define LBER_FLUSH_FREE_ALWAYS (LBER_FLUSH_FREE_ON_SUCCESS|LBER_FLUSH_FREE_ON_ERROR)
467 int freeit )); /* DEPRECATED */
469 LBER_F( BerElement * )
470 ber_alloc LDAP_P(( void )); /* DEPRECATED */
472 LBER_F( BerElement * )
473 der_alloc LDAP_P(( void )); /* DEPRECATED */
475 LBER_F( BerElement * )
479 LBER_F( BerElement * )
484 ber_get_next LDAP_P((
496 ber_init_w_nullc LDAP_P(( /* DEPRECATED */
505 LBER_F( BerElement * )
507 struct berval *bv ));
512 struct berval **bvPtr ));
515 ber_flatten2 LDAP_P((
521 ber_remaining LDAP_P((
525 * LBER ber accessor functions
529 ber_get_option LDAP_P((
535 ber_set_option LDAP_P((
538 LDAP_CONST void *invalue));
545 ber_sockbuf_alloc LDAP_P((
549 ber_sockbuf_free LDAP_P((
553 ber_sockbuf_add_io LDAP_P((
560 ber_sockbuf_remove_io LDAP_P((
566 ber_sockbuf_ctrl LDAP_P((
571 LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp;
572 LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead;
573 LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd;
574 LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug;
575 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
581 ber_memalloc LDAP_P((
585 ber_memrealloc LDAP_P((
590 ber_memcalloc LDAP_P((
599 ber_memvfree LDAP_P((
604 struct berval *bv ));
607 ber_bvecfree LDAP_P((
608 struct berval **bv ));
612 struct berval ***bvec,
613 struct berval *bv ));
615 LBER_F( struct berval * )
617 struct berval *dst, struct berval *src ));
619 LBER_F( struct berval * )
621 struct berval *src ));
623 LBER_F( struct berval * )
625 LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv));
627 LBER_F( struct berval * )
629 LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv));
631 #define ber_bvstr(a) ((ber_str2bv)((a), 0, 0, NULL))
632 #define ber_bvstrdup(a) ((ber_str2bv)((a), 0, 1, NULL))
636 LDAP_CONST char * ));
640 LDAP_CONST char *s, ber_len_t len ));
644 LDAP_CONST char *s, ber_len_t l ));
646 LBER_F( struct berval * )
647 ber_bvreplace LDAP_P((
648 struct berval *dst, LDAP_CONST struct berval *src ));
651 ber_bvarray_free LDAP_P(( BerVarray p ));
654 ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv ));
656 #define ber_bvcmp(v1,v2) \
657 ((v1)->bv_len < (v2)->bv_len \
658 ? -1 : ((v1)->bv_len > (v2)->bv_len \
659 ? 1 : memcmp((v1)->bv_val, (v2)->bv_val, (v1)->bv_len) ))
664 LBER_F( int * ) ber_errno_addr LDAP_P((void));
665 #define ber_errno (*(ber_errno_addr)())
667 #define LBER_ERROR_NONE 0
668 #define LBER_ERROR_PARAM 0x1
669 #define LBER_ERROR_MEMORY 0x2