]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/slap.h
fix substring_comp_candidates logic if intersection of candidates
[openldap] / servers / slapd / slap.h
index 10cd62fabcd70177c38577e1ea532ad9a8e2c15a..75a61b0ae283ea43f5cce52683b493ead1fcb4b3 100644 (file)
@@ -3,12 +3,13 @@
 #ifndef _SLDAPD_H_
 #define _SLDAPD_H_
 
-#include <stdlib.h>
+#include <ac/stdlib.h>
 
 #include <sys/types.h>
 #include <ac/syslog.h>
 #include <ac/regex.h>
-#include <ac/socket.h>                 /* needed by LDAP_CONNECTIONLESS */
+#include <ac/socket.h>
+#include <ac/time.h>
 
 #include "avl.h"
 
 #include "lber.h"
 #include "ldap.h"
 
+#include "ldap_schema.h"
+
 #include "ldap_pvt_thread.h"
 #include "ldif.h"
+
+LDAP_BEGIN_DECL
+
 #ifdef f_next
 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
 #endif
 
+#define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
+
+/* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
+ *
+ * This is a value used internally by the backends. It is needed to allow
+ * adding values that already exist without getting an error as required by
+ * modrdn when the new rdn was already an attribute value itself.
+ * JCG 05/1999 (gomez@engr.sgi.com)
+ */
+#define LDAP_MOD_SOFTADD       0x1000
+
 #define DN_DNS 0
 #define DN_X500        1
 
 #define SPACE(c)       ((c) == ' ' || (c) == '\n')
 #define NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
 
-LDAP_BEGIN_DECL
+#define SLAP_SCHERR_OUTOFMEM           1
+#define SLAP_SCHERR_CLASS_NOT_FOUND    2
+#define SLAP_SCHERR_ATTR_NOT_FOUND     3
+#define SLAP_SCHERR_DUP_CLASS          4
+#define SLAP_SCHERR_DUP_ATTR           5
+#define SLAP_SCHERR_DUP_SYNTAX         6
+#define SLAP_SCHERR_DUP_RULE           7
+#define SLAP_SCHERR_NO_NAME            8
+#define SLAP_SCHERR_ATTR_INCOMPLETE    9
+#define SLAP_SCHERR_MR_NOT_FOUND       10
+#define SLAP_SCHERR_SYN_NOT_FOUND      11
+#define SLAP_SCHERR_MR_INCOMPLETE      12
 
 extern int slap_debug;
 
@@ -57,19 +85,29 @@ typedef struct ava {
        struct berval   ava_value;
 } Ava;
 
