git.sur5r.net Git - openldap/blob - servers/slapd/back-ldap/back-ldap.h

   1 /* back-ldap.h - ldap backend header file */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1999-2006 The OpenLDAP Foundation.
   6  * Portions Copyright 2000-2003 Pierangelo Masarati.
   7  * Portions Copyright 1999-2003 Howard Chu.
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted only as authorized by the OpenLDAP
  12  * Public License.
  13  *
  14  * A copy of this license is available in the file LICENSE in the
  15  * top-level directory of the distribution or, alternatively, at
  16  * <http://www.OpenLDAP.org/license.html>.
  17  */
  18 /* ACKNOWLEDGEMENTS:
  19  * This work was initially developed by the Howard Chu for inclusion
  20  * in OpenLDAP Software and subsequently enhanced by Pierangelo
  21  * Masarati.
  22  */
  23
  24 #ifndef SLAPD_LDAP_H
  25 #define SLAPD_LDAP_H
  26
  27 LDAP_BEGIN_DECL
  28
  29 typedef struct ldapconn_t {
  30         Connection              *lc_conn;
  31 #define LDAP_BACK_PCONN         ((void *)0x0)
  32 #define LDAP_BACK_PCONN_TLS     ((void *)0x1)
  33 #define LDAP_BACK_PCONN_ID(c)   ((void *)(c) > LDAP_BACK_PCONN_TLS ? (c)->c_connid : -1)
  34 #ifdef HAVE_TLS
  35 #define LDAP_BACK_PCONN_SET(op) ((op)->o_conn->c_is_tls ? LDAP_BACK_PCONN_TLS : LDAP_BACK_PCONN)
  36 #else /* ! HAVE_TLS */
  37 #define LDAP_BACK_PCONN_SET(op) (LDAP_BACK_PCONN)
  38 #endif /* ! HAVE_TLS */
  39
  40         LDAP                    *lc_ld;
  41         struct berval           lc_cred;
  42         struct berval           lc_bound_ndn;
  43         struct berval           lc_local_ndn;
  44         unsigned                lc_lcflags;
  45 #define LDAP_BACK_CONN_ISSET(lc,f)      ((lc)->lc_lcflags & (f))
  46 #define LDAP_BACK_CONN_SET(lc,f)        ((lc)->lc_lcflags |= (f))
  47 #define LDAP_BACK_CONN_CLEAR(lc,f)      ((lc)->lc_lcflags &= ~(f))
  48 #define LDAP_BACK_CONN_CPY(lc,f,mlc) \
  49         do { \
  50                 if ( ((f) & (mlc)->lc_lcflags) == (f) ) { \
  51                         (lc)->lc_lcflags |= (f); \
  52                 } else { \
  53                         (lc)->lc_lcflags &= ~(f); \
  54                 } \
  55         } while ( 0 )
  56
  57 #define LDAP_BACK_FCONN_ISBOUND (0x00000001U)
  58 #define LDAP_BACK_FCONN_ISANON  (0x00000002U)
  59 #define LDAP_BACK_FCONN_ISBMASK (LDAP_BACK_FCONN_ISBOUND|LDAP_BACK_FCONN_ISANON)
  60 #define LDAP_BACK_FCONN_ISPRIV  (0x00000004U)
  61 #define LDAP_BACK_FCONN_ISTLS   (0x00000008U)
  62 #define LDAP_BACK_FCONN_BINDING (0x00000010U)
  63 #define LDAP_BACK_FCONN_TAINTED (0x00000020U)
  64
  65 /* 0x00FF0000 are reserved for back-meta */
  66
  67 #define LDAP_BACK_CONN_ISBOUND(lc)              LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISBOUND)
  68 #define LDAP_BACK_CONN_ISBOUND_SET(lc)          LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISBOUND)
  69 #define LDAP_BACK_CONN_ISBOUND_CLEAR(lc)        LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISBMASK)
  70 #define LDAP_BACK_CONN_ISBOUND_CPY(lc, mlc)     LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISBOUND, (mlc))
  71 #define LDAP_BACK_CONN_ISANON(lc)               LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISANON)
  72 #define LDAP_BACK_CONN_ISANON_SET(lc)           LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISANON)
  73 #define LDAP_BACK_CONN_ISANON_CLEAR(lc)         LDAP_BACK_CONN_ISBOUND_CLEAR((lc))
  74 #define LDAP_BACK_CONN_ISANON_CPY(lc, mlc)      LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISANON, (mlc))
  75 #define LDAP_BACK_CONN_ISPRIV(lc)               LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISPRIV)
  76 #define LDAP_BACK_CONN_ISPRIV_SET(lc)           LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISPRIV)
  77 #define LDAP_BACK_CONN_ISPRIV_CLEAR(lc)         LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISPRIV)
  78 #define LDAP_BACK_CONN_ISPRIV_CPY(lc, mlc)      LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISPRIV, (mlc))
  79 #define LDAP_BACK_CONN_ISTLS(lc)                LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISTLS)
  80 #define LDAP_BACK_CONN_ISTLS_SET(lc)            LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISTLS)
  81 #define LDAP_BACK_CONN_ISTLS_CLEAR(lc)          LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISTLS)
  82 #define LDAP_BACK_CONN_ISTLS_CPY(lc, mlc)       LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISTLS, (mlc))
  83 #define LDAP_BACK_CONN_BINDING(lc)              LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_BINDING)
  84 #define LDAP_BACK_CONN_BINDING_SET(lc)          LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_BINDING)
  85 #define LDAP_BACK_CONN_BINDING_CLEAR(lc)        LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_BINDING)
  86 #define LDAP_BACK_CONN_TAINTED(lc)              LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_TAINTED)
  87 #define LDAP_BACK_CONN_TAINTED_SET(lc)          LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_TAINTED)
  88 #define LDAP_BACK_CONN_TAINTED_CLEAR(lc)        LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_TAINTED)
  89
  90         unsigned                lc_refcnt;
  91         unsigned                lc_binding;
  92         unsigned                lc_flags;
  93         time_t                  lc_create_time;
  94         time_t                  lc_time;
  95 } ldapconn_t;
  96
  97 /*
  98  * identity assertion modes
  99  */
 100 enum {
 101         LDAP_BACK_IDASSERT_LEGACY = 1,
 102         LDAP_BACK_IDASSERT_NOASSERT,
 103         LDAP_BACK_IDASSERT_ANONYMOUS,
 104         LDAP_BACK_IDASSERT_SELF,
 105         LDAP_BACK_IDASSERT_OTHERDN,
 106         LDAP_BACK_IDASSERT_OTHERID
 107 };
 108
 109 /*
 110  * operation enumeration for timeouts
 111  */
 112 enum {
 113         LDAP_BACK_OP_ADD = 0,
 114         LDAP_BACK_OP_DELETE,
 115         LDAP_BACK_OP_MODIFY,
 116         LDAP_BACK_OP_MODRDN,
 117         LDAP_BACK_OP_LAST
 118 };
 119
 120 typedef struct ldap_avl_info_t {
 121         ldap_pvt_thread_mutex_t         lai_mutex;
 122         Avlnode                         *lai_tree;
 123 } ldap_avl_info_t;
 124
 125 typedef struct ldapinfo_t {
 126         /* li_uri: the string that goes into ldap_initialize()
 127          * TODO: use li_acl.sb_uri instead */
 128         char            *li_uri;
 129         /* li_bvuri: an array of each single URI that is equivalent;
 130          * to be checked for the presence of a certain item */
 131         BerVarray       li_bvuri;
 132         ldap_pvt_thread_mutex_t li_uri_mutex;
 133
 134         LDAP_REBIND_PROC        *li_rebind_f;
 135         LDAP_URLLIST_PROC       *li_urllist_f;
 136         void                    *li_urllist_p;
 137
 138         slap_bindconf   li_acl;
 139 #define li_acl_authcID  li_acl.sb_authcId
 140 #define li_acl_authcDN  li_acl.sb_binddn
 141 #define li_acl_passwd   li_acl.sb_cred
 142 #define li_acl_authzID  li_acl.sb_authzId
 143 #define li_acl_authmethod       li_acl.sb_method
 144 #define li_acl_sasl_mech        li_acl.sb_saslmech
 145 #define li_acl_sasl_realm       li_acl.sb_realm
 146 #define li_acl_secprops li_acl.sb_secprops
 147
 148         /* ID assert stuff */
 149         int             li_idassert_mode;
 150
 151         slap_bindconf   li_idassert;
 152 #define li_idassert_authcID     li_idassert.sb_authcId
 153 #define li_idassert_authcDN     li_idassert.sb_binddn
 154 #define li_idassert_passwd      li_idassert.sb_cred
 155 #define li_idassert_authzID     li_idassert.sb_authzId
 156 #define li_idassert_authmethod  li_idassert.sb_method
 157 #define li_idassert_sasl_mech   li_idassert.sb_saslmech
 158 #define li_idassert_sasl_realm  li_idassert.sb_realm
 159 #define li_idassert_secprops    li_idassert.sb_secprops
 160
 161         unsigned        li_idassert_flags;
 162 #define LDAP_BACK_AUTH_NONE                             0x00U
 163 #define LDAP_BACK_AUTH_NATIVE_AUTHZ                     0x01U
 164 #define LDAP_BACK_AUTH_OVERRIDE                         0x02U
 165 #define LDAP_BACK_AUTH_PRESCRIPTIVE                     0x04U
 166 #define LDAP_BACK_AUTH_OBSOLETE_PROXY_AUTHZ             0x08U
 167 #define LDAP_BACK_AUTH_OBSOLETE_ENCODING_WORKAROUND     0x10U
 168
 169         BerVarray       li_idassert_authz;
 170         /* end of ID assert stuff */
 171
 172         int             li_nretries;
 173 #define LDAP_BACK_RETRY_UNDEFINED       (-2)
 174 #define LDAP_BACK_RETRY_FOREVER         (-1)
 175 #define LDAP_BACK_RETRY_NEVER           (0)
 176 #define LDAP_BACK_RETRY_DEFAULT         (3)
 177
 178         unsigned        li_flags;
 179 #define LDAP_BACK_F_NONE                (0x0000U)
 180 #define LDAP_BACK_F_SAVECRED            (0x0001U)
 181 #define LDAP_BACK_F_USE_TLS             (0x0002U)
 182 #define LDAP_BACK_F_PROPAGATE_TLS       (0x0004U)
 183 #define LDAP_BACK_F_TLS_CRITICAL        (0x0008U)
 184 #define LDAP_BACK_F_TLS_USE_MASK        (LDAP_BACK_F_USE_TLS|LDAP_BACK_F_TLS_CRITICAL)
 185 #define LDAP_BACK_F_TLS_PROPAGATE_MASK  (LDAP_BACK_F_PROPAGATE_TLS|LDAP_BACK_F_TLS_CRITICAL)
 186 #define LDAP_BACK_F_TLS_MASK            (LDAP_BACK_F_TLS_USE_MASK|LDAP_BACK_F_TLS_PROPAGATE_MASK)
 187 #define LDAP_BACK_F_CHASE_REFERRALS     (0x0010U)
 188 #define LDAP_BACK_F_PROXY_WHOAMI        (0x0020U)
 189
 190 #define LDAP_BACK_F_T_F                 (0x0040U)
 191 #define LDAP_BACK_F_T_F_DISCOVER        (0x0080U)
 192 #define LDAP_BACK_F_T_F_MASK            (LDAP_BACK_F_T_F)
 193 #define LDAP_BACK_F_T_F_MASK2           (LDAP_BACK_F_T_F_MASK|LDAP_BACK_F_T_F_DISCOVER)
 194
 195 #define LDAP_BACK_F_MONITOR             (0x0100U)
 196 #define LDAP_BACK_F_SINGLECONN          (0x0200U)
 197
 198 #define LDAP_BACK_F_ISOPEN              (0x0400U)
 199
 200 #define LDAP_BACK_F_CANCEL_ABANDON      (0x0000U)
 201 #define LDAP_BACK_F_CANCEL_IGNORE       (0x1000U)
 202 #define LDAP_BACK_F_CANCEL_EXOP         (0x2000U)
 203 #define LDAP_BACK_F_CANCEL_EXOP_DISCOVER        (0x4000U)
 204 #define LDAP_BACK_F_CANCEL_MASK         (LDAP_BACK_F_CANCEL_IGNORE|LDAP_BACK_F_CANCEL_EXOP)
 205 #define LDAP_BACK_F_CANCEL_MASK2        (LDAP_BACK_F_CANCEL_MASK|LDAP_BACK_F_CANCEL_EXOP_DISCOVER)
 206
 207 #define LDAP_BACK_ISSET(li,f)           ( ( (li)->li_flags & (f) ) == (f) )
 208 #define LDAP_BACK_ISMASK(li,m,f)        ( ( (li)->li_flags & (m) ) == (f) )
 209
 210 #define LDAP_BACK_SAVECRED(li)          LDAP_BACK_ISSET( (li), LDAP_BACK_F_SAVECRED )
 211 #define LDAP_BACK_USE_TLS(li)           LDAP_BACK_ISSET( (li), LDAP_BACK_F_USE_TLS )
 212 #define LDAP_BACK_PROPAGATE_TLS(li)     LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROPAGATE_TLS )
 213 #define LDAP_BACK_TLS_CRITICAL(li)      LDAP_BACK_ISSET( (li), LDAP_BACK_F_TLS_CRITICAL )
 214 #define LDAP_BACK_CHASE_REFERRALS(li)   LDAP_BACK_ISSET( (li), LDAP_BACK_F_CHASE_REFERRALS )
 215 #define LDAP_BACK_PROXY_WHOAMI(li)      LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROXY_WHOAMI )
 216
 217 #define LDAP_BACK_T_F(li)               LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
 218 #define LDAP_BACK_T_F_DISCOVER(li)      LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK2, LDAP_BACK_F_T_F_DISCOVER )
 219
 220 #define LDAP_BACK_MONITOR(li)           LDAP_BACK_ISSET( (li), LDAP_BACK_F_MONITOR )
 221 #define LDAP_BACK_SINGLECONN(li)        LDAP_BACK_ISSET( (li), LDAP_BACK_F_SINGLECONN )
 222
 223 #define LDAP_BACK_ISOPEN(li)            LDAP_BACK_ISSET( (li), LDAP_BACK_F_ISOPEN )
 224
 225 #define LDAP_BACK_ABANDON(li)           LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
 226 #define LDAP_BACK_IGNORE(li)            LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
 227 #define LDAP_BACK_CANCEL(li)            LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
 228 #define LDAP_BACK_CANCEL_DISCOVER(li)   LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
 229
 230         int             li_version;
 231
 232         ldap_avl_info_t li_conninfo;
 233
 234         time_t          li_network_timeout;
 235         time_t          li_conn_ttl;
 236         time_t          li_idle_timeout;
 237         time_t          li_timeout[ LDAP_BACK_OP_LAST ];
 238 } ldapinfo_t;
 239
 240 typedef enum ldap_back_send_t {
 241         LDAP_BACK_DONTSEND              = 0x00,
 242         LDAP_BACK_SENDOK                = 0x01,
 243         LDAP_BACK_SENDERR               = 0x02,
 244         LDAP_BACK_SENDRESULT            = (LDAP_BACK_SENDOK|LDAP_BACK_SENDERR),
 245         LDAP_BACK_BINDING               = 0x04,
 246         LDAP_BACK_BIND_DONTSEND         = (LDAP_BACK_BINDING),
 247         LDAP_BACK_BIND_SOK              = (LDAP_BACK_BINDING|LDAP_BACK_SENDOK),
 248         LDAP_BACK_BIND_SERR             = (LDAP_BACK_BINDING|LDAP_BACK_SENDERR),
 249         LDAP_BACK_BIND_SRES             = (LDAP_BACK_BINDING|LDAP_BACK_SENDRESULT)
 250 } ldap_back_send_t;
 251
 252 /* define to use asynchronous StartTLS */
 253 #define SLAP_STARTTLS_ASYNCHRONOUS
 254
 255 /* timeout to use when calling ldap_result() */
 256 #define LDAP_BACK_RESULT_TIMEOUT        (0)
 257 #define LDAP_BACK_RESULT_UTIMEOUT       (100000)
 258 #define LDAP_BACK_TV_SET(tv) \
 259         do { \
 260                 (tv)->tv_sec = LDAP_BACK_RESULT_TIMEOUT; \
 261                 (tv)->tv_usec = LDAP_BACK_RESULT_UTIMEOUT; \
 262         } while ( 0 )
 263
 264 LDAP_END_DECL
 265
 266 #include "proto-ldap.h"
 267
 268 #endif /* SLAPD_LDAP_H */