X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=libraries%2Flibldap%2Fldap-int.h;h=e9146db127075b985e0816da0e673d53345672a7;hb=e0691dfbc07d0b2a0e6bec528b33802ed04f5960;hp=5a3fe703a247c916c43dae778727faa8513fdba6;hpb=984a661277ddf23190bca787210a09c373e6561e;p=openldap diff --git a/libraries/libldap/ldap-int.h b/libraries/libldap/ldap-int.h index 5a3fe703a2..e9146db127 100644 --- a/libraries/libldap/ldap-int.h +++ b/libraries/libldap/ldap-int.h @@ -1,43 +1,347 @@ /* + * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved. + * COPYING RESTRICTIONS APPLY, see COPYRIGHT file + */ +/* Portions * Copyright (c) 1995 Regents of the University of Michigan. * All rights reserved. * * ldap-int.h - defines & prototypes internal to the LDAP library */ +#ifndef _LDAP_INT_H +#define _LDAP_INT_H 1 + +#ifdef LDAP_R_COMPILE +#define LDAP_THREAD_SAFE 1 +#endif + +#include "../liblber/lber-int.h" + +#define ldap_debug (ldap_int_global_options.ldo_debug) +#undef Debug +#define Debug( level, fmt, arg1, arg2, arg3 ) \ + ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) ) + +#include "ldap_log.h" + +#include "ldap.h" + +#include "ldap_pvt.h" + +LDAP_BEGIN_DECL #define LDAP_URL_PREFIX "ldap://" -#define LDAP_URL_PREFIX_LEN 7 -#define LDAP_URL_URLCOLON "URL:" -#define LDAP_URL_URLCOLON_LEN 4 +#define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1) +#define LDAPS_URL_PREFIX "ldaps://" +#define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1) +#define LDAP_URL_URLCOLON "URL:" +#define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1) +#define NULLLDAPURLDESC ((LDAPURLDesc *)NULL) -#ifdef LDAP_REFERRALS #define LDAP_REF_STR "Referral:\n" -#define LDAP_REF_STR_LEN 10 +#define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1) #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX -#define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN -#ifdef LDAP_DNS +#define LDAP_LDAP_REF_STR_LEN (sizeof(LDAP_LDAP_REF_STR)-1) + +#ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS #define LDAP_DX_REF_STR "dx://" -#define LDAP_DX_REF_STR_LEN 5 -#endif /* LDAP_DNS */ -#endif /* LDAP_REFERRALS */ +#define LDAP_DX_REF_STR_LEN (sizeof(LDAP_DX_REF_STR)-1) +#endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */ + +#define LDAP_DEFAULT_REFHOPLIMIT 5 + +#define LDAP_BOOL_REFERRALS 0 +#define LDAP_BOOL_RESTART 1 +#define LDAP_BOOL_DNS 2 +#define LDAP_BOOL_TLS 3 + +#define LDAP_BOOLEANS unsigned long +#define LDAP_BOOL(n) (1 << (n)) +#define LDAP_BOOL_GET(lo, bool) ((lo)->ldo_booleans & LDAP_BOOL(bool) \ + ? -1 : 0) +#define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool)) +#define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool)) +#define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0) + +/* + * This structure represents both ldap messages and ldap responses. + * These are really the same, except in the case of search responses, + * where a response has multiple messages. + */ + +struct ldapmsg { + ber_int_t lm_msgid; /* the message id */ + ber_tag_t lm_msgtype; /* the message type */ + BerElement *lm_ber; /* the ber encoded message contents */ + struct ldapmsg *lm_chain; /* for search - next msg in the resp */ + struct ldapmsg *lm_next; /* next response */ + time_t lm_time; /* used to maintain cache */ +}; + +/* + * structure representing get/set'able options + * which have global defaults. + */ +struct ldapoptions { + short ldo_valid; +#define LDAP_UNINITIALIZED 0x0 +#define LDAP_INITIALIZED 0x1 +#define LDAP_VALID_SESSION 0x2 + + int ldo_debug; + /* per API call timeout */ + struct timeval *ldo_tm_api; + struct timeval *ldo_tm_net; + + ber_int_t ldo_version; /* version to connect at */ + ber_int_t ldo_deref; + ber_int_t ldo_timelimit; + ber_int_t ldo_sizelimit; + + int ldo_defport; + char* ldo_defbase; + char* ldo_defhost; + +#ifdef LDAP_CONNECTIONLESS + int ldo_cldaptries; /* connectionless search retry count */ + int ldo_cldaptimeout;/* time between retries */ +#endif + + int ldo_refhoplimit; /* limit on referral nesting */ + + /* LDAPv3 server and client controls */ + LDAPControl **ldo_sctrls; + LDAPControl **ldo_cctrls; + +#ifdef HAVE_TLS + /* tls context */ + void *ldo_tls_ctx; + int ldo_tls_mode; +#endif + LDAP_BOOLEANS ldo_booleans; /* boolean options */ +}; + + +/* + * structure for tracking LDAP server host, ports, DNs, etc. + */ +typedef struct ldap_server { + char *lsrv_host; + char *lsrv_dn; /* if NULL, use default */ + int lsrv_port; + struct ldap_server *lsrv_next; +} LDAPServer; + + +/* + * structure for representing an LDAP server connection + */ +typedef struct ldap_conn { + Sockbuf *lconn_sb; + int lconn_refcnt; + time_t lconn_lastused; /* time */ + int lconn_status; +#define LDAP_CONNST_NEEDSOCKET 1 +#define LDAP_CONNST_CONNECTING 2 +#define LDAP_CONNST_CONNECTED 3 + LDAPServer *lconn_server; + char *lconn_krbinstance; + struct ldap_conn *lconn_next; + BerElement *lconn_ber;/* ber receiving on this conn. */ +} LDAPConn; + + +/* + * structure used to track outstanding requests + */ +typedef struct ldapreq { + ber_int_t lr_msgid; /* the message id */ + int lr_status; /* status of request */ +#define LDAP_REQST_INPROGRESS 1 +#define LDAP_REQST_CHASINGREFS 2 +#define LDAP_REQST_NOTCONNECTED 3 +#define LDAP_REQST_WRITING 4 + int lr_outrefcnt; /* count of outstanding referrals */ + ber_int_t lr_origid; /* original request's message id */ + int lr_parentcnt; /* count of parent requests */ + ber_tag_t lr_res_msgtype; /* result message type */ + ber_int_t lr_res_errno; /* result LDAP errno */ + char *lr_res_error; /* result error string */ + char *lr_res_matched;/* result matched DN string */ + BerElement *lr_ber; /* ber encoded request contents */ + LDAPConn *lr_conn; /* connection used to send request */ + struct ldapreq *lr_parent; /* request that spawned this referral */ + struct ldapreq *lr_refnext; /* next referral spawned */ + struct ldapreq *lr_prev; /* previous request */ + struct ldapreq *lr_next; /* next request */ +} LDAPRequest; + +/* + * structure for client cache + */ +#define LDAP_CACHE_BUCKETS 31 /* cache hash table size */ +typedef struct ldapcache { + LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */ + LDAPMessage *lc_requests; /* unfulfilled reqs */ + long lc_timeout; /* request timeout */ + ber_len_t lc_maxmem; /* memory to use */ + ber_len_t lc_memused; /* memory in use */ + int lc_enabled; /* enabled? */ + unsigned long lc_options; /* options */ +#define LDAP_CACHE_OPT_CACHENOERRS 0x00000001 +#define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002 +} LDAPCache; + +/* + * handy macro for checking if handle is connectionless + */ + +#define LDAP_IS_CLDAP(ld) ((ld)->ld_cldapnaddr>0) + +/* + * structure representing an ldap connection + */ + +struct ldap { + Sockbuf ld_sb; /* socket descriptor & buffer */ + + struct ldapoptions ld_options; + +#define ld_valid ld_options.ldo_valid +#define ld_debug ld_options.ldo_debug + +#define ld_deref ld_options.ldo_deref +#define ld_timelimit ld_options.ldo_timelimit +#define ld_sizelimit ld_options.ldo_sizelimit + +#define ld_defbase ld_options.ldo_defbase +#define ld_defhost ld_options.ldo_defhost +#define ld_defport ld_options.ldo_defport + +#define ld_cldaptries ld_options.ldo_cldaptries +#define ld_cldaptimeout ld_options.ldo_cldaptimeout +#define ld_refhoplimit ld_options.ldo_refhoplimit + +#define ld_sctrls ld_options.ldo_sctrls +#define ld_cctrls ld_options.ldo_cctrls + + ber_int_t ld_version; /* version connected at */ + char *ld_host; + int ld_port; + + unsigned short ld_lberoptions; + + LDAPFiltDesc *ld_filtd; /* from getfilter for ufn searches */ + char *ld_ufnprefix; /* for incomplete ufn's */ + + ber_int_t ld_errno; + char *ld_error; + char *ld_matched; + ber_len_t ld_msgid; + + /* do not mess with these */ + LDAPRequest *ld_requests; /* list of outstanding requests */ + LDAPMessage *ld_responses; /* list of outstanding responses */ + + ber_int_t *ld_abandoned; /* array of abandoned requests */ + + LDAPCache *ld_cache; /* non-null if cache is initialized */ + /* stuff used by connectionless searches. */ + + char *ld_cldapdn; /* DN used in connectionless search */ + int ld_cldapnaddr; /* number of addresses */ + void **ld_cldapaddrs;/* addresses to send request to */ + + /* do not mess with the rest though */ + BERTranslateProc ld_lber_encode_translate_proc; + BERTranslateProc ld_lber_decode_translate_proc; + + LDAPConn *ld_defconn; /* default connection */ + LDAPConn *ld_conns; /* list of server connections */ + void *ld_selectinfo; /* platform specifics for select */ + int (*ld_rebindproc)( struct ldap *ld, char **dnp, + char **passwdp, int *authmethodp, int freeit ); + /* routine to get info needed for re-bind */ +}; +#define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION ) + +/* + * in init.c + */ + +extern struct ldapoptions ldap_int_global_options; +void ldap_int_initialize LDAP_P((void)); + + +/* memory.c */ + /* simple macros to realloc for now */ +#define LDAP_INT_MALLOC(s) (LBER_MALLOC((s))) +#define LDAP_INT_CALLOC(n,s) (LBER_CALLOC((n),(s))) +#define LDAP_INT_REALLOC(p,s) (LBER_REALLOC((p),(s))) +#define LDAP_INT_FREE(p) (LBER_FREE((p))) +#define LDAP_INT_VFREE(v) (LBER_VFREE((void **)(v))) +#define LDAP_INT_STRDUP(s) (LBER_STRDUP((s))) + +#define LDAP_MALLOC(s) (LBER_MALLOC((s))) +#define LDAP_CALLOC(n,s) (LBER_CALLOC((n),(s))) +#define LDAP_REALLOC(p,s) (LBER_REALLOC((p),(s))) +#define LDAP_FREE(p) (LBER_FREE((p))) +#define LDAP_VFREE(v) (LBER_VFREE((void **)(v))) +#define LDAP_STRDUP(s) (LBER_STRDUP((s))) + +/* + * in unit-int.c + */ +void ldap_int_utils_init LDAP_P(( void )); + + +/* + * in print.c + */ +int ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)); -LDAP_BEGIN_DECL /* * in cache.c */ -void ldap_add_request_to_cache LDAP_P(( LDAP *ld, unsigned long msgtype, +void ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request )); void ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result )); -int ldap_check_cache LDAP_P(( LDAP *ld, unsigned long msgtype, BerElement *request )); +int ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request )); + +/* + * in controls.c + */ +LDAPControl *ldap_control_dup LDAP_P(( + const LDAPControl *ctrl )); + +LDAPControl **ldap_controls_dup LDAP_P(( + LDAPControl *const *ctrls )); + +int ldap_int_get_controls LDAP_P(( + BerElement *be, + LDAPControl ***ctrlsp)); +int ldap_int_put_controls LDAP_P(( + LDAP *ld, + LDAPControl *const *ctrls, + BerElement *ber )); + +/* + * in dsparse.c + */ +int next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp )); +void free_strarray LDAP_P(( char **sap )); #ifdef HAVE_KERBEROS /* * in kerberos.c */ -char *ldap_get_kerberosv4_credentials LDAP_P(( LDAP *ld, char *who, char *service, - int *len )); +char *ldap_get_kerberosv4_credentials LDAP_P(( + LDAP *ld, + LDAP_CONST char *who, + LDAP_CONST char *service, + ber_len_t *len )); #endif /* HAVE_KERBEROS */ @@ -45,22 +349,25 @@ char *ldap_get_kerberosv4_credentials LDAP_P(( LDAP *ld, char *who, char *servic /* * in open.c */ -int open_ldap_connection( LDAP *ld, Sockbuf *sb, char *host, int defport, +int open_ldap_connection( LDAP *ld, Sockbuf *sb, const char *host, int defport, char **krbinstancep, int async ); /* * in os-ip.c */ -int ldap_connect_to_host( Sockbuf *sb, char *host, unsigned long address, int port, - int async ); +extern int ldap_int_tblsize; +int ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm ); +int ldap_connect_to_host( LDAP *ld, Sockbuf *sb, const char *host, + unsigned long address, int port, int async ); + void ldap_close_connection( Sockbuf *sb ); #ifdef HAVE_KERBEROS char *ldap_host_connected_to( Sockbuf *sb ); #endif /* HAVE_KERBEROS */ -#ifdef LDAP_REFERRALS +void ldap_int_ip_init( void ); int do_ldap_select( LDAP *ld, struct timeval *timeout ); void *ldap_new_select_info( void ); void ldap_free_select_info( void *sip ); @@ -69,55 +376,78 @@ void ldap_mark_select_read( LDAP *ld, Sockbuf *sb ); void ldap_mark_select_clear( LDAP *ld, Sockbuf *sb ); int ldap_is_read_ready( LDAP *ld, Sockbuf *sb ); int ldap_is_write_ready( LDAP *ld, Sockbuf *sb ); -#endif /* LDAP_REFERRALS */ /* * in request.c */ -int ldap_send_initial_request( LDAP *ld, unsigned long msgtype, - char *dn, BerElement *ber ); +ber_int_t ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype, + const char *dn, BerElement *ber ); BerElement *ldap_alloc_ber_with_options( LDAP *ld ); void ldap_set_ber_options( LDAP *ld, BerElement *ber ); -#if defined( LDAP_REFERRALS ) || defined( LDAP_DNS ) -int ldap_send_server_request( LDAP *ld, BerElement *ber, int msgid, +int ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPServer *srvlist, LDAPConn *lc, int bind ); LDAPConn *ldap_new_connection( LDAP *ld, LDAPServer **srvlistp, int use_ldsb, int connect, int bind ); -LDAPRequest *ldap_find_request_by_msgid( LDAP *ld, int msgid ); +LDAPRequest *ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid ); void ldap_free_request( LDAP *ld, LDAPRequest *lr ); void ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind ); void ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all ); void ldap_dump_requests_and_responses( LDAP *ld ); -#endif /* LDAP_REFERRALS || LDAP_DNS */ -#ifdef LDAP_REFERRALS int ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp ); int ldap_append_referral( LDAP *ld, char **referralsp, char *s ); -#endif /* LDAP_REFERRALS */ +/* + * in result.c: + */ +#ifdef LDAP_CONNECTIONLESS +int cldap_getmsg( LDAP *ld, struct timeval *timeout, BerElement *ber ); +#endif /* * in search.c */ -BerElement *ldap_build_search_req( LDAP *ld, char *base, int scope, - char *filter, char **attrs, int attrsonly ); +BerElement *ldap_build_search_req LDAP_P(( + LDAP *ld, + const char *base, + ber_int_t scope, + const char *filter, + char **attrs, + ber_int_t attrsonly, + LDAPControl **sctrls, + LDAPControl **cctrls, + ber_int_t timelimit, + ber_int_t sizelimit )); +/* + * in string.c + */ + /* see */ /* * in unbind.c */ -int ldap_ld_free( LDAP *ld, int close ); -int ldap_send_unbind( LDAP *ld, Sockbuf *sb ); +int ldap_ld_free LDAP_P(( + LDAP *ld, + int close, + LDAPControl **sctrls, + LDAPControl **cctrls )); + +int ldap_send_unbind LDAP_P(( + LDAP *ld, + Sockbuf *sb, + LDAPControl **sctrls, + LDAPControl **cctrls )); -#ifdef LDAP_DNS +#ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS /* * in getdxbyname.c */ -char **ldap_getdxbyname( char *domain ); -#endif /* LDAP_DNS */ +char **ldap_getdxbyname( const char *domain ); +#endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */ #if defined( STR_TRANSLATION ) && defined( LDAP_DEFAULT_CHARSET ) /* @@ -129,10 +459,12 @@ char **ldap_getdxbyname( char *domain ); */ #if LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET extern -int ldap_t61_to_8859( char **bufp, unsigned long *buflenp, int free_input ); +int ldap_t61_to_8859( char **bufp, ber_len_t *buflenp, int free_input ); extern -int ldap_8859_to_t61( char **bufp, unsigned long *buflenp, int free_input ); +int ldap_8859_to_t61( char **bufp, ber_len_t *buflenp, int free_input ); #endif /* LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET */ +#endif /* STR_TRANSLATION && LDAP_DEFAULT_CHARSET */ LDAP_END_DECL -#endif /* STR_TRANSLATION && LDAP_DEFAULT_CHARSET */ + +#endif /* _LDAP_INT_H */