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

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