]> git.sur5r.net Git - openldap/blobdiff - libraries/libldap/ldap-int.h
ITS#6254
[openldap] / libraries / libldap / ldap-int.h
index 11100f21f71654a01f4ab5a5d92be6869344a9a3..6c5b22e1d8c7c7585a18b5b00a474cd2d544b9c8 100644 (file)
@@ -2,7 +2,7 @@
 /* $OpenLDAP$ */
 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  *
- * Copyright 1998-2005 The OpenLDAP Foundation.
+ * Copyright 1998-2009 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
 #include <sasl.h>
 #endif
 
-#define SASL_MAX_BUFF_SIZE     65536
+#define SASL_MAX_BUFF_SIZE     (0xffffff)
 #define SASL_MIN_BUFF_SIZE     4096
 #endif
 
+/* for struct timeval */
+#include <ac/time.h>
+
 #undef TV2MILLISEC
 #define TV2MILLISEC(tv) (((tv)->tv_sec * 1000) + ((tv)->tv_usec/1000))
 
@@ -72,6 +75,9 @@
 
 #ifdef LDAP_DEBUG
 
+#define DebugTest( level ) \
+       ( ldap_debug & level )
+
 #define Debug( level, fmt, arg1, arg2, arg3 ) \
        do { if ( ldap_debug & level ) \
        ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) ); \
@@ -82,6 +88,7 @@
 
 #else
 
+#define DebugTest( level )                                    (0 == 1)
 #define Debug( level, fmt, arg1, arg2, arg3 )                 ((void)0)
 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 ) ((void)0)
 
 LDAP_BEGIN_DECL
 
 #define LDAP_URL_PREFIX         "ldap://"
-#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_PREFIX_LEN     STRLENOF(LDAP_URL_PREFIX)
+#define LDAPS_URL_PREFIX       "ldaps://"
+#define LDAPS_URL_PREFIX_LEN   STRLENOF(LDAPS_URL_PREFIX)
 #define LDAPI_URL_PREFIX       "ldapi://"
-#define LDAPI_URL_PREFIX_LEN   (sizeof(LDAPI_URL_PREFIX)-1)
+#define LDAPI_URL_PREFIX_LEN   STRLENOF(LDAPI_URL_PREFIX)
 #ifdef LDAP_CONNECTIONLESS
 #define LDAPC_URL_PREFIX       "cldap://"
-#define LDAPC_URL_PREFIX_LEN   (sizeof(LDAPC_URL_PREFIX)-1)
+#define LDAPC_URL_PREFIX_LEN   STRLENOF(LDAPC_URL_PREFIX)
 #endif
-#define LDAP_URL_URLCOLON              "URL:"
-#define LDAP_URL_URLCOLON_LEN  (sizeof(LDAP_URL_URLCOLON)-1)
+#define LDAP_URL_URLCOLON      "URL:"
+#define LDAP_URL_URLCOLON_LEN  STRLENOF(LDAP_URL_URLCOLON)
 
 #define LDAP_REF_STR           "Referral:\n"
-#define LDAP_REF_STR_LEN       (sizeof(LDAP_REF_STR)-1)
+#define LDAP_REF_STR_LEN       STRLENOF(LDAP_REF_STR)
 #define LDAP_LDAP_REF_STR      LDAP_URL_PREFIX
 #define LDAP_LDAP_REF_STR_LEN  LDAP_URL_PREFIX_LEN
 
@@ -117,6 +124,8 @@ LDAP_BEGIN_DECL
 #define LDAP_BOOL_REFERRALS            0
 #define LDAP_BOOL_RESTART              1
 #define LDAP_BOOL_TLS                  3
+#define        LDAP_BOOL_CONNECT_ASYNC         4
+#define        LDAP_BOOL_SASL_NOCANON          5
 
 #define LDAP_BOOLEANS  unsigned long
 #define LDAP_BOOL(n)   ((LDAP_BOOLEANS)1 << (n))
@@ -142,6 +151,25 @@ struct ldapmsg {
        time_t  lm_time;        /* used to maintain cache */
 };
 
