2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2010 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
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>.
16 /* ldap-pvt.h - Header for ldap_pvt_ functions.
17 * These are meant to be internal to OpenLDAP Software.
23 #include <lber.h> /* get ber_slen_t */
24 #include <lber_pvt.h> /* get Sockbuf_Buf */
28 #define LDAP_PROTO_TCP 1 /* ldap:// */
29 #define LDAP_PROTO_UDP 2 /* reserved */
30 #define LDAP_PROTO_IPC 3 /* ldapi:// */
31 #define LDAP_PROTO_EXT 4 /* user-defined socket/sockbuf */
34 ldap_pvt_url_scheme2proto LDAP_P((
37 ldap_pvt_url_scheme2tls LDAP_P((
41 ldap_pvt_url_scheme_port LDAP_P((
44 struct ldap_url_desc; /* avoid pulling in <ldap.h> */
46 #define LDAP_PVT_URL_PARSE_NONE (0x00U)
47 #define LDAP_PVT_URL_PARSE_NOEMPTY_HOST (0x01U)
48 #define LDAP_PVT_URL_PARSE_DEF_PORT (0x02U)
49 #define LDAP_PVT_URL_PARSE_NOEMPTY_DN (0x04U)
50 #define LDAP_PVT_URL_PARSE_NODEF_SCOPE (0x08U)
51 #define LDAP_PVT_URL_PARSE_HISTORIC (LDAP_PVT_URL_PARSE_NODEF_SCOPE | \
52 LDAP_PVT_URL_PARSE_NOEMPTY_HOST | \
53 LDAP_PVT_URL_PARSE_DEF_PORT)
56 ldap_url_parse_ext LDAP_P((
58 struct ldap_url_desc **ludpp,
61 LDAP_F (int) ldap_url_parselist LDAP_P(( /* deprecated, use ldap_url_parselist_ext() */
62 struct ldap_url_desc **ludlist,
65 LDAP_F (int) ldap_url_parselist_ext LDAP_P((
66 struct ldap_url_desc **ludlist,
71 LDAP_F (char *) ldap_url_list2urls LDAP_P((
72 struct ldap_url_desc *ludlist ));
74 LDAP_F (void) ldap_free_urllist LDAP_P((
75 struct ldap_url_desc *ludlist ));
77 LDAP_F (int) ldap_pvt_scope2bv LDAP_P ((
78 int scope, struct berval *bv ));
80 LDAP_F (LDAP_CONST char *) ldap_pvt_scope2str LDAP_P ((
83 LDAP_F (int) ldap_pvt_bv2scope LDAP_P ((
86 LDAP_F (int) ldap_pvt_str2scope LDAP_P ((
90 ldap_pvt_ctime LDAP_P((
94 LDAP_F( char *) ldap_pvt_get_fqdn LDAP_P(( char * ));
96 struct hostent; /* avoid pulling in <netdb.h> */
99 ldap_pvt_gethostbyname_a LDAP_P((
101 struct hostent *resbuf,
103 struct hostent **result,
107 ldap_pvt_gethostbyaddr_a LDAP_P((
111 struct hostent *resbuf,
113 struct hostent **result,
119 ldap_pvt_get_hname LDAP_P((
120 const struct sockaddr * sa,
130 ldap_charray_add LDAP_P((
135 ldap_charray_merge LDAP_P((
140 ldap_charray_free LDAP_P(( char **a ));
143 ldap_charray_inlist LDAP_P((
148 ldap_charray_dup LDAP_P(( char **a ));
151 ldap_str2charray LDAP_P((
153 const char *brkstr ));
156 ldap_charray2str LDAP_P((
157 char **array, const char* sep ));
161 #ifdef LDAP_AVA_NULL /* in ldap.h */
162 LDAP_F( void ) ldap_rdnfree_x LDAP_P(( LDAPRDN rdn, void *ctx ));
163 LDAP_F( void ) ldap_dnfree_x LDAP_P(( LDAPDN dn, void *ctx ));
165 LDAP_F( int ) ldap_bv2dn_x LDAP_P((
166 struct berval *bv, LDAPDN *dn, unsigned flags, void *ctx ));
167 LDAP_F( int ) ldap_dn2bv_x LDAP_P((
168 LDAPDN dn, struct berval *bv, unsigned flags, void *ctx ));
169 LDAP_F( int ) ldap_bv2rdn_x LDAP_P((
170 struct berval *, LDAPRDN *, char **, unsigned flags, void *ctx ));
171 LDAP_F( int ) ldap_rdn2bv_x LDAP_P((
172 LDAPRDN rdn, struct berval *bv, unsigned flags, void *ctx ));
173 #endif /* LDAP_AVA_NULL */
176 LDAP_F (void) ldap_pvt_hex_unescape LDAP_P(( char *s ));
179 * these macros assume 'x' is an ASCII x
180 * and assume the "C" locale
182 #define LDAP_ASCII(c) (!((c) & 0x80))
183 #define LDAP_SPACE(c) ((c) == ' ' || (c) == '\t' || (c) == '\n')
184 #define LDAP_DIGIT(c) ((c) >= '0' && (c) <= '9')
185 #define LDAP_LOWER(c) ((c) >= 'a' && (c) <= 'z')
186 #define LDAP_UPPER(c) ((c) >= 'A' && (c) <= 'Z')
187 #define LDAP_ALPHA(c) (LDAP_LOWER(c) || LDAP_UPPER(c))
188 #define LDAP_ALNUM(c) (LDAP_ALPHA(c) || LDAP_DIGIT(c))
190 #define LDAP_LDH(c) (LDAP_ALNUM(c) || (c) == '-')
192 #define LDAP_HEXLOWER(c) ((c) >= 'a' && (c) <= 'f')
193 #define LDAP_HEXUPPER(c) ((c) >= 'A' && (c) <= 'F')
194 #define LDAP_HEX(c) (LDAP_DIGIT(c) || \
195 LDAP_HEXLOWER(c) || LDAP_HEXUPPER(c))
200 ldap_pvt_put_control LDAP_P((
201 const struct ldapcontrol *c,
203 LDAP_F (int) ldap_pvt_get_controls LDAP_P((
205 struct ldapcontrol ***ctrlsp));
207 #ifdef HAVE_CYRUS_SASL
209 struct sasl_security_properties; /* avoid pulling in <sasl.h> */
210 LDAP_F (int) ldap_pvt_sasl_secprops LDAP_P((
212 struct sasl_security_properties *secprops ));
213 LDAP_F (void) ldap_pvt_sasl_secprops_unparse LDAP_P((
214 struct sasl_security_properties *secprops,
215 struct berval *out ));
217 LDAP_F (void *) ldap_pvt_sasl_mutex_new LDAP_P((void));
218 LDAP_F (int) ldap_pvt_sasl_mutex_lock LDAP_P((void *mutex));
219 LDAP_F (int) ldap_pvt_sasl_mutex_unlock LDAP_P((void *mutex));
220 LDAP_F (void) ldap_pvt_sasl_mutex_dispose LDAP_P((void *mutex));
221 #endif /* HAVE_CYRUS_SASL */
223 struct sockbuf; /* avoid pulling in <lber.h> */
224 LDAP_F (int) ldap_pvt_sasl_install LDAP_P(( struct sockbuf *, void * ));
225 LDAP_F (void) ldap_pvt_sasl_remove LDAP_P(( struct sockbuf * ));
228 * SASL encryption support for LBER Sockbufs
231 struct sb_sasl_generic_data;
233 struct sb_sasl_generic_ops {
234 void (*init)(struct sb_sasl_generic_data *p,
237 ber_len_t *max_recv);
238 ber_int_t (*encode)(struct sb_sasl_generic_data *p,
242 ber_int_t (*decode)(struct sb_sasl_generic_data *p,
243 const Sockbuf_Buf *src,
245 void (*reset_buf)(struct sb_sasl_generic_data *p,
247 void (*fini)(struct sb_sasl_generic_data *p);
250 struct sb_sasl_generic_install {
251 const struct sb_sasl_generic_ops *ops;
255 struct sb_sasl_generic_data {
256 const struct sb_sasl_generic_ops *ops;
258 Sockbuf_IO_Desc *sbiod;
262 Sockbuf_Buf sec_buf_in;
266 #define LDAP_PVT_SASL_PARTIAL_WRITE 1
269 #ifndef LDAP_PVT_SASL_LOCAL_SSF
270 #define LDAP_PVT_SASL_LOCAL_SSF 71 /* SSF for Unix Domain Sockets */
271 #endif /* ! LDAP_PVT_SASL_LOCAL_SSF */
277 LDAP_F ( int ) ldap_pvt_discard LDAP_P((
278 struct ldap *ld, ber_int_t msgid ));
281 LDAP_F( BerElement * )
282 ldap_get_message_ber LDAP_P((
286 LDAP_F (int) ldap_open_internal_connection LDAP_P((
287 struct ldap **ldp, ber_socket_t *fdp ));
288 LDAP_F (int) ldap_init_fd LDAP_P((
289 ber_socket_t fd, int proto, LDAP_CONST char *url, struct ldap **ldp ));
292 LDAP_F (int) ldap_pvt_sasl_generic_install LDAP_P(( Sockbuf *sb,
293 struct sb_sasl_generic_install *install_arg ));
294 LDAP_F (void) ldap_pvt_sasl_generic_remove LDAP_P(( Sockbuf *sb ));
297 LDAP_F( int ) ldap_pvt_put_filter LDAP_P((
302 ldap_pvt_find_wildcard LDAP_P(( const char *s ));
305 ldap_pvt_filter_value_unescape LDAP_P(( char *filter ));
308 ldap_bv2escaped_filter_value_len LDAP_P(( struct berval *in ));
311 ldap_bv2escaped_filter_value_x LDAP_P(( struct berval *in, struct berval *out,
312 int inplace, void *ctx ));
314 LDAP_F (int) ldap_pvt_search LDAP_P((
316 LDAP_CONST char *base,
318 LDAP_CONST char *filter,
321 struct ldapcontrol **sctrls,
322 struct ldapcontrol **cctrls,
323 struct timeval *timeout,
328 LDAP_F(int) ldap_pvt_search_s LDAP_P((
330 LDAP_CONST char *base,
332 LDAP_CONST char *filter,
335 struct ldapcontrol **sctrls,
336 struct ldapcontrol **cctrls,
337 struct timeval *timeout,
340 struct ldapmsg **res ));
344 ldap_pvt_str2upper LDAP_P(( char *str ));
347 ldap_pvt_str2lower LDAP_P(( char *str ));
349 LDAP_F( struct berval * )
350 ldap_pvt_str2upperbv LDAP_P(( char *str, struct berval *bv ));
352 LDAP_F( struct berval * )
353 ldap_pvt_str2lowerbv LDAP_P(( char *str, struct berval *bv ));
356 LDAP_F (int) ldap_int_tls_config LDAP_P(( struct ldap *ld,
357 int option, const char *arg ));
358 LDAP_F (int) ldap_pvt_tls_get_option LDAP_P(( struct ldap *ld,
359 int option, void *arg ));
360 LDAP_F (int) ldap_pvt_tls_set_option LDAP_P(( struct ldap *ld,
361 int option, void *arg ));
363 LDAP_F (void) ldap_pvt_tls_destroy LDAP_P(( void ));
364 LDAP_F (int) ldap_pvt_tls_init LDAP_P(( void ));
365 LDAP_F (int) ldap_pvt_tls_init_def_ctx LDAP_P(( int is_server ));
366 LDAP_F (int) ldap_pvt_tls_accept LDAP_P(( Sockbuf *sb, void *ctx_arg ));
367 LDAP_F (int) ldap_pvt_tls_inplace LDAP_P(( Sockbuf *sb ));
368 LDAP_F (void *) ldap_pvt_tls_sb_ctx LDAP_P(( Sockbuf *sb ));
369 LDAP_F (void) ldap_pvt_tls_ctx_free LDAP_P(( void * ));
371 typedef int LDAPDN_rewrite_dummy LDAP_P (( void *dn, unsigned flags ));
373 typedef int (LDAP_TLS_CONNECT_CB) LDAP_P (( struct ldap *ld, void *ssl,
374 void *ctx, void *arg ));
376 LDAP_F (int) ldap_pvt_tls_get_my_dn LDAP_P(( void *ctx, struct berval *dn,
377 LDAPDN_rewrite_dummy *func, unsigned flags ));
378 LDAP_F (int) ldap_pvt_tls_get_peer_dn LDAP_P(( void *ctx, struct berval *dn,
379 LDAPDN_rewrite_dummy *func, unsigned flags ));
380 LDAP_F (int) ldap_pvt_tls_get_strength LDAP_P(( void *ctx ));
385 * Multiple precision stuff
387 * May use OpenSSL's BIGNUM if built with TLS,
388 * or GNU's multiple precision library. But if
389 * long long is available, that's big enough
390 * and much more efficient.
392 * If none is available, unsigned long data is used.
399 * Use OpenSSL's BIGNUM
401 #include <openssl/crypto.h>
402 #include <openssl/bn.h>
404 typedef BIGNUM* ldap_pvt_mp_t;
405 #define LDAP_PVT_MP_INIT (NULL)
407 #define ldap_pvt_mp_init(mp) \
408 do { (mp) = BN_new(); } while (0)
410 /* FIXME: we rely on mpr being initialized */
411 #define ldap_pvt_mp_init_set(mpr,mpv) \
412 do { ldap_pvt_mp_init((mpr)); BN_add((mpr), (mpr), (mpv)); } while (0)
414 #define ldap_pvt_mp_add(mpr,mpv) \
415 BN_add((mpr), (mpr), (mpv))
417 #define ldap_pvt_mp_add_ulong(mp,v) \
418 BN_add_word((mp), (v))
420 #define ldap_pvt_mp_clear(mp) \
421 do { BN_free((mp)); (mp) = 0; } while (0)
423 #elif defined(USE_MP_GMP)
425 * Use GNU's multiple precision library
429 typedef mpz_t ldap_pvt_mp_t;
430 #define LDAP_PVT_MP_INIT { 0 }
432 #define ldap_pvt_mp_init(mp) \
435 #define ldap_pvt_mp_init_set(mpr,mpv) \
436 mpz_init_set((mpr), (mpv))
438 #define ldap_pvt_mp_add(mpr,mpv) \
439 mpz_add((mpr), (mpr), (mpv))
441 #define ldap_pvt_mp_add_ulong(mp,v) \
442 mpz_add_ui((mp), (mp), (v))
444 #define ldap_pvt_mp_clear(mp) \
449 * Use unsigned long long
452 #ifdef USE_MP_LONG_LONG
453 typedef unsigned long long ldap_pvt_mp_t;
454 #define LDAP_PVT_MP_INIT (0LL)
455 #elif defined(USE_MP_LONG)
456 typedef unsigned long ldap_pvt_mp_t;
457 #define LDAP_PVT_MP_INIT (0L)
458 #elif defined(HAVE_LONG_LONG)
459 typedef unsigned long long ldap_pvt_mp_t;
460 #define LDAP_PVT_MP_INIT (0LL)
462 typedef unsigned long ldap_pvt_mp_t;
463 #define LDAP_PVT_MP_INIT (0L)
466 #define ldap_pvt_mp_init(mp) \
467 do { (mp) = 0; } while (0)
469 #define ldap_pvt_mp_init_set(mpr,mpv) \
470 do { (mpr) = (mpv); } while (0)
472 #define ldap_pvt_mp_add(mpr,mpv) \
473 do { (mpr) += (mpv); } while (0)
475 #define ldap_pvt_mp_add_ulong(mp,v) \
476 do { (mp) += (v); } while (0)
478 #define ldap_pvt_mp_clear(mp) \
479 do { (mp) = 0; } while (0)
483 #include "ldap_pvt_uc.h"
489 #include <limits.h> /* get CHAR_BIT */
491 /* Buffer space for sign, decimal digits and \0. Note: log10(2) < 146/485. */
492 #define LDAP_PVT_INTTYPE_CHARS(type) (((sizeof(type)*CHAR_BIT-1)*146)/485 + 3)
496 #endif /* _LDAP_PVT_H */