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