]> git.sur5r.net Git - openldap/blob - include/lber.h
Add DER OID decoder/encoder
[openldap] / include / lber.h
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  *
4  * Copyright 1998-2007 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 /* Largest option used by the library */
142 #define LBER_SB_OPT_OPT_MAX             14
143
144 /* LBER IO operations stacking levels */
145 #define LBER_SBIOD_LEVEL_PROVIDER       10
146 #define LBER_SBIOD_LEVEL_TRANSPORT      20
147 #define LBER_SBIOD_LEVEL_APPLICATION    30
148
149 /* get/set options for Sockbuf */
150 #define LBER_OPT_SOCKBUF_DESC           0x1000
151 #define LBER_OPT_SOCKBUF_OPTIONS        0x1001
152 #define LBER_OPT_SOCKBUF_DEBUG          0x1002
153
154 /* on/off values */
155 LBER_V( char ) ber_pvt_opt_on;
156 #define LBER_OPT_ON             ((void *) &ber_pvt_opt_on)
157 #define LBER_OPT_OFF    ((void *) 0)
158
159 #define LBER_OPT_SUCCESS        (0)
160 #define LBER_OPT_ERROR          (-1)
161
162 typedef struct berelement BerElement;
163 typedef struct sockbuf Sockbuf;
164 typedef struct seqorset Seqorset;
165
166 typedef struct sockbuf_io Sockbuf_IO;
167
168 /* Structure for LBER IO operarion descriptor */
169 typedef struct sockbuf_io_desc {
170         int                     sbiod_level;
171         Sockbuf                 *sbiod_sb;
172         Sockbuf_IO              *sbiod_io;
173         void                    *sbiod_pvt;
174         struct sockbuf_io_desc  *sbiod_next;
175 } Sockbuf_IO_Desc;
176
177 /* Structure for LBER IO operation functions */
178 struct sockbuf_io {
179         int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
180         int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
181         int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
182
183         ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
184                 ber_len_t len );
185         ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
186                 ber_len_t len );
187
188         int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
189 };
190
191 /* Helper macros for LBER IO functions */
192 #define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
193         ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
194                 buf, len ) )
195 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
196         ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
197                 buf, len ) )
198 #define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
199         ( (sbiod)->sbiod_next ? \
200                 ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
201                 (sbiod)->sbiod_next, opt, arg ) ) : 0 )
202
203 /* structure for returning a sequence of octet strings + length */
204 typedef struct berval {
205         ber_len_t       bv_len;
206         char            *bv_val;
207 } BerValue;
208
209 typedef BerValue *BerVarray;    /* To distinguish from a single bv */
210
211 /* this should be moved to lber-int.h */
212
213 /*
214  * in bprint.c:
215  */
216 LBER_F( void )
217 ber_error_print LDAP_P((
218         LDAP_CONST char *data ));
219
220 LBER_F( void )
221 ber_bprint LDAP_P((
222         LDAP_CONST char *data, ber_len_t len ));
223
224 LBER_F( void )
225 ber_dump LDAP_P((
226         BerElement *ber, int inout ));
227
228 LBER_F( void )
229 ber_sos_dump LDAP_P((
230         Seqorset *sos ));
231
232 /*
233  * in decode.c:
234  */
235 typedef int (*BERDecodeCallback) LDAP_P((
236         BerElement *ber,
237         void *data,
238         int mode ));
239
240 LBER_F( ber_tag_t )
241 ber_get_tag LDAP_P((
242         BerElement *ber ));
243
244 LBER_F( ber_tag_t )
245 ber_skip_tag LDAP_P((
246         BerElement *ber,
247         ber_len_t *len ));
248
249 LBER_F( ber_tag_t )
250 ber_peek_tag LDAP_P((
251         BerElement *ber,
252         ber_len_t *len ));
253
254 LBER_F( ber_tag_t )
255 ber_get_int LDAP_P((
256         BerElement *ber,
257         ber_int_t *num ));
258
259 LBER_F( ber_tag_t )
260 ber_get_enum LDAP_P((
261         BerElement *ber,
262         ber_int_t *num ));
263
264 LBER_F( ber_tag_t )
265 ber_get_stringb LDAP_P((
266         BerElement *ber,
267         char *buf,
268         ber_len_t *len ));
269
270 LBER_F( ber_tag_t )
271 ber_get_stringbv LDAP_P((
272         BerElement *ber,
273         struct berval *bv,
274         int alloc ));
275
276 LBER_F( ber_tag_t )
277 ber_get_stringa LDAP_P((
278         BerElement *ber,
279         char **buf ));
280
281 LBER_F( ber_tag_t )
282 ber_get_stringal LDAP_P((
283         BerElement *ber,
284         struct berval **bv ));
285
286 LBER_F( ber_tag_t )
287 ber_get_bitstringa LDAP_P((
288         BerElement *ber,
289         char **buf,
290         ber_len_t *len ));
291
292 LBER_F( ber_tag_t )
293 ber_get_null LDAP_P((
294         BerElement *ber ));
295
296 LBER_F( ber_tag_t )
297 ber_get_boolean LDAP_P((
298         BerElement *ber,
299         ber_int_t *boolval ));
300
301 LBER_F( ber_tag_t )
302 ber_first_element LDAP_P((
303         BerElement *ber,
304         ber_len_t *len,
305         char **last ));
306
307 LBER_F( ber_tag_t )
308 ber_next_element LDAP_P((
309         BerElement *ber,
310         ber_len_t *len,
311         LDAP_CONST char *last ));
312
313 LBER_F( ber_tag_t )
314 ber_scanf LDAP_P((
315         BerElement *ber,
316         LDAP_CONST char *fmt,
317         ... ));
318
319 LBER_F( int )
320 ber_decode_oid LDAP_P((
321         struct berval *in,
322         struct berval *out ));
323
324 /*
325  * in encode.c
326  */
327 LBER_F( int )
328 ber_encode_oid LDAP_P((
329         struct berval *in,
330         struct berval *out ));
331
332 typedef int (*BEREncodeCallback) LDAP_P((
333         BerElement *ber,
334         void *data ));
335
336 LBER_F( int )
337 ber_put_enum LDAP_P((
338         BerElement *ber,
339         ber_int_t num,
340         ber_tag_t tag ));
341
342 LBER_F( int )
343 ber_put_int LDAP_P((
344         BerElement *ber,
345         ber_int_t num,
346         ber_tag_t tag ));
347
348 LBER_F( int )
349 ber_put_ostring LDAP_P((
350         BerElement *ber,
351         LDAP_CONST char *str,
352         ber_len_t len,
353         ber_tag_t tag ));
354
355 LBER_F( int )
356 ber_put_berval LDAP_P((
357         BerElement *ber,
358         struct berval *bv,
359         ber_tag_t tag ));
360
361 LBER_F( int )
362 ber_put_string LDAP_P((
363         BerElement *ber,
364         LDAP_CONST char *str,
365         ber_tag_t tag ));
366
367 LBER_F( int )
368 ber_put_bitstring LDAP_P((
369         BerElement *ber,
370         LDAP_CONST char *str,
371         ber_len_t bitlen,
372         ber_tag_t tag ));
373
374 LBER_F( int )
375 ber_put_null LDAP_P((
376         BerElement *ber,
377         ber_tag_t tag ));
378
379 LBER_F( int )
380 ber_put_boolean LDAP_P((
381         BerElement *ber,
382         ber_int_t boolval,
383         ber_tag_t tag ));
384
385 LBER_F( int )
386 ber_start_seq LDAP_P((
387         BerElement *ber,
388         ber_tag_t tag ));
389
390 LBER_F( int )
391 ber_start_set LDAP_P((
392         BerElement *ber,
393         ber_tag_t tag ));
394
395 LBER_F( int )
396 ber_put_seq LDAP_P((
397         BerElement *ber ));
398
399 LBER_F( int )
400 ber_put_set LDAP_P((
401         BerElement *ber ));
402
403 LBER_F( int )
404 ber_printf LDAP_P((
405         BerElement *ber,
406         LDAP_CONST char *fmt,
407         ... ));
408
409
410 /*
411  * in io.c:
412  */
413
414 LBER_F( ber_slen_t )
415 ber_skip_data LDAP_P((
416         BerElement *ber,
417         ber_len_t len ));
418
419 LBER_F( ber_slen_t )
420 ber_read LDAP_P((
421         BerElement *ber,
422         char *buf,
423         ber_len_t len ));
424
425 LBER_F( ber_slen_t )
426 ber_write LDAP_P((
427         BerElement *ber,
428         LDAP_CONST char *buf,
429         ber_len_t len,
430         int nosos ));
431
432 LBER_F( void )
433 ber_free LDAP_P((
434         BerElement *ber,
435         int freebuf ));
436
437 LBER_F( void )
438 ber_free_buf LDAP_P(( BerElement *ber ));
439
440 LBER_F( int )
441 ber_flush2 LDAP_P((
442         Sockbuf *sb,
443         BerElement *ber,
444         int freeit ));
445 #define LBER_FLUSH_FREE_NEVER           (0x0)   /* traditional behavior */
446 #define LBER_FLUSH_FREE_ON_SUCCESS      (0x1)   /* traditional behavior */
447 #define LBER_FLUSH_FREE_ON_ERROR        (0x2)
448 #define LBER_FLUSH_FREE_ALWAYS          (LBER_FLUSH_FREE_ON_SUCCESS|LBER_FLUSH_FREE_ON_ERROR)
449
450 LBER_F( int )
451 ber_flush LDAP_P((
452         Sockbuf *sb,
453         BerElement *ber,
454         int freeit )); /* DEPRECATED */
455
456 LBER_F( BerElement * )
457 ber_alloc LDAP_P(( void )); /* DEPRECATED */
458
459 LBER_F( BerElement * )
460 der_alloc LDAP_P(( void )); /* DEPRECATED */
461
462 LBER_F( BerElement * )
463 ber_alloc_t LDAP_P((
464         int beroptions ));
465
466 LBER_F( BerElement * )
467 ber_dup LDAP_P((
468         BerElement *ber ));
469
470 LBER_F( ber_tag_t )
471 ber_get_next LDAP_P((
472         Sockbuf *sb,
473         ber_len_t *len,
474         BerElement *ber ));
475
476 LBER_F( void )
477 ber_init2 LDAP_P((
478         BerElement *ber,
479         struct berval *bv,
480         int options ));
481
482 LBER_F( void )
483 ber_init_w_nullc LDAP_P((       /* DEPRECATED */
484         BerElement *ber,
485         int options ));
486
487 LBER_F( void )
488 ber_reset LDAP_P((
489         BerElement *ber,
490         int was_writing ));
491
492 LBER_F( BerElement * )
493 ber_init LDAP_P((
494         struct berval *bv ));
495
496 LBER_F( int )
497 ber_flatten LDAP_P((
498         BerElement *ber,
499         struct berval **bvPtr ));
500
501 LBER_F( int )
502 ber_flatten2 LDAP_P((
503         BerElement *ber,
504         struct berval *bv,
505         int alloc ));
506
507 LBER_F( int )
508 ber_remaining LDAP_P((
509         BerElement *ber ));
510
511 /*
512  * LBER ber accessor functions
513  */
514
515 LBER_F( int )
516 ber_get_option LDAP_P((
517         void *item,
518         int option,
519         void *outvalue));
520
521 LBER_F( int )
522 ber_set_option LDAP_P((
523         void *item,
524         int option,
525         LDAP_CONST void *invalue));
526
527 /*
528  * LBER sockbuf.c
529  */
530
531 LBER_F( Sockbuf *  )
532 ber_sockbuf_alloc LDAP_P((
533         void ));
534
535 LBER_F( void )
536 ber_sockbuf_free LDAP_P((
537         Sockbuf *sb ));
538
539 LBER_F( int )
540 ber_sockbuf_add_io LDAP_P((
541         Sockbuf *sb,
542         Sockbuf_IO *sbio,
543         int layer,
544         void *arg ));
545
546 LBER_F( int )
547 ber_sockbuf_remove_io LDAP_P((
548         Sockbuf *sb,
549         Sockbuf_IO *sbio,
550         int layer ));
551
552 LBER_F( int )
553 ber_sockbuf_ctrl LDAP_P((
554         Sockbuf *sb,
555         int opt,
556         void *arg ));
557
558 LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp;
559 LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead;
560 LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd;
561 LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug;
562 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
563
564 /*
565  * LBER memory.c
566  */
567 LBER_F( void * )
568 ber_memalloc LDAP_P((
569         ber_len_t s ));
570
571 LBER_F( void * )
572 ber_memrealloc LDAP_P((
573         void* p,
574         ber_len_t s ));
575
576 LBER_F( void * )
577 ber_memcalloc LDAP_P((
578         ber_len_t n,
579         ber_len_t s ));
580
581 LBER_F( void )
582 ber_memfree LDAP_P((
583         void* p ));
584
585 LBER_F( void )
586 ber_memvfree LDAP_P((
587         void** vector ));
588
589 LBER_F( void )
590 ber_bvfree LDAP_P((
591         struct berval *bv ));
592
593 LBER_F( void )
594 ber_bvecfree LDAP_P((
595         struct berval **bv ));
596
597 LBER_F( int )
598 ber_bvecadd LDAP_P((
599         struct berval ***bvec,
600         struct berval *bv ));
601
602 LBER_F( struct berval * )
603 ber_dupbv LDAP_P((
604         struct berval *dst, struct berval *src ));
605
606 LBER_F( struct berval * )
607 ber_bvdup LDAP_P((
608         struct berval *src ));
609
610 LBER_F( struct berval * )
611 ber_mem2bv LDAP_P((
612         LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv));
613
614 LBER_F( struct berval * )
615 ber_str2bv LDAP_P((
616         LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv));
617
618 #define ber_bvstr(a)    ((ber_str2bv)((a), 0, 0, NULL))
619 #define ber_bvstrdup(a) ((ber_str2bv)((a), 0, 1, NULL))
620
621 LBER_F( char * )
622 ber_strdup LDAP_P((
623         LDAP_CONST char * ));
624
625 LBER_F( struct berval * )
626 ber_bvreplace LDAP_P((
627         struct berval *dst, LDAP_CONST struct berval *src ));
628
629 LBER_F( void )
630 ber_bvarray_free LDAP_P(( BerVarray p ));
631
632 LBER_F( int )
633 ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv ));
634
635 #define ber_bvcmp(v1,v2) \
636         ((v1)->bv_len < (v2)->bv_len \
637                 ? -1 : ((v1)->bv_len > (v2)->bv_len \
638                         ? 1 : memcmp((v1)->bv_val, (v2)->bv_val, (v1)->bv_len) ))
639
640 /*
641  * error.c
642  */
643 LBER_F( int * ) ber_errno_addr LDAP_P((void));
644 #define ber_errno (*(ber_errno_addr)())
645
646 #define LBER_ERROR_NONE         0
647 #define LBER_ERROR_PARAM        0x1
648 #define LBER_ERROR_MEMORY       0x2
649
650 LDAP_END_DECL
651
652 #endif /* _LBER_H */