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         char            *ldo_tls_pin_hashalg;
 272         struct berval   ldo_tls_pin;
 273 #define LDAP_LDO_TLS_NULLARG ,0,0,0,{0,0,0,0,0,0,0,0,0},0,0,0,0,0,{0,0}
 274 #else
 275 #define LDAP_LDO_TLS_NULLARG
 276 #endif
 277
 278 #ifdef HAVE_CYRUS_SASL
 279         char*   ldo_def_sasl_mech;              /* SASL Mechanism(s) */
 280         char*   ldo_def_sasl_realm;             /* SASL realm */
 281         char*   ldo_def_sasl_authcid;   /* SASL authentication identity */
 282         char*   ldo_def_sasl_authzid;   /* SASL authorization identity */
 283
 284         /* SASL Security Properties */
 285         struct sasl_security_properties ldo_sasl_secprops;
 286 #define LDAP_LDO_SASL_NULLARG ,0,0,0,0,{0}
 287 #else
 288 #define LDAP_LDO_SASL_NULLARG
 289 #endif
 290
 291 #ifdef HAVE_GSSAPI
 292         unsigned ldo_gssapi_flags;
 293 #define LDAP_GSSAPI_OPT_DO_NOT_FREE_GSS_CONTEXT 0x0001
 294 #define LDAP_GSSAPI_OPT_ALLOW_REMOTE_PRINCIPAL  0x0002
 295         unsigned ldo_gssapi_options;
 296 #define LDAP_LDO_GSSAPI_NULLARG ,0,0
 297 #else
 298 #define LDAP_LDO_GSSAPI_NULLARG
 299 #endif
 300
 301 #ifdef LDAP_R_COMPILE
 302         ldap_pvt_thread_mutex_t ldo_mutex;
 303 #define LDAP_LDO_MUTEX_NULLARG  , LDAP_PVT_MUTEX_NULL
 304 #else
 305 #define LDAP_LDO_MUTEX_NULLARG
 306 #endif
 307 };
 308
 309
 310 /*
 311  * structure for representing an LDAP server connection
 312  */
 313 typedef struct ldap_conn {
 314         Sockbuf         *lconn_sb;
 315 #ifdef HAVE_CYRUS_SASL
 316         void            *lconn_sasl_authctx;    /* context for bind */
 317         void            *lconn_sasl_sockctx;    /* for security layer */
 318         void            *lconn_sasl_cbind;              /* for channel binding */
 319 #endif
 320 #ifdef HAVE_GSSAPI
 321         void            *lconn_gss_ctx;         /* gss_ctx_id_t */
 322 #endif
 323         int                     lconn_refcnt;
 324         time_t          lconn_created;  /* time */
 325         time_t          lconn_lastused; /* time */
 326         int                     lconn_rebind_inprogress;        /* set if rebind in progress */
 327         char            ***lconn_rebind_queue;          /* used if rebind in progress */
 328         int                     lconn_status;
 329 #define LDAP_CONNST_NEEDSOCKET          1
 330 #define LDAP_CONNST_CONNECTING          2
 331 #define LDAP_CONNST_CONNECTED           3
 332         LDAPURLDesc             *lconn_server;
 333         BerElement              *lconn_ber;     /* ber receiving on this conn. */
 334
 335         struct ldap_conn *lconn_next;
 336 } LDAPConn;
 337
 338
 339 /*
 340  * structure used to track outstanding requests
 341  */
 342 typedef struct ldapreq {
 343         ber_int_t       lr_msgid;       /* the message id */
 344         int             lr_status;      /* status of request */
 345 #define LDAP_REQST_COMPLETED    0
 346 #define LDAP_REQST_INPROGRESS   1
 347 #define LDAP_REQST_CHASINGREFS  2
 348 #define LDAP_REQST_NOTCONNECTED 3
 349 #define LDAP_REQST_WRITING      4
 350         int             lr_refcnt;      /* count of references */
 351         int             lr_outrefcnt;   /* count of outstanding referrals */
 352         int             lr_abandoned;   /* the request has been abandoned */
 353         ber_int_t       lr_origid;      /* original request's message id */
 354         int             lr_parentcnt;   /* count of parent requests */
 355         ber_tag_t       lr_res_msgtype; /* result message type */
 356         ber_int_t       lr_res_errno;   /* result LDAP errno */
 357         char            *lr_res_error;  /* result error string */
 358         char            *lr_res_matched;/* result matched DN string */
 359         BerElement      *lr_ber;        /* ber encoded request contents */
 360         LDAPConn        *lr_conn;       /* connection used to send request */
 361         struct berval   lr_dn;          /* DN of request, in lr_ber */
 362         struct ldapreq  *lr_parent;     /* request that spawned this referral */
 363         struct ldapreq  *lr_child;      /* first child request */
 364         struct ldapreq  *lr_refnext;    /* next referral spawned */
 365         struct ldapreq  *lr_prev;       /* previous request */
 366         struct ldapreq  *lr_next;       /* next request */
 367 } LDAPRequest;
 368
 369 /*
 370  * structure for client cache
 371  */
 372 #define LDAP_CACHE_BUCKETS      31      /* cache hash table size */
 373 typedef struct ldapcache {
 374         LDAPMessage     *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
 375         LDAPMessage     *lc_requests;                   /* unfulfilled reqs */
 376         long            lc_timeout;                     /* request timeout */
 377         ber_len_t               lc_maxmem;                      /* memory to use */
 378         ber_len_t               lc_memused;                     /* memory in use */
 379         int             lc_enabled;                     /* enabled? */
 380         unsigned long   lc_options;                     /* options */
 381 #define LDAP_CACHE_OPT_CACHENOERRS      0x00000001
 382 #define LDAP_CACHE_OPT_CACHEALLERRS     0x00000002
 383 }  LDAPCache;
 384
 385 /*
 386  * structure containing referral request info for rebind procedure
 387  */
 388 typedef struct ldapreqinfo {
 389         ber_len_t       ri_msgid;
 390         int                     ri_request;
 391         char            *ri_url;
 392 } LDAPreqinfo;
 393
 394 /*
 395  * structure representing an ldap connection
 396  */
 397
 398 struct ldap_common {
 399         Sockbuf         *ldc_sb;        /* socket descriptor & buffer */
 400 #define ld_sb                   ldc->ldc_sb
 401
 402         unsigned short  ldc_lberoptions;
 403 #define ld_lberoptions          ldc->ldc_lberoptions
 404
 405         /* protected by msgid_mutex */
 406         ber_len_t               ldc_msgid;
 407 #define ld_msgid                ldc->ldc_msgid
 408
 409         /* do not mess with these */
 410         /* protected by req_mutex */
 411         LDAPRequest     *ldc_requests;  /* list of outstanding requests */
 412         /* protected by res_mutex */
 413         LDAPMessage     *ldc_responses; /* list of outstanding responses */
 414 #define ld_requests             ldc->ldc_requests
 415 #define ld_responses            ldc->ldc_responses
 416
 417         /* protected by abandon_mutex */
 418         ber_len_t       ldc_nabandoned;
 419         ber_int_t       *ldc_abandoned; /* array of abandoned requests */
 420 #define ld_nabandoned           ldc->ldc_nabandoned
 421 #define ld_abandoned            ldc->ldc_abandoned
 422
 423         /* unused by libldap */
 424         LDAPCache       *ldc_cache;     /* non-null if cache is initialized */
 425 #define ld_cache                ldc->ldc_cache
 426
 427         /* do not mess with the rest though */
 428
 429         /* protected by conn_mutex */
 430         LDAPConn        *ldc_defconn;   /* default connection */
 431 #define ld_defconn              ldc->ldc_defconn
 432         LDAPConn        *ldc_conns;     /* list of server connections */
 433 #define ld_conns                ldc->ldc_conns
 434         void            *ldc_selectinfo;/* platform specifics for select */
 435 #define ld_selectinfo           ldc->ldc_selectinfo
 436
 437         /* ldap_common refcnt - free only if 0 */
 438         /* protected by ldc_mutex */
 439         unsigned int            ldc_refcnt;
 440 #define ld_ldcrefcnt            ldc->ldc_refcnt
 441
 442         /* protected by ldo_mutex */
 443         struct ldapoptions ldc_options;
 444 #define ld_options              ldc->ldc_options
 445
 446 #define ld_valid                ld_options.ldo_valid
 447 #define ld_debug                ld_options.ldo_debug
 448
 449 #define ld_deref                ld_options.ldo_deref
 450 #define ld_timelimit            ld_options.ldo_timelimit
 451 #define ld_sizelimit            ld_options.ldo_sizelimit
 452
 453 #define ld_defbinddn            ld_options.ldo_defbinddn
 454 #define ld_defbase              ld_options.ldo_defbase
 455 #define ld_defhost              ld_options.ldo_defhost
 456 #define ld_defport              ld_options.ldo_defport
 457
 458 #define ld_refhoplimit          ld_options.ldo_refhoplimit
 459
 460 #define ld_sctrls               ld_options.ldo_sctrls
 461 #define ld_cctrls               ld_options.ldo_cctrls
 462 #define ld_rebind_proc          ld_options.ldo_rebind_proc
 463 #define ld_rebind_params        ld_options.ldo_rebind_params
 464 #define ld_nextref_proc         ld_options.ldo_nextref_proc
 465 #define ld_nextref_params       ld_options.ldo_nextref_params
 466 #define ld_urllist_proc         ld_options.ldo_urllist_proc
 467 #define ld_urllist_params       ld_options.ldo_urllist_params
 468
 469 #define ld_version              ld_options.ldo_version
 470
 471 #ifdef LDAP_R_COMPILE
 472         ldap_pvt_thread_mutex_t ldc_mutex;
 473         ldap_pvt_thread_mutex_t ldc_msgid_mutex;
 474         ldap_pvt_thread_mutex_t ldc_conn_mutex;
 475         ldap_pvt_thread_mutex_t ldc_req_mutex;
 476         ldap_pvt_thread_mutex_t ldc_res_mutex;
 477         ldap_pvt_thread_mutex_t ldc_abandon_mutex;
 478 #define ld_ldopts_mutex         ld_options.ldo_mutex
 479 #define ld_ldcmutex             ldc->ldc_mutex
 480 #define ld_msgid_mutex          ldc->ldc_msgid_mutex
 481 #define ld_conn_mutex           ldc->ldc_conn_mutex
 482 #define ld_req_mutex            ldc->ldc_req_mutex
 483 #define ld_res_mutex            ldc->ldc_res_mutex
 484 #define ld_abandon_mutex        ldc->ldc_abandon_mutex
 485 #endif
 486 };
 487
 488 struct ldap {
 489         /* thread shared */
 490         struct ldap_common      *ldc;
 491
 492         /* thread specific */
 493         ber_int_t               ld_errno;
 494         char                    *ld_error;
 495         char                    *ld_matched;
 496         char                    **ld_referrals;
 497 };
 498
 499 #define LDAP_VALID(ld)          ( (ld)->ld_valid == LDAP_VALID_SESSION )
 500 #define LDAP_TRASHED(ld)        ( (ld)->ld_valid == LDAP_TRASHED_SESSION )
 501 #define LDAP_TRASH(ld)          ( (ld)->ld_valid = LDAP_TRASHED_SESSION )
 502
 503 #ifdef LDAP_R_COMPILE
 504 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
 505 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_hostname_mutex;
 506 LDAP_V ( int ) ldap_int_stackguard;
 507
 508 #ifdef HAVE_GSSAPI
 509 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_gssapi_mutex;
 510 #endif
 511 #endif
 512
 513 #ifdef LDAP_R_COMPILE
 514 #define LDAP_MUTEX_LOCK(mutex)    ldap_pvt_thread_mutex_lock( mutex )
 515 #define LDAP_MUTEX_UNLOCK(mutex)  ldap_pvt_thread_mutex_unlock( mutex )
 516 #define LDAP_ASSERT_MUTEX_OWNER(mutex) \
 517         LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER(mutex)
 518 #else
 519 #define LDAP_MUTEX_LOCK(mutex)    ((void) 0)
 520 #define LDAP_MUTEX_UNLOCK(mutex)  ((void) 0)
 521 #define LDAP_ASSERT_MUTEX_OWNER(mutex) ((void) 0)
 522 #endif
 523
 524 #define LDAP_NEXT_MSGID(ld, id) do { \
 525         LDAP_MUTEX_LOCK( &(ld)->ld_msgid_mutex ); \
 526         (id) = ++(ld)->ld_msgid; \
 527         LDAP_MUTEX_UNLOCK( &(ld)->ld_msgid_mutex ); \
 528 } while (0)
 529
 530 /*
 531  * in abandon.c
 532  */
 533
 534 LDAP_F (int)
 535 ldap_int_bisect_find( ber_int_t *v, ber_len_t n, ber_int_t id, int *idxp );
 536 LDAP_F (int)
 537 ldap_int_bisect_insert( ber_int_t **vp, ber_len_t *np, int id, int idx );
 538 LDAP_F (int)
 539 ldap_int_bisect_delete( ber_int_t **vp, ber_len_t *np, int id, int idx );
 540
 541 /*
 542  * in add.c
 543  */
 544
 545 LDAP_F (BerElement *) ldap_build_add_req LDAP_P((
 546         LDAP *ld,
 547         const char *dn,
 548         LDAPMod **attrs,
 549         LDAPControl **sctrls,
 550         LDAPControl **cctrls,
 551         ber_int_t *msgidp ));
 552
 553 /*
 554  * in lbase64.c
 555  */
 556
 557 LDAP_F (int) ldap_int_decode_b64_inplace LDAP_P((
 558         struct berval *value ));
 559
 560 /*
 561  * in compare.c
 562  */
 563
 564 LDAP_F (BerElement *) ldap_build_compare_req LDAP_P((
 565         LDAP *ld,
 566         const char *dn,
 567         const char *attr,
 568         struct berval *bvalue,
 569         LDAPControl **sctrls,
 570         LDAPControl **cctrls,
 571         ber_int_t *msgidp ));
 572
 573 /*
 574  * in delete.c
 575  */
 576
 577 LDAP_F (BerElement *) ldap_build_delete_req LDAP_P((
 578         LDAP *ld,
 579         const char *dn,
 580         LDAPControl **sctrls,
 581         LDAPControl **cctrls,
 582         ber_int_t *msgidp ));
 583
 584 /*
 585  * in extended.c
 586  */
 587
 588 LDAP_F (BerElement *) ldap_build_extended_req LDAP_P((
 589         LDAP *ld,
 590         const char *reqoid,
 591         struct berval *reqdata,
 592         LDAPControl **sctrls,
 593         LDAPControl **cctrls,
 594         ber_int_t *msgidp ));
 595
 596 /*
 597  * in init.c
 598  */
 599
 600 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
 601
 602 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
 603 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
 604         struct ldapoptions *, int *));
 605
 606 /* memory.c */
 607         /* simple macros to realloc for now */
 608 #define LDAP_MALLOC(s)          (ber_memalloc_x((s),NULL))
 609 #define LDAP_CALLOC(n,s)        (ber_memcalloc_x((n),(s),NULL))
 610 #define LDAP_REALLOC(p,s)       (ber_memrealloc_x((p),(s),NULL))
 611 #define LDAP_FREE(p)            (ber_memfree_x((p),NULL))
 612 #define LDAP_VFREE(v)           (ber_memvfree_x((void **)(v),NULL))
 613 #define LDAP_STRDUP(s)          (ber_strdup_x((s),NULL))
 614 #define LDAP_STRNDUP(s,l)       (ber_strndup_x((s),(l),NULL))
 615
 616 #define LDAP_MALLOCX(s,x)       (ber_memalloc_x((s),(x)))
 617 #define LDAP_CALLOCX(n,s,x)     (ber_memcalloc_x((n),(s),(x)))
 618 #define LDAP_REALLOCX(p,s,x)    (ber_memrealloc_x((p),(s),(x)))
 619 #define LDAP_FREEX(p,x)         (ber_memfree_x((p),(x)))
 620 #define LDAP_VFREEX(v,x)        (ber_memvfree_x((void **)(v),(x)))
 621 #define LDAP_STRDUPX(s,x)       (ber_strdup_x((s),(x)))
 622 #define LDAP_STRNDUPX(s,l,x)    (ber_strndup_x((s),(l),(x)))
 623
 624 /*
 625  * in error.c
 626  */
 627 LDAP_F (void) ldap_int_error_init( void );
 628
 629 /*
 630  * in modify.c
 631  */
 632
 633 LDAP_F (BerElement *) ldap_build_modify_req LDAP_P((
 634         LDAP *ld,
 635         const char *dn,
 636         LDAPMod **mods,
 637         LDAPControl **sctrls,
 638         LDAPControl **cctrls,
 639         ber_int_t *msgidp ));
 640
 641 /*
 642  * in modrdn.c
 643  */
 644
 645 LDAP_F (BerElement *) ldap_build_moddn_req LDAP_P((
 646         LDAP *ld,
 647         const char *dn,
 648         const char *newrdn,
 649         const char *newSuperior,
 650         int deleteoldrdn,
 651         LDAPControl **sctrls,
 652         LDAPControl **cctrls,
 653         ber_int_t *msgidp ));
 654
 655 /*
 656  * in unit-int.c
 657  */
 658 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
 659
 660
 661 /*
 662  * in print.c
 663  */
 664 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
 665
 666 /*
 667  * in controls.c
 668  */
 669 LDAP_F (int) ldap_int_put_controls LDAP_P((
 670         LDAP *ld,
 671         LDAPControl *const *ctrls,
 672         BerElement *ber ));
 673
 674 LDAP_F (int) ldap_int_client_controls LDAP_P((
 675         LDAP *ld,
 676         LDAPControl **ctrlp ));
 677
 678 /*
 679  * in dsparse.c
 680  */
 681 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
 682
 683
 684 /*
 685  * in open.c
 686  */
 687 LDAP_F (int) ldap_open_defconn( LDAP *ld );
 688 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
 689         LDAPConn *conn, LDAPURLDesc *srvlist, int async );
 690 LDAP_F (int) ldap_int_check_async_open( LDAP *ld, ber_socket_t sd );
 691
 692 /*
 693  * in os-ip.c
 694  */
 695 #ifndef HAVE_POLL
 696 LDAP_V (int) ldap_int_tblsize;
 697 LDAP_F (void) ldap_int_ip_init( void );
 698 #endif
 699
 700 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest,
 701         const struct timeval *tm );
 702 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
 703         int proto, LDAPURLDesc *srv, int async );
 704 LDAP_F (int) ldap_int_poll( LDAP *ld, ber_socket_t s,
 705         struct timeval *tvp, int wr );
 706
 707 #if defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
 708 LDAP_V (char *) ldap_int_hostname;
 709 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb,
 710         const char *host );
 711 #endif
 712
 713 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
 714 LDAP_F (void *) ldap_new_select_info( void );
 715 LDAP_F (void) ldap_free_select_info( void *sip );
 716 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
 717 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
 718 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
 719 LDAP_F (void) ldap_clear_select_write( LDAP *ld, Sockbuf *sb );
 720 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
 721 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
 722
 723 LDAP_F (int) ldap_int_connect_cbs( LDAP *ld, Sockbuf *sb,
 724         ber_socket_t *s, LDAPURLDesc *srv, struct sockaddr *addr );
 725
 726 /*
 727  * in os-local.c
 728  */
 729 #ifdef LDAP_PF_LOCAL
 730 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
 731         LDAPURLDesc *srv, int async );
 732 #endif /* LDAP_PF_LOCAL */
 733
 734 /*
 735  * in request.c
 736  */
 737 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
 738         const char *dn, BerElement *ber, ber_int_t msgid );
 739 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
 740 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
 741
 742 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber,
 743         ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc **srvlist,
 744         LDAPConn *lc, LDAPreqinfo *bind, int noconn, int m_res );
 745 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist,
 746         int use_ldsb, int connect, LDAPreqinfo *bind, int m_req, int m_res );
 747 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
 748 LDAP_F (void) ldap_return_request( LDAP *ld, LDAPRequest *lr, int freeit );
 749 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
 750 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
 751 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
 752 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
 753 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
 754         char **errstrp, int sref, int *hadrefp );
 755 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
 756         char **refs, int sref, char **referralsp, int *hadrefp );
 757 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
 758 LDAP_F (int) ldap_int_flush_request( LDAP *ld, LDAPRequest *lr );
 759
 760 /*
 761  * in result.c:
 762  */
 763 LDAP_F (const char *) ldap_int_msgtype2str( ber_tag_t tag );
 764
 765 /*
 766  * in search.c
 767  */
 768 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
 769         LDAP *ld,
 770         const char *base,
 771         ber_int_t scope,
 772         const char *filter,
 773         char **attrs,
 774         ber_int_t attrsonly,
 775         LDAPControl **sctrls,
 776         LDAPControl **cctrls,
 777         ber_int_t timelimit,
 778         ber_int_t sizelimit,
 779         ber_int_t deref,
 780         ber_int_t *msgidp));
 781
 782
 783 /*
 784  * in unbind.c
 785  */
 786 LDAP_F (int) ldap_ld_free LDAP_P((
 787         LDAP *ld,
 788         int close,
 789         LDAPControl **sctrls,
 790         LDAPControl **cctrls ));
 791
 792 LDAP_F (int) ldap_send_unbind LDAP_P((
 793         LDAP *ld,
 794         Sockbuf *sb,
 795         LDAPControl **sctrls,
 796         LDAPControl **cctrls ));
 797
 798 /*
 799  * in url.c
 800  */
 801 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
 802         LDAPURLDesc *ludp ));
 803
 804 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
 805         LDAPURLDesc *ludlist ));
 806
 807 LDAP_F (int) ldap_url_parsehosts LDAP_P((
 808         LDAPURLDesc **ludlist,
 809         const char *hosts,
 810         int port ));
 811
 812 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
 813         LDAPURLDesc *ludlist ));
 814
 815 /*
 816  * in cyrus.c
 817  */
 818
 819 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
 820
 821 LDAP_F (int) ldap_int_sasl_open LDAP_P((
 822         LDAP *ld, LDAPConn *conn,
 823         const char* host ));
 824 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
 825
 826 LDAP_F (int) ldap_int_sasl_external LDAP_P((
 827         LDAP *ld, LDAPConn *conn,
 828         const char* authid, ber_len_t ssf ));
 829
 830 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
 831         int option, void *arg ));
 832 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
 833         int option, void *arg ));
 834 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
 835         int option, const char *arg ));
 836
 837 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
 838         LDAP *ld,
 839         const char *,
 840         const char *,
 841         LDAPControl **, LDAPControl **,
 842
 843         /* should be passed in client controls */
 844         unsigned flags,
 845         LDAP_SASL_INTERACT_PROC *interact,
 846         void *defaults,
 847         LDAPMessage *result,
 848         const char **rmech,
 849         int *msgid ));
 850
 851 /* in sasl.c */
 852
 853 LDAP_F (BerElement *) ldap_build_bind_req LDAP_P((
 854         LDAP *ld,
 855         const char *dn,
 856         const char *mech,
 857         struct berval *cred,
 858         LDAPControl **sctrls,
 859         LDAPControl **cctrls,
 860         ber_int_t *msgidp ));
 861
 862 /* in schema.c */
 863 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
 864         const char **sp,
 865         int *code,
 866         const int flags ));
 867
 868 /*
 869  * in tls.c
 870  */
 871 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
 872         LDAPConn *conn, LDAPURLDesc *srv ));
 873
 874 LDAP_F (void) ldap_int_tls_destroy LDAP_P(( struct ldapoptions *lo ));
 875
 876 /*
 877  *      in getvalues.c
 878  */
 879 LDAP_F (char **) ldap_value_dup LDAP_P((
 880         char *const *vals ));
 881
 882 /*
 883  *      in gssapi.c
 884  */
 885 #ifdef HAVE_GSSAPI
 886 LDAP_F(int) ldap_int_gssapi_get_option LDAP_P(( LDAP *ld, int option, void *arg ));
 887 LDAP_F(int) ldap_int_gssapi_set_option LDAP_P(( LDAP *ld, int option, void *arg ));
 888 LDAP_F(int) ldap_int_gssapi_config LDAP_P(( struct ldapoptions *lo, int option, const char *arg ));
 889 LDAP_F(void) ldap_int_gssapi_close LDAP_P(( LDAP *ld, LDAPConn *lc ));
 890 #endif
 891
 892 LDAP_END_DECL
 893
 894 #endif /* _LDAP_INT_H */