]> git.sur5r.net Git - openldap/blob - libraries/libldap/ldap-int.h
new rebind proc
[openldap] / libraries / libldap / ldap-int.h
1 /*  ldap-int.h - defines & prototypes internal to the LDAP library */
2 /* $OpenLDAP$ */
3 /*
4  * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6  */
7 /*  Portions
8  *  Copyright (c) 1995 Regents of the University of Michigan.
9  *  All rights reserved.
10  */
11
12 #ifndef _LDAP_INT_H
13 #define _LDAP_INT_H 1
14
15 #ifdef LDAP_R_COMPILE
16 #define LDAP_THREAD_SAFE 1
17 #endif
18
19 #include "../liblber/lber-int.h"
20
21 #ifdef HAVE_CYRUS_SASL
22         /* the need for this should be removed */
23 #include <sasl.h>
24
25 #define SASL_MAX_BUFF_SIZE      65536
26 #define SASL_MIN_BUFF_SIZE      4096
27 #endif
28
29 /* 
30  * Support needed if the library is running in the kernel
31  */
32 #if LDAP_INT_IN_KERNEL
33         /* 
34          * Platform specific function to return a pointer to the
35          * process-specific global options. 
36          *
37          * This function should perform the following functions:
38          *  Allocate and initialize a global options struct on a per process basis
39          *  Use callers process identifier to return its global options struct
40          *  Note: Deallocate structure when the process exits
41          */
42 #       define LDAP_INT_GLOBAL_OPT() ldap_int_global_opt()
43    struct ldapoptions *ldap_int_global_opt(void);
44 #else
45 #       define LDAP_INT_GLOBAL_OPT() (&ldap_int_global_options)
46 #endif
47
48 #define ldap_debug      ((LDAP_INT_GLOBAL_OPT())->ldo_debug)
49
50 #include "ldap_log.h"
51
52 #undef Debug
53 #define Debug( level, fmt, arg1, arg2, arg3 ) \
54         ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
55
56 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 )\
57         ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
58
59 #include "ldap.h"
60
61 #include "ldap_pvt.h"
62
63 LDAP_BEGIN_DECL
64
65 #define LDAP_URL_PREFIX         "ldap://"
66 #define LDAP_URL_PREFIX_LEN     (sizeof(LDAP_URL_PREFIX)-1)
67 #define LDAPS_URL_PREFIX                "ldaps://"
68 #define LDAPS_URL_PREFIX_LEN    (sizeof(LDAPS_URL_PREFIX)-1)
69 #define LDAPI_URL_PREFIX        "ldapi://"
70 #define LDAPI_URL_PREFIX_LEN    (sizeof(LDAPI_URL_PREFIX)-1)
71 #define LDAP_URL_URLCOLON               "URL:"
72 #define LDAP_URL_URLCOLON_LEN   (sizeof(LDAP_URL_URLCOLON)-1)
73
74 #define LDAP_REF_STR            "Referral:\n"
75 #define LDAP_REF_STR_LEN        (sizeof(LDAP_REF_STR)-1)
76 #define LDAP_LDAP_REF_STR       LDAP_URL_PREFIX
77 #define LDAP_LDAP_REF_STR_LEN   LDAP_URL_PREFIX_LEN
78
79 #define LDAP_DEFAULT_REFHOPLIMIT 5
80
81 #define LDAP_BOOL_REFERRALS             0
82 #define LDAP_BOOL_RESTART               1
83 #define LDAP_BOOL_TLS                   3
84
85 #define LDAP_BOOLEANS   unsigned long
86 #define LDAP_BOOL(n)    (1 << (n))
87 #define LDAP_BOOL_GET(lo, bool) \
88         ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
89 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
90 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
91 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
92
93 /*
94  * This structure represents both ldap messages and ldap responses.
95  * These are really the same, except in the case of search responses,
96  * where a response has multiple messages.
97  */
98
99 struct ldapmsg {
100         ber_int_t               lm_msgid;       /* the message id */
101         ber_tag_t               lm_msgtype;     /* the message type */
102         BerElement      *lm_ber;        /* the ber encoded message contents */
103         struct ldapmsg  *lm_chain;      /* for search - next msg in the resp */
104         struct ldapmsg  *lm_next;       /* next response */
105         time_t  lm_time;        /* used to maintain cache */
106 };
107
108 /*
109  * structure representing get/set'able options
110  * which have global defaults.
111  */
112 struct ldapoptions {
113         short ldo_valid;
114 #define LDAP_UNINITIALIZED      0x0
115 #define LDAP_INITIALIZED        0x1
116 #define LDAP_VALID_SESSION      0x2
117
118         int             ldo_debug;
119         /* per API call timeout */
120         struct timeval          *ldo_tm_api;
121         struct timeval          *ldo_tm_net;
122
123         ber_int_t               ldo_version;
124         ber_int_t               ldo_deref;
125         ber_int_t               ldo_timelimit;
126         ber_int_t               ldo_sizelimit;
127
128         LDAPURLDesc *ldo_defludp;
129         int             ldo_defport;
130         char*   ldo_defbase;
131         char*   ldo_defbinddn;  /* bind dn */
132
133 #ifdef HAVE_CYRUS_SASL
134         char*   ldo_def_sasl_mech;              /* SASL Mechanism(s) */
135         char*   ldo_def_sasl_realm;             /* SASL realm */
136         char*   ldo_def_sasl_authcid;   /* SASL authentication identity */
137         char*   ldo_def_sasl_authzid;   /* SASL authorization identity */
138
139         /* SASL Security Properties */
140         struct sasl_security_properties ldo_sasl_secprops;
141 #endif
142
143         int             ldo_refhoplimit;        /* limit on referral nesting */
144
145         /* LDAPv3 server and client controls */
146         LDAPControl     **ldo_sctrls;
147         LDAPControl **ldo_cctrls;
148
149         /* LDAP rebind callback function */
150         LDAP_REBIND_PROC *ldo_rebind_proc;
151         void *ldo_rebind_params;
152
153 #ifdef HAVE_TLS
154         /* tls context */
155         void            *ldo_tls_ctx;
156         int             ldo_tls_mode;
157 #endif
158         LDAP_BOOLEANS ldo_booleans;     /* boolean options */
159 };
160
161
162 /*
163  * structure for tracking LDAP server host, ports, DNs, etc.
164  */
165 typedef struct ldap_server {
166         char                    *lsrv_host;
167         char                    *lsrv_dn;       /* if NULL, use default */
168         int                     lsrv_port;
169         struct ldap_server      *lsrv_next;
170 } LDAPServer;
171
172
173 /*
174  * structure for representing an LDAP server connection
175  */
176 typedef struct ldap_conn {
177         Sockbuf         *lconn_sb;
178         void            *lconn_sasl_ctx;
179         int                     lconn_refcnt;
180         time_t          lconn_lastused; /* time */
181         int                     lconn_rebind_inprogress;        /* set if rebind in progress */
182         char            ***lconn_rebind_queue;          /* used if rebind in progress */
183         int                     lconn_status;
184 #define LDAP_CONNST_NEEDSOCKET          1
185 #define LDAP_CONNST_CONNECTING          2
186 #define LDAP_CONNST_CONNECTED           3
187         LDAPURLDesc             *lconn_server;
188 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
189         char                    *lconn_krbinstance;
190 #endif
191         struct ldap_conn        *lconn_next;
192         BerElement              *lconn_ber;/* ber receiving on this conn. */
193 } LDAPConn;
194
195
196 /*
197  * structure used to track outstanding requests
198  */
199 typedef struct ldapreq {
200         ber_int_t               lr_msgid;       /* the message id */
201         int             lr_status;      /* status of request */
202 #define LDAP_REQST_COMPLETED    0
203 #define LDAP_REQST_INPROGRESS   1
204 #define LDAP_REQST_CHASINGREFS  2
205 #define LDAP_REQST_NOTCONNECTED 3
206 #define LDAP_REQST_WRITING      4
207         int             lr_outrefcnt;   /* count of outstanding referrals */
208         ber_int_t               lr_origid;      /* original request's message id */
209         int             lr_parentcnt;   /* count of parent requests */
210         ber_tag_t               lr_res_msgtype; /* result message type */
211         ber_int_t               lr_res_errno;   /* result LDAP errno */
212         char            *lr_res_error;  /* result error string */
213         char            *lr_res_matched;/* result matched DN string */
214         BerElement      *lr_ber;        /* ber encoded request contents */
215         LDAPConn        *lr_conn;       /* connection used to send request */
216         struct ldapreq  *lr_parent;     /* request that spawned this referral */
217         struct ldapreq  *lr_refnext;    /* next referral spawned */
218         struct ldapreq  *lr_prev;       /* previous request */
219         struct ldapreq  *lr_next;       /* next request */
220 } LDAPRequest;
221
222 /*
223  * structure for client cache
224  */
225 #define LDAP_CACHE_BUCKETS      31      /* cache hash table size */
226 typedef struct ldapcache {
227         LDAPMessage     *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
228         LDAPMessage     *lc_requests;                   /* unfulfilled reqs */
229         long            lc_timeout;                     /* request timeout */
230         ber_len_t               lc_maxmem;                      /* memory to use */
231         ber_len_t               lc_memused;                     /* memory in use */
232         int             lc_enabled;                     /* enabled? */
233         unsigned long   lc_options;                     /* options */
234 #define LDAP_CACHE_OPT_CACHENOERRS      0x00000001
235 #define LDAP_CACHE_OPT_CACHEALLERRS     0x00000002
236 }  LDAPCache;
237
238 /*
239  * structure containing referral request info for rebind procedure
240  */
241 typedef struct ldapreqinfo {
242         ber_len_t       ri_msgid;
243         int                     ri_request;
244         char            *ri_url;
245 } LDAPreqinfo;
246
247 /*
248  * structure representing an ldap connection
249  */
250
251 struct ldap {
252         Sockbuf         *ld_sb;         /* socket descriptor & buffer */
253
254         struct ldapoptions ld_options;
255
256 #define ld_valid                ld_options.ldo_valid
257 #define ld_debug                ld_options.ldo_debug
258
259 #define ld_deref                ld_options.ldo_deref
260 #define ld_timelimit    ld_options.ldo_timelimit
261 #define ld_sizelimit    ld_options.ldo_sizelimit
262
263 #define ld_defbinddn    ld_options.ldo_defbinddn
264 #define ld_defbase              ld_options.ldo_defbase
265 #define ld_defhost              ld_options.ldo_defhost
266 #define ld_defport              ld_options.ldo_defport
267
268 #define ld_refhoplimit  ld_options.ldo_refhoplimit
269
270 #define ld_sctrls               ld_options.ldo_sctrls
271 #define ld_cctrls               ld_options.ldo_cctrls
272 #define ld_rebind_proc  ld_options.ldo_rebind_proc
273 #define ld_rebind_params        ld_options.ldo_rebind_params
274
275 #define ld_version              ld_options.ldo_version
276
277         char    *ld_host;
278         int             ld_port;
279
280         unsigned short  ld_lberoptions;
281
282         ber_int_t       ld_errno;
283         char    *ld_error;
284         char    *ld_matched;
285         ber_len_t               ld_msgid;
286
287         /* do not mess with these */
288         LDAPRequest     *ld_requests;   /* list of outstanding requests */
289         LDAPMessage     *ld_responses;  /* list of outstanding responses */
290
291         ber_int_t               *ld_abandoned;  /* array of abandoned requests */
292
293         LDAPCache       *ld_cache;      /* non-null if cache is initialized */
294
295         /* do not mess with the rest though */
296
297         LDAPConn        *ld_defconn;    /* default connection */
298         LDAPConn        *ld_conns;      /* list of server connections */
299         void            *ld_selectinfo; /* platform specifics for select */
300 };
301 #define LDAP_VALID(ld)  ( (ld)->ld_valid == LDAP_VALID_SESSION )
302
303 #ifdef LDAP_R_COMPILE
304 #include <ldap_pvt_thread.h>
305
306 #ifdef HAVE_RES_QUERY
307 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
308 #endif /* HAVE_RES_QUERY */
309
310 #ifdef HAVE_CYRUS_SASL
311 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
312 #endif
313 #endif
314
315 /*
316  * in init.c
317  */
318
319 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
320
321 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
322 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
323         struct ldapoptions *, int *));
324
325 /* memory.c */
326         /* simple macros to realloc for now */
327 #define LDAP_INT_MALLOC(s)              (LBER_MALLOC((s)))
328 #define LDAP_INT_CALLOC(n,s)    (LBER_CALLOC((n),(s)))
329 #define LDAP_INT_REALLOC(p,s)   (LBER_REALLOC((p),(s)))
330 #define LDAP_INT_FREE(p)                (LBER_FREE((p)))
331 #define LDAP_INT_VFREE(v)               (LBER_VFREE((void **)(v)))
332 #define LDAP_INT_STRDUP(s)              (LBER_STRDUP((s)))
333
334 #define LDAP_MALLOC(s)          (LBER_MALLOC((s)))
335 #define LDAP_CALLOC(n,s)        (LBER_CALLOC((n),(s)))
336 #define LDAP_REALLOC(p,s)       (LBER_REALLOC((p),(s)))
337 #define LDAP_FREE(p)            (LBER_FREE((p)))
338 #define LDAP_VFREE(v)           (LBER_VFREE((void **)(v)))
339 #define LDAP_STRDUP(s)          (LBER_STRDUP((s)))
340
341 /*
342  * in unit-int.c
343  */
344 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
345
346
347 /*
348  * in print.c
349  */
350 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
351
352 /*
353  * in cache.c
354  */
355 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
356         BerElement *request ));
357 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
358 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
359
360 /*
361  * in controls.c
362  */
363 LDAP_F (LDAPControl *) ldap_control_dup LDAP_P((
364         const LDAPControl *ctrl ));
365
366 LDAP_F (LDAPControl **) ldap_controls_dup LDAP_P((
367         LDAPControl *const *ctrls ));
368
369 LDAP_F (int) ldap_int_get_controls LDAP_P((
370         BerElement *be,
371         LDAPControl ***ctrlsp));
372
373 LDAP_F (int) ldap_int_put_controls LDAP_P((
374         LDAP *ld,
375         LDAPControl *const *ctrls,
376         BerElement *ber ));
377
378
379 /*
380  * in dsparse.c
381  */
382 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
383
384 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
385 /*
386  * in kerberos.c
387  */
388 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
389         LDAP *ld,
390         LDAP_CONST char *who,
391         LDAP_CONST char *service,
392         ber_len_t *len ));
393
394 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
395
396
397 /*
398  * in open.c
399  */
400 LDAP_F (int) ldap_open_defconn( LDAP *ld );
401 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
402         LDAPConn *conn, LDAPURLDesc *srvlist, int async );
403
404 /*
405  * in os-ip.c
406  */
407 LDAP_F (int) ldap_int_tblsize;
408 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm );
409 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
410         int proto, const char *host, unsigned long address, int port,
411         int async );
412
413 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
414 LDAP_V (char *) ldap_int_hostname;
415 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb );
416 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
417
418 LDAP_F (void) ldap_int_ip_init( void );
419 LDAP_F (int) do_ldap_select( LDAP *ld, struct timeval *timeout );
420 LDAP_F (void *) ldap_new_select_info( void );
421 LDAP_F (void) ldap_free_select_info( void *sip );
422 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
423 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
424 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
425 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
426 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
427
428 /*
429  * in os-local.c
430  */
431 #ifdef LDAP_PF_LOCAL
432 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
433         const char *path, int async );
434 #endif /* LDAP_PF_LOCAL */
435
436 /*
437  * in request.c
438  */
439 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
440         const char *dn, BerElement *ber );
441 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
442 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
443
444 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
445 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
446 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
447 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
448 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
449 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
450 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
451 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
452         char **errstrp, int sref, int *hadrefp );
453 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
454         char **refs, int sref, char **referralsp, int *hadrefp );
455 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
456
457 /*
458  * in result.c:
459  */
460 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
461
462 /*
463  * in search.c
464  */
465 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
466         LDAP *ld,
467         const char *base,
468         ber_int_t scope,
469         const char *filter,
470         char **attrs,
471         ber_int_t attrsonly,
472         LDAPControl **sctrls,
473         LDAPControl **cctrls,
474         ber_int_t timelimit,
475         ber_int_t sizelimit ));
476
477 /*
478  * in string.c
479  */
480         /* see <ac/string.h> */
481
482 /*
483  * in unbind.c
484  */
485 LDAP_F (int) ldap_ld_free LDAP_P((
486         LDAP *ld,
487         int close,
488         LDAPControl **sctrls,
489         LDAPControl **cctrls ));
490
491 LDAP_F (int) ldap_send_unbind LDAP_P((
492         LDAP *ld,
493         Sockbuf *sb,
494         LDAPControl **sctrls,
495         LDAPControl **cctrls ));
496
497 /*
498  * in url.c
499  */
500 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
501         LDAPURLDesc *ludp ));
502
503 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
504         LDAPURLDesc *ludlist ));
505
506 LDAP_F (int) ldap_url_parselist LDAP_P((
507         LDAPURLDesc **ludlist,
508         const char *url ));
509
510 LDAP_F (int) ldap_url_parsehosts LDAP_P((
511         LDAPURLDesc **ludlist,
512         const char *hosts,
513         int port ));
514
515 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
516         LDAPURLDesc *ludlist ));
517
518 LDAP_F (char *) ldap_url_list2urls LDAP_P((
519         LDAPURLDesc *ludlist ));
520
521 LDAP_F (void) ldap_free_urllist LDAP_P((
522         LDAPURLDesc *ludlist ));
523
524 /*
525  * in cyrus.c
526  */
527
528 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
529
530 LDAP_F (int) ldap_int_sasl_open LDAP_P((
531         LDAP *ld, LDAPConn *conn,
532         const char* host, ber_len_t ssf ));
533 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
534
535 LDAP_F (int) ldap_int_sasl_external LDAP_P((
536         LDAP *ld, const char* authid, ber_len_t ssf ));
537
538 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
539         int option, void *arg ));
540 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
541         int option, void *arg ));
542 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
543         int option, const char *arg ));
544
545 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
546         struct ldap *ld,
547         const char *,
548         const char *,
549         LDAPControl **, LDAPControl **,
550
551         /* should be passed in client controls */
552         unsigned flags,
553         LDAP_SASL_INTERACT_PROC *interact,
554         void *defaults ));
555
556
557 /*
558  * in tls.c
559  */
560 LDAP_F (int) ldap_int_tls_config LDAP_P(( struct ldapoptions *lo, int option, const char *arg ));
561
562 LDAP_END_DECL
563
564 #endif /* _LDAP_INT_H */