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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
   4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   5  */
   6 /*  Portions
   7  *  Copyright (c) 1995 Regents of the University of Michigan.
   8  *  All rights reserved.
   9  *
  10  *  ldap-int.h - defines & prototypes internal to the LDAP library
  11  */
  12
  13 #ifndef _LDAP_INT_H
  14 #define _LDAP_INT_H 1
  15
  16 #ifdef LDAP_R_COMPILE
  17 #define LDAP_THREAD_SAFE 1
  18 #endif
  19
  20 #include "../liblber/lber-int.h"
  21
  22 #define ldap_debug      (ldap_int_global_options.ldo_debug)
  23 #undef Debug
  24 #define Debug( level, fmt, arg1, arg2, arg3 ) \
  25         ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
  26
  27 #include "ldap_log.h"
  28
  29 #include "ldap.h"
  30
  31 #include "ldap_pvt.h"
  32
  33 LDAP_BEGIN_DECL
  34
  35 #define LDAP_URL_PREFIX         "ldap://"
  36 #define LDAP_URL_PREFIX_LEN     (sizeof(LDAP_URL_PREFIX)-1)
  37 #define LDAPS_URL_PREFIX                "ldaps://"
  38 #define LDAPS_URL_PREFIX_LEN    (sizeof(LDAPS_URL_PREFIX)-1)
  39 #define LDAP_URL_URLCOLON               "URL:"
  40 #define LDAP_URL_URLCOLON_LEN   (sizeof(LDAP_URL_URLCOLON)-1)
  41 #define NULLLDAPURLDESC ((LDAPURLDesc *)NULL)
  42
  43 #define LDAP_REF_STR            "Referral:\n"
  44 #define LDAP_REF_STR_LEN        (sizeof(LDAP_REF_STR)-1)
  45 #define LDAP_LDAP_REF_STR       LDAP_URL_PREFIX
  46 #define LDAP_LDAP_REF_STR_LEN   (sizeof(LDAP_LDAP_REF_STR)-1)
  47
  48 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
  49 #define LDAP_DX_REF_STR         "dx://"
  50 #define LDAP_DX_REF_STR_LEN     (sizeof(LDAP_DX_REF_STR)-1)
  51 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
  52
  53 #define LDAP_DEFAULT_REFHOPLIMIT 5
  54
  55 #define LDAP_BOOL_REFERRALS             0
  56 #define LDAP_BOOL_RESTART               1
  57 #define LDAP_BOOL_DNS                   2
  58 #define LDAP_BOOL_TLS                   3
  59
  60 #define LDAP_BOOLEANS   unsigned long
  61 #define LDAP_BOOL(n)    (1 << (n))
  62 #define LDAP_BOOL_GET(lo, bool) ((lo)->ldo_booleans & LDAP_BOOL(bool) \
  63                                                                         ?  -1 : 0)
  64 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
  65 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
  66 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
  67
  68 /*
  69  * This structure represents both ldap messages and ldap responses.
  70  * These are really the same, except in the case of search responses,
  71  * where a response has multiple messages.
  72  */
  73
  74 struct ldapmsg {
  75         ber_int_t               lm_msgid;       /* the message id */
  76         ber_tag_t               lm_msgtype;     /* the message type */
  77         BerElement      *lm_ber;        /* the ber encoded message contents */
  78         struct ldapmsg  *lm_chain;      /* for search - next msg in the resp */
  79         struct ldapmsg  *lm_next;       /* next response */
  80         time_t  lm_time;        /* used to maintain cache */
  81 };
  82
  83 /*
  84  * structure representing get/set'able options
  85  * which have global defaults.
  86  */
  87 struct ldapoptions {
  88         short ldo_valid;
  89 #define LDAP_UNINITIALIZED      0x0
  90 #define LDAP_INITIALIZED        0x1
  91 #define LDAP_VALID_SESSION      0x2
  92
  93         int             ldo_debug;
  94         /* per API call timeout */
  95         struct timeval          *ldo_tm_api;
  96         struct timeval          *ldo_tm_net;
  97
  98         ber_int_t               ldo_version;    /* version to connect at */
  99         ber_int_t               ldo_deref;
 100         ber_int_t               ldo_timelimit;
 101         ber_int_t               ldo_sizelimit;
 102
 103         LDAPURLDesc *ldo_defludp;
 104         int             ldo_defport;
 105         char*   ldo_defbase;
 106
 107 #ifdef LDAP_CONNECTIONLESS
 108         int             ldo_cldaptries; /* connectionless search retry count */
 109         int             ldo_cldaptimeout;/* time between retries */
 110 #endif
 111
 112         int             ldo_refhoplimit;        /* limit on referral nesting */
 113
 114         /* LDAPv3 server and client controls */
 115         LDAPControl     **ldo_sctrls;
 116         LDAPControl **ldo_cctrls;
 117
 118 #ifdef HAVE_TLS
 119         /* tls context */
 120         void            *ldo_tls_ctx;
 121         int             ldo_tls_mode;
 122 #endif
 123         LDAP_BOOLEANS ldo_booleans;     /* boolean options */
 124 };
 125
 126
 127 /*
 128  * structure for tracking LDAP server host, ports, DNs, etc.
 129  */
 130 typedef struct ldap_server {
 131         char                    *lsrv_host;
 132         char                    *lsrv_dn;       /* if NULL, use default */
 133         int                     lsrv_port;
 134         struct ldap_server      *lsrv_next;
 135 } LDAPServer;
 136
 137
 138 /*
 139  * structure for representing an LDAP server connection
 140  */
 141 typedef struct ldap_conn {
 142         Sockbuf                 *lconn_sb;
 143         int                     lconn_refcnt;
 144         time_t          lconn_lastused; /* time */
 145         int                     lconn_status;
 146 #define LDAP_CONNST_NEEDSOCKET          1
 147 #define LDAP_CONNST_CONNECTING          2
 148 #define LDAP_CONNST_CONNECTED           3
 149         LDAPURLDesc             *lconn_server;
 150         char                    *lconn_krbinstance;
 151         struct ldap_conn        *lconn_next;
 152         BerElement              *lconn_ber;/* ber receiving on this conn. */
 153 } LDAPConn;
 154
 155
 156 /*
 157  * structure used to track outstanding requests
 158  */
 159 typedef struct ldapreq {
 160         ber_int_t               lr_msgid;       /* the message id */
 161         int             lr_status;      /* status of request */
 162 #define LDAP_REQST_INPROGRESS   1
 163 #define LDAP_REQST_CHASINGREFS  2
 164 #define LDAP_REQST_NOTCONNECTED 3
 165 #define LDAP_REQST_WRITING      4
 166         int             lr_outrefcnt;   /* count of outstanding referrals */
 167         ber_int_t               lr_origid;      /* original request's message id */
 168         int             lr_parentcnt;   /* count of parent requests */
 169         ber_tag_t               lr_res_msgtype; /* result message type */
 170         ber_int_t               lr_res_errno;   /* result LDAP errno */
 171         char            *lr_res_error;  /* result error string */
 172         char            *lr_res_matched;/* result matched DN string */
 173         BerElement      *lr_ber;        /* ber encoded request contents */
 174         LDAPConn        *lr_conn;       /* connection used to send request */
 175         struct ldapreq  *lr_parent;     /* request that spawned this referral */
 176         struct ldapreq  *lr_refnext;    /* next referral spawned */
 177         struct ldapreq  *lr_prev;       /* previous request */
 178         struct ldapreq  *lr_next;       /* next request */
 179 } LDAPRequest;
 180
 181 /*
 182  * structure for client cache
 183  */
 184 #define LDAP_CACHE_BUCKETS      31      /* cache hash table size */
 185 typedef struct ldapcache {
 186         LDAPMessage     *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
 187         LDAPMessage     *lc_requests;                   /* unfulfilled reqs */
 188         long            lc_timeout;                     /* request timeout */
 189         ber_len_t               lc_maxmem;                      /* memory to use */
 190         ber_len_t               lc_memused;                     /* memory in use */
 191         int             lc_enabled;                     /* enabled? */
 192         unsigned long   lc_options;                     /* options */
 193 #define LDAP_CACHE_OPT_CACHENOERRS      0x00000001
 194 #define LDAP_CACHE_OPT_CACHEALLERRS     0x00000002
 195 }  LDAPCache;
 196
 197 /*
 198  * handy macro for checking if handle is connectionless
 199  */
 200
 201 #define LDAP_IS_CLDAP(ld) ((ld)->ld_cldapnaddr>0)
 202
 203 /*
 204  * structure representing an ldap connection
 205  */
 206
 207 struct ldap {
 208         Sockbuf         ld_sb;          /* socket descriptor & buffer */
 209
 210         struct ldapoptions ld_options;
 211
 212 #define ld_valid                ld_options.ldo_valid
 213 #define ld_debug                ld_options.ldo_debug
 214
 215 #define ld_deref                ld_options.ldo_deref
 216 #define ld_timelimit    ld_options.ldo_timelimit
 217 #define ld_sizelimit    ld_options.ldo_sizelimit
 218
 219 #define ld_defbase              ld_options.ldo_defbase
 220 #define ld_defhost              ld_options.ldo_defhost
 221 #define ld_defport              ld_options.ldo_defport
 222
 223 #define ld_cldaptries   ld_options.ldo_cldaptries
 224 #define ld_cldaptimeout ld_options.ldo_cldaptimeout
 225 #define ld_refhoplimit  ld_options.ldo_refhoplimit
 226
 227 #define ld_sctrls               ld_options.ldo_sctrls
 228 #define ld_cctrls               ld_options.ldo_cctrls
 229
 230         ber_int_t               ld_version;             /* version connected at */
 231         char    *ld_host;
 232         int             ld_port;
 233
 234         unsigned short  ld_lberoptions;
 235
 236         LDAPFiltDesc    *ld_filtd;      /* from getfilter for ufn searches */
 237         char            *ld_ufnprefix;  /* for incomplete ufn's */
 238
 239         ber_int_t       ld_errno;
 240         char    *ld_error;
 241         char    *ld_matched;
 242         ber_len_t               ld_msgid;
 243
 244         /* do not mess with these */
 245         LDAPRequest     *ld_requests;   /* list of outstanding requests */
 246         LDAPMessage     *ld_responses;  /* list of outstanding responses */
 247
 248         ber_int_t               *ld_abandoned;  /* array of abandoned requests */
 249
 250         LDAPCache       *ld_cache;      /* non-null if cache is initialized */
 251         /* stuff used by connectionless searches. */
 252
 253         char            *ld_cldapdn;    /* DN used in connectionless search */
 254         int             ld_cldapnaddr; /* number of addresses */
 255         void            **ld_cldapaddrs;/* addresses to send request to */
 256
 257         /* do not mess with the rest though */
 258         BERTranslateProc ld_lber_encode_translate_proc;
 259         BERTranslateProc ld_lber_decode_translate_proc;
 260
 261         LDAPConn        *ld_defconn;    /* default connection */
 262         LDAPConn        *ld_conns;      /* list of server connections */
 263         void            *ld_selectinfo; /* platform specifics for select */
 264         int             (*ld_rebindproc)( struct ldap *ld, char **dnp,
 265                                 char **passwdp, int *authmethodp, int freeit );
 266                                 /* routine to get info needed for re-bind */
 267 };
 268 #define LDAP_VALID(ld)  ( (ld)->ld_valid == LDAP_VALID_SESSION )
 269
 270 /*
 271  * in init.c
 272  */
 273
 274 LIBLDAP_F ( struct ldapoptions ) ldap_int_global_options;
 275 LIBLDAP_F ( void ) ldap_int_initialize LDAP_P((void));
 276
 277
 278 /* memory.c */
 279         /* simple macros to realloc for now */
 280 #define LDAP_INT_MALLOC(s)              (LBER_MALLOC((s)))
 281 #define LDAP_INT_CALLOC(n,s)    (LBER_CALLOC((n),(s)))
 282 #define LDAP_INT_REALLOC(p,s)   (LBER_REALLOC((p),(s)))
 283 #define LDAP_INT_FREE(p)                (LBER_FREE((p)))
 284 #define LDAP_INT_VFREE(v)               (LBER_VFREE((void **)(v)))
 285 #define LDAP_INT_STRDUP(s)              (LBER_STRDUP((s)))
 286
 287 #define LDAP_MALLOC(s)          (LBER_MALLOC((s)))
 288 #define LDAP_CALLOC(n,s)        (LBER_CALLOC((n),(s)))
 289 #define LDAP_REALLOC(p,s)       (LBER_REALLOC((p),(s)))
 290 #define LDAP_FREE(p)            (LBER_FREE((p)))
 291 #define LDAP_VFREE(v)           (LBER_VFREE((void **)(v)))
 292 #define LDAP_STRDUP(s)          (LBER_STRDUP((s)))
 293
 294 /*
 295  * in unit-int.c
 296  */
 297 LIBLDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
 298
 299
 300 /*
 301  * in print.c
 302  */
 303 LIBLDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
 304
 305 /*
 306  * in cache.c
 307  */
 308 LIBLDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
 309         BerElement *request ));
 310 LIBLDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
 311 LIBLDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
 312
 313 /*
 314  * in controls.c
 315  */
 316 LIBLDAP_F (LDAPControl *) ldap_control_dup LDAP_P((
 317         const LDAPControl *ctrl ));
 318
 319 LIBLDAP_F (LDAPControl **) ldap_controls_dup LDAP_P((
 320         LDAPControl *const *ctrls ));
 321
 322 LIBLDAP_F (int) ldap_int_get_controls LDAP_P((
 323         BerElement *be,
 324         LDAPControl ***ctrlsp));
 325
 326 LIBLDAP_F (int) ldap_int_put_controls LDAP_P((
 327         LDAP *ld,
 328         LDAPControl *const *ctrls,
 329         BerElement *ber ));
 330
 331 /*
 332  * in dsparse.c
 333  */
 334 LIBLDAP_F (int) next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
 335 LIBLDAP_F (void) free_strarray LDAP_P(( char **sap ));
 336
 337 #ifdef HAVE_KERBEROS
 338 /*
 339  * in kerberos.c
 340  */
 341 LIBLDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
 342         LDAP *ld,
 343         LDAP_CONST char *who,
 344         LDAP_CONST char *service,
 345         ber_len_t *len ));
 346
 347 #endif /* HAVE_KERBEROS */
 348
 349
 350 /*
 351  * in open.c
 352  */
 353 LIBLDAP_F (int) ldap_open_defconn( LDAP *ld );
 354 LIBLDAP_F (int) open_ldap_connection( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srvlist, char **krbinstancep, int async );
 355
 356
 357 /*
 358  * in os-ip.c
 359  */
 360 LIBLDAP_F (int) ldap_int_tblsize;
 361 LIBLDAP_F (int) ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm );
 362 LIBLDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb, const char *host, unsigned long address, int port, int async );
 363
 364 LIBLDAP_F (void) ldap_close_connection( Sockbuf *sb );
 365
 366 #ifdef HAVE_KERBEROS
 367 LIBLDAP_F (char *) ldap_host_connected_to( Sockbuf *sb );
 368 #endif /* HAVE_KERBEROS */
 369
 370 LIBLDAP_F (void) ldap_int_ip_init( void );
 371 LIBLDAP_F (int) do_ldap_select( LDAP *ld, struct timeval *timeout );
 372 LIBLDAP_F (void *) ldap_new_select_info( void );
 373 LIBLDAP_F (void) ldap_free_select_info( void *sip );
 374 LIBLDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
 375 LIBLDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
 376 LIBLDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
 377 LIBLDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
 378 LIBLDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
 379
 380
 381 /*
 382  * in request.c
 383  */
 384 LIBLDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
 385         const char *dn, BerElement *ber );
 386 LIBLDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
 387 LIBLDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
 388
 389 LIBLDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, int bind );
 390 LIBLDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, int bind );
 391 LIBLDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
 392 LIBLDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
 393 LIBLDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
 394 LIBLDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
 395 LIBLDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
 396
 397 LIBLDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp );
 398 LIBLDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
 399
 400 /*
 401  * in result.c:
 402  */
 403 #ifdef LDAP_CONNECTIONLESS
 404 LIBLDAP_F (int) cldap_getmsg( LDAP *ld, struct timeval *timeout, BerElement *ber );
 405 #endif
 406
 407 /*
 408  * in search.c
 409  */
 410 LIBLDAP_F (BerElement *) ldap_build_search_req LDAP_P((
 411         LDAP *ld,
 412         const char *base,
 413         ber_int_t scope,
 414         const char *filter,
 415         char **attrs,
 416         ber_int_t attrsonly,
 417         LDAPControl **sctrls,
 418         LDAPControl **cctrls,
 419         ber_int_t timelimit,
 420         ber_int_t sizelimit ));
 421
 422 /*
 423  * in string.c
 424  */
 425         /* see <ac/string.h> */
 426
 427 /*
 428  * in unbind.c
 429  */
 430 LIBLDAP_F (int) ldap_ld_free LDAP_P((
 431         LDAP *ld,
 432         int close,
 433         LDAPControl **sctrls,
 434         LDAPControl **cctrls ));
 435
 436 LIBLDAP_F (int) ldap_send_unbind LDAP_P((
 437         LDAP *ld,
 438         Sockbuf *sb,
 439         LDAPControl **sctrls,
 440         LDAPControl **cctrls ));
 441
 442 /*
 443  * in url.c
 444  */
 445 LIBLDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
 446         LDAPURLDesc *ludp ));
 447
 448 LIBLDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
 449         LDAPURLDesc *ludlist ));
 450
 451 LIBLDAP_F (int) ldap_url_parselist LDAP_P((
 452         LDAPURLDesc **ludlist,
 453         const char *url ));
 454
 455 LIBLDAP_F (int) ldap_url_parsehosts LDAP_P((
 456         LDAPURLDesc **ludlist,
 457         const char *hosts ));
 458
 459 LIBLDAP_F (char *) ldap_url_list2hosts LDAP_P((
 460         LDAPURLDesc *ludlist ));
 461
 462 LIBLDAP_F (char *) ldap_url_list2urls LDAP_P((
 463         LDAPURLDesc *ludlist ));
 464
 465 LIBLDAP_F (void) ldap_free_urllist LDAP_P((
 466         LDAPURLDesc *ludlist ));
 467
 468
 469 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
 470 /*
 471  * in getdxbyname.c
 472  */
 473 LIBLDAP_F (char **) ldap_getdxbyname( const char *domain );
 474 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
 475
 476 #if defined( STR_TRANSLATION ) && defined( LDAP_DEFAULT_CHARSET )
 477 /*
 478  * in charset.c
 479  *
 480  * added-in this stuff so that libldap.a would build, i.e. refs to
 481  * these routines from open.c would resolve.
 482  * hodges@stanford.edu 5-Feb-96
 483  */
 484 #if LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET
 485 LIBLDAP_F (int) ldap_t61_to_8859( char **bufp, ber_len_t *buflenp, int free_input );
 486 LIBLDAP_F (int) ldap_8859_to_t61( char **bufp, ber_len_t *buflenp, int free_input );
 487 #endif /* LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET */
 488 #endif /* STR_TRANSLATION && LDAP_DEFAULT_CHARSET */
 489
 490 LDAP_END_DECL
 491
 492 #endif /* _LDAP_INT_H */