]> git.sur5r.net Git - openldap/blob - include/lber.h
ITS#6353
[openldap] / include / lber.h
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  *
4  * Copyright 1998-2009 The OpenLDAP Foundation.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted only as authorized by the OpenLDAP
9  * Public License.
10  *
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>.
14  */
15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
16  * All rights reserved.
17  *
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.
24  */
25
26 #ifndef _LBER_H
27 #define _LBER_H
28
29 #include <lber_types.h>
30 #include <string.h>
31
32 LDAP_BEGIN_DECL
33
34 /* Overview of LBER tag construction
35  *
36  *      Bits
37  *      ______
38  *      8 7 | CLASS
39  *      0 0 = UNIVERSAL
40  *      0 1 = APPLICATION
41  *      1 0 = CONTEXT-SPECIFIC
42  *      1 1 = PRIVATE
43  *              _____
44  *              | 6 | DATA-TYPE
45  *                0 = PRIMITIVE
46  *                1 = CONSTRUCTED
47  *                      ___________
48  *                      | 5 ... 1 | TAG-NUMBER
49  */
50
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)
57
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)
62
63 #define LBER_BIG_TAG_MASK               ((ber_tag_t) 0x1fU)
64 #define LBER_MORE_TAG_MASK              ((ber_tag_t) 0x80U)
65
66 /*
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:
70  */
71 #define LBER_INVALID(t)     (((t) & (ber_tag_t) 0x080UL) \
72         && (((t) & (ber_tag_t) ~ 0x0FF))
73
74 #define LBER_ERROR                      ((ber_tag_t) -1)
75 #define LBER_DEFAULT            ((ber_tag_t) -1)
76
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 */
86
87 /* LBER BerElement options */
88 #define LBER_USE_DER            0x01
89
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
97
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
102
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
107
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 */
111
112 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
113
114 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf ));
115
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 ));
120
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;
127
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
141
142 /* Only meaningful ifdef LDAP_PF_LOCAL_SENDMSG */
143 #define LBER_SB_OPT_UNGET_BUF   15
144
145 /* Largest option used by the library */
146 #define LBER_SB_OPT_OPT_MAX             15
147
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
152
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
157
158 /* on/off values */
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)
162
163 #define LBER_OPT_SUCCESS        (0)
164 #define LBER_OPT_ERROR          (-1)
165
166 typedef struct berelement BerElement;
167 typedef struct sockbuf Sockbuf;
168
169 typedef struct sockbuf_io Sockbuf_IO;
170
171 /* Structure for LBER IO operarion descriptor */
172 typedef struct sockbuf_io_desc {
173         int                     sbiod_level;
174         Sockbuf                 *sbiod_sb;
175         Sockbuf_IO              *sbiod_io;
176         void                    *sbiod_pvt;
177         struct sockbuf_io_desc  *sbiod_next;
178 } Sockbuf_IO_Desc;
179
180 /* Structure for LBER IO operation functions */
181 struct sockbuf_io {
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);
185
186         ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
187                 ber_len_t len );
188         ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
189                 ber_len_t len );
190
191         int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
192 };
193
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, \
197                 buf, len ) )
198 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
199         ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
200                 buf, len ) )
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 )
205
206 /* structure for returning a sequence of octet strings + length */
207 typedef struct berval {
208         ber_len_t       bv_len;
209         char            *bv_val;
210 } BerValue;
211
212 typedef BerValue *BerVarray;    /* To distinguish from a single bv */
213
214 /* this should be moved to lber-int.h */
215
216 /*
217  * in bprint.c:
218  */
219 LBER_F( void )
220 ber_error_print LDAP_P((
221         LDAP_CONST char *data ));
222
223 LBER_F( void )
224 ber_bprint LDAP_P((
225         LDAP_CONST char *data, ber_len_t len ));
226
227 LBER_F( void )
228 ber_dump LDAP_P((
229         BerElement *ber, int inout ));
230
231 /*
232  * in decode.c:
233  */
234 typedef int (*BERDecodeCallback) LDAP_P((
235         BerElement *ber,
236         void *data,
237         int mode ));
238
239 LBER_F( ber_tag_t )
240 ber_get_tag LDAP_P((
241         BerElement *ber ));
242
243 LBER_F( ber_tag_t )
244 ber_skip_tag LDAP_P((
245         BerElement *ber,
246         ber_len_t *len ));
247
248 LBER_F( ber_tag_t )
249 ber_peek_tag LDAP_P((
250         BerElement *ber,
251         ber_len_t *len ));
252
253 LBER_F( ber_tag_t )
254 ber_skip_element LDAP_P((
255         BerElement *ber,
256         struct berval *bv ));
257
258 LBER_F( ber_tag_t )
259 ber_peek_element LDAP_P((
260         LDAP_CONST BerElement *ber,
261         struct berval *bv ));
262
263 LBER_F( ber_tag_t )
264 ber_get_int LDAP_P((
265         BerElement *ber,
266         ber_int_t *num ));
267
268 LBER_F( ber_tag_t )
269 ber_get_enum LDAP_P((
270         BerElement *ber,
271         ber_int_t *num ));
272
273 LBER_F( ber_tag_t )
274 ber_get_stringb LDAP_P((
275         BerElement *ber,
276         char *buf,
277         ber_len_t *len ));
278
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 */
282
283 LBER_F( ber_tag_t )
284 ber_get_stringbv LDAP_P((
285         BerElement *ber,
286         struct berval *bv,
287         int options ));
288
289 LBER_F( ber_tag_t )
290 ber_get_stringa LDAP_P((
291         BerElement *ber,
292         char **buf ));
293
294 LBER_F( ber_tag_t )
295 ber_get_stringal LDAP_P((
296         BerElement *ber,
297         struct berval **bv ));
298
299 LBER_F( ber_tag_t )
300 ber_get_bitstringa LDAP_P((
301         BerElement *ber,
302         char **buf,
303         ber_len_t *len ));
304
305 LBER_F( ber_tag_t )
306 ber_get_null LDAP_P((
307         BerElement *ber ));
308
309 LBER_F( ber_tag_t )
310 ber_get_boolean LDAP_P((
311         BerElement *ber,
312         ber_int_t *boolval ));
313
314 LBER_F( ber_tag_t )
315 ber_first_element LDAP_P((
316         BerElement *ber,
317         ber_len_t *len,
318         char **last ));
319
320 LBER_F( ber_tag_t )
321 ber_next_element LDAP_P((
322         BerElement *ber,
323         ber_len_t *len,
324         LDAP_CONST char *last ));
325
326 LBER_F( ber_tag_t )
327 ber_scanf LDAP_P((
328         BerElement *ber,
329         LDAP_CONST char *fmt,
330         ... ));
331
332 LBER_F( int )
333 ber_decode_oid LDAP_P((
334         struct berval *in,
335         struct berval *out ));
336
337 /*
338  * in encode.c
339  */
340 LBER_F( int )
341 ber_encode_oid LDAP_P((
342         struct berval *in,
343         struct berval *out ));
344
345 typedef int (*BEREncodeCallback) LDAP_P((
346         BerElement *ber,
347         void *data ));
348
349 LBER_F( int )
350 ber_put_enum LDAP_P((
351         BerElement *ber,
352         ber_int_t num,
353         ber_tag_t tag ));
354
355 LBER_F( int )
356 ber_put_int LDAP_P((
357         BerElement *ber,
358         ber_int_t num,
359         ber_tag_t tag ));
360
361 LBER_F( int )
362 ber_put_ostring LDAP_P((
363         BerElement *ber,
364         LDAP_CONST char *str,
365         ber_len_t len,
366         ber_tag_t tag ));
367
368 LBER_F( int )
369 ber_put_berval LDAP_P((
370         BerElement *ber,
371         struct berval *bv,
372         ber_tag_t tag ));
373
374 LBER_F( int )
375 ber_put_string LDAP_P((
376         BerElement *ber,
377         LDAP_CONST char *str,
378         ber_tag_t tag ));
379
380 LBER_F( int )
381 ber_put_bitstring LDAP_P((
382         BerElement *ber,
383         LDAP_CONST char *str,
384         ber_len_t bitlen,
385         ber_tag_t tag ));
386
387 LBER_F( int )
388 ber_put_null LDAP_P((
389         BerElement *ber,
390         ber_tag_t tag ));
391
392 LBER_F( int )
393 ber_put_boolean LDAP_P((
394         BerElement *ber,
395         ber_int_t boolval,
396         ber_tag_t tag ));
397
398 LBER_F( int )
399 ber_start_seq LDAP_P((
400         BerElement *ber,
401         ber_tag_t tag ));
402
403 LBER_F( int )
404 ber_start_set LDAP_P((
405         BerElement *ber,
406         ber_tag_t tag ));
407
408 LBER_F( int )
409 ber_put_seq LDAP_P((
410         BerElement *ber ));
411
412 LBER_F( int )
413 ber_put_set LDAP_P((
414         BerElement *ber ));
415
416 LBER_F( int )
417 ber_printf LDAP_P((
418         BerElement *ber,
419         LDAP_CONST char *fmt,
420         ... ));
421
422
423 /*
424  * in io.c:
425  */
426
427 LBER_F( ber_slen_t )
428 ber_skip_data LDAP_P((
429         BerElement *ber,
430         ber_len_t len ));
431
432 LBER_F( ber_slen_t )
433 ber_read LDAP_P((
434         BerElement *ber,
435         char *buf,
436         ber_len_t len ));
437
438 LBER_F( ber_slen_t )
439 ber_write LDAP_P((
440         BerElement *ber,
441         LDAP_CONST char *buf,
442         ber_len_t len,
443         int zero ));    /* nonzero is unsupported from OpenLDAP 2.4.18 */
444
445 LBER_F( void )
446 ber_free LDAP_P((
447         BerElement *ber,
448         int freebuf ));
449
450 LBER_F( void )
451 ber_free_buf LDAP_P(( BerElement *ber ));
452
453 LBER_F( int )
454 ber_flush2 LDAP_P((
455         Sockbuf *sb,
456         BerElement *ber,
457         int freeit ));
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)
462
463 LBER_F( int )
464 ber_flush LDAP_P((
465         Sockbuf *sb,
466         BerElement *ber,
467         int freeit )); /* DEPRECATED */
468
469 LBER_F( BerElement * )
470 ber_alloc LDAP_P(( void )); /* DEPRECATED */
471
472 LBER_F( BerElement * )
473 der_alloc LDAP_P(( void )); /* DEPRECATED */
474
475 LBER_F( BerElement * )
476 ber_alloc_t LDAP_P((
477         int beroptions ));
478
479 LBER_F( BerElement * )
480 ber_dup LDAP_P((
481         BerElement *ber ));
482
483 LBER_F( ber_tag_t )
484 ber_get_next LDAP_P((
485         Sockbuf *sb,
486         ber_len_t *len,
487         BerElement *ber ));
488
489 LBER_F( void )
490 ber_init2 LDAP_P((
491         BerElement *ber,
492         struct berval *bv,
493         int options ));
494
495 LBER_F( void )
496 ber_init_w_nullc LDAP_P((       /* DEPRECATED */
497         BerElement *ber,
498         int options ));
499
500 LBER_F( void )
501 ber_reset LDAP_P((
502         BerElement *ber,
503         int was_writing ));
504
505 LBER_F( BerElement * )
506 ber_init LDAP_P((
507         struct berval *bv ));
508
509 LBER_F( int )
510 ber_flatten LDAP_P((
511         BerElement *ber,
512         struct berval **bvPtr ));
513
514 LBER_F( int )
515 ber_flatten2 LDAP_P((
516         BerElement *ber,
517         struct berval *bv,
518         int alloc ));
519
520 LBER_F( int )
521 ber_remaining LDAP_P((
522         BerElement *ber ));
523
524 /*
525  * LBER ber accessor functions
526  */
527
528 LBER_F( int )
529 ber_get_option LDAP_P((
530         void *item,
531         int option,
532         void *outvalue));
533
534 LBER_F( int )
535 ber_set_option LDAP_P((
536         void *item,
537         int option,
538         LDAP_CONST void *invalue));
539
540 /*
541  * LBER sockbuf.c
542  */
543
544 LBER_F( Sockbuf *  )
545 ber_sockbuf_alloc LDAP_P((
546         void ));
547
548 LBER_F( void )
549 ber_sockbuf_free LDAP_P((
550         Sockbuf *sb ));
551
552 LBER_F( int )
553 ber_sockbuf_add_io LDAP_P((
554         Sockbuf *sb,
555         Sockbuf_IO *sbio,
556         int layer,
557         void *arg ));
558
559 LBER_F( int )
560 ber_sockbuf_remove_io LDAP_P((
561         Sockbuf *sb,
562         Sockbuf_IO *sbio,
563         int layer ));
564
565 LBER_F( int )
566 ber_sockbuf_ctrl LDAP_P((
567         Sockbuf *sb,
568         int opt,
569         void *arg ));
570
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;
576
577 /*
578  * LBER memory.c
579  */
580 LBER_F( void * )
581 ber_memalloc LDAP_P((
582         ber_len_t s ));
583
584 LBER_F( void * )
585 ber_memrealloc LDAP_P((
586         void* p,
587         ber_len_t s ));
588
589 LBER_F( void * )
590 ber_memcalloc LDAP_P((
591         ber_len_t n,
592         ber_len_t s ));
593
594 LBER_F( void )
595 ber_memfree LDAP_P((
596         void* p ));
597
598 LBER_F( void )
599 ber_memvfree LDAP_P((
600         void** vector ));
601
602 LBER_F( void )
603 ber_bvfree LDAP_P((
604         struct berval *bv ));
605
606 LBER_F( void )
607 ber_bvecfree LDAP_P((
608         struct berval **bv ));
609
610 LBER_F( int )
611 ber_bvecadd LDAP_P((
612         struct berval ***bvec,
613         struct berval *bv ));
614
615 LBER_F( struct berval * )
616 ber_dupbv LDAP_P((
617         struct berval *dst, struct berval *src ));
618
619 LBER_F( struct berval * )
620 ber_bvdup LDAP_P((
621         struct berval *src ));
622
623 LBER_F( struct berval * )
624 ber_mem2bv LDAP_P((
625         LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv));
626
627 LBER_F( struct berval * )
628 ber_str2bv LDAP_P((
629         LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv));
630
631 #define ber_bvstr(a)    ((ber_str2bv)((a), 0, 0, NULL))
632 #define ber_bvstrdup(a) ((ber_str2bv)((a), 0, 1, NULL))
633
634 LBER_F( char * )
635 ber_strdup LDAP_P((
636         LDAP_CONST char * ));
637
638 LBER_F( ber_len_t )
639 ber_strnlen LDAP_P((
640         LDAP_CONST char *s, ber_len_t len ));
641
642 LBER_F( char * )
643 ber_strndup LDAP_P((
644         LDAP_CONST char *s, ber_len_t l ));
645
646 LBER_F( struct berval * )
647 ber_bvreplace LDAP_P((
648         struct berval *dst, LDAP_CONST struct berval *src ));
649
650 LBER_F( void )
651 ber_bvarray_free LDAP_P(( BerVarray p ));
652
653 LBER_F( int )
654 ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv ));
655
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) ))
660
661 /*
662  * error.c
663  */
664 LBER_F( int * ) ber_errno_addr LDAP_P((void));
665 #define ber_errno (*(ber_errno_addr)())
666
667 #define LBER_ERROR_NONE         0
668 #define LBER_ERROR_PARAM        0x1
669 #define LBER_ERROR_MEMORY       0x2
670
671 LDAP_END_DECL
672
673 #endif /* _LBER_H */