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-2005 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 struct ldapconn {
  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 (0x01)
  58 #define LDAP_BACK_FCONN_ISANON  (0x02)
  59 #define LDAP_BACK_FCONN_ISBMASK (LDAP_BACK_FCONN_ISBOUND|LDAP_BACK_FCONN_ISANON)
  60 #define LDAP_BACK_FCONN_ISPRIV  (0x04)
  61 #define LDAP_BACK_FCONN_ISTLS   (0x08)
  62
  63 #define LDAP_BACK_CONN_ISBOUND(lc)              LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISBOUND)
  64 #define LDAP_BACK_CONN_ISBOUND_SET(lc)          LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISBOUND)
  65 #define LDAP_BACK_CONN_ISBOUND_CLEAR(lc)        LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISBMASK)
  66 #define LDAP_BACK_CONN_ISBOUND_CPY(lc, mlc)     LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISBOUND, (mlc))
  67 #define LDAP_BACK_CONN_ISANON(lc)               LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISANON)
  68 #define LDAP_BACK_CONN_ISANON_SET(lc)           LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISANON)
  69 #define LDAP_BACK_CONN_ISANON_CLEAR(lc)         LDAP_BACK_CONN_ISBOUND_CLEAR((lc))
  70 #define LDAP_BACK_CONN_ISANON_CPY(lc, mlc)      LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISANON, (mlc))
  71 #define LDAP_BACK_CONN_ISPRIV(lc)               LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISPRIV)
  72 #define LDAP_BACK_CONN_ISPRIV_SET(lc)           LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISPRIV)
  73 #define LDAP_BACK_CONN_ISPRIV_CLEAR(lc)         LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISPRIV)
  74 #define LDAP_BACK_CONN_ISPRIV_CPY(lc, mlc)      LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISPRIV, (mlc))
  75 #define LDAP_BACK_CONN_ISTLS(lc)                LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISTLS)
  76 #define LDAP_BACK_CONN_ISTLS_SET(lc)            LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISTLS)
  77 #define LDAP_BACK_CONN_ISTLS_CLEAR(lc)          LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISTLS)
  78 #define LDAP_BACK_CONN_ISTLS_CPY(lc, mlc)       LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISTLS, (mlc))
  79
  80         unsigned                lc_refcnt;
  81         unsigned                lc_flags;
  82 };
  83
  84 /*
  85  * identity assertion modes
  86  */
  87 enum {
  88         LDAP_BACK_IDASSERT_LEGACY = 1,
  89         LDAP_BACK_IDASSERT_NOASSERT,
  90         LDAP_BACK_IDASSERT_ANONYMOUS,
  91         LDAP_BACK_IDASSERT_SELF,
  92         LDAP_BACK_IDASSERT_OTHERDN,
  93         LDAP_BACK_IDASSERT_OTHERID
  94 };
  95
  96 /*
  97  * operation enumeration for timeouts
  98  */
  99 enum {
 100         LDAP_BACK_OP_ADD = 0,
 101         LDAP_BACK_OP_DELETE,
 102         LDAP_BACK_OP_MODIFY,
 103         LDAP_BACK_OP_MODRDN,
 104         LDAP_BACK_OP_LAST
 105 };
 106
 107 struct ldapinfo {
 108         char            *url;
 109         LDAPURLDesc     *lud;
 110
 111         slap_bindconf   acl_sb;
 112 #define acl_authcID     acl_sb.sb_authcId
 113 #define acl_authcDN     acl_sb.sb_binddn
 114 #define acl_passwd      acl_sb.sb_cred
 115 #define acl_authzID     acl_sb.sb_authzId
 116 #define acl_authmethod  acl_sb.sb_method
 117 #define acl_sasl_mech   acl_sb.sb_saslmech
 118 #define acl_sasl_realm  acl_sb.sb_realm
 119 #define acl_secprops    acl_sb.sb_secprops
 120
 121         /* ID assert stuff */
 122         int             idassert_mode;
 123
 124         slap_bindconf   idassert_sb;
 125 #define idassert_authcID        idassert_sb.sb_authcId
 126 #define idassert_authcDN        idassert_sb.sb_binddn
 127 #define idassert_passwd         idassert_sb.sb_cred
 128 #define idassert_authzID        idassert_sb.sb_authzId
 129 #define idassert_authmethod     idassert_sb.sb_method
 130 #define idassert_sasl_mech      idassert_sb.sb_saslmech
 131 #define idassert_sasl_realm     idassert_sb.sb_realm
 132 #define idassert_secprops       idassert_sb.sb_secprops
 133
 134         unsigned        idassert_flags;
 135 #define LDAP_BACK_AUTH_NONE             0x00U
 136 #define LDAP_BACK_AUTH_NATIVE_AUTHZ     0x01U
 137 #define LDAP_BACK_AUTH_OVERRIDE         0x02U
 138 #define LDAP_BACK_AUTH_PRESCRIPTIVE     0x04U
 139
 140         BerVarray       idassert_authz;
 141         /* end of ID assert stuff */
 142
 143         int             nretries;
 144 #define LDAP_BACK_RETRY_UNDEFINED       (-2)
 145 #define LDAP_BACK_RETRY_FOREVER         (-1)
 146 #define LDAP_BACK_RETRY_NEVER           (0)
 147 #define LDAP_BACK_RETRY_DEFAULT         (3)
 148
 149         ldap_pvt_thread_mutex_t         conn_mutex;
 150         unsigned        flags;
 151 #define LDAP_BACK_F_NONE                0x00U
 152 #define LDAP_BACK_F_SAVECRED            0x01U
 153 #define LDAP_BACK_F_USE_TLS             0x02U
 154 #define LDAP_BACK_F_PROPAGATE_TLS       0x04U
 155 #define LDAP_BACK_F_TLS_CRITICAL        0x08U
 156 #define LDAP_BACK_F_TLS_USE_MASK        (LDAP_BACK_F_USE_TLS|LDAP_BACK_F_TLS_CRITICAL)
 157 #define LDAP_BACK_F_TLS_PROPAGATE_MASK  (LDAP_BACK_F_PROPAGATE_TLS|LDAP_BACK_F_TLS_CRITICAL)
 158 #define LDAP_BACK_F_TLS_MASK            (LDAP_BACK_F_TLS_USE_MASK|LDAP_BACK_F_TLS_PROPAGATE_MASK)
 159 #define LDAP_BACK_F_CHASE_REFERRALS     0x10U
 160 #define LDAP_BACK_F_PROXY_WHOAMI        0x20U
 161
 162 #define LDAP_BACK_F_SUPPORT_T_F                 0x80U
 163 #define LDAP_BACK_F_SUPPORT_T_F_DISCOVER        0x40U
 164 #define LDAP_BACK_F_SUPPORT_T_F_MASK            (LDAP_BACK_F_SUPPORT_T_F|LDAP_BACK_F_SUPPORT_T_F_DISCOVER)
 165
 166 #define LDAP_BACK_SAVECRED(li)          ( (li)->flags & LDAP_BACK_F_SAVECRED )
 167 #define LDAP_BACK_USE_TLS(li)           ( (li)->flags & LDAP_BACK_F_USE_TLS )
 168 #define LDAP_BACK_PROPAGATE_TLS(li)     ( (li)->flags & LDAP_BACK_F_PROPAGATE_TLS )
 169 #define LDAP_BACK_TLS_CRITICAL(li)      ( (li)->flags & LDAP_BACK_F_TLS_CRITICAL )
 170 #define LDAP_BACK_CHASE_REFERRALS(li)   ( (li)->flags & LDAP_BACK_F_CHASE_REFERRALS )
 171
 172         int             version;
 173
 174         Avlnode         *conntree;
 175
 176 #if 0
 177         /* FIXME: automatic rwm instantiation removed */
 178         int             rwm_started;
 179 #endif
 180
 181         time_t                  timeout[ LDAP_BACK_OP_LAST ];
 182 };
 183
 184 typedef enum ldap_back_send_t {
 185         LDAP_BACK_DONTSEND              = 0x00,
 186         LDAP_BACK_SENDOK                = 0x01,
 187         LDAP_BACK_SENDERR               = 0x02,
 188         LDAP_BACK_SENDRESULT            = (LDAP_BACK_SENDOK|LDAP_BACK_SENDERR)
 189 } ldap_back_send_t;
 190
 191 /* define to use asynchronous StartTLS */
 192 #define SLAP_STARTTLS_ASYNCHRONOUS
 193
 194 /* timeout to use when calling ldap_result() */
 195 #define LDAP_BACK_RESULT_TIMEOUT        (0)
 196 #define LDAP_BACK_RESULT_UTIMEOUT       (100000)
 197 #define LDAP_BACK_TV_SET(tv) \
 198         do { \
 199                 (tv)->tv_sec = LDAP_BACK_RESULT_TIMEOUT; \
 200                 (tv)->tv_usec = LDAP_BACK_RESULT_UTIMEOUT; \
 201         } while ( 0 )
 202
 203 LDAP_END_DECL
 204
 205 #include "proto-ldap.h"
 206
 207 #endif /* SLAPD_LDAP_H */