]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/back-ldap/back-ldap.h
allow pretty time form in quarantine string
[openldap] / servers / slapd / back-ldap / back-ldap.h
index dd16d53d05f5b769fdbcc4788b2e5441df75c8d3..86a660e9115903f63fc8a39281beac3239ff4cb1 100644 (file)
@@ -26,6 +26,8 @@
 
 LDAP_BEGIN_DECL
 
+struct ldapinfo_t;
+
 typedef struct ldapconn_t {
        Connection              *lc_conn;
 #define        LDAP_BACK_PCONN         ((void *)0x0)
@@ -54,12 +56,15 @@ typedef struct ldapconn_t {
                } \
        } while ( 0 )
 
-#define        LDAP_BACK_FCONN_ISBOUND (0x01)
-#define        LDAP_BACK_FCONN_ISANON  (0x02)
+#define        LDAP_BACK_FCONN_ISBOUND (0x00000001U)
+#define        LDAP_BACK_FCONN_ISANON  (0x00000002U)
 #define        LDAP_BACK_FCONN_ISBMASK (LDAP_BACK_FCONN_ISBOUND|LDAP_BACK_FCONN_ISANON)
-#define        LDAP_BACK_FCONN_ISPRIV  (0x04)
-#define        LDAP_BACK_FCONN_ISTLS   (0x08)
-#define        LDAP_BACK_FCONN_BINDING (0x10)
+#define        LDAP_BACK_FCONN_ISPRIV  (0x00000004U)
+#define        LDAP_BACK_FCONN_ISTLS   (0x00000008U)
+#define        LDAP_BACK_FCONN_BINDING (0x00000010U)
+#define        LDAP_BACK_FCONN_TAINTED (0x00000020U)
+
+/* 0x00FF0000 are reserved for back-meta */
 
 #define        LDAP_BACK_CONN_ISBOUND(lc)              LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISBOUND)
 #define        LDAP_BACK_CONN_ISBOUND_SET(lc)          LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISBOUND)
@@ -80,9 +85,14 @@ typedef struct ldapconn_t {
 #define        LDAP_BACK_CONN_BINDING(lc)              LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_BINDING)
 #define        LDAP_BACK_CONN_BINDING_SET(lc)          LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_BINDING)
 #define        LDAP_BACK_CONN_BINDING_CLEAR(lc)        LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_BINDING)
+#define        LDAP_BACK_CONN_TAINTED(lc)              LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_TAINTED)
+#define        LDAP_BACK_CONN_TAINTED_SET(lc)          LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_TAINTED)
+#define        LDAP_BACK_CONN_TAINTED_CLEAR(lc)        LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_TAINTED)
 
        unsigned                lc_refcnt;
+       unsigned                lc_binding;
        unsigned                lc_flags;
+       time_t                  lc_create_time;
        time_t                  lc_time;
 } ldapconn_t;
 
@@ -114,13 +124,36 @@ typedef struct ldap_avl_info_t {
        Avlnode                         *lai_tree;
 } ldap_avl_info_t;
 
