2 * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
5 * Redistribution and use in source and binary forms are permitted only
6 * as authorized by the OpenLDAP Public License. A copy of this
7 * license is available at http://www.OpenLDAP.org/license.html or
8 * in file LICENSE in the top-level directory of the distribution.
11 * Copyright (c) 1990 Regents of the University of Michigan.
12 * All rights reserved.
14 * Redistribution and use in source and binary forms are permitted
15 * provided that this notice is preserved and that due credit is given
16 * to the University of Michigan at Ann Arbor. The name of the University
17 * may not be used to endorse or promote products derived from this
18 * software without specific prior written permission. This software
19 * is provided ``as is'' without express or implied warranty.
25 #include <ldap_cdefs.h>
29 /* BER classes and mask */
30 #define LBER_CLASS_UNIVERSAL 0x00
31 #define LBER_CLASS_APPLICATION 0x40
32 #define LBER_CLASS_CONTEXT 0x80
33 #define LBER_CLASS_PRIVATE 0xc0
34 #define LBER_CLASS_MASK 0xc0
36 /* BER encoding type and mask */
37 #define LBER_PRIMITIVE 0x00
38 #define LBER_CONSTRUCTED 0x20
39 #define LBER_ENCODING_MASK 0x20
41 #define LBER_BIG_TAG_MASK 0x1f
42 #define LBER_MORE_TAG_MASK 0x80
45 * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
46 * as valid BER tags, and so it is safe to use them to report errors. In
47 * fact, any tag for which the following is true is invalid:
48 * (( tag & 0x00000080 ) != 0 ) && (( tag & 0xFFFFFF00 ) != 0 )
50 #define LBER_ERROR 0xffffffffL
51 #define LBER_DEFAULT 0xffffffffL
52 /* #define LBER_END_SEQORSET 0xfffffffeL *//* no part of LDAP C-API */
54 /* general BER types we know about */
55 #define LBER_BOOLEAN 0x01L
56 #define LBER_INTEGER 0x02L
57 #define LBER_BITSTRING 0x03L
58 #define LBER_OCTETSTRING 0x04L
59 #define LBER_NULL 0x05L
60 #define LBER_ENUMERATED 0x0aL
61 #define LBER_SEQUENCE 0x30L /* constructed */
62 #define LBER_SET 0x31L /* constructed */
64 #define OLD_LBER_SEQUENCE 0x10L /* w/o constructed bit - broken */
65 #define OLD_LBER_SET 0x11L /* w/o constructed bit - broken */
67 typedef int (*BERTranslateProc) LDAP_P(( char **bufp,
68 unsigned long *buflenp,
71 /* LBER BerElement options */
72 #define LBER_USE_DER 0x01
73 #define LBER_USE_INDEFINITE_LEN 0x02
74 #define LBER_TRANSLATE_STRINGS 0x04
76 /* get/set options for BerElement */
77 #define LBER_OPT_BER_OPTIONS 0x01
78 #define LBER_OPT_BER_DEBUG 0x02
80 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG
81 #define LBER_OPT_LOG_PRINT_FN 0x8001
83 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
85 /* LBER Sockbuf options */
86 #define LBER_TO_FILE 0x01 /* to a file referenced by sb_fd */
87 #define LBER_TO_FILE_ONLY 0x02 /* only write to file, not network */
88 #define LBER_MAX_INCOMING_SIZE 0x04 /* impose limit on incoming stuff */
89 #define LBER_NO_READ_AHEAD 0x08 /* read only as much as requested */
91 /* get/set options for Sockbuf */
92 #define LBER_OPT_SOCKBUF_DESC 0x1000
93 #define LBER_OPT_SOCKBUF_OPTIONS 0x1001
94 #define LBER_OPT_SOCKBUF_DEBUG 0x1002
97 #define LBER_OPT_ON ((void *) 1)
98 #define LBER_OPT_OFF ((void *) 0)
100 #define LBER_OPT_SUCCESS 0
101 #define LBER_OPT_ERROR (-1)
103 typedef struct berelement BerElement;
104 #define NULLBER ((BerElement *) 0)
106 typedef struct sockbuf Sockbuf;
108 typedef struct seqorset Seqorset;
109 #define NULLSEQORSET ((Seqorset *) 0)
111 /* structure for returning a sequence of octet strings + length */
113 unsigned long bv_len;
120 LDAP_F void ber_print_error LDAP_P(( char *data ));
121 LDAP_F void ber_bprint LDAP_P(( char *data, int len ));
122 #define lber_bprint(d,l) ber_bprint((d),(l))
124 LDAP_F void ber_dump LDAP_P(( BerElement *ber, int inout ));
125 LDAP_F void ber_sos_dump LDAP_P(( Seqorset *sos ));
131 LDAP_F unsigned long ber_get_tag LDAP_P(( BerElement *ber ));
132 LDAP_F unsigned long ber_skip_tag LDAP_P(( BerElement *ber, unsigned long *len ));
133 LDAP_F unsigned long ber_peek_tag LDAP_P(( BerElement *ber, unsigned long *len ));
134 LDAP_F unsigned long ber_get_int LDAP_P(( BerElement *ber, long *num ));
135 LDAP_F unsigned long ber_get_stringb LDAP_P(( BerElement *ber, char *buf,
136 unsigned long *len ));
137 LDAP_F unsigned long ber_get_stringa LDAP_P(( BerElement *ber, char **buf ));
138 LDAP_F unsigned long ber_get_stringal LDAP_P(( BerElement *ber, struct berval **bv ));
139 LDAP_F unsigned long ber_get_bitstringa LDAP_P(( BerElement *ber, char **buf,
140 unsigned long *len ));
141 LDAP_F unsigned long ber_get_null LDAP_P(( BerElement *ber ));
142 LDAP_F unsigned long ber_get_boolean LDAP_P(( BerElement *ber, int *boolval ));
143 LDAP_F unsigned long ber_first_element LDAP_P(( BerElement *ber, unsigned long *len,
145 LDAP_F unsigned long ber_next_element LDAP_P(( BerElement *ber, unsigned long *len,
147 LDAP_F unsigned long ber_scanf LDAP_P(( BerElement *ber, char *fmt, ... ));
148 LDAP_F void ber_bvfree LDAP_P(( struct berval *bv ));
149 LDAP_F void ber_bvecfree LDAP_P(( struct berval **bv ));
150 LDAP_F struct berval *ber_bvdup LDAP_P(( struct berval *bv ));
151 LDAP_F void ber_set_string_translators LDAP_P(( BerElement *ber,
152 BERTranslateProc encode_proc, BERTranslateProc decode_proc ));
157 LDAP_F int ber_put_enum LDAP_P(( BerElement *ber, long num, unsigned long tag ));
158 LDAP_F int ber_put_int LDAP_P(( BerElement *ber, long num, unsigned long tag ));
159 LDAP_F int ber_put_ostring LDAP_P(( BerElement *ber, char *str, unsigned long len,
160 unsigned long tag ));
161 LDAP_F int ber_put_string LDAP_P(( BerElement *ber, char *str, unsigned long tag ));
162 LDAP_F int ber_put_bitstring LDAP_P(( BerElement *ber, char *str,
163 unsigned long bitlen, unsigned long tag ));
164 LDAP_F int ber_put_null LDAP_P(( BerElement *ber, unsigned long tag ));
165 LDAP_F int ber_put_boolean LDAP_P(( BerElement *ber, int boolval,
166 unsigned long tag ));
167 LDAP_F int ber_start_seq LDAP_P(( BerElement *ber, unsigned long tag ));
168 LDAP_F int ber_start_set LDAP_P(( BerElement *ber, unsigned long tag ));
169 LDAP_F int ber_put_seq LDAP_P(( BerElement *ber ));
170 LDAP_F int ber_put_set LDAP_P(( BerElement *ber ));
171 LDAP_F int ber_printf LDAP_P(( BerElement *ber, char *fmt, ... ));
176 LDAP_F long ber_read LDAP_P(( BerElement *ber, char *buf, unsigned long len ));
177 LDAP_F long ber_write LDAP_P(( BerElement *ber, char *buf, unsigned long len,
179 LDAP_F void ber_free LDAP_P(( BerElement *ber, int freebuf ));
180 LDAP_F void ber_clear LDAP_P(( BerElement *ber, int freebuf ));
181 LDAP_F int ber_flush LDAP_P(( Sockbuf *sb, BerElement *ber, int freeit ));
182 LDAP_F BerElement *ber_alloc LDAP_P(( void ));
183 LDAP_F BerElement *der_alloc LDAP_P(( void ));
184 LDAP_F BerElement *ber_alloc_t LDAP_P(( int options ));
185 LDAP_F BerElement *ber_dup LDAP_P(( BerElement *ber ));
186 LDAP_F unsigned long ber_get_next LDAP_P(( Sockbuf *sb, unsigned long *len,
188 LDAP_F void ber_init_w_nullc LDAP_P(( BerElement *ber, int options ));
189 LDAP_F void ber_reset LDAP_P(( BerElement *ber, int was_writing ));
192 * LBER draft-ietf-ldapext-ldap-c-api-01 routines
194 LDAP_F BerElement *ber_init LDAP_P(( struct berval *bv ));
195 LDAP_F int ber_flatten LDAP_P(( BerElement *ber, struct berval **bvPtr ));
198 * LBER ber accessor functions
201 lber_get_option LDAP_P((void *item, int option, void *outvalue));
204 lber_set_option LDAP_P((void *item, int option, void *invalue));
207 * LBER Sockbuf functions
209 LDAP_F Sockbuf *lber_pvt_sk_alloc LDAP_P((void));
210 LDAP_F Sockbuf *lber_pvt_sb_alloc_fd LDAP_P((int fd));
211 LDAP_F void lber_pvt_sb_free LDAP_P((Sockbuf *sb));