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

   1 /*  ldap-int.h - defines & prototypes internal to the LDAP library */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2012 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16 /*  Portions Copyright (c) 1995 Regents of the University of Michigan.
  17  *  All rights reserved.
  18  */
  19
  20 #ifndef _LDAP_INT_H
  21 #define _LDAP_INT_H 1
  22
  23 #ifdef LDAP_R_COMPILE
  24 #define LDAP_THREAD_SAFE 1
  25 #endif
  26
  27 #include "../liblber/lber-int.h"
  28 #include "lutil.h"
  29
  30 #ifdef LDAP_R_COMPILE
  31 #include <ldap_pvt_thread.h>
  32 #endif
  33
  34 #ifdef HAVE_CYRUS_SASL
  35         /* the need for this should be removed */
  36 #ifdef HAVE_SASL_SASL_H
  37 #include <sasl/sasl.h>
  38 #else
  39 #include <sasl.h>
  40 #endif
  41
  42 #define SASL_MAX_BUFF_SIZE      (0xffffff)
  43 #define SASL_MIN_BUFF_SIZE      4096
  44 #endif
  45
  46 /* for struct timeval */
  47 #include <ac/time.h>
  48
  49 #undef TV2MILLISEC
  50 #define TV2MILLISEC(tv) (((tv)->tv_sec * 1000) + ((tv)->tv_usec/1000))
  51
  52 /*
  53  * Support needed if the library is running in the kernel
  54  */
  55 #if LDAP_INT_IN_KERNEL
  56         /*
  57          * Platform specific function to return a pointer to the
  58          * process-specific global options.
  59          *
  60          * This function should perform the following functions:
  61          *  Allocate and initialize a global options struct on a per process basis
  62          *  Use callers process identifier to return its global options struct
  63          *  Note: Deallocate structure when the process exits
  64          */
  65 #       define LDAP_INT_GLOBAL_OPT() ldap_int_global_opt()
  66         struct ldapoptions *ldap_int_global_opt(void);
  67 #else
  68 #       define LDAP_INT_GLOBAL_OPT() (&ldap_int_global_options)
  69 #endif
  70
  71 #define ldap_debug      ((LDAP_INT_GLOBAL_OPT())->ldo_debug)
  72
  73 #include "ldap_log.h"
  74
  75 #undef Debug
  76
  77 #ifdef LDAP_DEBUG
  78
  79 #define DebugTest( level ) \
  80         ( ldap_debug & level )
  81
  82 #define Debug( level, fmt, arg1, arg2, arg3 ) \
  83         do { if ( ldap_debug & level ) \
  84         ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) ); \
  85         } while ( 0 )
  86
  87 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 )\
  88         ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
  89
  90 #else
  91
  92 #define DebugTest( level )                                    (0 == 1)
  93 #define Debug( level, fmt, arg1, arg2, arg3 )                 ((void)0)
  94 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 ) ((void)0)
  95
  96 #endif /* LDAP_DEBUG */
  97
  98 #define LDAP_DEPRECATED 1
  99 #include "ldap.h"
 100
 101 #include "ldap_pvt.h"
 102
 103 LDAP_BEGIN_DECL
 104
 105 #define LDAP_URL_PREFIX         "ldap://"
 106 #define LDAP_URL_PREFIX_LEN     STRLENOF(LDAP_URL_PREFIX)
 107 #define LDAPS_URL_PREFIX        "ldaps://"
 108 #define LDAPS_URL_PREFIX_LEN    STRLENOF(LDAPS_URL_PREFIX)
 109 #define LDAPI_URL_PREFIX        "ldapi://"
 110 #define LDAPI_URL_PREFIX_LEN    STRLENOF(LDAPI_URL_PREFIX)
 111 #ifdef LDAP_CONNECTIONLESS
 112 #define LDAPC_URL_PREFIX        "cldap://"
 113 #define LDAPC_URL_PREFIX_LEN    STRLENOF(LDAPC_URL_PREFIX)
 114 #endif
 115 #define LDAP_URL_URLCOLON       "URL:"
 116 #define LDAP_URL_URLCOLON_LEN   STRLENOF(LDAP_URL_URLCOLON)
 117
 118 #define LDAP_REF_STR            "Referral:\n"
 119 #define LDAP_REF_STR_LEN        STRLENOF(LDAP_REF_STR)
 120 #define LDAP_LDAP_REF_STR       LDAP_URL_PREFIX
 121 #define LDAP_LDAP_REF_STR_LEN   LDAP_URL_PREFIX_LEN
 122
 123 #define LDAP_DEFAULT_REFHOPLIMIT 5
 124
 125 #define LDAP_BOOL_REFERRALS             0
 126 #define LDAP_BOOL_RESTART               1
 127 #define LDAP_BOOL_TLS                   3
 128 #define LDAP_BOOL_CONNECT_ASYNC         4
 129 #define LDAP_BOOL_SASL_NOCANON          5
 130
 131 #define LDAP_BOOLEANS   unsigned long
 132 #define LDAP_BOOL(n)    ((LDAP_BOOLEANS)1 << (n))
 133 #define LDAP_BOOL_GET(lo, bool) \
 134         ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
 135 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
 136 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
 137 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
 138
 139 /*
 140  * This structure represents both ldap messages and ldap responses.
 141  * These are really the same, except in the case of search responses,
 142  * where a response has multiple messages.
 143  */
 144
 145 struct ldapmsg {
 146         ber_int_t               lm_msgid;       /* the message id */
 147         ber_tag_t               lm_msgtype;     /* the message type */
 148         BerElement      *lm_ber;        /* the ber encoded message contents */
 149         struct ldapmsg  *lm_chain;      /* for search - next msg in the resp */
 150         struct ldapmsg  *lm_chain_tail;
 151         struct ldapmsg  *lm_next;       /* next response */
 152         time_t  lm_time;        /* used to maintain cache */
 153 };
 154
 155 #ifdef HAVE_TLS
 156 struct ldaptls {
 157         char            *lt_certfile;
 158         char            *lt_keyfile;
 159         char            *lt_dhfile;
 160         char            *lt_cacertfile;
 161         char            *lt_cacertdir;
 162         char            *lt_ciphersuite;
 163         char            *lt_crlfile;
 164         char            *lt_randfile;   /* OpenSSL only */
 165         int             lt_protocol_min;
 166 };
 167 #endif
 168
 169 typedef struct ldaplist {
 170         struct ldaplist *ll_next;
 171         void *ll_data;
 172 } ldaplist;
 173
 174 /*
 175  * structure representing get/set'able options
 176  * which have global defaults.
 177  * Protect access to this struct with ldo_mutex
 178  * ldap_log.h:ldapoptions_prefix must match the head of this struct.
 179  */
 180 struct ldapoptions {
 181         short ldo_valid;
 182 #define LDAP_UNINITIALIZED      0x0
 183 #define LDAP_INITIALIZED        0x1
 184 #define LDAP_VALID_SESSION      0x2
 185 #define LDAP_TRASHED_SESSION    0xFF
 186         int   ldo_debug;
 187
 188         ber_int_t               ldo_version;
 189         ber_int_t               ldo_deref;
 190         ber_int_t               ldo_timelimit;
 191         ber_int_t               ldo_sizelimit;
 192
 193         /* per API call timeout */
 194         struct timeval          ldo_tm_api;
 195         struct timeval          ldo_tm_net;
 196
 197         LDAPURLDesc *ldo_defludp;
 198         int             ldo_defport;
 199         char*   ldo_defbase;
 200         char*   ldo_defbinddn;  /* bind dn */
 201
 202         /*
 203          * Per connection tcp-keepalive settings (Linux only,
 204          * ignored where unsupported)
 205          */
 206         ber_int_t ldo_keepalive_idle;
 207         ber_int_t ldo_keepalive_probes;
 208         ber_int_t ldo_keepalive_interval;
 209
 210         int             ldo_refhoplimit;        /* limit on referral nesting */
 211
 212         /* LDAPv3 server and client controls */
 213         LDAPControl     **ldo_sctrls;
 214         LDAPControl **ldo_cctrls;
 215
 216         /* LDAP rebind callback function */
 217         LDAP_REBIND_PROC *ldo_rebind_proc;
 218         void *ldo_rebind_params;
 219         LDAP_NEXTREF_PROC *ldo_nextref_proc;
 220         void *ldo_nextref_params;
 221         LDAP_URLLIST_PROC *ldo_urllist_proc;
 222         void *ldo_urllist_params;
 223
 224         /* LDAP connection callback stack */
 225         ldaplist *ldo_conn_cbs;
 226
 227         LDAP_BOOLEANS ldo_booleans;     /* boolean options */
 228
 229 #define LDAP_LDO_NULLARG        ,0,0,0,0 ,{0},{0} ,0,0,0,0, 0,0,0,0, 0,0, 0,0,0,0,0,0, 0, 0
 230
 231 #ifdef LDAP_CONNECTIONLESS
 232 #define LDAP_IS_UDP(ld)         ((ld)->ld_options.ldo_is_udp)
 233         void*                   ldo_peer;       /* struct sockaddr* */
 234         char*                   ldo_cldapdn;
 235         int                     ldo_is_udp;
 236 #define LDAP_LDO_CONNECTIONLESS_NULLARG ,0,0,0
 237 #else
 238 #define LDAP_LDO_CONNECTIONLESS_NULLARG
 239 #endif
 240
 241 #ifdef HAVE_TLS
 242         /* tls context */
 243         void            *ldo_tls_ctx;
 244         LDAP_TLS_CONNECT_CB     *ldo_tls_connect_cb;
 245         void*                   ldo_tls_connect_arg;
 246         struct ldaptls ldo_tls_info;
 247 #define ldo_tls_certfile        ldo_tls_info.lt_certfile
 248 #define ldo_tls_keyfile ldo_tls_info.lt_keyfile
 249 #define ldo_tls_dhfile  ldo_tls_info.lt_dhfile
 250 #define ldo_tls_cacertfile      ldo_tls_info.lt_cacertfile
 251 #define ldo_tls_cacertdir       ldo_tls_info.lt_cacertdir
 252 #define ldo_tls_ciphersuite     ldo_tls_info.lt_ciphersuite
 253 #define ldo_tls_protocol_min    ldo_tls_info.lt_protocol_min
 254 #define ldo_tls_crlfile ldo_tls_info.lt_crlfile
 255 #define ldo_tls_randfile        ldo_tls_info.lt_randfile
 256         int                     ldo_tls_mode;
 257         int                     ldo_tls_require_cert;
 258         int                     ldo_tls_impl;
 259         int                     ldo_tls_crlcheck;
 260 #define LDAP_LDO_TLS_NULLARG ,0,0,0,{0,0,0,0,0,0,0,0,0},0,0,0,0
 261 #else
 262 #define LDAP_LDO_TLS_NULLARG
 263 #endif
 264
 265 #ifdef HAVE_CYRUS_SASL
 266         char*   ldo_def_sasl_mech;              /* SASL Mechanism(s) */
 267         char*   ldo_def_sasl_realm;             /* SASL realm */
 268         char*   ldo_def_sasl_authcid;   /* SASL authentication identity */
 269         char*   ldo_def_sasl_authzid;   /* SASL authorization identity */
 270
 271         /* SASL Security Properties */
 272         struct sasl_security_properties ldo_sasl_secprops;
 273 #define LDAP_LDO_SASL_NULLARG ,0,0,0,0,{0}
 274 #else
 275 #define LDAP_LDO_SASL_NULLARG
 276 #endif
 277
 278 #ifdef HAVE_GSSAPI
 279         unsigned ldo_gssapi_flags;
 280 #define LDAP_GSSAPI_OPT_DO_NOT_FREE_GSS_CONTEXT 0x0001
 281 #define LDAP_GSSAPI_OPT_ALLOW_REMOTE_PRINCIPAL  0x0002
 282         unsigned ldo_gssapi_options;
 283 #define LDAP_LDO_GSSAPI_NULLARG ,0,0
 284 #else
 285 #define LDAP_LDO_GSSAPI_NULLARG
 286 #endif
 287
 288 #ifdef LDAP_R_COMPILE
 289         ldap_pvt_thread_mutex_t ldo_mutex;
 290 #define LDAP_LDO_MUTEX_NULLARG  , LDAP_PVT_MUTEX_NULL
 291 #else
 292 #define LDAP_LDO_MUTEX_NULLARG
 293 #endif
 294 };
 295
 296
 297 /*
 298  * structure for representing an LDAP server connection
 299  */
 300 typedef struct ldap_conn {
 301         Sockbuf         *lconn_sb;
 302 #ifdef HAVE_CYRUS_SASL
 303         void            *lconn_sasl_authctx;    /* context for bind */
 304         void            *lconn_sasl_sockctx;    /* for security layer */
 305 #endif
 306 #ifdef HAVE_GSSAPI
 307         void            *lconn_gss_ctx;         /* gss_ctx_id_t */
 308 #endif
 309         int                     lconn_refcnt;
 310         time_t          lconn_created;  /* time */
 311         time_t          lconn_lastused; /* time */
 312         int                     lconn_rebind_inprogress;        /* set if rebind in progress */
 313         char            ***lconn_rebind_queue;          /* used if rebind in progress */
 314         int                     lconn_status;
 315 #define LDAP_CONNST_NEEDSOCKET          1
 316 #define LDAP_CONNST_CONNECTING          2
 317 #define LDAP_CONNST_CONNECTED           3
 318         LDAPURLDesc             *lconn_server;
 319         BerElement              *lconn_ber;     /* ber receiving on this conn. */
 320
 321         struct ldap_conn *lconn_next;
 322 } LDAPConn;
 323
 324
 325 /*
 326  * structure used to track outstanding requests
 327  */
 328 typedef struct ldapreq {
 329         ber_int_t       lr_msgid;       /* the message id */
 330         int             lr_status;      /* status of request */
 331 #define LDAP_REQST_COMPLETED    0
 332 #define LDAP_REQST_INPROGRESS   1
 333 #define LDAP_REQST_CHASINGREFS  2
 334 #define LDAP_REQST_NOTCONNECTED 3
 335 #define LDAP_REQST_WRITING      4
 336         int             lr_refcnt;      /* count of references */
 337         int             lr_outrefcnt;   /* count of outstanding referrals */
 338         int             lr_abandoned;   /* the request has been abandoned */
 339         ber_int_t       lr_origid;      /* original request's message id */
 340         int             lr_parentcnt;   /* count of parent requests */
 341         ber_tag_t       lr_res_msgtype; /* result message type */
 342         ber_int_t       lr_res_errno;   /* result LDAP errno */
 343         char            *lr_res_error;  /* result error string */
 344         char            *lr_res_matched;/* result matched DN string */
 345         BerElement      *lr_ber;        /* ber encoded request contents */
 346         LDAPConn        *lr_conn;       /* connection used to send request */
 347         struct berval   lr_dn;          /* DN of request, in lr_ber */
 348         struct ldapreq  *lr_parent;     /* request that spawned this referral */
 349         struct ldapreq  *lr_child;      /* first child request */
 350         struct ldapreq  *lr_refnext;    /* next referral spawned */
 351         struct ldapreq  *lr_prev;       /* previous request */
 352         struct ldapreq  *lr_next;       /* next request */
 353 } LDAPRequest;
 354
 355 /*
 356  * structure for client cache
 357  */
 358 #define LDAP_CACHE_BUCKETS      31      /* cache hash table size */
 359 typedef struct ldapcache {
 360         LDAPMessage     *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
 361         LDAPMessage     *lc_requests;                   /* unfulfilled reqs */
 362         long            lc_timeout;                     /* request timeout */
 363         ber_len_t               lc_maxmem;                      /* memory to use */
 364         ber_len_t               lc_memused;                     /* memory in use */
 365         int             lc_enabled;                     /* enabled? */
 366         unsigned long   lc_options;                     /* options */
 367 #define LDAP_CACHE_OPT_CACHENOERRS      0x00000001
 368 #define LDAP_CACHE_OPT_CACHEALLERRS     0x00000002
 369 }  LDAPCache;
 370
 371 /*
 372  * structure containing referral request info for rebind procedure
 373  */
 374 typedef struct ldapreqinfo {
 375         ber_len_t       ri_msgid;
 376         int                     ri_request;
 377         char            *ri_url;
 378 } LDAPreqinfo;
 379
 380 /*
 381  * structure representing an ldap connection
 382  */
 383
 384 struct ldap_common {
 385         Sockbuf         *ldc_sb;        /* socket descriptor & buffer */
 386 #define ld_sb                   ldc->ldc_sb
 387
 388         unsigned short  ldc_lberoptions;
 389 #define ld_lberoptions          ldc->ldc_lberoptions
 390
 391         /* protected by msgid_mutex */
 392         ber_len_t               ldc_msgid;
 393 #define ld_msgid                ldc->ldc_msgid
 394
 395         /* do not mess with these */
 396         /* protected by req_mutex */
 397         LDAPRequest     *ldc_requests;  /* list of outstanding requests */
 398         /* protected by res_mutex */
 399         LDAPMessage     *ldc_responses; /* list of outstanding responses */
 400 #define ld_requests             ldc->ldc_requests
 401 #define ld_responses            ldc->ldc_responses
 402
 403         /* protected by abandon_mutex */
 404         ber_len_t       ldc_nabandoned;
 405         ber_int_t       *ldc_abandoned; /* array of abandoned requests */
 406 #define ld_nabandoned           ldc->ldc_nabandoned
 407 #define ld_abandoned            ldc->ldc_abandoned
 408
 409         /* unused by libldap */
 410         LDAPCache       *ldc_cache;     /* non-null if cache is initialized */
 411 #define ld_cache                ldc->ldc_cache
 412
 413         /* do not mess with the rest though */
 414
 415         /* protected by conn_mutex */
 416         LDAPConn        *ldc_defconn;   /* default connection */
 417 #define ld_defconn              ldc->ldc_defconn
 418         LDAPConn        *ldc_conns;     /* list of server connections */
 419 #define ld_conns                ldc->ldc_conns
 420         void            *ldc_selectinfo;/* platform specifics for select */
 421 #define ld_selectinfo           ldc->ldc_selectinfo
 422
 423         /* ldap_common refcnt - free only if 0 */
 424         /* protected by ldc_mutex */
 425         unsigned int            ldc_refcnt;
 426 #define ld_ldcrefcnt            ldc->ldc_refcnt
 427
 428         /* protected by ldo_mutex */
 429         struct ldapoptions ldc_options;
 430 #define ld_options              ldc->ldc_options
 431
 432 #define ld_valid                ld_options.ldo_valid
 433 #define ld_debug                ld_options.ldo_debug
 434
 435 #define ld_deref                ld_options.ldo_deref
 436 #define ld_timelimit            ld_options.ldo_timelimit
 437 #define ld_sizelimit            ld_options.ldo_sizelimit
 438
 439 #define ld_defbinddn            ld_options.ldo_defbinddn
 440 #define ld_defbase              ld_options.ldo_defbase
 441 #define ld_defhost              ld_options.ldo_defhost
 442 #define ld_defport              ld_options.ldo_defport
 443
 444 #define ld_refhoplimit          ld_options.ldo_refhoplimit
 445
 446 #define ld_sctrls               ld_options.ldo_sctrls
 447 #define ld_cctrls               ld_options.ldo_cctrls
 448 #define ld_rebind_proc          ld_options.ldo_rebind_proc
 449 #define ld_rebind_params        ld_options.ldo_rebind_params
 450 #define ld_nextref_proc         ld_options.ldo_nextref_proc
 451 #define ld_nextref_params       ld_options.ldo_nextref_params
 452 #define ld_urllist_proc         ld_options.ldo_urllist_proc
 453 #define ld_urllist_params       ld_options.ldo_urllist_params
 454
 455 #define ld_version              ld_options.ldo_version
 456
 457 #ifdef LDAP_R_COMPILE
 458         ldap_pvt_thread_mutex_t ldc_mutex;
 459         ldap_pvt_thread_mutex_t ldc_msgid_mutex;
 460         ldap_pvt_thread_mutex_t ldc_conn_mutex;
 461         ldap_pvt_thread_mutex_t ldc_req_mutex;
 462         ldap_pvt_thread_mutex_t ldc_res_mutex;
 463         ldap_pvt_thread_mutex_t ldc_abandon_mutex;
 464 #define ld_ldopts_mutex         ld_options.ldo_mutex
 465 #define ld_ldcmutex             ldc->ldc_mutex
 466 #define ld_msgid_mutex          ldc->ldc_msgid_mutex
 467 #define ld_conn_mutex           ldc->ldc_conn_mutex
 468 #define ld_req_mutex            ldc->ldc_req_mutex
 469 #define ld_res_mutex            ldc->ldc_res_mutex
 470 #define ld_abandon_mutex        ldc->ldc_abandon_mutex
 471 #endif
 472 };
 473
 474 struct ldap {
 475         /* thread shared */
 476         struct ldap_common      *ldc;
 477
 478         /* thread specific */
 479         ber_int_t               ld_errno;
 480         char                    *ld_error;
 481         char                    *ld_matched;
 482         char                    **ld_referrals;
 483 };
 484
 485 #define LDAP_VALID(ld)          ( (ld)->ld_valid == LDAP_VALID_SESSION )
 486 #define LDAP_TRASHED(ld)        ( (ld)->ld_valid == LDAP_TRASHED_SESSION )
 487 #define LDAP_TRASH(ld)          ( (ld)->ld_valid = LDAP_TRASHED_SESSION )
 488
 489 #ifdef LDAP_R_COMPILE
 490 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
 491 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_hostname_mutex;
 492
 493 #ifdef HAVE_CYRUS_SASL
 494 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
 495 #endif
 496 #ifdef HAVE_GSSAPI
 497 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_gssapi_mutex;
 498 #endif
 499 #endif
 500
 501 #ifdef LDAP_R_COMPILE
 502 #define LDAP_MUTEX_LOCK(mutex)    ldap_pvt_thread_mutex_lock( mutex )
 503 #define LDAP_MUTEX_UNLOCK(mutex)  ldap_pvt_thread_mutex_unlock( mutex )
 504 #define LDAP_ASSERT_MUTEX_OWNER(mutex) \
 505         LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER(mutex)
 506 #else
 507 #define LDAP_MUTEX_LOCK(mutex)    ((void) 0)
 508 #define LDAP_MUTEX_UNLOCK(mutex)  ((void) 0)
 509 #define LDAP_ASSERT_MUTEX_OWNER(mutex) ((void) 0)
 510 #endif
 511
 512 #define LDAP_NEXT_MSGID(ld, id) do { \
 513         LDAP_MUTEX_LOCK( &(ld)->ld_msgid_mutex ); \
 514         (id) = ++(ld)->ld_msgid; \
 515         LDAP_MUTEX_UNLOCK( &(ld)->ld_msgid_mutex ); \
 516 } while (0)
 517
 518 /*
 519  * in abandon.c
 520  */
 521
 522 LDAP_F (int)
 523 ldap_int_bisect_find( ber_int_t *v, ber_len_t n, ber_int_t id, int *idxp );
 524 LDAP_F (int)
 525 ldap_int_bisect_insert( ber_int_t **vp, ber_len_t *np, int id, int idx );
 526 LDAP_F (int)
 527 ldap_int_bisect_delete( ber_int_t **vp, ber_len_t *np, int id, int idx );
 528
 529 /*
 530  * in init.c
 531  */
 532
 533 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
 534
 535 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
 536 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
 537         struct ldapoptions *, int *));
 538
 539 /* memory.c */
 540         /* simple macros to realloc for now */
 541 #define LDAP_MALLOC(s)          (ber_memalloc_x((s),NULL))
 542 #define LDAP_CALLOC(n,s)        (ber_memcalloc_x((n),(s),NULL))
 543 #define LDAP_REALLOC(p,s)       (ber_memrealloc_x((p),(s),NULL))
 544 #define LDAP_FREE(p)            (ber_memfree_x((p),NULL))
 545 #define LDAP_VFREE(v)           (ber_memvfree_x((void **)(v),NULL))
 546 #define LDAP_STRDUP(s)          (ber_strdup_x((s),NULL))
 547 #define LDAP_STRNDUP(s,l)       (ber_strndup_x((s),(l),NULL))
 548
 549 #define LDAP_MALLOCX(s,x)       (ber_memalloc_x((s),(x)))
 550 #define LDAP_CALLOCX(n,s,x)     (ber_memcalloc_x((n),(s),(x)))
 551 #define LDAP_REALLOCX(p,s,x)    (ber_memrealloc_x((p),(s),(x)))
 552 #define LDAP_FREEX(p,x)         (ber_memfree_x((p),(x)))
 553 #define LDAP_VFREEX(v,x)        (ber_memvfree_x((void **)(v),(x)))
 554 #define LDAP_STRDUPX(s,x)       (ber_strdup_x((s),(x)))
 555 #define LDAP_STRNDUPX(s,l,x)    (ber_strndup_x((s),(l),(x)))
 556
 557 /*
 558  * in error.c
 559  */
 560 LDAP_F (void) ldap_int_error_init( void );
 561
 562 /*
 563  * in unit-int.c
 564  */
 565 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
 566
 567
 568 /*
 569  * in print.c
 570  */
 571 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
 572
 573 /*
 574  * in controls.c
 575  */
 576 LDAP_F (int) ldap_int_put_controls LDAP_P((
 577         LDAP *ld,
 578         LDAPControl *const *ctrls,
 579         BerElement *ber ));
 580
 581 LDAP_F (int) ldap_int_client_controls LDAP_P((
 582         LDAP *ld,
 583         LDAPControl **ctrlp ));
 584
 585 /*
 586  * in dsparse.c
 587  */
 588 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
 589
 590
 591 /*
 592  * in open.c
 593  */
 594 LDAP_F (int) ldap_open_defconn( LDAP *ld );
 595 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
 596         LDAPConn *conn, LDAPURLDesc *srvlist, int async );
 597 LDAP_F (int) ldap_int_check_async_open( LDAP *ld, ber_socket_t sd );
 598
 599 /*
 600  * in os-ip.c
 601  */
 602 #ifndef HAVE_POLL
 603 LDAP_V (int) ldap_int_tblsize;
 604 LDAP_F (void) ldap_int_ip_init( void );
 605 #endif
 606
 607 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest,
 608         const struct timeval *tm );
 609 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
 610         int proto, LDAPURLDesc *srv, int async );
 611 LDAP_F (int) ldap_int_poll( LDAP *ld, ber_socket_t s,
 612         struct timeval *tvp );
 613
 614 #if defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
 615 LDAP_V (char *) ldap_int_hostname;
 616 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb,
 617         const char *host );
 618 #endif
 619
 620 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
 621 LDAP_F (void *) ldap_new_select_info( void );
 622 LDAP_F (void) ldap_free_select_info( void *sip );
 623 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
 624 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
 625 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
 626 LDAP_F (void) ldap_clear_select_write( LDAP *ld, Sockbuf *sb );
 627 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
 628 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
 629
 630 LDAP_F (int) ldap_int_connect_cbs( LDAP *ld, Sockbuf *sb,
 631         ber_socket_t *s, LDAPURLDesc *srv, struct sockaddr *addr );
 632
 633 /*
 634  * in os-local.c
 635  */
 636 #ifdef LDAP_PF_LOCAL
 637 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
 638         LDAPURLDesc *srv, int async );
 639 #endif /* LDAP_PF_LOCAL */
 640
 641 /*
 642  * in request.c
 643  */
 644 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
 645         const char *dn, BerElement *ber, ber_int_t msgid );
 646 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
 647 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
 648
 649 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber,
 650         ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc **srvlist,
 651         LDAPConn *lc, LDAPreqinfo *bind, int noconn, int m_res );
 652 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist,
 653         int use_ldsb, int connect, LDAPreqinfo *bind, int m_req, int m_res );
 654 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
 655 LDAP_F (void) ldap_return_request( LDAP *ld, LDAPRequest *lr, int freeit );
 656 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
 657 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
 658 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
 659 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
 660 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
 661         char **errstrp, int sref, int *hadrefp );
 662 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
 663         char **refs, int sref, char **referralsp, int *hadrefp );
 664 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
 665 LDAP_F (int) ldap_int_flush_request( LDAP *ld, LDAPRequest *lr );
 666
 667 /*
 668  * in result.c:
 669  */
 670 LDAP_F (const char *) ldap_int_msgtype2str( ber_tag_t tag );
 671
 672 /*
 673  * in search.c
 674  */
 675 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
 676         LDAP *ld,
 677         const char *base,
 678         ber_int_t scope,
 679         const char *filter,
 680         char **attrs,
 681         ber_int_t attrsonly,
 682         LDAPControl **sctrls,
 683         LDAPControl **cctrls,
 684         ber_int_t timelimit,
 685         ber_int_t sizelimit,
 686         ber_int_t deref,
 687         ber_int_t *msgidp));
 688
 689
 690 /*
 691  * in unbind.c
 692  */
 693 LDAP_F (int) ldap_ld_free LDAP_P((
 694         LDAP *ld,
 695         int close,
 696         LDAPControl **sctrls,
 697         LDAPControl **cctrls ));
 698
 699 LDAP_F (int) ldap_send_unbind LDAP_P((
 700         LDAP *ld,
 701         Sockbuf *sb,
 702         LDAPControl **sctrls,
 703         LDAPControl **cctrls ));
 704
 705 /*
 706  * in url.c
 707  */
 708 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
 709         LDAPURLDesc *ludp ));
 710
 711 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
 712         LDAPURLDesc *ludlist ));
 713
 714 LDAP_F (int) ldap_url_parsehosts LDAP_P((
 715         LDAPURLDesc **ludlist,
 716         const char *hosts,
 717         int port ));
 718
 719 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
 720         LDAPURLDesc *ludlist ));
 721
 722 /*
 723  * in cyrus.c
 724  */
 725
 726 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
 727
 728 LDAP_F (int) ldap_int_sasl_open LDAP_P((
 729         LDAP *ld, LDAPConn *conn,
 730         const char* host ));
 731 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
 732
 733 LDAP_F (int) ldap_int_sasl_external LDAP_P((
 734         LDAP *ld, LDAPConn *conn,
 735         const char* authid, ber_len_t ssf ));
 736
 737 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
 738         int option, void *arg ));
 739 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
 740         int option, void *arg ));
 741 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
 742         int option, const char *arg ));
 743
 744 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
 745         LDAP *ld,
 746         const char *,
 747         const char *,
 748         LDAPControl **, LDAPControl **,
 749
 750         /* should be passed in client controls */
 751         unsigned flags,
 752         LDAP_SASL_INTERACT_PROC *interact,
 753         void *defaults,
 754         LDAPMessage *result,
 755         const char **rmech,
 756         int *msgid ));
 757
 758 /* in schema.c */
 759 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
 760         const char **sp,
 761         int *code,
 762         const int flags ));
 763
 764 /*
 765  * in tls.c
 766  */
 767 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
 768         LDAPConn *conn, LDAPURLDesc *srv ));
 769
 770 LDAP_F (void) ldap_int_tls_destroy LDAP_P(( struct ldapoptions *lo ));
 771
 772 /*
 773  *      in getvalues.c
 774  */
 775 LDAP_F (char **) ldap_value_dup LDAP_P((
 776         char *const *vals ));
 777
 778 /*
 779  *      in gssapi.c
 780  */
 781 #ifdef HAVE_GSSAPI
 782 LDAP_F(int) ldap_int_gssapi_get_option LDAP_P(( LDAP *ld, int option, void *arg ));
 783 LDAP_F(int) ldap_int_gssapi_set_option LDAP_P(( LDAP *ld, int option, void *arg ));
 784 LDAP_F(int) ldap_int_gssapi_config LDAP_P(( struct ldapoptions *lo, int option, const char *arg ));
 785 LDAP_F(void) ldap_int_gssapi_close LDAP_P(( LDAP *ld, LDAPConn *lc ));
 786 #endif
 787
 788 LDAP_END_DECL
 789
 790 #endif /* _LDAP_INT_H */