3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1995 Regents of the University of Michigan.
10 * ldap-int.h - defines & prototypes internal to the LDAP library
17 #define LDAP_THREAD_SAFE 1
20 #include "../liblber/lber-int.h"
22 #define ldap_debug (ldap_int_global_options.ldo_debug)
24 #define Debug( level, fmt, arg1, arg2, arg3 ) \
25 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
35 #define LDAP_URL_PREFIX "ldap://"
36 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
37 #define LDAPS_URL_PREFIX "ldaps://"
38 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
39 #define LDAP_URL_URLCOLON "URL:"
40 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
41 #define NULLLDAPURLDESC ((LDAPURLDesc *)NULL)
43 #define LDAP_REF_STR "Referral:\n"
44 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
45 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
46 #define LDAP_LDAP_REF_STR_LEN (sizeof(LDAP_LDAP_REF_STR)-1)
48 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
49 #define LDAP_DX_REF_STR "dx://"
50 #define LDAP_DX_REF_STR_LEN (sizeof(LDAP_DX_REF_STR)-1)
51 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
53 #define LDAP_DEFAULT_REFHOPLIMIT 5
55 #define LDAP_BOOL_REFERRALS 0
56 #define LDAP_BOOL_RESTART 1
57 #define LDAP_BOOL_DNS 2
58 #define LDAP_BOOL_TLS 3
60 #define LDAP_BOOLEANS unsigned long
61 #define LDAP_BOOL(n) (1 << (n))
62 #define LDAP_BOOL_GET(lo, bool) ((lo)->ldo_booleans & LDAP_BOOL(bool) \
64 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
65 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
66 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
69 * This structure represents both ldap messages and ldap responses.
70 * These are really the same, except in the case of search responses,
71 * where a response has multiple messages.
75 ber_int_t lm_msgid; /* the message id */
76 ber_tag_t lm_msgtype; /* the message type */
77 BerElement *lm_ber; /* the ber encoded message contents */
78 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
79 struct ldapmsg *lm_next; /* next response */
80 time_t lm_time; /* used to maintain cache */
84 * structure representing get/set'able options
85 * which have global defaults.
89 #define LDAP_UNINITIALIZED 0x0
90 #define LDAP_INITIALIZED 0x1
91 #define LDAP_VALID_SESSION 0x2
94 /* per API call timeout */
95 struct timeval *ldo_tm_api;
96 struct timeval *ldo_tm_net;
98 ber_int_t ldo_version; /* version to connect at */
100 ber_int_t ldo_timelimit;
101 ber_int_t ldo_sizelimit;
103 LDAPURLDesc *ldo_defludp;
106 char* ldo_defbinddn; /* simple bind dn */
108 #ifdef LDAP_CONNECTIONLESS
109 int ldo_cldaptries; /* connectionless search retry count */
110 int ldo_cldaptimeout;/* time between retries */
113 int ldo_refhoplimit; /* limit on referral nesting */
115 /* LDAPv3 server and client controls */
116 LDAPControl **ldo_sctrls;
117 LDAPControl **ldo_cctrls;
124 LDAP_BOOLEANS ldo_booleans; /* boolean options */
129 * structure for tracking LDAP server host, ports, DNs, etc.
131 typedef struct ldap_server {
133 char *lsrv_dn; /* if NULL, use default */
135 struct ldap_server *lsrv_next;
140 * structure for representing an LDAP server connection
142 typedef struct ldap_conn {
145 time_t lconn_lastused; /* time */
147 #define LDAP_CONNST_NEEDSOCKET 1
148 #define LDAP_CONNST_CONNECTING 2
149 #define LDAP_CONNST_CONNECTED 3
150 LDAPURLDesc *lconn_server;
151 char *lconn_krbinstance;
152 struct ldap_conn *lconn_next;
153 BerElement *lconn_ber;/* ber receiving on this conn. */
158 * structure used to track outstanding requests
160 typedef struct ldapreq {
161 ber_int_t lr_msgid; /* the message id */
162 int lr_status; /* status of request */
163 #define LDAP_REQST_INPROGRESS 1
164 #define LDAP_REQST_CHASINGREFS 2
165 #define LDAP_REQST_NOTCONNECTED 3
166 #define LDAP_REQST_WRITING 4
167 int lr_outrefcnt; /* count of outstanding referrals */
168 ber_int_t lr_origid; /* original request's message id */
169 int lr_parentcnt; /* count of parent requests */
170 ber_tag_t lr_res_msgtype; /* result message type */
171 ber_int_t lr_res_errno; /* result LDAP errno */
172 char *lr_res_error; /* result error string */
173 char *lr_res_matched;/* result matched DN string */
174 BerElement *lr_ber; /* ber encoded request contents */
175 LDAPConn *lr_conn; /* connection used to send request */
176 struct ldapreq *lr_parent; /* request that spawned this referral */
177 struct ldapreq *lr_refnext; /* next referral spawned */
178 struct ldapreq *lr_prev; /* previous request */
179 struct ldapreq *lr_next; /* next request */
183 * structure for client cache
185 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
186 typedef struct ldapcache {
187 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
188 LDAPMessage *lc_requests; /* unfulfilled reqs */
189 long lc_timeout; /* request timeout */
190 ber_len_t lc_maxmem; /* memory to use */
191 ber_len_t lc_memused; /* memory in use */
192 int lc_enabled; /* enabled? */
193 unsigned long lc_options; /* options */
194 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
195 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
199 * handy macro for checking if handle is connectionless
202 #define LDAP_IS_CLDAP(ld) ((ld)->ld_cldapnaddr>0)
205 * structure representing an ldap connection
209 Sockbuf ld_sb; /* socket descriptor & buffer */
211 struct ldapoptions ld_options;
213 #define ld_valid ld_options.ldo_valid
214 #define ld_debug ld_options.ldo_debug
216 #define ld_deref ld_options.ldo_deref
217 #define ld_timelimit ld_options.ldo_timelimit
218 #define ld_sizelimit ld_options.ldo_sizelimit
220 #define ld_defbinddn ld_options.ldo_defbinddn
221 #define ld_defbase ld_options.ldo_defbase
222 #define ld_defhost ld_options.ldo_defhost
223 #define ld_defport ld_options.ldo_defport
225 #define ld_cldaptries ld_options.ldo_cldaptries
226 #define ld_cldaptimeout ld_options.ldo_cldaptimeout
227 #define ld_refhoplimit ld_options.ldo_refhoplimit
229 #define ld_sctrls ld_options.ldo_sctrls
230 #define ld_cctrls ld_options.ldo_cctrls
232 ber_int_t ld_version; /* version connected at */
236 unsigned short ld_lberoptions;
238 LDAPFiltDesc *ld_filtd; /* from getfilter for ufn searches */
239 char *ld_ufnprefix; /* for incomplete ufn's */
246 /* do not mess with these */
247 LDAPRequest *ld_requests; /* list of outstanding requests */
248 LDAPMessage *ld_responses; /* list of outstanding responses */
250 ber_int_t *ld_abandoned; /* array of abandoned requests */
252 LDAPCache *ld_cache; /* non-null if cache is initialized */
253 /* stuff used by connectionless searches. */
255 char *ld_cldapdn; /* DN used in connectionless search */
256 int ld_cldapnaddr; /* number of addresses */
257 void **ld_cldapaddrs;/* addresses to send request to */
259 /* do not mess with the rest though */
260 BERTranslateProc ld_lber_encode_translate_proc;
261 BERTranslateProc ld_lber_decode_translate_proc;
263 LDAPConn *ld_defconn; /* default connection */
264 LDAPConn *ld_conns; /* list of server connections */
265 void *ld_selectinfo; /* platform specifics for select */
266 int (*ld_rebindproc)( struct ldap *ld, char **dnp,
267 char **passwdp, int *authmethodp, int freeit );
268 /* routine to get info needed for re-bind */
270 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
276 LIBLDAP_F ( struct ldapoptions ) ldap_int_global_options;
277 LIBLDAP_F ( void ) ldap_int_initialize LDAP_P((void));
281 /* simple macros to realloc for now */
282 #define LDAP_INT_MALLOC(s) (LBER_MALLOC((s)))
283 #define LDAP_INT_CALLOC(n,s) (LBER_CALLOC((n),(s)))
284 #define LDAP_INT_REALLOC(p,s) (LBER_REALLOC((p),(s)))
285 #define LDAP_INT_FREE(p) (LBER_FREE((p)))
286 #define LDAP_INT_VFREE(v) (LBER_VFREE((void **)(v)))
287 #define LDAP_INT_STRDUP(s) (LBER_STRDUP((s)))
289 #define LDAP_MALLOC(s) (LBER_MALLOC((s)))
290 #define LDAP_CALLOC(n,s) (LBER_CALLOC((n),(s)))
291 #define LDAP_REALLOC(p,s) (LBER_REALLOC((p),(s)))
292 #define LDAP_FREE(p) (LBER_FREE((p)))
293 #define LDAP_VFREE(v) (LBER_VFREE((void **)(v)))
294 #define LDAP_STRDUP(s) (LBER_STRDUP((s)))
299 LIBLDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
305 LIBLDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
310 LIBLDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
311 BerElement *request ));
312 LIBLDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
313 LIBLDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
318 LIBLDAP_F (LDAPControl *) ldap_control_dup LDAP_P((
319 const LDAPControl *ctrl ));
321 LIBLDAP_F (LDAPControl **) ldap_controls_dup LDAP_P((
322 LDAPControl *const *ctrls ));
324 LIBLDAP_F (int) ldap_int_get_controls LDAP_P((
326 LDAPControl ***ctrlsp));
328 LIBLDAP_F (int) ldap_int_put_controls LDAP_P((
330 LDAPControl *const *ctrls,
336 LIBLDAP_F (int) next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
337 LIBLDAP_F (void) free_strarray LDAP_P(( char **sap ));
343 LIBLDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
345 LDAP_CONST char *who,
346 LDAP_CONST char *service,
349 #endif /* HAVE_KERBEROS */
355 LIBLDAP_F (int) ldap_open_defconn( LDAP *ld );
356 LIBLDAP_F (int) open_ldap_connection( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srvlist, char **krbinstancep, int async );
362 LIBLDAP_F (int) ldap_int_tblsize;
363 LIBLDAP_F (int) ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm );
364 LIBLDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb, const char *host, unsigned long address, int port, int async );
366 LIBLDAP_F (void) ldap_close_connection( Sockbuf *sb );
369 LIBLDAP_F (char *) ldap_host_connected_to( Sockbuf *sb );
370 #endif /* HAVE_KERBEROS */
372 LIBLDAP_F (void) ldap_int_ip_init( void );
373 LIBLDAP_F (int) do_ldap_select( LDAP *ld, struct timeval *timeout );
374 LIBLDAP_F (void *) ldap_new_select_info( void );
375 LIBLDAP_F (void) ldap_free_select_info( void *sip );
376 LIBLDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
377 LIBLDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
378 LIBLDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
379 LIBLDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
380 LIBLDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
386 LIBLDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
387 const char *dn, BerElement *ber );
388 LIBLDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
389 LIBLDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
391 LIBLDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, int bind );
392 LIBLDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, int bind );
393 LIBLDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
394 LIBLDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
395 LIBLDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
396 LIBLDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
397 LIBLDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
399 LIBLDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp );
400 LIBLDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
405 #ifdef LDAP_CONNECTIONLESS
406 LIBLDAP_F (int) cldap_getmsg( LDAP *ld, struct timeval *timeout, BerElement *ber );
412 LIBLDAP_F (BerElement *) ldap_build_search_req LDAP_P((
419 LDAPControl **sctrls,
420 LDAPControl **cctrls,
422 ber_int_t sizelimit ));
427 /* see <ac/string.h> */
432 LIBLDAP_F (int) ldap_ld_free LDAP_P((
435 LDAPControl **sctrls,
436 LDAPControl **cctrls ));
438 LIBLDAP_F (int) ldap_send_unbind LDAP_P((
441 LDAPControl **sctrls,
442 LDAPControl **cctrls ));
447 LIBLDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
448 LDAPURLDesc *ludp ));
450 LIBLDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
451 LDAPURLDesc *ludlist ));
453 LIBLDAP_F (int) ldap_url_parselist LDAP_P((
454 LDAPURLDesc **ludlist,
457 LIBLDAP_F (int) ldap_url_parsehosts LDAP_P((
458 LDAPURLDesc **ludlist,
459 const char *hosts ));
461 LIBLDAP_F (char *) ldap_url_list2hosts LDAP_P((
462 LDAPURLDesc *ludlist ));
464 LIBLDAP_F (char *) ldap_url_list2urls LDAP_P((
465 LDAPURLDesc *ludlist ));
467 LIBLDAP_F (void) ldap_free_urllist LDAP_P((
468 LDAPURLDesc *ludlist ));
471 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
475 LIBLDAP_F (char **) ldap_getdxbyname( const char *domain );
476 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
478 #if defined( STR_TRANSLATION ) && defined( LDAP_DEFAULT_CHARSET )
482 * added-in this stuff so that libldap.a would build, i.e. refs to
483 * these routines from open.c would resolve.
484 * hodges@stanford.edu 5-Feb-96
486 #if LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET
487 LIBLDAP_F (int) ldap_t61_to_8859( char **bufp, ber_len_t *buflenp, int free_input );
488 LIBLDAP_F (int) ldap_8859_to_t61( char **bufp, ber_len_t *buflenp, int free_input );
489 #endif /* LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET */
490 #endif /* STR_TRANSLATION && LDAP_DEFAULT_CHARSET */
494 #endif /* _LDAP_INT_H */