+#ifdef HAVE_TLS
+struct ldaptls {
+       char            *lt_certfile;
+       char            *lt_keyfile;
+       char            *lt_dhfile;
+       char            *lt_cacertfile;
+       char            *lt_cacertdir;
+       char            *lt_ciphersuite;
+       char            *lt_crlfile;
+       char            *lt_randfile;   /* OpenSSL only */
+       int             lt_protocol_min;
+};
+#endif
+
+typedef struct ldaplist {
+       struct ldaplist *ll_next;
+       void *ll_data;
+} ldaplist;
+
 /*
  * structure representing get/set'able options
  * which have global defaults.
@@ -151,6 +179,7 @@ struct ldapoptions {
 #define LDAP_UNINITIALIZED     0x0
 #define LDAP_INITIALIZED       0x1
 #define LDAP_VALID_SESSION     0x2
+#define LDAP_TRASHED_SESSION   0xFF
        int   ldo_debug;
 #ifdef LDAP_CONNECTIONLESS
 #define        LDAP_IS_UDP(ld)         ((ld)->ld_options.ldo_is_udp)
@@ -160,8 +189,8 @@ struct ldapoptions {
 #endif
 
        /* per API call timeout */
-       struct timeval          *ldo_tm_api;
-       struct timeval          *ldo_tm_net;
+       struct timeval          ldo_tm_api;
+       struct timeval          ldo_tm_net;
 
        ber_int_t               ldo_version;
        ber_int_t               ldo_deref;
