2 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
3 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 * Copyright (c) 1995 Regents of the University of Michigan.
9 * ldap-int.h - defines & prototypes internal to the LDAP library
16 #define LDAP_THREAD_SAFE 1
19 #include "../liblber/lber-int.h"
21 #define ldap_debug (ldap_int_global_options.ldo_debug)
23 #define Debug( level, fmt, arg1, arg2, arg3 ) \
24 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
34 #define LDAP_URL_PREFIX "ldap://"
35 #define LDAP_URL_PREFIX_LEN 7
36 #define LDAP_URL_URLCOLON "URL:"
37 #define LDAP_URL_URLCOLON_LEN 4
38 #define NULLLDAPURLDESC ((LDAPURLDesc *)NULL)
40 #define LDAP_REF_STR "Referral:\n"
41 #define LDAP_REF_STR_LEN 10
42 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
43 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
45 #define LDAP_DEFAULT_REFHOPLIMIT 5
47 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
48 #define LDAP_DX_REF_STR "dx://"
49 #define LDAP_DX_REF_STR_LEN 5
50 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
52 #define LDAP_BOOL_REFERRALS 0
53 #define LDAP_BOOL_RESTART 1
54 #define LDAP_BOOL_DNS 2
56 #define LDAP_BOOLEANS unsigned long
57 #define LDAP_BOOL(n) (1 << (n))
58 #define LDAP_BOOL_GET(lo, bool) ((lo)->ldo_booleans & LDAP_BOOL(bool) \
59 ? LDAP_OPT_ON : LDAP_OPT_OFF)
60 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
61 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
62 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
65 * This structure represents both ldap messages and ldap responses.
66 * These are really the same, except in the case of search responses,
67 * where a response has multiple messages.
71 int lm_msgid; /* the message id */
72 int lm_msgtype; /* the message type */
73 BerElement *lm_ber; /* the ber encoded message contents */
74 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
75 struct ldapmsg *lm_next; /* next response */
76 time_t lm_time; /* used to maintain cache */
78 #define NULLMSG ((LDAPMessage *)NULL)
80 * structure representing get/set'able options
81 * which have global defaults.
85 #define LDAP_UNINITIALIZED 0x0
86 #define LDAP_INITIALIZED 0x1
87 #define LDAP_VALID_SESSION 0x2
91 int ldo_version; /* version to connect at */
100 #ifdef LDAP_CONNECTIONLESS
101 int ldo_cldaptries; /* connectionless search retry count */
102 int ldo_cldaptimeout;/* time between retries */
105 int ldo_refhoplimit; /* limit on referral nesting */
107 /* LDAPv3 server and client controls */
108 LDAPControl **ldo_sctrls;
109 LDAPControl **ldo_cctrls;
111 LDAP_BOOLEANS ldo_booleans; /* boolean options */
115 * structure for tracking LDAP server host, ports, DNs, etc.
117 typedef struct ldap_server {
119 char *lsrv_dn; /* if NULL, use default */
121 struct ldap_server *lsrv_next;
126 * structure for representing an LDAP server connection
128 typedef struct ldap_conn {
131 time_t lconn_lastused; /* time */
133 #define LDAP_CONNST_NEEDSOCKET 1
134 #define LDAP_CONNST_CONNECTING 2
135 #define LDAP_CONNST_CONNECTED 3
136 LDAPServer *lconn_server;
137 char *lconn_krbinstance;
138 struct ldap_conn *lconn_next;
139 BerElement *lconn_ber;/* ber receiving on this conn. */
144 * structure used to track outstanding requests
146 typedef struct ldapreq {
147 int lr_msgid; /* the message id */
148 int lr_status; /* status of request */
149 #define LDAP_REQST_INPROGRESS 1
150 #define LDAP_REQST_CHASINGREFS 2
151 #define LDAP_REQST_NOTCONNECTED 3
152 #define LDAP_REQST_WRITING 4
153 int lr_outrefcnt; /* count of outstanding referrals */
154 int lr_origid; /* original request's message id */
155 int lr_parentcnt; /* count of parent requests */
156 int lr_res_msgtype; /* result message type */
157 int lr_res_errno; /* result LDAP errno */
158 char *lr_res_error; /* result error string */
159 char *lr_res_matched;/* result matched DN string */
160 BerElement *lr_ber; /* ber encoded request contents */
161 LDAPConn *lr_conn; /* connection used to send request */
162 struct ldapreq *lr_parent; /* request that spawned this referral */
163 struct ldapreq *lr_refnext; /* next referral spawned */
164 struct ldapreq *lr_prev; /* previous request */
165 struct ldapreq *lr_next; /* next request */
169 * structure for client cache
171 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
172 typedef struct ldapcache {
173 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
174 LDAPMessage *lc_requests; /* unfulfilled reqs */
175 long lc_timeout; /* request timeout */
176 long lc_maxmem; /* memory to use */
177 long lc_memused; /* memory in use */
178 int lc_enabled; /* enabled? */
179 unsigned long lc_options; /* options */
180 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
181 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
183 #define NULLLDCACHE ((LDAPCache *)NULL)
186 * handy macro for checking if handle is connectionless
189 #define LDAP_IS_CLDAP(ld) ((ld)->ld_cldapnaddr>0)
192 * structure representing an ldap connection
196 Sockbuf ld_sb; /* socket descriptor & buffer */
198 struct ldapoptions ld_options;
200 #define ld_valid ld_options.ldo_valid
201 #define ld_debug ld_options.ldo_debug
203 #define ld_deref ld_options.ldo_deref
204 #define ld_timelimit ld_options.ldo_timelimit
205 #define ld_sizelimit ld_options.ldo_sizelimit
207 #define ld_defbase ld_options.ldo_defbase
208 #define ld_defhost ld_options.ldo_defhost
209 #define ld_defport ld_options.ldo_defport
211 #define ld_cldaptries ld_options.ldo_cldaptries
212 #define ld_cldaptimeout ld_options.ldo_cldaptimeout
213 #define ld_refhoplimit ld_options.ldo_refhoplimit
215 #define ld_sctrls ld_options.ldo_sctrls
216 #define ld_cctrls ld_options.ldo_cctrls
218 int ld_version; /* version connected at */
222 short ld_lberoptions;
224 LDAPFiltDesc *ld_filtd; /* from getfilter for ufn searches */
225 char *ld_ufnprefix; /* for incomplete ufn's */
232 /* do not mess with these */
233 LDAPRequest *ld_requests; /* list of outstanding requests */
234 LDAPMessage *ld_responses; /* list of outstanding responses */
236 int *ld_abandoned; /* array of abandoned requests */
238 LDAPCache *ld_cache; /* non-null if cache is initialized */
239 /* stuff used by connectionless searches. */
241 char *ld_cldapdn; /* DN used in connectionless search */
242 int ld_cldapnaddr; /* number of addresses */
243 void **ld_cldapaddrs;/* addresses to send request to */
245 /* do not mess with the rest though */
246 BERTranslateProc ld_lber_encode_translate_proc;
247 BERTranslateProc ld_lber_decode_translate_proc;
249 LDAPConn *ld_defconn; /* default connection */
250 LDAPConn *ld_conns; /* list of server connections */
251 void *ld_selectinfo; /* platform specifics for select */
252 int (*ld_rebindproc)( struct ldap *ld, char **dnp,
253 char **passwdp, int *authmethodp, int freeit );
254 /* routine to get info needed for re-bind */
256 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
262 extern struct ldapoptions ldap_int_global_options;
263 void ldap_int_initialize LDAP_P((void));
269 void ldap_int_utils_init LDAP_P(( void ));
275 int ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...));
280 void ldap_add_request_to_cache LDAP_P(( LDAP *ld, unsigned long msgtype,
281 BerElement *request ));
282 void ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
283 int ldap_check_cache LDAP_P(( LDAP *ld, unsigned long msgtype, BerElement *request ));
288 LDAPControl *ldap_control_dup LDAP_P((
289 const LDAPControl *ctrl ));
291 LDAPControl **ldap_controls_dup LDAP_P((
292 const LDAPControl **ctrls ));
294 int ldap_int_get_controls LDAP_P((
296 LDAPControl ***ctrlsp));
298 int ldap_int_put_controls LDAP_P((
306 int next_line_tokens LDAP_P(( char **bufp, long *blenp, char ***toksp ));
307 void free_strarray LDAP_P(( char **sap ));
313 char *ldap_get_kerberosv4_credentials LDAP_P((
315 LDAP_CONST char *who,
316 LDAP_CONST char *service,
319 #endif /* HAVE_KERBEROS */
325 int open_ldap_connection( LDAP *ld, Sockbuf *sb, const char *host, int defport,
326 char **krbinstancep, int async );
332 int ldap_connect_to_host( Sockbuf *sb, const char *host, unsigned long address, int port,
334 void ldap_close_connection( Sockbuf *sb );
337 char *ldap_host_connected_to( Sockbuf *sb );
338 #endif /* HAVE_KERBEROS */
340 int do_ldap_select( LDAP *ld, struct timeval *timeout );
341 void *ldap_new_select_info( void );
342 void ldap_free_select_info( void *sip );
343 void ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
344 void ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
345 void ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
346 int ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
347 int ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
353 int ldap_send_initial_request( LDAP *ld, unsigned long msgtype,
354 const char *dn, BerElement *ber );
355 BerElement *ldap_alloc_ber_with_options( LDAP *ld );
356 void ldap_set_ber_options( LDAP *ld, BerElement *ber );
358 int ldap_send_server_request( LDAP *ld, BerElement *ber, int msgid,
359 LDAPRequest *parentreq, LDAPServer *srvlist, LDAPConn *lc,
361 LDAPConn *ldap_new_connection( LDAP *ld, LDAPServer **srvlistp, int use_ldsb,
362 int connect, int bind );
363 LDAPRequest *ldap_find_request_by_msgid( LDAP *ld, int msgid );
364 void ldap_free_request( LDAP *ld, LDAPRequest *lr );
365 void ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
366 void ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
367 void ldap_dump_requests_and_responses( LDAP *ld );
369 int ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp );
370 int ldap_append_referral( LDAP *ld, char **referralsp, char *s );
375 #ifdef LDAP_CONNECTIONLESS
376 LDAP_F int cldap_getmsg ( LDAP *ld, struct timeval *timeout, BerElement *ber );
382 BerElement *ldap_build_search_req LDAP_P((
384 const char *base, int scope,
385 const char *filter, char **attrs, int attrsonly,
386 LDAPControl **sctrls,
387 LDAPControl **cctrls,
394 char *ldap_strdup LDAP_P(( const char * ));
399 int ldap_ld_free LDAP_P((
402 LDAPControl **sctrls,
403 LDAPControl **cctrls ));
405 int ldap_send_unbind LDAP_P((
408 LDAPControl **sctrls,
409 LDAPControl **cctrls ));
411 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
415 char **ldap_getdxbyname( const char *domain );
416 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
418 #if defined( STR_TRANSLATION ) && defined( LDAP_DEFAULT_CHARSET )
422 * added-in this stuff so that libldap.a would build, i.e. refs to
423 * these routines from open.c would resolve.
424 * hodges@stanford.edu 5-Feb-96
426 #if LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET
428 int ldap_t61_to_8859( char **bufp, unsigned long *buflenp, int free_input );
430 int ldap_8859_to_t61( char **bufp, unsigned long *buflenp, int free_input );
431 #endif /* LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET */
432 #endif /* STR_TRANSLATION && LDAP_DEFAULT_CHARSET */
436 #endif /* _LDAP_INT_H */