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