+typedef struct mra {
+       char    *mra_rule;
+       char    *mra_type;
+       char    *mra_value;
+       int             mra_dnattrs;
+} Mra;
+
 /*
  * represents a search filter
  */
 typedef struct filter {
-       unsigned long   f_choice;       /* values taken from ldap.h */
+       ber_tag_t       f_choice;       /* values taken from ldap.h */
 
-       union {
+       union f_un_u {
                /* present */
                char            *f_un_type;
 
                /* equality, lessorequal, greaterorequal, approx */
                Ava             f_un_ava;
 
+               /* extensible */
+               Mra             f_un_fra;       
+
                /* and, or, not */
                struct filter   *f_un_complex;
 
@@ -85,6 +123,10 @@ typedef struct filter {
 #define f_ava          f_un.f_un_ava
 #define f_avtype       f_un.f_un_ava.ava_type
 #define f_avvalue      f_un.f_un_ava.ava_value
+#define f_mra          f_un.f_un_mra
+#define f_mrtype       f_un.f_un_mra.mra_type
+#define f_mrvalue      f_un.f_un_mra.mra_value
+#define        f_mrdnaddrs     f_un.f_un_mra.mra_dnattrs
 #define f_and          f_un.f_un_complex
 #define f_or           f_un.f_un_complex
 #define f_not          f_un.f_un_complex
@@ -122,7 +164,7 @@ typedef struct attr {
  * the id used in the indexes to refer to an entry
  */
 typedef unsigned long  ID;
-#define NOID   ((unsigned long)-1)
+#define NOID   ((unsigned long)~0)
 
 /*
  * represents an entry in core
@@ -149,12 +191,43 @@ typedef struct entry {
 
 /* the "by" part */
 struct access {
-#define ACL_NONE       0x01
-#define ACL_COMPARE    0x02
-#define ACL_SEARCH     0x04
-#define ACL_READ       0x08
-#define ACL_WRITE      0x10
-#define ACL_SELF       0x40
+
+#define ACL_NONE               0x0001
+#define ACL_AUTH               0x0004
+#define ACL_COMPARE            0x0008
+#define ACL_SEARCH             0x0010
+#define ACL_READ               0x0020
+#define ACL_WRITE              0x0040
+#define ACL_PRIV_MASK  0x00ff
+
+#define ACL_SELF               0x4000
+#define ACL_INVALID            (-1)
+
+#define ACL_IS(a,lvl)  (((a) & (lvl)) == (lvl))
+
+#define ACL_IS_NONE(a)         ACL_IS((a),ACL_SELF)
+#define ACL_IS_AUTH(a)         ACL_IS((a),ACL_AUTH)
+#define ACL_IS_COMPARE(a)      ACL_IS((a),ACL_COMPARE)
+#define ACL_IS_SEARCH(a)       ACL_IS((a),ACL_SEARCH)
+#define ACL_IS_READ(a)         ACL_IS((a),ACL_READ)
+#define ACL_IS_WRITE(a)                ACL_IS((a),ACL_WRITE)
+#define ACL_IS_SELF(a)         ACL_IS((a),ACL_SELF)
+#define ACL_IS_INVALID(a)      ((a) == ACL_INVALID)
+
+#define ACL_CLR(a)                     ((a) = 0)
+#define ACL_SET(a,lvl)         ((a) |= (lvl))
+#define ACL_SET_NONE(a)                ACL_SET((a),ACL_SELF)
+#define ACL_SET_AUTH(a)                ACL_SET((a),ACL_AUTH)
+#define ACL_SET_COMPARE(a)     ACL_SET((a),ACL_COMPARE)
+#define ACL_SET_SEARCH(a)      ACL_SET((a),ACL_SEARCH)
+#define ACL_SET_READ(a)                ACL_SET((a),ACL_READ)
+#define ACL_SET_WRITE(a)       ACL_SET((a),ACL_WRITE)
+#define ACL_SET_SELF(a)                ACL_SET((a),ACL_SELF)
+#define ACL_SET_INVALID(a)     ((a) = ACL_INVALID)
+
+#define        ACL_PRIV(a)                     ((a) & ACL_PRIV_MASK)
+#define ACL_GRANT(a,lvl)       (ACL_PRIV(a) >= (lvl))
+
        int                     a_access;
 
        char            *a_dnpat;
@@ -162,11 +235,11 @@ struct access {
        char            *a_domainpat;
        char            *a_dnattr;
 
-#ifdef SLAPD_ACLGROUPS
-        char           *a_group;
-        char           *a_objectclassvalue;
-        char           *a_groupattrname;
-#endif
+       /* ACL Groups */
+       char            *a_group;
+       char            *a_group_oc;
+       char            *a_group_at;
+
        struct access   *a_next;
 };
 
@@ -199,13 +272,74 @@ typedef struct ldapmodlist {
 /*
  * represents schema information for a database
  */
-
-struct objclass {
-       char            *oc_name;
-       char            **oc_required;
-       char            **oc_allowed;
-       struct objclass *oc_next;
-};
+typedef int slap_syntax_check_func LDAP_P((struct berval * val));
+
+typedef struct slap_syntax {
+       LDAP_SYNTAX                     ssyn_syn;
+       slap_syntax_check_func          *ssyn_check;
+       struct slap_syntax              *ssyn_next;
+} Syntax;
+#define ssyn_oid                       ssyn_syn.syn_oid
+#define ssyn_desc                      ssyn_syn.syn_desc
+
+typedef int slap_mr_normalize_func LDAP_P((struct berval * val, struct berval **normalized));
+typedef int slap_mr_compare_func LDAP_P((struct berval * val1, struct berval * val2));
+
+typedef struct slap_matching_rule {
+       LDAP_MATCHING_RULE              smr_mrule;
+       slap_mr_normalize_func          *smr_normalize;
+       slap_mr_compare_func            *smr_compare;
+       Syntax                          *smr_syntax;
+       struct slap_matching_rule       *smr_next;
+} MatchingRule;
+#define smr_oid                                smr_mrule.mr_oid
+#define smr_names                      smr_mrule.mr_names
+#define smr_desc                       smr_mrule.mr_desc
+#define smr_obsolete                   smr_mrule.mr_obsolete
+#define smr_syntax_oid                 smr_mrule.mr_syntax_oid
+
+typedef struct slap_attribute_type {
+       LDAP_ATTRIBUTE_TYPE             sat_atype;
+       struct slap_attribute_type      *sat_sup;
+       struct slap_attribute_type      **sat_subtypes;
+       MatchingRule                    *sat_equality;
+       MatchingRule                    *sat_ordering;
+       MatchingRule                    *sat_substr;
+       Syntax                          *sat_syntax;
+       /* The next one is created to help in the transition */
+       int                             sat_syntax_compat;
+       struct slap_attribute_type      *sat_next;
+} AttributeType;
+#define sat_oid                        sat_atype.at_oid
+#define sat_names              sat_atype.at_names
+#define sat_desc               sat_atype.at_desc
+#define sat_obsolete           sat_atype.at_obsolete
+#define sat_sup_oid            sat_atype.at_sup_oid
+#define sat_equality_oid       sat_atype.at_equality_oid
+#define sat_ordering_oid       sat_atype.at_ordering_oid
+#define sat_substr_oid         sat_atype.at_substr_oid
+#define sat_syntax_oid         sat_atype.at_syntax_oid
+#define sat_syntax_len         sat_atype.at_syntax_len
+#define sat_single_value       sat_atype.at_single_value
+#define sat_collective         sat_atype.at_collective
+#define sat_no_user_mods       sat_atype.at_no_user_mods
+#define sat_usage              sat_atype.at_usage
+
+typedef struct slap_object_class {
+       LDAP_OBJECT_CLASS               soc_oclass;
+       struct slap_object_class        **soc_sups;
+       AttributeType                   **soc_required;
+       AttributeType                   **soc_allowed;
+       struct slap_object_class        *soc_next;
+} ObjectClass;
+#define soc_oid                        soc_oclass.oc_oid
+#define soc_names              soc_oclass.oc_names
+#define soc_desc               soc_oclass.oc_desc
+#define soc_obsolete           soc_oclass.oc_obsolete
+#define soc_sup_oids           soc_oclass.oc_sup_oids
+#define soc_kind               soc_oclass.oc_kind
+#define soc_at_oids_must       soc_oclass.oc_at_oids_must
+#define soc_at_oids_may                soc_oclass.oc_at_oids_may
 
 /*
  * Backend-info
@@ -253,14 +387,18 @@ struct backend_db {
 #define                be_release      bd_info->bi_entry_release_rw
 #define                be_group        bd_info->bi_acl_group
 
+#define                be_connection_init      bd_info->bi_connection_init
+#define                be_connection_destroy   bd_info->bi_connection_destroy
+
+
        /* these should be renamed from be_ to bd_ */
        char    **be_suffix;    /* the DN suffixes of data in this backend */
-       char    **be_suffixAlias;       /* the DN suffix aliases of data in this backend */
+       char    **be_nsuffix;   /* the normalized DN suffixes in this backend */
        char    *be_root_dn;    /* the magic "root" dn for this db      */
        char    *be_root_ndn;   /* the magic "root" normalized dn for this db   */
        char    *be_root_pw;    /* the magic "root" password for this db        */
        int     be_readonly;    /* 1 => db is in "read only" mode          */
-       int     be_maxDerefDepth;       /* limit for depth of an alias deref  */
+       unsigned int be_max_deref_depth;       /* limit for depth of an alias deref  */
        int     be_sizelimit;   /* size limit for this backend             */
        int     be_timelimit;   /* time limit for this backend             */
        struct acl *be_acl;     /* access control list for this backend    */
@@ -268,8 +406,11 @@ struct backend_db {
        char    **be_replica;   /* replicas of this backend (in master)    */
        char    *be_replogfile; /* replication log file (in master)        */
        char    *be_update_ndn; /* allowed to make changes (in replicas)   */
+       struct berval **be_update_refs; /* where to refer modifying clients to */
        int     be_lastmod;     /* keep track of lastmodified{by,time}     */
 
+       char    *be_realm;
+
        void    *be_private;    /* anything the backend database needs     */
 };
 
@@ -334,13 +475,16 @@ struct backend_info {
        /* LDAP Operations Handling Routines */
        int     (*bi_op_bind)  LDAP_P(( BackendDB *bd,
                struct slap_conn *c, struct slap_op *o,
-               char *dn, int method, struct berval *cred, char** edn ));
+               char *dn, int method, char* mechanism,
+               struct berval *cred, char** edn ));
        int (*bi_op_unbind) LDAP_P((BackendDB *bd,
                struct slap_conn *c, struct slap_op *o ));
        int     (*bi_op_search) LDAP_P((BackendDB *bd,
                struct slap_conn *c, struct slap_op *o,
-               char *base, int scope, int deref, int slimit, int tlimit,
-               Filter *f, char *filterstr, char **attrs, int attrsonly));
+               char *base, int scope, int deref,
+               int slimit, int tlimit,
+               Filter *f, char *filterstr, char **attrs,
+               int attrsonly));
        int     (*bi_op_compare)LDAP_P((BackendDB *bd,
                struct slap_conn *c, struct slap_op *o,
                char *dn, Ava *ava));
@@ -357,18 +501,22 @@ struct backend_info {
        int     (*bi_op_delete) LDAP_P((BackendDB *bd,
                struct slap_conn *c, struct slap_op *o,
                char *dn));
-       /* Bug: be_op_abandon in unused! */
        int     (*bi_op_abandon) LDAP_P((BackendDB *bd,
                struct slap_conn *c, struct slap_op *o,
-               int msgid));
+               ber_int_t msgid));
 
        /* Auxilary Functions */
        int     (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
-#ifdef SLAPD_ACLGROUPS
+
        int     (*bi_acl_group)  LDAP_P((Backend *bd,
                Entry *e, char *bdn, char *edn,
                char *objectclassValue, char *groupattrName ));
-#endif
+
+       int     (*bi_connection_init) LDAP_P((BackendDB *bd,
+               struct slap_conn *c));
+       int     (*bi_connection_destroy) LDAP_P((BackendDB *bd,
+               struct slap_conn *c));
+
 
        unsigned int bi_nDB;    /* number of databases of this type */
        void    *bi_private;    /* anything the backend type needs */
@@ -379,22 +527,29 @@ struct backend_info {
  */
 
 typedef struct slap_op {
-       long    o_opid;         /* id of this operation           */
-       long    o_msgid;        /* msgid of the request           */
+       ber_int_t       o_opid;         /* id of this operation           */
+       ber_int_t       o_msgid;        /* msgid of the request           */
 
        ldap_pvt_thread_t       o_tid;          /* thread handling this op        */
 
        BerElement      *o_ber;         /* ber of the request             */
 
-       unsigned long   o_tag;          /* tag of the request             */
+       ber_tag_t       o_tag;          /* tag of the request             */
        time_t          o_time;         /* time op was initiated          */
+
+       int             o_bind_in_progress;     /* multi-op bind in progress */
+
        char            *o_dn;          /* dn bound when op was initiated */
        char            *o_ndn;         /* normalized dn bound when op was initiated */
-       int                     o_authtype;     /* auth method used to bind dn    */
+       ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
+       ber_tag_t       o_authtype;     /* auth method used to bind dn    */
                                        /* values taken from ldap.h       */
                                        /* LDAP_AUTH_*                    */
+       char            *o_authmech; /* SASL mechanism used to bind dn */
+
+       LDAPControl     **o_ctrls;       /* controls */
 
-/*      long   o_connid;       *//* id of conn initiating this op  */
+       unsigned long   o_connid; /* id of conn initiating this op  */
 
 #ifdef LDAP_CONNECTIONLESS
        int             o_cldap;        /* != 0 if this came in via CLDAP */
@@ -422,18 +577,20 @@ typedef struct slap_conn {
 
        /* only can be changed by connect_init */
        time_t          c_starttime;    /* when the connection was opened */
-       long            c_connid;       /* id of this connection for stats*/
+       time_t          c_activitytime; /* when the connection was last used */
+       unsigned long           c_connid;       /* id of this connection for stats*/
        char            *c_client_addr; /* address of client */
        char            *c_client_name; /* name of client */
 
        /* only can be changed by binding thread */
+       int             c_bind_in_progress;     /* multi-op bind in progress */
+
        char    *c_cdn;         /* DN provided by the client */
        char    *c_dn;          /* DN bound to this conn  */
-       int             c_protocol;     /* version of the LDAP protocol used by client */
-       int             c_authtype;     /* auth method used to bind c_dn  */
-#ifdef LDAP_COMPAT
-       int             c_version;      /* for compatibility w/ U-Mich 2.0 & 3.0 */
-#endif
+       ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
+       ber_tag_t       c_authtype;/* auth method used to bind c_dn  */
+       char    *c_authmech;    /* SASL mechanism used to bind c_dn */
+       void    *c_authstate;   /* SASL state data */
 
        Operation       *c_ops;                 /* list of operations being processed */
        Operation       *c_pending_ops; /* list of pending operations */
@@ -444,10 +601,17 @@ typedef struct slap_conn {
        BerElement      *c_currentber;  /* ber we're attempting to read */
        int             c_writewaiter;  /* true if writer is waiting */
 
+       int     c_is_tls;               /* true if this LDAP over raw TLS */
+       int     c_needs_tls_accept;     /* true if SSL_accept should be called */
+
        long    c_n_ops_received;               /* num of ops received (next op_id) */
        long    c_n_ops_executing;      /* num of ops currently executing */
        long    c_n_ops_pending;                /* num of ops pending execution */
        long    c_n_ops_completed;      /* num of ops completed */
+
+       long    c_n_get;                /* num of get calls */
+       long    c_n_read;               /* num of read calls */
+       long    c_n_write;              /* num of write calls */
 } Connection;
 
 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
@@ -463,8 +627,8 @@ typedef struct slap_conn {
 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
 #endif
 
-#include "proto-slap.h"
-
 LDAP_END_DECL
 
+#include "proto-slap.h"
+
 #endif /* _slap_h_ */