]> git.sur5r.net Git - openldap/blob - include/ldap_pvt.h
Assist in cache debugging
[openldap] / include / ldap_pvt.h
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  * 
4  * Copyright 1998-2004 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
16 /* ldap-pvt.h - Header for ldap_pvt_ functions.
17  * These are meant to be internal to OpenLDAP Software.
18  */
19
20 #ifndef _LDAP_PVT_H
21 #define _LDAP_PVT_H 1
22
23 #include <lber.h>                               /* get ber_slen_t */
24
25 LDAP_BEGIN_DECL
26
27 #define LDAP_PROTO_TCP 1 /* ldap://  */
28 #define LDAP_PROTO_UDP 2 /* reserved */
29 #define LDAP_PROTO_IPC 3 /* ldapi:// */
30
31 LDAP_F ( int )
32 ldap_pvt_url_scheme2proto LDAP_P((
33         const char * ));
34 LDAP_F ( int )
35 ldap_pvt_url_scheme2tls LDAP_P((
36         const char * ));
37
38 LDAP_F ( int )
39 ldap_pvt_url_scheme_port LDAP_P((
40         const char *, int ));
41
42 struct ldap_url_desc; /* avoid pulling in <ldap.h> */
43
44 LDAP_F( int )
45 ldap_url_parse_ext LDAP_P((
46         LDAP_CONST char *url,
47         struct ldap_url_desc **ludpp ));
48
49 LDAP_F( char * )
50 ldap_pvt_ctime LDAP_P((
51         const time_t *tp,
52         char *buf ));
53
54 LDAP_F( char *) ldap_pvt_get_fqdn LDAP_P(( char * ));
55
56 struct hostent; /* avoid pulling in <netdb.h> */
57
58 LDAP_F( int )
59 ldap_pvt_gethostbyname_a LDAP_P((
60         const char *name,
61         struct hostent *resbuf,
62         char **buf,
63         struct hostent **result,
64         int *herrno_ptr ));
65
66 LDAP_F( int )
67 ldap_pvt_gethostbyaddr_a LDAP_P((
68         const char *addr,
69         int len,
70         int type,
71         struct hostent *resbuf,
72         char **buf,
73         struct hostent **result,
74         int *herrno_ptr ));
75
76 struct sockaddr;
77
78 LDAP_F( int )
79 ldap_pvt_get_hname LDAP_P((
80         const struct sockaddr * sa,
81         int salen,
82         char *name,
83         int namelen,
84         char **herr ));
85
86
87 /* charray.c */
88
89 LDAP_F( int )
90 ldap_charray_add LDAP_P((
91     char        ***a,
92     const char *s ));
93
94 LDAP_F( int )
95 ldap_charray_merge LDAP_P((
96     char        ***a,
97     char        **s ));
98
99 LDAP_F( void )
100 ldap_charray_free LDAP_P(( char **a ));
101
102 LDAP_F( int )
103 ldap_charray_inlist LDAP_P((
104     char        **a,
105     const char *s ));
106
107 LDAP_F( char ** )
108 ldap_charray_dup LDAP_P(( char **a ));
109
110 LDAP_F( char ** )
111 ldap_str2charray LDAP_P((
112         const char *str,
113         const char *brkstr ));
114
115 LDAP_F( char * )
116 ldap_charray2str LDAP_P((
117         char **array, const char* sep ));
118
119 /* getdn.c */
120
121 #ifdef LDAP_AVA_NULL    /* in ldap.h */
122 LDAP_F( void ) ldap_rdnfree_x LDAP_P(( LDAPRDN rdn, void *ctx ));
123 LDAP_F( void ) ldap_dnfree_x LDAP_P(( LDAPDN dn, void *ctx ));
124
125 LDAP_F( int ) ldap_bv2dn_x LDAP_P(( 
126         struct berval *bv, LDAPDN *dn, unsigned flags, void *ctx ));
127 LDAP_F( int ) ldap_dn2bv_x LDAP_P(( 
128         LDAPDN dn, struct berval *bv, unsigned flags, void *ctx ));
129 LDAP_F( int ) ldap_bv2rdn_x LDAP_P(( 
130         struct berval *, LDAPRDN *, char **, unsigned flags, void *ctx ));
131 LDAP_F( int ) ldap_rdn2bv_x LDAP_P(( 
132         LDAPRDN rdn, struct berval *bv, unsigned flags, void *ctx ));
133 #endif
134
135 /* url.c */
136 LDAP_F (void) ldap_pvt_hex_unescape LDAP_P(( char *s ));
137
138 /*
139  * these macros assume 'x' is an ASCII x
140  * and assume the "C" locale
141  */
142 #define LDAP_ASCII(c)           (!((c) & 0x80))
143 #define LDAP_SPACE(c)           ((c) == ' ' || (c) == '\t' || (c) == '\n')
144 #define LDAP_DIGIT(c)           ((c) >= '0' && (c) <= '9')
145 #define LDAP_LOWER(c)           ((c) >= 'a' && (c) <= 'z')
146 #define LDAP_UPPER(c)           ((c) >= 'A' && (c) <= 'Z')
147 #define LDAP_ALPHA(c)           (LDAP_LOWER(c) || LDAP_UPPER(c))
148 #define LDAP_ALNUM(c)           (LDAP_ALPHA(c) || LDAP_DIGIT(c))
149
150 #define LDAP_LDH(c)                     (LDAP_ALNUM(c) || (c) == '-')
151
152 #define LDAP_HEXLOWER(c)        ((c) >= 'a' && (c) <= 'f')
153 #define LDAP_HEXUPPER(c)        ((c) >= 'A' && (c) <= 'F')
154 #define LDAP_HEX(c)                     (LDAP_DIGIT(c) || \
155                                                                 LDAP_HEXLOWER(c) || LDAP_HEXUPPER(c))
156
157 /* controls.c */
158 struct ldapcontrol;
159 LDAP_F (struct ldapcontrol *) ldap_control_dup LDAP_P((
160         const struct ldapcontrol *ctrl ));
161
162 LDAP_F (struct ldapcontrol **) ldap_controls_dup LDAP_P((
163         struct ldapcontrol *const *ctrls ));
164
165 LDAP_F (int) ldap_pvt_get_controls LDAP_P((
166         BerElement *be,
167         struct ldapcontrol ***ctrlsp));
168
169 #ifdef HAVE_CYRUS_SASL
170 /* cyrus.c */
171 struct sasl_security_properties; /* avoid pulling in <sasl.h> */
172 LDAP_F (int) ldap_pvt_sasl_secprops LDAP_P((
173         const char *in,
174         struct sasl_security_properties *secprops ));
175
176 LDAP_F (void *) ldap_pvt_sasl_mutex_new LDAP_P((void));
177 LDAP_F (int) ldap_pvt_sasl_mutex_lock LDAP_P((void *mutex));
178 LDAP_F (int) ldap_pvt_sasl_mutex_unlock LDAP_P((void *mutex));
179 LDAP_F (void) ldap_pvt_sasl_mutex_dispose LDAP_P((void *mutex));
180
181 struct sockbuf; /* avoid pulling in <lber.h> */
182 LDAP_F (int) ldap_pvt_sasl_install LDAP_P(( struct sockbuf *, void * ));
183 LDAP_F (void) ldap_pvt_sasl_remove LDAP_P(( struct sockbuf * ));
184 #endif /* HAVE_CYRUS_SASL */
185
186 #ifndef LDAP_PVT_SASL_LOCAL_SSF
187 #define LDAP_PVT_SASL_LOCAL_SSF 71      /* SSF for Unix Domain Sockets */
188 #endif
189
190 struct ldap;
191 struct ldapmsg;
192
193 LDAP_F (int) ldap_open_internal_connection LDAP_P((
194         struct ldap **ldp, ber_socket_t *fdp ));
195
196 /* messages.c */
197 LDAP_F( BerElement * )
198 ldap_get_message_ber LDAP_P((
199         struct ldapmsg * ));
200
201 /* search.c */
202 LDAP_F( int ) ldap_pvt_put_filter LDAP_P((
203         BerElement *ber,
204         const char *str ));
205
206 LDAP_F( char * )
207 ldap_pvt_find_wildcard LDAP_P(( const char *s ));
208
209 LDAP_F( ber_slen_t )
210 ldap_pvt_filter_value_unescape LDAP_P(( char *filter ));
211
212 /* string.c */
213 LDAP_F( char * )
214 ldap_pvt_str2upper LDAP_P(( char *str ));
215
216 LDAP_F( char * )
217 ldap_pvt_str2lower LDAP_P(( char *str ));
218
219 LDAP_F( struct berval * )
220 ldap_pvt_str2upperbv LDAP_P(( char *str, struct berval *bv ));
221
222 LDAP_F( struct berval * )
223 ldap_pvt_str2lowerbv LDAP_P(( char *str, struct berval *bv ));
224
225 /* tls.c */
226 LDAP_F (int) ldap_int_tls_config LDAP_P(( struct ldap *ld,
227         int option, const char *arg ));
228 LDAP_F (int) ldap_pvt_tls_get_option LDAP_P(( struct ldap *ld,
229         int option, void *arg ));
230 LDAP_F (int) ldap_pvt_tls_set_option LDAP_P(( struct ldap *ld,
231         int option, void *arg ));
232
233 LDAP_F (void) ldap_pvt_tls_destroy LDAP_P(( void ));
234 LDAP_F (int) ldap_pvt_tls_init LDAP_P(( void ));
235 LDAP_F (int) ldap_pvt_tls_init_def_ctx LDAP_P(( void ));
236 LDAP_F (int) ldap_pvt_tls_accept LDAP_P(( Sockbuf *sb, void *ctx_arg ));
237 LDAP_F (int) ldap_pvt_tls_inplace LDAP_P(( Sockbuf *sb ));
238 LDAP_F (void *) ldap_pvt_tls_sb_ctx LDAP_P(( Sockbuf *sb ));
239
240 LDAP_F (int) ldap_pvt_tls_init_default_ctx LDAP_P(( void ));
241
242 typedef int LDAPDN_rewrite_dummy LDAP_P (( void *dn, unsigned flags ));
243
244 LDAP_F (int) ldap_pvt_tls_get_my_dn LDAP_P(( void *ctx, struct berval *dn,
245         LDAPDN_rewrite_dummy *func, unsigned flags ));
246 LDAP_F (int) ldap_pvt_tls_get_peer_dn LDAP_P(( void *ctx, struct berval *dn,
247         LDAPDN_rewrite_dummy *func, unsigned flags ));
248 LDAP_F (int) ldap_pvt_tls_get_strength LDAP_P(( void *ctx ));
249
250 LDAP_END_DECL
251
252 /*
253  * Multiple precision stuff
254  * 
255  * May use OpenSSL's BIGNUM if built with TLS,
256  * or GNU's multiple precision library.
257  *
258  * If none is available, unsigned long data is used.
259  */
260 #ifdef HAVE_BIGNUM
261 /*
262  * Use OpenSSL's BIGNUM
263  */
264 #if defined(HAVE_OPENSSL_CRYPTO_H)
265 #include <openssl/crypto.h>
266 #elif HAVE_CRYPTO_H
267 #include <crypto.h>
268 #endif /* HAVE_OPENSSL_CRYPTO_H || HAVE_CRYPTO_H */
269 #ifdef HAVE_OPENSSL_BN_H
270 #include <openssl/bn.h>
271 #elif HAVE_BN_H
272 #include <bn.h>
273 #endif /* HAVE_OPENSSL_BN_H || HAVE_BN_H */
274
275 typedef BIGNUM*         ldap_pvt_mp_t;
276
277 #define ldap_pvt_mp_init(mp) \
278         do { (mp) = BN_new(); BN_init((mp)); } while (0)
279
280 /* FIXME: we rely on mpr being initialized */
281 #define ldap_pvt_mp_init_set(mpr,mpv) \
282         do { ldap_pvt_mp_init((mpr)); BN_add((mpr), (mpr), (mpv)); } while (0)
283
284 #define ldap_pvt_mp_add(mpr,mpv) \
285         BN_add((mpr), (mpr), (mpv))
286
287 #define ldap_pvt_mp_add_ulong(mp,v) \
288         BN_add_word((mp), (v))
289
290 #define ldap_pvt_mp_clear(mp) \
291         do { BN_free((mp)); (mp) = 0; } while (0)
292
293 #elif defined(HAVE_GMP)
294 /*
295  * Use GNU's multiple precision library
296  */
297 #ifdef HAVE_GMP_H
298 #include <gmp.h>
299 #endif
300
301 typedef mpz_t           ldap_pvt_mp_t;
302 #define ldap_pvt_mp_init(mp) \
303         mpz_init((mp))
304
305 #define ldap_pvt_mp_init_set(mpr,mpv) \
306         mpz_init_set((mpr), (mpv))
307
308 #define ldap_pvt_mp_add(mpr,mpv) \
309         mpz_add((mpr), (mpr), (mpv))
310
311 #define ldap_pvt_mp_add_ulong(mp,v)     \
312         mpz_add_ui((mp), (mp), (v))
313
314 #define ldap_pvt_mp_clear(mp) \
315         mpz_clear((mp))
316
317 #else /* ! HAVE_BIGNUM && ! HAVE_GMP */
318 /*
319  * Use unsigned long
320  */
321
322 typedef unsigned long   ldap_pvt_mp_t;
323
324 #define ldap_pvt_mp_init(mp) \
325         (mp) = 0
326
327 #define ldap_pvt_mp_init_set(mpr,mpv) \
328         (mpr) = (mpv)
329
330 #define ldap_pvt_mp_add(mpr,mpv) \
331         (mpr) += (mpv)
332
333 #define ldap_pvt_mp_add_ulong(mp,v) \
334         (mp) += (v)
335
336 #define ldap_pvt_mp_clear(mp) \
337         (mp) = 0
338
339 #endif /* ! HAVE_BIGNUM && ! HAVE_GMP */
340
341 #include "ldap_pvt_uc.h"
342
343 #endif