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