+typedef struct slap_retry_info_t {
+       time_t          *ri_interval;
+       int             *ri_num;
+       int             ri_idx;
+       int             ri_count;
+       time_t          ri_last;
+
+#define SLAP_RETRYNUM_FOREVER  (-1)            /* retry forever */
+#define SLAP_RETRYNUM_TAIL     (-2)            /* end of retrynum array */
+#define SLAP_RETRYNUM_VALID(n) ((n) >= SLAP_RETRYNUM_FOREVER)  /* valid retrynum */
+#define SLAP_RETRYNUM_FINITE(n)        ((n) > SLAP_RETRYNUM_FOREVER)   /* not forever */
+} slap_retry_info_t;
+
+/*
+ * Hook to allow mucking with ldapinfo_t when quarantine is over
+ */
+typedef int (*ldap_back_quarantine_f)(struct ldapinfo_t *, void *);
+
 typedef struct ldapinfo_t {
        /* li_uri: the string that goes into ldap_initialize()
         * TODO: use li_acl.sb_uri instead */
-       char            *li_uri;
+       char                    *li_uri;
        /* li_bvuri: an array of each single URI that is equivalent;
         * to be checked for the presence of a certain item */
-       BerVarray       li_bvuri;
+       BerVarray               li_bvuri;
+       ldap_pvt_thread_mutex_t li_uri_mutex;
+
+       LDAP_REBIND_PROC        *li_rebind_f;
+       LDAP_URLLIST_PROC       *li_urllist_f;
+       void                    *li_urllist_p;
 
        slap_bindconf   li_acl;
 #define        li_acl_authcID  li_acl.sb_authcId
@@ -146,10 +179,12 @@ typedef struct ldapinfo_t {
 #define        li_idassert_secprops    li_idassert.sb_secprops
 
        unsigned        li_idassert_flags;
-#define LDAP_BACK_AUTH_NONE            0x00U
-#define        LDAP_BACK_AUTH_NATIVE_AUTHZ     0x01U
-#define        LDAP_BACK_AUTH_OVERRIDE         0x02U
-#define        LDAP_BACK_AUTH_PRESCRIPTIVE     0x04U
+#define LDAP_BACK_AUTH_NONE                            0x00U
+#define        LDAP_BACK_AUTH_NATIVE_AUTHZ                     0x01U
+#define        LDAP_BACK_AUTH_OVERRIDE                         0x02U
+#define        LDAP_BACK_AUTH_PRESCRIPTIVE                     0x04U
+#define        LDAP_BACK_AUTH_OBSOLETE_PROXY_AUTHZ             0x08U
+#define        LDAP_BACK_AUTH_OBSOLETE_ENCODING_WORKAROUND     0x10U
 
        BerVarray       li_idassert_authz;
        /* end of ID assert stuff */
@@ -161,22 +196,37 @@ typedef struct ldapinfo_t {
 #define LDAP_BACK_RETRY_DEFAULT                (3)
 
        unsigned        li_flags;
-#define LDAP_BACK_F_NONE               0x00U
-#define LDAP_BACK_F_SAVECRED           0x01U
-#define LDAP_BACK_F_USE_TLS            0x02U
-#define LDAP_BACK_F_PROPAGATE_TLS      0x04U
-#define LDAP_BACK_F_TLS_CRITICAL       0x08U
+#define LDAP_BACK_F_NONE               (0x0000U)
+#define LDAP_BACK_F_SAVECRED           (0x0001U)
+#define LDAP_BACK_F_USE_TLS            (0x0002U)
+#define LDAP_BACK_F_PROPAGATE_TLS      (0x0004U)
+#define LDAP_BACK_F_TLS_CRITICAL       (0x0008U)
 #define LDAP_BACK_F_TLS_USE_MASK       (LDAP_BACK_F_USE_TLS|LDAP_BACK_F_TLS_CRITICAL)
 #define LDAP_BACK_F_TLS_PROPAGATE_MASK (LDAP_BACK_F_PROPAGATE_TLS|LDAP_BACK_F_TLS_CRITICAL)
 #define LDAP_BACK_F_TLS_MASK           (LDAP_BACK_F_TLS_USE_MASK|LDAP_BACK_F_TLS_PROPAGATE_MASK)
-#define LDAP_BACK_F_CHASE_REFERRALS    0x10U
-#define LDAP_BACK_F_PROXY_WHOAMI       0x20U
+#define LDAP_BACK_F_CHASE_REFERRALS    (0x0010U)
+#define LDAP_BACK_F_PROXY_WHOAMI       (0x0020U)
+
+#define        LDAP_BACK_F_T_F                 (0x0040U)
+#define        LDAP_BACK_F_T_F_DISCOVER        (0x0080U)
+#define        LDAP_BACK_F_T_F_MASK            (LDAP_BACK_F_T_F)
+#define        LDAP_BACK_F_T_F_MASK2           (LDAP_BACK_F_T_F_MASK|LDAP_BACK_F_T_F_DISCOVER)
 
-#define        LDAP_BACK_F_SUPPORT_T_F                 0x80U
-#define        LDAP_BACK_F_SUPPORT_T_F_DISCOVER        0x40U
-#define        LDAP_BACK_F_SUPPORT_T_F_MASK            (LDAP_BACK_F_SUPPORT_T_F|LDAP_BACK_F_SUPPORT_T_F_DISCOVER)
+#define LDAP_BACK_F_MONITOR            (0x0100U)
+#define        LDAP_BACK_F_SINGLECONN          (0x0200U)
+
+#define        LDAP_BACK_F_ISOPEN              (0x0400U)
+
+#define        LDAP_BACK_F_CANCEL_ABANDON      (0x0000U)
+#define        LDAP_BACK_F_CANCEL_IGNORE       (0x1000U)
+#define        LDAP_BACK_F_CANCEL_EXOP         (0x2000U)
+#define        LDAP_BACK_F_CANCEL_EXOP_DISCOVER        (0x4000U)
+#define        LDAP_BACK_F_CANCEL_MASK         (LDAP_BACK_F_CANCEL_IGNORE|LDAP_BACK_F_CANCEL_EXOP)
+#define        LDAP_BACK_F_CANCEL_MASK2        (LDAP_BACK_F_CANCEL_MASK|LDAP_BACK_F_CANCEL_EXOP_DISCOVER)
 
 #define        LDAP_BACK_ISSET(li,f)           ( ( (li)->li_flags & (f) ) == (f) )
+#define        LDAP_BACK_ISMASK(li,m,f)        ( ( (li)->li_flags & (m) ) == (f) )
+
 #define LDAP_BACK_SAVECRED(li)         LDAP_BACK_ISSET( (li), LDAP_BACK_F_SAVECRED )
 #define LDAP_BACK_USE_TLS(li)          LDAP_BACK_ISSET( (li), LDAP_BACK_F_USE_TLS )
 #define LDAP_BACK_PROPAGATE_TLS(li)    LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROPAGATE_TLS )
@@ -184,11 +234,36 @@ typedef struct ldapinfo_t {
 #define LDAP_BACK_CHASE_REFERRALS(li)  LDAP_BACK_ISSET( (li), LDAP_BACK_F_CHASE_REFERRALS )
 #define LDAP_BACK_PROXY_WHOAMI(li)     LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROXY_WHOAMI )
 
+#define        LDAP_BACK_T_F(li)               LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
+#define        LDAP_BACK_T_F_DISCOVER(li)      LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK2, LDAP_BACK_F_T_F_DISCOVER )
+
+#define LDAP_BACK_MONITOR(li)          LDAP_BACK_ISSET( (li), LDAP_BACK_F_MONITOR )
+#define        LDAP_BACK_SINGLECONN(li)        LDAP_BACK_ISSET( (li), LDAP_BACK_F_SINGLECONN )
+
+#define        LDAP_BACK_ISOPEN(li)            LDAP_BACK_ISSET( (li), LDAP_BACK_F_ISOPEN )
+
+#define        LDAP_BACK_ABANDON(li)           LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
+#define        LDAP_BACK_IGNORE(li)            LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
+#define        LDAP_BACK_CANCEL(li)            LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
+#define        LDAP_BACK_CANCEL_DISCOVER(li)   LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
+
        int             li_version;
 
        ldap_avl_info_t li_conninfo;
 
+       slap_retry_info_t       li_quarantine;
+       /* NOTE: quarantine uses the connection mutex */
+       sig_atomic_t            li_isquarantined;
+#define        LDAP_BACK_FQ_NO         (0)
+#define        LDAP_BACK_FQ_YES        (1)
+#define        LDAP_BACK_FQ_RETRYING   (2)
+
+#define        LDAP_BACK_QUARANTINE(li)        ( (li)->li_quarantine.ri_num != NULL )
+       ldap_back_quarantine_f  li_quarantine_func;
+       void                    *li_quarantine_arg;
+
        time_t          li_network_timeout;
+       time_t          li_conn_ttl;
        time_t          li_idle_timeout;
        time_t          li_timeout[ LDAP_BACK_OP_LAST ];
 } ldapinfo_t;