git.sur5r.net Git - openldap/blob - libraries/libldap/ldap-int.h

   1 /*
   2  * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
   3  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   4  */
   5 /*  Portions
   6  *  Copyright (c) 1995 Regents of the University of Michigan.
   7  *  All rights reserved.
   8  *
   9  *  ldap-int.h - defines & prototypes internal to the LDAP library
  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 #define ldap_debug      (openldap_ldap_global_options.ldo_debug)
  22 #undef Debug
  23 #define Debug( level, fmt, arg1, arg2, arg3 ) \
  24         ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
  25
  26 #include "ldap_log.h"
  27
  28 #include "ldap.h"
  29
  30 #include "ldap_pvt.h"
  31
  32 LDAP_BEGIN_DECL
  33
  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)
  39
  40 #define LDAP_REF_STR            "Referral:\n"
  41 #define LDAP_REF_STR_LEN        10
  42 #define LDAP_LDAP_REF_STR       LDAP_URL_PREFIX
  43 #define LDAP_LDAP_REF_STR_LEN   LDAP_URL_PREFIX_LEN
  44
  45 #define LDAP_DEFAULT_REFHOPLIMIT 5
  46
  47 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
  48 #define LDAP_DX_REF_STR         "dx://"
  49 #define LDAP_DX_REF_STR_LEN     5
  50 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
  51
  52 #define LDAP_BOOL_REFERRALS             0
  53 #define LDAP_BOOL_RESTART               1
  54 #define LDAP_BOOL_DNS                   2
  55
  56 #define LDAP_BOOLEANS   unsigned long
  57 #define LDAP_BOOL(n)    (1 << (n))
  58 #define LDAP_BOOL_GET(lo, bool) ((lo)->ldo_booleans & LDAP_BOOL(bool) \
  59                                                                         ?  LDAP_OPT_ON : LDAP_OPT_OFF)
  60 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
  61 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
  62 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
  63
  64 /*
  65  * This structure represents both ldap messages and ldap responses.
  66  * These are really the same, except in the case of search responses,
  67  * where a response has multiple messages.
  68  */
  69
  70 struct ldapmsg {
  71         int             lm_msgid;       /* the message id */
  72         int             lm_msgtype;     /* the message type */
  73         BerElement      *lm_ber;        /* the ber encoded message contents */
  74         struct ldapmsg  *lm_chain;      /* for search - next msg in the resp */
  75         struct ldapmsg  *lm_next;       /* next response */
  76         unsigned int    lm_time;        /* used to maintain cache */
  77 };
  78 #define NULLMSG ((LDAPMessage *)NULL)
  79 /*
  80  * structure representing get/set'able options
  81  * which have global defaults.
  82  */
  83 struct ldapoptions {
  84         int             ldo_debug;
  85
  86         int             ldo_version;    /* version to connect at */
  87         int             ldo_deref;
  88         int             ldo_timelimit;
  89         int             ldo_sizelimit;
  90
  91         int             ldo_defport;
  92         char*   ldo_defbase;
  93         char*   ldo_defhost;
  94
  95         int             ldo_cldaptries; /* connectionless search retry count */
  96         int             ldo_cldaptimeout;/* time between retries */
  97         int             ldo_refhoplimit;        /* limit on referral nesting */
  98
  99         /* LDAPv3 server and client controls */
 100         LDAPControl     **ldo_sctrls;
 101         LDAPControl **ldo_cctrls;
 102
 103         LDAP_BOOLEANS ldo_booleans;     /* boolean options */
 104 };
 105
 106 /*
 107  * structure for tracking LDAP server host, ports, DNs, etc.
 108  */
 109 typedef struct ldap_server {
 110         char                    *lsrv_host;
 111         char                    *lsrv_dn;       /* if NULL, use default */
 112         int                     lsrv_port;
 113         struct ldap_server      *lsrv_next;
 114 } LDAPServer;
 115
 116
 117 /*
 118  * structure for representing an LDAP server connection
 119  */
 120 typedef struct ldap_conn {
 121         Sockbuf                 *lconn_sb;
 122         int                     lconn_refcnt;
 123         time_t          lconn_lastused; /* time */
 124         int                     lconn_status;
 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. */
 132 } LDAPConn;
 133
 134
 135 /*
 136  * structure used to track outstanding requests
 137  */
 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 */
 158 } LDAPRequest;
 159
 160 /*
 161  * structure for client cache
 162  */
 163 #define LDAP_CACHE_BUCKETS      31      /* cache hash table size */
 164 typedef struct ldapcache {
 165         LDAPMessage     *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
 166         LDAPMessage     *lc_requests;                   /* unfulfilled reqs */
 167         long            lc_timeout;                     /* request timeout */
 168         long            lc_maxmem;                      /* memory to use */
 169         long            lc_memused;                     /* memory in use */
 170         int             lc_enabled;                     /* enabled? */
 171         unsigned long   lc_options;                     /* options */
 172 #define LDAP_CACHE_OPT_CACHENOERRS      0x00000001
 173 #define LDAP_CACHE_OPT_CACHEALLERRS     0x00000002
 174 }  LDAPCache;
 175 #define NULLLDCACHE ((LDAPCache *)NULL)
 176
 177 /*
 178  * handy macro for checking if handle is connectionless
 179  */
 180
 181 #define LDAP_IS_CLDAP(ld) ((ld)->ld_cldapnaddr>0)
 182
 183 /*
 184  * structure representing an ldap connection
 185  */
 186
 187 struct ldap {
 188         Sockbuf         ld_sb;          /* socket descriptor & buffer */
 189
 190         struct ldapoptions ld_options;
 191
 192 #define ld_deref                ld_options.ldo_deref
 193 #define ld_timelimit    ld_options.ldo_timelimit
 194 #define ld_sizelimit    ld_options.ldo_sizelimit
 195
 196 #define ld_defbase              ld_options.ldo_defbase
 197 #define ld_defhost              ld_options.ldo_defhost
 198 #define ld_defport              ld_options.ldo_defport
 199
 200 #define ld_cldaptries   ld_options.ldo_cldaptries
 201 #define ld_cldaptimeout ld_options.ldo_cldaptimeout
 202 #define ld_refhoplimit  ld_options.ldo_refhoplimit
 203
 204 #define ld_sctrls               ld_options.ldo_sctrls
 205 #define ld_cctrls               ld_options.ldo_cctrls
 206
 207         int             ld_version;             /* version connected at */
 208         char    *ld_host;
 209         int             ld_port;
 210
 211         short           ld_lberoptions;
 212
 213         LDAPFiltDesc    *ld_filtd;      /* from getfilter for ufn searches */
 214         char            *ld_ufnprefix;  /* for incomplete ufn's */
 215
 216         int             ld_errno;
 217         char    *ld_error;
 218         char    *ld_matched;
 219         int             ld_msgid;
 220
 221         /* do not mess with these */
 222         LDAPRequest     *ld_requests;   /* list of outstanding requests */
 223         LDAPMessage     *ld_responses;  /* list of outstanding responses */
 224
 225         int             *ld_abandoned;  /* array of abandoned requests */
 226
 227         LDAPCache       *ld_cache;      /* non-null if cache is initialized */
 228         /* stuff used by connectionless searches. */
 229         char            *ld_cldapdn;    /* DN used in connectionless search */
 230         int             ld_cldapnaddr; /* number of addresses */
 231         void            **ld_cldapaddrs;/* addresses to send request to */
 232
 233         /* do not mess with the rest though */
 234         BERTranslateProc ld_lber_encode_translate_proc;
 235         BERTranslateProc ld_lber_decode_translate_proc;
 236
 237         LDAPConn        *ld_defconn;    /* default connection */
 238         LDAPConn        *ld_conns;      /* list of server connections */
 239         void            *ld_selectinfo; /* platform specifics for select */
 240         int             (*ld_rebindproc)( struct ldap *ld, char **dnp,
 241                                 char **passwdp, int *authmethodp, int freeit );
 242                                 /* routine to get info needed for re-bind */
 243 };
 244
 245 /*
 246  * in init.c
 247  */
 248 extern int openldap_ldap_initialized;
 249 extern struct ldapoptions openldap_ldap_global_options;
 250 void openldap_ldap_initialize LDAP_P((void));
 251
 252
 253 /*
 254  * in unit-int.c
 255  */
 256 void ldap_int_utils_init LDAP_P(( void ));
 257
 258
 259 /*
 260  * in print.c
 261  */
 262 int ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...));
 263
 264 /*
 265  * in cache.c
 266  */
 267 void ldap_add_request_to_cache LDAP_P(( LDAP *ld, unsigned long msgtype,
 268         BerElement *request ));
 269 void ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
 270 int ldap_check_cache LDAP_P(( LDAP *ld, unsigned long msgtype, BerElement *request ));
 271
 272 /*
 273  * in controls.c
 274  */
 275 LDAPControl *ldap_control_dup LDAP_P((
 276         const LDAPControl *ctrl ));
 277
 278 LDAPControl **ldap_controls_dup LDAP_P((
 279         const LDAPControl **ctrls ));
 280
 281 int ldap_int_get_controls LDAP_P((
 282         BerElement *be,
 283         LDAPControl ***ctrlsp));
 284
 285 int ldap_int_put_controls LDAP_P((
 286         LDAP *ld,
 287         LDAPControl **ctrls,
 288         BerElement *ber ));
 289
 290 /*
 291  * in dsparse.c
 292  */
 293 int next_line_tokens LDAP_P(( char **bufp, long *blenp, char ***toksp ));
 294 void free_strarray LDAP_P(( char **sap ));
 295
 296 #ifdef HAVE_KERBEROS
 297 /*
 298  * in kerberos.c
 299  */
 300 char *ldap_get_kerberosv4_credentials LDAP_P((
 301         LDAP *ld,
 302         LDAP_CONST char *who,
 303         LDAP_CONST char *service,
 304         int *len ));
 305
 306 #endif /* HAVE_KERBEROS */
 307
 308
 309 /*
 310  * in open.c
 311  */
 312 int open_ldap_connection( LDAP *ld, Sockbuf *sb, const char *host, int defport,
 313         char **krbinstancep, int async );
 314
 315
 316 /*
 317  * in os-ip.c
 318  */
 319 int ldap_connect_to_host( Sockbuf *sb, const char *host, unsigned long address, int port,
 320         int async );
 321 void ldap_close_connection( Sockbuf *sb );
 322
 323 #ifdef HAVE_KERBEROS
 324 char *ldap_host_connected_to( Sockbuf *sb );
 325 #endif /* HAVE_KERBEROS */
 326
 327 int do_ldap_select( LDAP *ld, struct timeval *timeout );
 328 void *ldap_new_select_info( void );
 329 void ldap_free_select_info( void *sip );
 330 void ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
 331 void ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
 332 void ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
 333 int ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
 334 int ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
 335
 336
 337 /*
 338  * in request.c
 339  */
 340 int ldap_send_initial_request( LDAP *ld, unsigned long msgtype,
 341         const char *dn, BerElement *ber );
 342 BerElement *ldap_alloc_ber_with_options( LDAP *ld );
 343 void ldap_set_ber_options( LDAP *ld, BerElement *ber );
 344
 345 int ldap_send_server_request( LDAP *ld, BerElement *ber, int msgid,
 346         LDAPRequest *parentreq, LDAPServer *srvlist, LDAPConn *lc,
 347         int bind );
 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
 356 int ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp );
 357 int ldap_append_referral( LDAP *ld, char **referralsp, char *s );
 358
 359 /*
 360  * in result.c:
 361  */
 362 #ifdef LDAP_CONNECTIONLESS
 363 LDAP_F int cldap_getmsg ( LDAP *ld, struct timeval *timeout, BerElement *ber );
 364 #endif
 365
 366 /*
 367  * in search.c
 368  */
 369 BerElement *ldap_build_search_req LDAP_P((
 370         LDAP *ld,
 371         const char *base, int scope,
 372         const char *filter, char **attrs, int attrsonly,
 373         LDAPControl **sctrls,
 374         LDAPControl **cctrls,
 375         int timelimit,
 376         int sizelimit ));
 377
 378 /*
 379  * in strdup.c
 380  */
 381 char *ldap_strdup LDAP_P(( const char * ));
 382
 383 /*
 384  * in unbind.c
 385  */
 386 int ldap_ld_free LDAP_P((
 387         LDAP *ld,
 388         int close,
 389         LDAPControl **sctrls,
 390         LDAPControl **cctrls ));
 391
 392 int ldap_send_unbind LDAP_P((
 393         LDAP *ld,
 394         Sockbuf *sb,
 395         LDAPControl **sctrls,
 396         LDAPControl **cctrls ));
 397
 398 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
 399 /*
 400  * in getdxbyname.c
 401  */
 402 char **ldap_getdxbyname( const char *domain );
 403 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
 404
 405 #if defined( STR_TRANSLATION ) && defined( LDAP_DEFAULT_CHARSET )
 406 /*
 407  * in charset.c
 408  *
 409  * added-in this stuff so that libldap.a would build, i.e. refs to
 410  * these routines from open.c would resolve.
 411  * hodges@stanford.edu 5-Feb-96
 412  */
 413 #if LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET
 414 extern
 415 int ldap_t61_to_8859( char **bufp, unsigned long *buflenp, int free_input );
 416 extern
 417 int ldap_8859_to_t61( char **bufp, unsigned long *buflenp, int free_input );
 418 #endif /* LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET */
 419 #endif /* STR_TRANSLATION && LDAP_DEFAULT_CHARSET */
 420
 421 LDAP_END_DECL
 422
 423 #endif /* _LDAP_INT_H */