@@ -169,9 +198,26 @@ struct ldapoptions {
        ber_int_t               ldo_sizelimit;
 
 #ifdef HAVE_TLS
-       int                     ldo_tls_mode;
+       /* tls context */
+       void            *ldo_tls_ctx;
        LDAP_TLS_CONNECT_CB     *ldo_tls_connect_cb;
        void*                   ldo_tls_connect_arg;
+       struct ldaptls ldo_tls_info;
+#define ldo_tls_certfile       ldo_tls_info.lt_certfile
+#define ldo_tls_keyfile        ldo_tls_info.lt_keyfile
+#define ldo_tls_dhfile ldo_tls_info.lt_dhfile
+#define ldo_tls_cacertfile     ldo_tls_info.lt_cacertfile
+#define ldo_tls_cacertdir      ldo_tls_info.lt_cacertdir
+#define ldo_tls_ciphersuite    ldo_tls_info.lt_ciphersuite
+#define ldo_tls_protocol_min   ldo_tls_info.lt_protocol_min
+#define ldo_tls_crlfile        ldo_tls_info.lt_crlfile
+#define ldo_tls_randfile       ldo_tls_info.lt_randfile
+       int                     ldo_tls_mode;
+       int                     ldo_tls_require_cert;
+       int                     ldo_tls_impl;
+#ifdef HAVE_OPENSSL_CRL
+       int                     ldo_tls_crlcheck;
+#endif
 #endif
 
        LDAPURLDesc *ldo_defludp;
@@ -189,6 +235,23 @@ struct ldapoptions {
        struct sasl_security_properties ldo_sasl_secprops;
 #endif
 
+#ifdef HAVE_GSSAPI
+       unsigned gssapi_flags;
+
+       unsigned ldo_gssapi_flags;
+#define LDAP_GSSAPI_OPT_DO_NOT_FREE_GSS_CONTEXT        0x0001
+#define LDAP_GSSAPI_OPT_ALLOW_REMOTE_PRINCIPAL 0x0002
+       unsigned ldo_gssapi_options;
+#endif
+
+       /*
+        * Per connection tcp-keepalive settings (Linux only,
+        * ignored where unsupported)
+        */
+       ber_int_t ldo_keepalive_idle;
+       ber_int_t ldo_keepalive_probes;
+       ber_int_t ldo_keepalive_interval;
+
        int             ldo_refhoplimit;        /* limit on referral nesting */
 
        /* LDAPv3 server and client controls */
@@ -200,6 +263,11 @@ struct ldapoptions {
        void *ldo_rebind_params;
        LDAP_NEXTREF_PROC *ldo_nextref_proc;
        void *ldo_nextref_params;
+       LDAP_URLLIST_PROC *ldo_urllist_proc;
+       void *ldo_urllist_params;
+
+       /* LDAP connection callback stack */
+       ldaplist *ldo_conn_cbs;
 
        LDAP_BOOLEANS ldo_booleans;     /* boolean options */
 };
@@ -210,15 +278,15 @@ struct ldapoptions {
  */
 typedef struct ldap_conn {
        Sockbuf         *lconn_sb;
-#ifdef HAVE_TLS
-       /* tls context */
-       void            *lconn_tls_ctx;
-#endif
 #ifdef HAVE_CYRUS_SASL
        void            *lconn_sasl_authctx;    /* context for bind */
        void            *lconn_sasl_sockctx;    /* for security layer */
+#endif
+#ifdef HAVE_GSSAPI
+       void            *lconn_gss_ctx;         /* gss_ctx_id_t */
 #endif
        int                     lconn_refcnt;
+       time_t          lconn_created;  /* time */
        time_t          lconn_lastused; /* time */
        int                     lconn_rebind_inprogress;        /* set if rebind in progress */
        char            ***lconn_rebind_queue;          /* used if rebind in progress */
@@ -227,9 +295,6 @@ typedef struct ldap_conn {
 #define LDAP_CONNST_CONNECTING         2
 #define LDAP_CONNST_CONNECTED          3
        LDAPURLDesc             *lconn_server;
-#ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
-       char                    *lconn_krbinstance;
-#endif
        BerElement              *lconn_ber;     /* ber receiving on this conn. */
 
        struct ldap_conn *lconn_next;
@@ -240,22 +305,25 @@ typedef struct ldap_conn {
  * structure used to track outstanding requests
  */
 typedef struct ldapreq {
-       ber_int_t               lr_msgid;       /* the message id */
+       ber_int_t       lr_msgid;       /* the message id */
        int             lr_status;      /* status of request */
 #define LDAP_REQST_COMPLETED   0
 #define LDAP_REQST_INPROGRESS  1
 #define LDAP_REQST_CHASINGREFS 2
 #define LDAP_REQST_NOTCONNECTED        3
 #define LDAP_REQST_WRITING     4
+       int             lr_refcnt;      /* count of references */
        int             lr_outrefcnt;   /* count of outstanding referrals */
-       ber_int_t               lr_origid;      /* original request's message id */
+       int             lr_abandoned;   /* the request has been abandoned */
+       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 */
+       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 berval   lr_dn;          /* DN of request, in lr_ber */
        struct ldapreq  *lr_parent;     /* request that spawned this referral */
        struct ldapreq  *lr_child;      /* first child request */
        struct ldapreq  *lr_refnext;    /* next referral spawned */
@@ -317,6 +385,8 @@ struct ldap {
 #define ld_rebind_params       ld_options.ldo_rebind_params
 #define ld_nextref_proc                ld_options.ldo_nextref_proc
 #define ld_nextref_params      ld_options.ldo_nextref_params
+#define ld_urllist_proc                ld_options.ldo_urllist_proc
+#define ld_urllist_params      ld_options.ldo_urllist_params
 
 #define ld_version             ld_options.ldo_version
 
@@ -333,11 +403,13 @@ struct ldap {
        LDAPMessage     *ld_responses;  /* list of outstanding responses */
 
 #ifdef LDAP_R_COMPILE
+       ldap_pvt_thread_mutex_t ld_conn_mutex;
        ldap_pvt_thread_mutex_t ld_req_mutex;
        ldap_pvt_thread_mutex_t ld_res_mutex;
 #endif
 
-       ber_int_t               *ld_abandoned;  /* array of abandoned requests */
+       ber_len_t       ld_nabandoned;
+       ber_int_t       *ld_abandoned;  /* array of abandoned requests */
 
        LDAPCache       *ld_cache;      /* non-null if cache is initialized */
 
@@ -347,7 +419,9 @@ struct ldap {
        LDAPConn        *ld_conns;      /* list of server connections */
        void            *ld_selectinfo; /* platform specifics for select */
 };
-#define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
+#define LDAP_VALID(ld)         ( (ld)->ld_valid == LDAP_VALID_SESSION )
+#define LDAP_TRASHED(ld)       ( (ld)->ld_valid == LDAP_TRASHED_SESSION )
+#define LDAP_TRASH(ld)         ( (ld)->ld_valid = LDAP_TRASHED_SESSION )
 
 #ifdef LDAP_R_COMPILE
 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
@@ -355,6 +429,9 @@ LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
 #ifdef HAVE_CYRUS_SASL
 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
 #endif
+#ifdef HAVE_GSSAPI
+LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_gssapi_mutex;
+#endif
 #endif
 
 #ifdef LDAP_R_COMPILE
@@ -366,6 +443,17 @@ LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
 #define        LDAP_NEXT_MSGID(ld, id) id = ++(ld)->ld_msgid
 #endif
 
+/*
+ * in abandon.c
+ */
+
+LDAP_F (int)
+ldap_int_bisect_find( ber_int_t *v, ber_len_t n, ber_int_t id, int *idxp );
+LDAP_F (int)
+ldap_int_bisect_insert( ber_int_t **vp, ber_len_t *np, int id, int idx );
+LDAP_F (int)
+ldap_int_bisect_delete( ber_int_t **vp, ber_len_t *np, int id, int idx );
+
 /*
  * in init.c
  */
@@ -435,18 +523,6 @@ LDAP_F (int) ldap_int_client_controls LDAP_P((
  */
 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
 
-#ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
-/*
- * in kerberos.c
- */
-LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
-       LDAP *ld,
-       LDAP_CONST char *who,
-       LDAP_CONST char *service,
-       ber_len_t *len ));
-
-#endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
-
 
 /*
  * in open.c
@@ -466,10 +542,11 @@ LDAP_F (void) ldap_int_ip_init( void );
 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest,
        const struct timeval *tm );
 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
-       int proto, const char *host, int port, int async );
+       int proto, LDAPURLDesc *srv, int async );
+LDAP_F (int) ldap_int_poll( LDAP *ld, ber_socket_t s,
+       struct timeval *tvp );
 
-#if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
-       defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
+#if defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
 LDAP_V (char *) ldap_int_hostname;
 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb,
        const char *host );
@@ -484,12 +561,15 @@ LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
 
+LDAP_F (int) ldap_int_connect_cbs( LDAP *ld, Sockbuf *sb,
+       ber_socket_t *s, LDAPURLDesc *srv, struct sockaddr *addr );
+
 /*
  * in os-local.c
  */
 #ifdef LDAP_PF_LOCAL
 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
-       const char *path, int async );
+       LDAPURLDesc *srv, int async );
 #endif /* LDAP_PF_LOCAL */
 
 /*
@@ -500,9 +580,10 @@ LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
 
-LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
-LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
+LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc **srvlist, LDAPConn *lc, LDAPreqinfo *bind );
+LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
+LDAP_F (void) ldap_return_request( LDAP *ld, LDAPRequest *lr, int freeit );
 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
@@ -517,7 +598,7 @@ LDAP_F (int) ldap_int_flush_request( LDAP *ld, LDAPRequest *lr );
 /*
  * in result.c:
  */
-LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
+LDAP_F (const char *) ldap_int_msgtype2str( ber_tag_t tag );
 
 /*
  * in search.c
@@ -533,6 +614,7 @@ LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
        LDAPControl **cctrls,
        ber_int_t timelimit,
        ber_int_t sizelimit,
+       ber_int_t deref,
        ber_int_t *msgidp));
 
 
@@ -560,15 +642,6 @@ LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
        LDAPURLDesc *ludlist ));
 
-LDAP_F (int) ldap_url_parselist LDAP_P((
-       LDAPURLDesc **ludlist,
-       const char *url ));
-
-LDAP_F (int) ldap_url_parselist_ext LDAP_P((
-       LDAPURLDesc **ludlist,
-       const char *url,
-       const char *sep ));
-
 LDAP_F (int) ldap_url_parsehosts LDAP_P((
        LDAPURLDesc **ludlist,
        const char *hosts,
@@ -577,12 +650,6 @@ LDAP_F (int) ldap_url_parsehosts LDAP_P((
 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
        LDAPURLDesc *ludlist ));
 
-LDAP_F (char *) ldap_url_list2urls LDAP_P((
-       LDAPURLDesc *ludlist ));
-
-LDAP_F (void) ldap_free_urllist LDAP_P((
-       LDAPURLDesc *ludlist ));
-
 /*
  * in cyrus.c
  */
@@ -631,12 +698,24 @@ LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
        LDAPConn *conn, LDAPURLDesc *srv ));
 
+LDAP_F (void) ldap_int_tls_destroy LDAP_P(( struct ldapoptions *lo ));
+
 /*
  *     in getvalues.c
  */
 LDAP_F (char **) ldap_value_dup LDAP_P((
        char *const *vals ));
 
+/*
+ *     in gssapi.c
+ */
+#ifdef HAVE_GSSAPI
+LDAP_F(int) ldap_int_gssapi_get_option LDAP_P(( LDAP *ld, int option, void *arg ));
+LDAP_F(int) ldap_int_gssapi_set_option LDAP_P(( LDAP *ld, int option, void *arg ));
+LDAP_F(int) ldap_int_gssapi_config LDAP_P(( struct ldapoptions *lo, int option, const char *arg ));
+LDAP_F(void) ldap_int_gssapi_close LDAP_P(( LDAP *ld, LDAPConn *lc ));
+#endif 
+
 LDAP_END_DECL
 
 #endif /* _LDAP_INT_H */