]> git.sur5r.net Git - openldap/blob - include/lber.h
More for ITS#6215
[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
282 LBER_F( ber_tag_t )
283 ber_get_stringbv LDAP_P((
284         BerElement *ber,
285         struct berval *bv,
286         int options ));
287
288 LBER_F( ber_tag_t )
289 ber_get_stringa LDAP_P((
290         BerElement *ber,
291         char **buf ));
292
293 LBER_F( ber_tag_t )
294 ber_get_stringal LDAP_P((
295         BerElement *ber,
296         struct berval **bv ));
297
298 LBER_F( ber_tag_t )
299 ber_get_bitstringa LDAP_P((
300         BerElement *ber,
301         char **buf,
302         ber_len_t *len ));
303
304 LBER_F( ber_tag_t )
305 ber_get_null LDAP_P((
306         BerElement *ber ));
307
308 LBER_F( ber_tag_t )
309 ber_get_boolean LDAP_P((
310         BerElement *ber,
311         ber_int_t *boolval ));
312
313 LBER_F( ber_tag_t )
314 ber_first_element LDAP_P((
315         BerElement *ber,
316         ber_len_t *len,
317         char **last ));
318
319 LBER_F( ber_tag_t )
320 ber_next_element LDAP_P((
321         BerElement *ber,
322         ber_len_t *len,
323         LDAP_CONST char *last ));
324
325 LBER_F( ber_tag_t )
326 ber_scanf LDAP_P((
327         BerElement *ber,
328         LDAP_CONST char *fmt,
329         ... ));
330
331 LBER_F( int )
332 ber_decode_oid LDAP_P((
333         struct berval *in,
334         struct berval *out ));
335
336 /*
337  * in encode.c
338  */
339 LBER_F( int )
340 ber_encode_oid LDAP_P((
341         struct berval *in,
342         struct berval *out ));
343
344 typedef int (*BEREncodeCallback) LDAP_P((
345         BerElement *ber,
346         void *data ));
347
348 LBER_F( int )
349 ber_put_enum LDAP_P((
350         BerElement *ber,
351         ber_int_t num,
352         ber_tag_t tag ));
353
354 LBER_F( int )
355 ber_put_int LDAP_P((
356         BerElement *ber,
357         ber_int_t num,
358         ber_tag_t tag ));
359
360 LBER_F( int )
361 ber_put_ostring LDAP_P((
362         BerElement *ber,
363         LDAP_CONST char *str,
364         ber_len_t len,
365         ber_tag_t tag ));
366
367 LBER_F( int )
368 ber_put_berval LDAP_P((
369         BerElement *ber,
370         struct berval *bv,
371         ber_tag_t tag ));
372
373 LBER_F( int )
374 ber_put_string LDAP_P((
375         BerElement *ber,
376         LDAP_CONST char *str,
377         ber_tag_t tag ));
378
379 LBER_F( int )
380 ber_put_bitstring LDAP_P((
381         BerElement *ber,
382         LDAP_CONST char *str,
383         ber_len_t bitlen,
384         ber_tag_t tag ));
385
386 LBER_F( int )
387 ber_put_null LDAP_P((
388         BerElement *ber,
389         ber_tag_t tag ));
390
391 LBER_F( int )
392 ber_put_boolean LDAP_P((
393         BerElement *ber,
394         ber_int_t boolval,
395         ber_tag_t tag ));
396
397 LBER_F( int )
398 ber_start_seq LDAP_P((
399         BerElement *ber,
400         ber_tag_t tag ));
401
402 LBER_F( int )
403 ber_start_set LDAP_P((
404         BerElement *ber,
405         ber_tag_t tag ));
406
407 LBER_F( int )
408 ber_put_seq LDAP_P((
409         BerElement *ber ));
410
411 LBER_F( int )
412 ber_put_set LDAP_P((
413         BerElement *ber ));
414
415 LBER_F( int )
416 ber_printf LDAP_P((
417         BerElement *ber,
418         LDAP_CONST char *fmt,
419         ... ));
420
421
422 /*
423  * in io.c:
424  */
425
426 LBER_F( ber_slen_t )
427 ber_skip_data LDAP_P((
428         BerElement *ber,
429         ber_len_t len ));
430
431 LBER_F( ber_slen_t )
432 ber_read LDAP_P((
433         BerElement *ber,
434         char *buf,
435         ber_len_t len ));
436
437 LBER_F( ber_slen_t )
438 ber_write LDAP_P((
439         BerElement *ber,
440         LDAP_CONST char *buf,
441         ber_len_t len,
442         int zero ));    /* nonzero is unsupported from OpenLDAP 2.4.18 */
443
444 LBER_F( void )
445 ber_free LDAP_P((
446         BerElement *ber,
447         int freebuf ));
448
449 LBER_F( void )
450 ber_free_buf LDAP_P(( BerElement *ber ));
451
452 LBER_F( int )
453 ber_flush2 LDAP_P((
454         Sockbuf *sb,
455         BerElement *ber,
456         int freeit ));
457 #define LBER_FLUSH_FREE_NEVER           (0x0)   /* traditional behavior */
458 #define LBER_FLUSH_FREE_ON_SUCCESS      (0x1)   /* traditional behavior */
459 #define LBER_FLUSH_FREE_ON_ERROR        (0x2)
460 #define LBER_FLUSH_FREE_ALWAYS          (LBER_FLUSH_FREE_ON_SUCCESS|LBER_FLUSH_FREE_ON_ERROR)
461
462 LBER_F( int )
463 ber_flush LDAP_P((
464         Sockbuf *sb,
465         BerElement *ber,
466         int freeit )); /* DEPRECATED */
467
468 LBER_F( BerElement * )
469 ber_alloc LDAP_P(( void )); /* DEPRECATED */
470
471 LBER_F( BerElement * )
472 der_alloc LDAP_P(( void )); /* DEPRECATED */
473
474 LBER_F( BerElement * )
475 ber_alloc_t LDAP_P((
476         int beroptions ));
477
478 LBER_F( BerElement * )
479 ber_dup LDAP_P((
480         BerElement *ber ));
481
482 LBER_F( ber_tag_t )
483 ber_get_next LDAP_P((
484         Sockbuf *sb,
485         ber_len_t *len,
486         BerElement *ber ));
487
488 LBER_F( void )
489 ber_init2 LDAP_P((
490         BerElement *ber,
491         struct berval *bv,
492         int options ));
493
494 LBER_F( void )
495 ber_init_w_nullc LDAP_P((       /* DEPRECATED */
496         BerElement *ber,
497         int options ));
498
499 LBER_F( void )
500 ber_reset LDAP_P((
501         BerElement *ber,
502         int was_writing ));
503
504 LBER_F( BerElement * )
505 ber_init LDAP_P((
506         struct berval *bv ));
507
508 LBER_F( int )
509 ber_flatten LDAP_P((
510         BerElement *ber,
511         struct berval **bvPtr ));
512
513 LBER_F( int )
514 ber_flatten2 LDAP_P((
515         BerElement *ber,
516         struct berval *bv,
517         int alloc ));
518
519 LBER_F( int )
520 ber_remaining LDAP_P((
521         BerElement *ber ));
522
523 /*
524  * LBER ber accessor functions
525  */
526
527 LBER_F( int )
528 ber_get_option LDAP_P((
529         void *item,
530         int option,
531         void *outvalue));
532
533 LBER_F( int )
534 ber_set_option LDAP_P((
535         void *item,
536         int option,
537         LDAP_CONST void *invalue));
538
539 /*
540  * LBER sockbuf.c
541  */
542
543 LBER_F( Sockbuf *  )
544 ber_sockbuf_alloc LDAP_P((
545         void ));
546
547 LBER_F( void )
548 ber_sockbuf_free LDAP_P((
549         Sockbuf *sb ));
550
551 LBER_F( int )
552 ber_sockbuf_add_io LDAP_P((
553         Sockbuf *sb,
554         Sockbuf_IO *sbio,
555         int layer,
556         void *arg ));
557
558 LBER_F( int )
559 ber_sockbuf_remove_io LDAP_P((
560         Sockbuf *sb,
561         Sockbuf_IO *sbio,
562         int layer ));
563
564 LBER_F( int )
565 ber_sockbuf_ctrl LDAP_P((
566         Sockbuf *sb,
567         int opt,
568         void *arg ));
569
570 LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp;
571 LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead;
572 LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd;
573 LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug;
574 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
575
576 /*
577  * LBER memory.c
578  */
579 LBER_F( void * )
580 ber_memalloc LDAP_P((
581         ber_len_t s ));
582
583 LBER_F( void * )
584 ber_memrealloc LDAP_P((
585         void* p,
586         ber_len_t s ));
587
588 LBER_F( void * )
589 ber_memcalloc LDAP_P((
590         ber_len_t n,
591         ber_len_t s ));
592
593 LBER_F( void )
594 ber_memfree LDAP_P((
595         void* p ));
596
597 LBER_F( void )
598 ber_memvfree LDAP_P((
599         void** vector ));
600
601 LBER_F( void )
602 ber_bvfree LDAP_P((
603         struct berval *bv ));
604
605 LBER_F( void )
606 ber_bvecfree LDAP_P((
607         struct berval **bv ));
608
609 LBER_F( int )
610 ber_bvecadd LDAP_P((
611         struct berval ***bvec,
612         struct berval *bv ));
613
614 LBER_F( struct berval * )
615 ber_dupbv LDAP_P((
616         struct berval *dst, struct berval *src ));
617
618 LBER_F( struct berval * )
619 ber_bvdup LDAP_P((
620         struct berval *src ));
621
622 LBER_F( struct berval * )
623 ber_mem2bv LDAP_P((
624         LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv));
625
626 LBER_F( struct berval * )
627 ber_str2bv LDAP_P((
628         LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv));
629
630 #define ber_bvstr(a)    ((ber_str2bv)((a), 0, 0, NULL))
631 #define ber_bvstrdup(a) ((ber_str2bv)((a), 0, 1, NULL))
632
633 LBER_F( char * )
634 ber_strdup LDAP_P((
635         LDAP_CONST char * ));
636
637 LBER_F( ber_len_t )
638 ber_strnlen LDAP_P((
639         LDAP_CONST char *s, ber_len_t len ));
640
641 LBER_F( char * )
642 ber_strndup LDAP_P((
643         LDAP_CONST char *s, ber_len_t l ));
644
645 LBER_F( struct berval * )
646 ber_bvreplace LDAP_P((
647         struct berval *dst, LDAP_CONST struct berval *src ));
648
649 LBER_F( void )
650 ber_bvarray_free LDAP_P(( BerVarray p ));
651
652 LBER_F( int )
653 ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv ));
654
655 #define ber_bvcmp(v1,v2) \
656         ((v1)->bv_len < (v2)->bv_len \
657                 ? -1 : ((v1)->bv_len > (v2)->bv_len \
658                         ? 1 : memcmp((v1)->bv_val, (v2)->bv_val, (v1)->bv_len) ))
659
660 /*
661  * error.c
662  */
663 LBER_F( int * ) ber_errno_addr LDAP_P((void));
664 #define ber_errno (*(ber_errno_addr)())
665
666 #define LBER_ERROR_NONE         0
667 #define LBER_ERROR_PARAM        0x1
668 #define LBER_ERROR_MEMORY       0x2
669
670 LDAP_END_DECL
671
672 #endif /* _LBER_H */