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 (openldap_ldap_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 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
41 #define LDAP_REF_STR "Referral:\n"
42 #define LDAP_REF_STR_LEN 10
43 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
44 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
45 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
46 #define LDAP_DX_REF_STR "dx://"
47 #define LDAP_DX_REF_STR_LEN 5
48 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
49 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
51 #define LDAP_BOOL_REFERRALS 0
52 #define LDAP_BOOL_RESTART 1
53 #define LDAP_BOOL_DNS 2
55 #define LDAP_BOOLEANS unsigned long
56 #define LDAP_BOOL(n) (1 << (n))
57 #define LDAP_BOOL_GET(lo, bool) ((lo)->ldo_booleans & LDAP_BOOL(bool) \
58 ? LDAP_OPT_ON : LDAP_OPT_OFF)
59 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
60 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
61 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
64 * This structure represents both ldap messages and ldap responses.
65 * These are really the same, except in the case of search responses,
66 * where a response has multiple messages.
70 int lm_msgid; /* the message id */
71 int lm_msgtype; /* the message type */
72 BerElement *lm_ber; /* the ber encoded message contents */
73 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
74 struct ldapmsg *lm_next; /* next response */
75 unsigned int lm_time; /* used to maintain cache */
77 #define NULLMSG ((LDAPMessage *)NULL)
79 * structure representing get/set'able options
80 * which have global defaults.
85 int ldo_version; /* version to connect at */
94 int ldo_cldaptries; /* connectionless search retry count */
95 int ldo_cldaptimeout;/* time between retries */
96 int ldo_refhoplimit; /* limit on referral nesting */
98 /* LDAPv3 server and client controls */
99 LDAPControl **ldo_sctrls;
100 LDAPControl **ldo_cctrls;
102 LDAP_BOOLEANS ldo_booleans; /* boolean options */
105 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
107 * structure for tracking LDAP server host, ports, DNs, etc.
109 typedef struct ldap_server {
111 char *lsrv_dn; /* if NULL, use default */
113 struct ldap_server *lsrv_next;
118 * structure for representing an LDAP server connection
120 typedef struct ldap_conn {
123 time_t lconn_lastused; /* time */
125 #define LDAP_CONNST_NEEDSOCKET 1
126 #define LDAP_CONNST_CONNECTING 2
127 #define LDAP_CONNST_CONNECTED 3
128 LDAPServer *lconn_server;
129 char *lconn_krbinstance;
130 struct ldap_conn *lconn_next;
131 BerElement lconn_ber;/* ber receiving on this conn. */
136 * structure used to track outstanding requests
138 typedef struct ldapreq {
139 int lr_msgid; /* the message id */
140 int lr_status; /* status of request */
141 #define LDAP_REQST_INPROGRESS 1
142 #define LDAP_REQST_CHASINGREFS 2
143 #define LDAP_REQST_NOTCONNECTED 3
144 #define LDAP_REQST_WRITING 4
145 int lr_outrefcnt; /* count of outstanding referrals */
146 int lr_origid; /* original request's message id */
147 int lr_parentcnt; /* count of parent requests */
148 int lr_res_msgtype; /* result message type */
149 int lr_res_errno; /* result LDAP errno */
150 char *lr_res_error; /* result error string */
151 char *lr_res_matched;/* result matched DN string */
152 BerElement *lr_ber; /* ber encoded request contents */
153 LDAPConn *lr_conn; /* connection used to send request */
154 struct ldapreq *lr_parent; /* request that spawned this referral */
155 struct ldapreq *lr_refnext; /* next referral spawned */
156 struct ldapreq *lr_prev; /* previous request */
157 struct ldapreq *lr_next; /* next request */
159 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
162 * structure for client cache
164 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
165 typedef struct ldapcache {
166 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
167 LDAPMessage *lc_requests; /* unfulfilled reqs */
168 long lc_timeout; /* request timeout */
169 long lc_maxmem; /* memory to use */
170 long lc_memused; /* memory in use */
171 int lc_enabled; /* enabled? */
172 unsigned long lc_options; /* options */
173 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
174 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
176 #define NULLLDCACHE ((LDAPCache *)NULL)
179 * handy macro for checking if handle is connectionless
182 #define LDAP_IS_CLDAP(ld) ((ld)->ld_cldapnaddr>0)
185 * structure representing an ldap connection
189 Sockbuf ld_sb; /* socket descriptor & buffer */
191 struct ldapoptions ld_options;
193 #define ld_deref ld_options.ldo_deref
194 #define ld_timelimit ld_options.ldo_timelimit
195 #define ld_sizelimit ld_options.ldo_sizelimit
197 #define ld_defbase ld_options.ldo_defbase
198 #define ld_defhost ld_options.ldo_defhost
199 #define ld_defport ld_options.ldo_defport
201 #define ld_cldaptries ld_options.ldo_cldaptries
202 #define ld_cldaptimeout ld_options.ldo_cldaptimeout
203 #define ld_refhoplimit ld_options.ldo_refhoplimit
205 #define ld_sctrls ld_options.ldo_sctrls
206 #define ld_cctrls ld_options.ldo_cctrls
208 int ld_version; /* version connected at */
212 short ld_lberoptions;
214 LDAPFiltDesc *ld_filtd; /* from getfilter for ufn searches */
215 char *ld_ufnprefix; /* for incomplete ufn's */
222 /* do not mess with these */
223 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
224 LDAPRequest *ld_requests; /* list of outstanding requests */
225 #else /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
226 LDAPMessage *ld_requests; /* list of outstanding requests */
227 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
228 LDAPMessage *ld_responses; /* list of outstanding responses */
229 int *ld_abandoned; /* array of abandoned requests */
230 char ld_attrbuffer[LDAP_MAX_ATTR_LEN];
231 LDAPCache *ld_cache; /* non-null if cache is initialized */
232 /* stuff used by connectionless searches. */
233 char *ld_cldapdn; /* DN used in connectionless search */
234 int ld_cldapnaddr; /* number of addresses */
235 void **ld_cldapaddrs;/* addresses to send request to */
236 #ifndef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
237 /* BerElement that this connection is receiving. */
240 /* do not mess with the rest though */
241 BERTranslateProc ld_lber_encode_translate_proc;
242 BERTranslateProc ld_lber_decode_translate_proc;
244 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
245 LDAPConn *ld_defconn; /* default connection */
246 LDAPConn *ld_conns; /* list of server connections */
247 void *ld_selectinfo; /* platform specifics for select */
248 int (*ld_rebindproc)( struct ldap *ld, char **dnp,
249 char **passwdp, int *authmethodp, int freeit );
250 /* routine to get info needed for re-bind */
251 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
257 extern int openldap_ldap_initialized;
258 extern struct ldapoptions openldap_ldap_global_options;
259 void openldap_ldap_initialize LDAP_P((void));
264 int ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...));
269 void ldap_add_request_to_cache LDAP_P(( LDAP *ld, unsigned long msgtype,
270 BerElement *request ));
271 void ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
272 int ldap_check_cache LDAP_P(( LDAP *ld, unsigned long msgtype, BerElement *request ));
277 LDAPControl *ldap_control_dup LDAP_P(( const LDAPControl *ctrl ));
278 LDAPControl **ldap_controls_dup LDAP_P(( const LDAPControl **ctrls ));
280 int ldap_int_get_controls LDAP_P((
284 int ldap_int_put_controls LDAP_P((
292 int next_line_tokens LDAP_P(( char **bufp, long *blenp, char ***toksp ));
293 void free_strarray LDAP_P(( char **sap ));
299 char *ldap_get_kerberosv4_credentials LDAP_P(( LDAP *ld, char *who, char *service,
302 #endif /* HAVE_KERBEROS */
308 int open_ldap_connection( LDAP *ld, Sockbuf *sb, const char *host, int defport,
309 char **krbinstancep, int async );
315 int ldap_connect_to_host( Sockbuf *sb, const char *host, unsigned long address, int port,
317 void ldap_close_connection( Sockbuf *sb );
320 char *ldap_host_connected_to( Sockbuf *sb );
321 #endif /* HAVE_KERBEROS */
323 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
324 int do_ldap_select( LDAP *ld, struct timeval *timeout );
325 void *ldap_new_select_info( void );
326 void ldap_free_select_info( void *sip );
327 void ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
328 void ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
329 void ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
330 int ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
331 int ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
332 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
338 int ldap_send_initial_request( LDAP *ld, unsigned long msgtype,
339 const char *dn, BerElement *ber );
340 BerElement *ldap_alloc_ber_with_options( LDAP *ld );
341 void ldap_set_ber_options( LDAP *ld, BerElement *ber );
343 #if defined( LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS ) \
344 || defined( LDAP_API_FEATURE_X_OPENLDAP_V2_DNS )
345 int ldap_send_server_request( LDAP *ld, BerElement *ber, int msgid,
346 LDAPRequest *parentreq, LDAPServer *srvlist, LDAPConn *lc,
348 LDAPConn *ldap_new_connection( LDAP *ld, LDAPServer **srvlistp, int use_ldsb,
349 int connect, int bind );
350 LDAPRequest *ldap_find_request_by_msgid( LDAP *ld, int msgid );
351 void ldap_free_request( LDAP *ld, LDAPRequest *lr );
352 void ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
353 void ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
354 void ldap_dump_requests_and_responses( LDAP *ld );
355 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS || LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
357 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
358 int ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp );
359 int ldap_append_referral( LDAP *ld, char **referralsp, char *s );
360 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
365 #ifdef LDAP_CONNECTIONLESS
366 LDAP_F int cldap_getmsg ( LDAP *ld, struct timeval *timeout, BerElement *ber );
372 BerElement *ldap_build_search_req( LDAP *ld, const char *base, int scope,
373 const char *filter, char **attrs, int attrsonly,
374 LDAPControl **sctrls, LDAPControl **cctrls );
379 char *ldap_strdup LDAP_P(( const char * ));
384 int ldap_ld_free LDAP_P((
387 LDAPControl **sctrls,
388 LDAPControl **cctrls ));
390 int ldap_send_unbind LDAP_P((
393 LDAPControl **sctrls,
394 LDAPControl **cctrls ));
396 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
400 char **ldap_getdxbyname( const char *domain );
401 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
403 #if defined( STR_TRANSLATION ) && defined( LDAP_DEFAULT_CHARSET )
407 * added-in this stuff so that libldap.a would build, i.e. refs to
408 * these routines from open.c would resolve.
409 * hodges@stanford.edu 5-Feb-96
411 #if LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET
413 int ldap_t61_to_8859( char **bufp, unsigned long *buflenp, int free_input );
415 int ldap_8859_to_t61( char **bufp, unsigned long *buflenp, int free_input );
416 #endif /* LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET */
417 #endif /* STR_TRANSLATION && LDAP_DEFAULT_CHARSET */
421 #endif /* _LDAP_INT_H */