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