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