]> git.sur5r.net Git - openldap/blob - libraries/libldap/ldap-int.h
suffix option; allows partial replication of a database
[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 #ifdef HAVE_TLS
129         int                     ldo_tls_mode;
130 #endif
131
132         LDAPURLDesc *ldo_defludp;
133         int             ldo_defport;
134         char*   ldo_defbase;
135         char*   ldo_defbinddn;  /* bind dn */
136
137 #ifdef HAVE_CYRUS_SASL
138         char*   ldo_def_sasl_mech;              /* SASL Mechanism(s) */
139         char*   ldo_def_sasl_realm;             /* SASL realm */
140         char*   ldo_def_sasl_authcid;   /* SASL authentication identity */
141         char*   ldo_def_sasl_authzid;   /* SASL authorization identity */
142
143         /* SASL Security Properties */
144         struct sasl_security_properties ldo_sasl_secprops;
145 #endif
146
147         int             ldo_refhoplimit;        /* limit on referral nesting */
148
149         /* LDAPv3 server and client controls */
150         LDAPControl     **ldo_sctrls;
151         LDAPControl **ldo_cctrls;
152
153         /* LDAP rebind callback function */
154         LDAP_REBIND_PROC *ldo_rebind_proc;
155         void *ldo_rebind_params;
156
157         LDAP_BOOLEANS ldo_booleans;     /* boolean options */
158 };
159
160
161 /*
162  * structure for representing an LDAP server connection
163  */
164 typedef struct ldap_conn {
165         Sockbuf         *lconn_sb;
166 #ifdef HAVE_TLS
167         /* tls context */
168         void            *lconn_tls_ctx;
169 #endif
170 #ifdef HAVE_CYRUS_SASL
171         void            *lconn_sasl_ctx;
172 #endif
173         int                     lconn_refcnt;
174         time_t          lconn_lastused; /* time */
175         int                     lconn_rebind_inprogress;        /* set if rebind in progress */
176         char            ***lconn_rebind_queue;          /* used if rebind in progress */
177         int                     lconn_status;
178 #define LDAP_CONNST_NEEDSOCKET          1
179 #define LDAP_CONNST_CONNECTING          2
180 #define LDAP_CONNST_CONNECTED           3
181         LDAPURLDesc             *lconn_server;
182 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
183         char                    *lconn_krbinstance;
184 #endif
185         BerElement              *lconn_ber;     /* ber receiving on this conn. */
186
187         struct ldap_conn        *lconn_next;
188 } LDAPConn;
189
190
191 /*
192  * structure used to track outstanding requests
193  */
194 typedef struct ldapreq {
195         ber_int_t               lr_msgid;       /* the message id */
196         int             lr_status;      /* status of request */
197 #define LDAP_REQST_COMPLETED    0
198 #define LDAP_REQST_INPROGRESS   1
199 #define LDAP_REQST_CHASINGREFS  2
200 #define LDAP_REQST_NOTCONNECTED 3
201 #define LDAP_REQST_WRITING      4
202         int             lr_outrefcnt;   /* count of outstanding referrals */
203         ber_int_t               lr_origid;      /* original request's message id */
204         int             lr_parentcnt;   /* count of parent requests */
205         ber_tag_t               lr_res_msgtype; /* result message type */
206         ber_int_t               lr_res_errno;   /* result LDAP errno */
207         char            *lr_res_error;  /* result error string */
208         char            *lr_res_matched;/* result matched DN string */
209         BerElement      *lr_ber;        /* ber encoded request contents */
210         LDAPConn        *lr_conn;       /* connection used to send request */
211         struct ldapreq  *lr_parent;     /* request that spawned this referral */
212         struct ldapreq  *lr_refnext;    /* next referral spawned */
213         struct ldapreq  *lr_prev;       /* previous request */
214         struct ldapreq  *lr_next;       /* next request */
215 } LDAPRequest;
216
217 /*
218  * structure for client cache
219  */
220 #define LDAP_CACHE_BUCKETS      31      /* cache hash table size */
221 typedef struct ldapcache {
222         LDAPMessage     *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
223         LDAPMessage     *lc_requests;                   /* unfulfilled reqs */
224         long            lc_timeout;                     /* request timeout */
225         ber_len_t               lc_maxmem;                      /* memory to use */
226         ber_len_t               lc_memused;                     /* memory in use */
227         int             lc_enabled;                     /* enabled? */
228         unsigned long   lc_options;                     /* options */
229 #define LDAP_CACHE_OPT_CACHENOERRS      0x00000001
230 #define LDAP_CACHE_OPT_CACHEALLERRS     0x00000002
231 }  LDAPCache;
232
233 /*
234  * structure containing referral request info for rebind procedure
235  */
236 typedef struct ldapreqinfo {
237         ber_len_t       ri_msgid;
238         int                     ri_request;
239         char            *ri_url;
240 } LDAPreqinfo;
241
242 /*
243  * structure representing an ldap connection
244  */
245
246 struct ldap {
247         Sockbuf         *ld_sb;         /* socket descriptor & buffer */
248
249         struct ldapoptions ld_options;
250
251 #define ld_valid                ld_options.ldo_valid
252 #define ld_debug                ld_options.ldo_debug
253
254 #define ld_deref                ld_options.ldo_deref
255 #define ld_timelimit    ld_options.ldo_timelimit
256 #define ld_sizelimit    ld_options.ldo_sizelimit
257
258 #define ld_defbinddn    ld_options.ldo_defbinddn
259 #define ld_defbase              ld_options.ldo_defbase
260 #define ld_defhost              ld_options.ldo_defhost
261 #define ld_defport              ld_options.ldo_defport
262
263 #define ld_refhoplimit  ld_options.ldo_refhoplimit
264
265 #define ld_sctrls               ld_options.ldo_sctrls
266 #define ld_cctrls               ld_options.ldo_cctrls
267 #define ld_rebind_proc  ld_options.ldo_rebind_proc
268 #define ld_rebind_params        ld_options.ldo_rebind_params
269
270 #define ld_version              ld_options.ldo_version
271
272         unsigned short  ld_lberoptions;
273
274         ber_int_t       ld_errno;
275         char    *ld_error;
276         char    *ld_matched;
277         ber_len_t               ld_msgid;
278
279         /* do not mess with these */
280         LDAPRequest     *ld_requests;   /* list of outstanding requests */
281         LDAPMessage     *ld_responses;  /* list of outstanding responses */
282
283         ber_int_t               *ld_abandoned;  /* array of abandoned requests */
284
285         LDAPCache       *ld_cache;      /* non-null if cache is initialized */
286
287         /* do not mess with the rest though */
288
289         LDAPConn        *ld_defconn;    /* default connection */
290         LDAPConn        *ld_conns;      /* list of server connections */
291         void            *ld_selectinfo; /* platform specifics for select */
292 };
293 #define LDAP_VALID(ld)  ( (ld)->ld_valid == LDAP_VALID_SESSION )
294
295 #ifdef LDAP_R_COMPILE
296 #include <ldap_pvt_thread.h>
297
298 #ifdef HAVE_RES_QUERY
299 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
300 #endif
301
302 #ifdef HAVE_CYRUS_SASL
303 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
304 #endif
305 #endif
306
307 /*
308  * in init.c
309  */
310
311 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
312
313 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
314 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
315         struct ldapoptions *, int *));
316
317 /* memory.c */
318         /* simple macros to realloc for now */
319 #define LDAP_INT_MALLOC(s)              (LBER_MALLOC((s)))
320 #define LDAP_INT_CALLOC(n,s)    (LBER_CALLOC((n),(s)))
321 #define LDAP_INT_REALLOC(p,s)   (LBER_REALLOC((p),(s)))
322 #define LDAP_INT_FREE(p)                (LBER_FREE((p)))
323 #define LDAP_INT_VFREE(v)               (LBER_VFREE((void **)(v)))
324 #define LDAP_INT_STRDUP(s)              (LBER_STRDUP((s)))
325
326 #define LDAP_MALLOC(s)          (LBER_MALLOC((s)))
327 #define LDAP_CALLOC(n,s)        (LBER_CALLOC((n),(s)))
328 #define LDAP_REALLOC(p,s)       (LBER_REALLOC((p),(s)))
329 #define LDAP_FREE(p)            (LBER_FREE((p)))
330 #define LDAP_VFREE(v)           (LBER_VFREE((void **)(v)))
331 #define LDAP_STRDUP(s)          (LBER_STRDUP((s)))
332
333 /*
334  * in unit-int.c
335  */
336 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
337
338
339 /*
340  * in print.c
341  */
342 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
343
344 /*
345  * in cache.c
346  */
347 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
348         BerElement *request ));
349 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
350 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
351
352 /*
353  * in controls.c
354  */
355 LDAP_F (LDAPControl *) ldap_control_dup LDAP_P((
356         const LDAPControl *ctrl ));
357
358 LDAP_F (LDAPControl **) ldap_controls_dup LDAP_P((
359         LDAPControl *const *ctrls ));
360
361 LDAP_F (int) ldap_int_get_controls LDAP_P((
362         BerElement *be,
363         LDAPControl ***ctrlsp));
364
365 LDAP_F (int) ldap_int_put_controls LDAP_P((
366         LDAP *ld,
367         LDAPControl *const *ctrls,
368         BerElement *ber ));
369
370 LDAP_F (int) ldap_int_client_controls LDAP_P((
371         LDAP *ld,
372         LDAPControl **ctrlp ));
373
374 /*
375  * in dsparse.c
376  */
377 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
378
379 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
380 /*
381  * in kerberos.c
382  */
383 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
384         LDAP *ld,
385         LDAP_CONST char *who,
386         LDAP_CONST char *service,
387         ber_len_t *len ));
388
389 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
390
391
392 /*
393  * in open.c
394  */
395 LDAP_F (int) ldap_open_defconn( LDAP *ld );
396 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
397         LDAPConn *conn, LDAPURLDesc *srvlist, int async );
398
399 /*
400  * in os-ip.c
401  */
402 LDAP_F (int) ldap_int_tblsize;
403 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm );
404 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
405         int proto, const char *host, unsigned long address, int port,
406         int async );
407
408 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
409         defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
410 LDAP_V (char *) ldap_int_hostname;
411 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb );
412 #endif
413
414 LDAP_F (void) ldap_int_ip_init( void );
415 LDAP_F (int) do_ldap_select( LDAP *ld, struct timeval *timeout );
416 LDAP_F (void *) ldap_new_select_info( void );
417 LDAP_F (void) ldap_free_select_info( void *sip );
418 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
419 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
420 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
421 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
422 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
423
424 /*
425  * in os-local.c
426  */
427 #ifdef LDAP_PF_LOCAL
428 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
429         const char *path, int async );
430 #endif /* LDAP_PF_LOCAL */
431
432 /*
433  * in request.c
434  */
435 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
436         const char *dn, BerElement *ber );
437 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
438 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
439
440 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
441 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
442 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
443 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
444 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
445 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
446 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
447 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
448         char **errstrp, int sref, int *hadrefp );
449 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
450         char **refs, int sref, char **referralsp, int *hadrefp );
451 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
452
453 /*
454  * in result.c:
455  */
456 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
457
458 /*
459  * in search.c
460  */
461 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
462         LDAP *ld,
463         const char *base,
464         ber_int_t scope,
465         const char *filter,
466         char **attrs,
467         ber_int_t attrsonly,
468         LDAPControl **sctrls,
469         LDAPControl **cctrls,
470         ber_int_t timelimit,
471         ber_int_t sizelimit ));
472
473 /*
474  * in string.c
475  */
476         /* see <ac/string.h> */
477
478 /*
479  * in unbind.c
480  */
481 LDAP_F (int) ldap_ld_free LDAP_P((
482         LDAP *ld,
483         int close,
484         LDAPControl **sctrls,
485         LDAPControl **cctrls ));
486
487 LDAP_F (int) ldap_send_unbind LDAP_P((
488         LDAP *ld,
489         Sockbuf *sb,
490         LDAPControl **sctrls,
491         LDAPControl **cctrls ));
492
493 /*
494  * in url.c
495  */
496 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
497         LDAPURLDesc *ludp ));
498
499 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
500         LDAPURLDesc *ludlist ));
501
502 LDAP_F (int) ldap_url_parselist LDAP_P((
503         LDAPURLDesc **ludlist,
504         const char *url ));
505
506 LDAP_F (int) ldap_url_parsehosts LDAP_P((
507         LDAPURLDesc **ludlist,
508         const char *hosts,
509         int port ));
510
511 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
512         LDAPURLDesc *ludlist ));
513
514 LDAP_F (char *) ldap_url_list2urls LDAP_P((
515         LDAPURLDesc *ludlist ));
516
517 LDAP_F (void) ldap_free_urllist LDAP_P((
518         LDAPURLDesc *ludlist ));
519
520 /*
521  * in cyrus.c
522  */
523
524 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
525
526 LDAP_F (int) ldap_int_sasl_open LDAP_P((
527         LDAP *ld, LDAPConn *conn,
528         const char* host, ber_len_t ssf ));
529 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
530
531 LDAP_F (int) ldap_int_sasl_external LDAP_P((
532         LDAP *ld, const char* authid, ber_len_t ssf ));
533
534 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
535         int option, void *arg ));
536 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
537         int option, void *arg ));
538 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
539         int option, const char *arg ));
540
541 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
542         LDAP *ld,
543         const char *,
544         const char *,
545         LDAPControl **, LDAPControl **,
546
547         /* should be passed in client controls */
548         unsigned flags,
549         LDAP_SASL_INTERACT_PROC *interact,
550         void *defaults ));
551
552
553 /*
554  * in tls.c
555  */
556 LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
557         int option, const char *arg ));
558
559 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
560         LDAPConn *conn ));
561
562 LDAP_END_DECL
563
564 #endif /* _LDAP_INT_H */