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 #include "../back-monitor/back-monitor.h"
  28
  29 LDAP_BEGIN_DECL
  30
  31 struct ldapinfo_t;
  32
  33 /* stuff required for monitoring */
  34 typedef struct ldap_monitor_info_t {
  35         monitor_subsys_t        lmi_mss;
  36         struct ldapinfo_t       *lmi_li;
  37
  38         struct berval           lmi_rdn;
  39         struct berval           lmi_nrdn;
  40         monitor_callback_t      *lmi_cb;
  41         struct berval           lmi_base;
  42         int                     lmi_scope;
  43         struct berval           lmi_filter;
  44         struct berval           lmi_more_filter;
  45 } ldap_monitor_info_t;
  46
  47 typedef struct ldapconn_t {
  48         Connection              *lc_conn;
  49 #define LDAP_BACK_PCONN         ((void *)0x0)
  50 #define LDAP_BACK_PCONN_TLS     ((void *)0x1)
  51 #define LDAP_BACK_PCONN_PRIV    (-1)
  52 #define LDAP_BACK_PCONN_ISPRIV(lc)      ((void *)(lc)->lc_conn <= LDAP_BACK_PCONN_TLS)
  53 #define LDAP_BACK_PCONN_ID(lc)  (LDAP_BACK_PCONN_ISPRIV((lc)) ? LDAP_BACK_PCONN_PRIV : (lc)->lc_conn->c_connid )
  54 #ifdef HAVE_TLS
  55 #define LDAP_BACK_PCONN_SET(op) ((op)->o_conn->c_is_tls ? LDAP_BACK_PCONN_TLS : LDAP_BACK_PCONN)
  56 #else /* ! HAVE_TLS */
  57 #define LDAP_BACK_PCONN_SET(op) (LDAP_BACK_PCONN)
  58 #endif /* ! HAVE_TLS */
  59
  60         LDAP                    *lc_ld;
  61         struct berval           lc_cred;
  62         struct berval           lc_bound_ndn;
  63         struct berval           lc_local_ndn;
  64         unsigned                lc_lcflags;
  65 #define LDAP_BACK_CONN_ISSET_F(fp,f)    (*(fp) & (f))
  66 #define LDAP_BACK_CONN_SET_F(fp,f)      (*(fp) |= (f))
  67 #define LDAP_BACK_CONN_CLEAR_F(fp,f)    (*(fp) &= ~(f))
  68 #define LDAP_BACK_CONN_CPY_F(fp,f,mfp) \
  69         do { \
  70                 if ( ((f) & *(mfp)) == (f) ) { \
  71                         *(fp) |= (f); \
  72                 } else { \
  73                         *(fp) &= ~(f); \
  74                 } \
  75         } while ( 0 )
  76
  77 #define LDAP_BACK_CONN_ISSET(lc,f)      LDAP_BACK_CONN_ISSET_F(&(lc)->lc_lcflags, (f))
  78 #define LDAP_BACK_CONN_SET(lc,f)        LDAP_BACK_CONN_SET_F(&(lc)->lc_lcflags, (f))
  79 #define LDAP_BACK_CONN_CLEAR(lc,f)      LDAP_BACK_CONN_CLEAR_F(&(lc)->lc_lcflags, (f))
  80 #define LDAP_BACK_CONN_CPY(lc,f,mlc)    LDAP_BACK_CONN_CPY_F(&(lc)->lc_lcflags, (f), &(mlc)->lc_lcflags)
  81
  82 #define LDAP_BACK_FCONN_ISBOUND (0x00000001U)
  83 #define LDAP_BACK_FCONN_ISANON  (0x00000002U)
  84 #define LDAP_BACK_FCONN_ISBMASK (LDAP_BACK_FCONN_ISBOUND|LDAP_BACK_FCONN_ISANON)
  85 #define LDAP_BACK_FCONN_ISPRIV  (0x00000004U)
  86 #define LDAP_BACK_FCONN_ISTLS   (0x00000008U)
  87 #define LDAP_BACK_FCONN_BINDING (0x00000010U)
  88 #define LDAP_BACK_FCONN_TAINTED (0x00000020U)
  89 #define LDAP_BACK_FCONN_ISIDASR (0x00000040U)
  90
  91 /* 0x00FF0000 are reserved for back-meta */
  92
  93 #define LDAP_BACK_CONN_ISBOUND(lc)              LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISBOUND)
  94 #define LDAP_BACK_CONN_ISBOUND_SET(lc)          LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISBOUND)
  95 #define LDAP_BACK_CONN_ISBOUND_CLEAR(lc)        LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISBMASK)
  96 #define LDAP_BACK_CONN_ISBOUND_CPY(lc, mlc)     LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISBOUND, (mlc))
  97 #define LDAP_BACK_CONN_ISANON(lc)               LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISANON)
  98 #define LDAP_BACK_CONN_ISANON_SET(lc)           LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISANON)
  99 #define LDAP_BACK_CONN_ISANON_CLEAR(lc)         LDAP_BACK_CONN_ISBOUND_CLEAR((lc))
 100 #define LDAP_BACK_CONN_ISANON_CPY(lc, mlc)      LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISANON, (mlc))
 101 #define LDAP_BACK_CONN_ISPRIV(lc)               LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISPRIV)
 102 #define LDAP_BACK_CONN_ISPRIV_SET(lc)           LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISPRIV)
 103 #define LDAP_BACK_CONN_ISPRIV_CLEAR(lc)         LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISPRIV)
 104 #define LDAP_BACK_CONN_ISPRIV_CPY(lc, mlc)      LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISPRIV, (mlc))
 105 #define LDAP_BACK_CONN_ISTLS(lc)                LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISTLS)
 106 #define LDAP_BACK_CONN_ISTLS_SET(lc)            LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISTLS)
 107 #define LDAP_BACK_CONN_ISTLS_CLEAR(lc)          LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISTLS)
 108 #define LDAP_BACK_CONN_ISTLS_CPY(lc, mlc)       LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISTLS, (mlc))
 109 #define LDAP_BACK_CONN_BINDING(lc)              LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_BINDING)
 110 #define LDAP_BACK_CONN_BINDING_SET(lc)          LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_BINDING)
 111 #define LDAP_BACK_CONN_BINDING_CLEAR(lc)        LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_BINDING)
 112 #define LDAP_BACK_CONN_TAINTED(lc)              LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_TAINTED)
 113 #define LDAP_BACK_CONN_TAINTED_SET(lc)          LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_TAINTED)
 114 #define LDAP_BACK_CONN_TAINTED_CLEAR(lc)        LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_TAINTED)
 115 #define LDAP_BACK_CONN_ISIDASSERT(lc)           LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISIDASR)
 116 #define LDAP_BACK_CONN_ISIDASSERT_SET(lc)       LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISIDASR)
 117 #define LDAP_BACK_CONN_ISIDASSERT_CLEAR(lc)     LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISIDASR)
 118 #define LDAP_BACK_CONN_ISIDASSERT_CPY(lc, mlc)  LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISIDASR, (mlc))
 119
 120         unsigned                lc_refcnt;
 121         unsigned                lc_binding;
 122         unsigned                lc_flags;
 123         time_t                  lc_create_time;
 124         time_t                  lc_time;
 125 } ldapconn_t;
 126
 127 typedef struct ldap_avl_info_t {
 128         ldap_pvt_thread_mutex_t         lai_mutex;
 129         Avlnode                         *lai_tree;
 130 } ldap_avl_info_t;
 131
 132 typedef struct slap_retry_info_t {
 133         time_t          *ri_interval;
 134         int             *ri_num;
 135         int             ri_idx;
 136         int             ri_count;
 137         time_t          ri_last;
 138
 139 #define SLAP_RETRYNUM_FOREVER   (-1)            /* retry forever */
 140 #define SLAP_RETRYNUM_TAIL      (-2)            /* end of retrynum array */
 141 #define SLAP_RETRYNUM_VALID(n)  ((n) >= SLAP_RETRYNUM_FOREVER)  /* valid retrynum */
 142 #define SLAP_RETRYNUM_FINITE(n) ((n) > SLAP_RETRYNUM_FOREVER)   /* not forever */
 143 } slap_retry_info_t;
 144
 145 /*
 146  * identity assertion modes
 147  */
 148 typedef enum {
 149         LDAP_BACK_IDASSERT_LEGACY = 1,
 150         LDAP_BACK_IDASSERT_NOASSERT,
 151         LDAP_BACK_IDASSERT_ANONYMOUS,
 152         LDAP_BACK_IDASSERT_SELF,
 153         LDAP_BACK_IDASSERT_OTHERDN,
 154         LDAP_BACK_IDASSERT_OTHERID
 155 } slap_idassert_mode_t;
 156
 157 /* ID assert stuff */
 158 typedef struct slap_idassert_t {
 159         slap_idassert_mode_t    si_mode;
 160 #define li_idassert_mode        li_idassert.si_mode
 161
 162         slap_bindconf   si_bc;
 163 #define li_idassert_authcID     li_idassert.si_bc.sb_authcId
 164 #define li_idassert_authcDN     li_idassert.si_bc.sb_binddn
 165 #define li_idassert_passwd      li_idassert.si_bc.sb_cred
 166 #define li_idassert_authzID     li_idassert.si_bc.sb_authzId
 167 #define li_idassert_authmethod  li_idassert.si_bc.sb_method
 168 #define li_idassert_sasl_mech   li_idassert.si_bc.sb_saslmech
 169 #define li_idassert_sasl_realm  li_idassert.si_bc.sb_realm
 170 #define li_idassert_secprops    li_idassert.si_bc.sb_secprops
 171 #define li_idassert_tls         li_idassert.si_bc.sb_tls
 172
 173         unsigned        si_flags;
 174 #define LDAP_BACK_AUTH_NONE                             0x00U
 175 #define LDAP_BACK_AUTH_NATIVE_AUTHZ                     0x01U
 176 #define LDAP_BACK_AUTH_OVERRIDE                         0x02U
 177 #define LDAP_BACK_AUTH_PRESCRIPTIVE                     0x04U
 178 #define LDAP_BACK_AUTH_OBSOLETE_PROXY_AUTHZ             0x08U
 179 #define LDAP_BACK_AUTH_OBSOLETE_ENCODING_WORKAROUND     0x10U
 180 #define li_idassert_flags       li_idassert.si_flags
 181
 182         BerVarray       si_authz;
 183 #define li_idassert_authz       li_idassert.si_authz
 184 } slap_idassert_t;
 185
 186 /*
 187  * Hook to allow mucking with ldapinfo_t when quarantine is over
 188  */
 189 typedef int (*ldap_back_quarantine_f)( struct ldapinfo_t *, void * );
 190
 191 typedef struct ldapinfo_t {
 192         /* li_uri: the string that goes into ldap_initialize()
 193          * TODO: use li_acl.sb_uri instead */
 194         char                    *li_uri;
 195         /* li_bvuri: an array of each single URI that is equivalent;
 196          * to be checked for the presence of a certain item */
 197         BerVarray               li_bvuri;
 198         ldap_pvt_thread_mutex_t li_uri_mutex;
 199
 200         LDAP_REBIND_PROC        *li_rebind_f;
 201         LDAP_URLLIST_PROC       *li_urllist_f;
 202         void                    *li_urllist_p;
 203
 204         slap_bindconf   li_acl;
 205 #define li_acl_authcID  li_acl.sb_authcId
 206 #define li_acl_authcDN  li_acl.sb_binddn
 207 #define li_acl_passwd   li_acl.sb_cred
 208 #define li_acl_authzID  li_acl.sb_authzId
 209 #define li_acl_authmethod       li_acl.sb_method
 210 #define li_acl_sasl_mech        li_acl.sb_saslmech
 211 #define li_acl_sasl_realm       li_acl.sb_realm
 212 #define li_acl_secprops li_acl.sb_secprops
 213
 214         /* ID assert stuff */
 215         slap_idassert_t li_idassert;
 216         /* end of ID assert stuff */
 217
 218         int             li_nretries;
 219 #define LDAP_BACK_RETRY_UNDEFINED       (-2)
 220 #define LDAP_BACK_RETRY_FOREVER         (-1)
 221 #define LDAP_BACK_RETRY_NEVER           (0)
 222 #define LDAP_BACK_RETRY_DEFAULT         (3)
 223
 224         unsigned        li_flags;
 225 #define LDAP_BACK_F_NONE                (0x0000U)
 226 #define LDAP_BACK_F_SAVECRED            (0x0001U)
 227 #define LDAP_BACK_F_USE_TLS             (0x0002U)
 228 #define LDAP_BACK_F_PROPAGATE_TLS       (0x0004U)
 229 #define LDAP_BACK_F_TLS_CRITICAL        (0x0008U)
 230 #define LDAP_BACK_F_TLS_USE_MASK        (LDAP_BACK_F_USE_TLS|LDAP_BACK_F_TLS_CRITICAL)
 231 #define LDAP_BACK_F_TLS_PROPAGATE_MASK  (LDAP_BACK_F_PROPAGATE_TLS|LDAP_BACK_F_TLS_CRITICAL)
 232 #define LDAP_BACK_F_TLS_MASK            (LDAP_BACK_F_TLS_USE_MASK|LDAP_BACK_F_TLS_PROPAGATE_MASK)
 233 #define LDAP_BACK_F_CHASE_REFERRALS     (0x0010U)
 234 #define LDAP_BACK_F_PROXY_WHOAMI        (0x0020U)
 235
 236 #define LDAP_BACK_F_T_F                 (0x0040U)
 237 #define LDAP_BACK_F_T_F_DISCOVER        (0x0080U)
 238 #define LDAP_BACK_F_T_F_MASK            (LDAP_BACK_F_T_F)
 239 #define LDAP_BACK_F_T_F_MASK2           (LDAP_BACK_F_T_F_MASK|LDAP_BACK_F_T_F_DISCOVER)
 240
 241 #define LDAP_BACK_F_MONITOR             (0x0100U)
 242 #define LDAP_BACK_F_SINGLECONN          (0x0200U)
 243
 244 #define LDAP_BACK_F_ISOPEN              (0x0400U)
 245
 246 #define LDAP_BACK_F_CANCEL_ABANDON      (0x0000U)
 247 #define LDAP_BACK_F_CANCEL_IGNORE       (0x1000U)
 248 #define LDAP_BACK_F_CANCEL_EXOP         (0x2000U)
 249 #define LDAP_BACK_F_CANCEL_EXOP_DISCOVER        (0x4000U)
 250 #define LDAP_BACK_F_CANCEL_MASK         (LDAP_BACK_F_CANCEL_IGNORE|LDAP_BACK_F_CANCEL_EXOP)
 251 #define LDAP_BACK_F_CANCEL_MASK2        (LDAP_BACK_F_CANCEL_MASK|LDAP_BACK_F_CANCEL_EXOP_DISCOVER)
 252
 253 #define LDAP_BACK_ISSET(li,f)           ( ( (li)->li_flags & (f) ) == (f) )
 254 #define LDAP_BACK_ISMASK(li,m,f)        ( ( (li)->li_flags & (m) ) == (f) )
 255
 256 #define LDAP_BACK_SAVECRED(li)          LDAP_BACK_ISSET( (li), LDAP_BACK_F_SAVECRED )
 257 #define LDAP_BACK_USE_TLS(li)           LDAP_BACK_ISSET( (li), LDAP_BACK_F_USE_TLS )
 258 #define LDAP_BACK_PROPAGATE_TLS(li)     LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROPAGATE_TLS )
 259 #define LDAP_BACK_TLS_CRITICAL(li)      LDAP_BACK_ISSET( (li), LDAP_BACK_F_TLS_CRITICAL )
 260 #define LDAP_BACK_CHASE_REFERRALS(li)   LDAP_BACK_ISSET( (li), LDAP_BACK_F_CHASE_REFERRALS )
 261 #define LDAP_BACK_PROXY_WHOAMI(li)      LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROXY_WHOAMI )
 262
 263 #define LDAP_BACK_T_F(li)               LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
 264 #define LDAP_BACK_T_F_DISCOVER(li)      LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK2, LDAP_BACK_F_T_F_DISCOVER )
 265
 266 #define LDAP_BACK_MONITOR(li)           LDAP_BACK_ISSET( (li), LDAP_BACK_F_MONITOR )
 267 #define LDAP_BACK_SINGLECONN(li)        LDAP_BACK_ISSET( (li), LDAP_BACK_F_SINGLECONN )
 268
 269 #define LDAP_BACK_ISOPEN(li)            LDAP_BACK_ISSET( (li), LDAP_BACK_F_ISOPEN )
 270
 271 #define LDAP_BACK_ABANDON(li)           LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
 272 #define LDAP_BACK_IGNORE(li)            LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
 273 #define LDAP_BACK_CANCEL(li)            LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
 274 #define LDAP_BACK_CANCEL_DISCOVER(li)   LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
 275
 276         int             li_version;
 277
 278         ldap_avl_info_t li_conninfo;
 279
 280         ldap_monitor_info_t     li_monitor_info;
 281
 282         sig_atomic_t            li_isquarantined;
 283 #define LDAP_BACK_FQ_NO         (0)
 284 #define LDAP_BACK_FQ_YES        (1)
 285 #define LDAP_BACK_FQ_RETRYING   (2)
 286
 287         slap_retry_info_t       li_quarantine;
 288 #define LDAP_BACK_QUARANTINE(li)        ( (li)->li_quarantine.ri_num != NULL )
 289         ldap_pvt_thread_mutex_t li_quarantine_mutex;
 290         ldap_back_quarantine_f  li_quarantine_f;
 291         void                    *li_quarantine_p;
 292
 293         time_t          li_network_timeout;
 294         time_t          li_conn_ttl;
 295         time_t          li_idle_timeout;
 296         time_t          li_timeout[ SLAP_OP_LAST ];
 297 } ldapinfo_t;
 298
 299 typedef enum ldap_back_send_t {
 300         LDAP_BACK_DONTSEND              = 0x00,
 301         LDAP_BACK_SENDOK                = 0x01,
 302         LDAP_BACK_SENDERR               = 0x02,
 303         LDAP_BACK_SENDRESULT            = (LDAP_BACK_SENDOK|LDAP_BACK_SENDERR),
 304         LDAP_BACK_BINDING               = 0x04,
 305
 306         LDAP_BACK_BIND_DONTSEND         = (LDAP_BACK_BINDING),
 307         LDAP_BACK_BIND_SOK              = (LDAP_BACK_BINDING|LDAP_BACK_SENDOK),
 308         LDAP_BACK_BIND_SERR             = (LDAP_BACK_BINDING|LDAP_BACK_SENDERR),
 309         LDAP_BACK_BIND_SRES             = (LDAP_BACK_BINDING|LDAP_BACK_SENDRESULT),
 310
 311         LDAP_BACK_RETRYING              = 0x08,
 312         LDAP_BACK_RETRY_DONTSEND        = (LDAP_BACK_RETRYING),
 313         LDAP_BACK_RETRY_SOK             = (LDAP_BACK_RETRYING|LDAP_BACK_SENDOK),
 314         LDAP_BACK_RETRY_SERR            = (LDAP_BACK_RETRYING|LDAP_BACK_SENDERR),
 315         LDAP_BACK_RETRY_SRES            = (LDAP_BACK_RETRYING|LDAP_BACK_SENDRESULT),
 316
 317         LDAP_BACK_GETCONN               = 0x10
 318 } ldap_back_send_t;
 319
 320 /* define to use asynchronous StartTLS */
 321 #define SLAP_STARTTLS_ASYNCHRONOUS
 322
 323 /* timeout to use when calling ldap_result() */
 324 #define LDAP_BACK_RESULT_TIMEOUT        (0)
 325 #define LDAP_BACK_RESULT_UTIMEOUT       (100000)
 326 #define LDAP_BACK_TV_SET(tv) \
 327         do { \
 328                 (tv)->tv_sec = LDAP_BACK_RESULT_TIMEOUT; \
 329                 (tv)->tv_usec = LDAP_BACK_RESULT_UTIMEOUT; \
 330         } while ( 0 )
 331
 332 #ifndef LDAP_BACK_PRINT_CONNTREE
 333 #define LDAP_BACK_PRINT_CONNTREE 0
 334 #endif /* !LDAP_BACK_PRINT_CONNTREE */
 335
 336 LDAP_END_DECL
 337
 338 #include "proto-ldap.h"
 339
 340 #endif /* SLAPD_LDAP_H */