]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/slap.h
cleanup comments
[openldap] / servers / slapd / slap.h
index c965f984d330fd9f1a44ced96dccf3d8eb24f505..f23101680e2040654629546975f376d5a93865f3 100644 (file)
@@ -16,6 +16,7 @@
 #include <sys/types.h>
 #include <ac/syslog.h>
 #include <ac/regex.h>
+#include <ac/signal.h>
 #include <ac/socket.h>
 #include <ac/time.h>
 #include <ac/param.h>
@@ -217,24 +218,26 @@ typedef struct slap_ssf_set {
 /*
  * represents schema information for a database
  */
-#define SLAP_SCHERR_OUTOFMEM           1
-#define SLAP_SCHERR_CLASS_NOT_FOUND    2
-#define SLAP_SCHERR_CLASS_BAD_USAGE    3
-#define SLAP_SCHERR_ATTR_NOT_FOUND     4
-#define SLAP_SCHERR_ATTR_BAD_USAGE     5
-#define SLAP_SCHERR_DUP_CLASS          6
-#define SLAP_SCHERR_DUP_ATTR           7
-#define SLAP_SCHERR_DUP_SYNTAX         8
-#define SLAP_SCHERR_DUP_RULE           9
-#define SLAP_SCHERR_NO_NAME            10
-#define SLAP_SCHERR_ATTR_INCOMPLETE    11
-#define SLAP_SCHERR_MR_NOT_FOUND       12
-#define SLAP_SCHERR_SYN_NOT_FOUND      13
-#define SLAP_SCHERR_MR_INCOMPLETE      14
-#define SLAP_SCHERR_NOT_SUPPORTED      15
-#define SLAP_SCHERR_BAD_DESCR          16
-#define SLAP_SCHERR_OIDM                       17
-#define SLAP_SCHERR_LAST                       SLAP_SCHERR_OIDM
+#define SLAP_SCHERR_OUTOFMEM                   1
+#define SLAP_SCHERR_CLASS_NOT_FOUND            2
+#define SLAP_SCHERR_CLASS_BAD_USAGE            3
+#define SLAP_SCHERR_CLASS_BAD_SUP              4
+#define SLAP_SCHERR_CLASS_DUP                  5
+#define SLAP_SCHERR_ATTR_NOT_FOUND             6
+#define SLAP_SCHERR_ATTR_BAD_USAGE             7
+#define SLAP_SCHERR_ATTR_BAD_SUP               8
+#define SLAP_SCHERR_ATTR_INCOMPLETE            9
+#define SLAP_SCHERR_ATTR_DUP                   10
+#define SLAP_SCHERR_MR_NOT_FOUND               11
+#define SLAP_SCHERR_MR_INCOMPLETE              12
+#define SLAP_SCHERR_MR_DUP                             13
+#define SLAP_SCHERR_SYN_NOT_FOUND              14
+#define SLAP_SCHERR_SYN_DUP                            15
+#define SLAP_SCHERR_NO_NAME                            16
+#define SLAP_SCHERR_NOT_SUPPORTED              17
+#define SLAP_SCHERR_BAD_DESCR                  18
+#define SLAP_SCHERR_OIDM                               19
+#define SLAP_SCHERR_LAST                               SLAP_SCHERR_OIDM
 
 typedef union slap_sockaddr {
        struct sockaddr sa_addr;
@@ -247,6 +250,10 @@ typedef union slap_sockaddr {
 #endif
 } Sockaddr;
 
+#ifdef LDAP_PF_INET6
+extern int slap_inet4or6;
+#endif
+
 typedef struct slap_oid_macro {
        struct berval som_oid;
        char **som_names;
@@ -300,6 +307,18 @@ typedef struct slap_syntax {
 #define slap_syntax_is_ber(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
 #define slap_syntax_is_hidden(s)       slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
 
+typedef struct slap_syntax_defs_rec {
+       char *sd_desc;
+       int sd_flags;
+       slap_syntax_validate_func *sd_validate;
+       slap_syntax_transform_func *sd_normalize;
+       slap_syntax_transform_func *sd_pretty;
+#ifdef SLAPD_BINARY_CONVERSION
+       slap_syntax_transform_func *sd_ber2str;
+       slap_syntax_transform_func *sd_str2ber;
+#endif
+} slap_syntax_defs_rec;
+
 /* X -> Y Converter */
 typedef int slap_mr_convert_func LDAP_P((
        struct berval * in,
@@ -407,6 +426,18 @@ typedef struct slap_matching_rule {
 #define smr_extensions         smr_mrule.mr_extensions
 } MatchingRule;
 
+typedef struct slap_mrule_defs_rec {
+       char *                                          mrd_desc;
+       slap_mask_t                                     mrd_usage;
+       slap_mr_convert_func *          mrd_convert;
+       slap_mr_normalize_func *        mrd_normalize;
+       slap_mr_match_func *            mrd_match;
+       slap_mr_indexer_func *          mrd_indexer;
+       slap_mr_filter_func *           mrd_filter;
+
+       char *                                          mrd_associated;
+} slap_mrule_defs_rec;
+
 struct slap_backend_db;
 struct slap_entry;
 struct slap_attr;
@@ -430,6 +461,11 @@ typedef struct slap_attribute_type {
        Syntax                                  *sat_syntax;
 
        AttributeTypeSchemaCheckFN      *sat_check;
+
+#define SLAP_AT_NONE           0x0000U
+#define SLAP_AT_ABSTRACT       0x0100U /* cannot be instantiated */
+#define SLAP_AT_FINAL          0x0200U /* cannot be subtyped */
+#define SLAP_AT_HIDE           0x8000U /* hide attribute */
        slap_mask_t                                     sat_flags;
 
        struct slap_attribute_type      *sat_next;
@@ -469,7 +505,8 @@ typedef int (ObjectClassSchemaCheckFN)(
        char *textbuf, size_t textlen );
 
 typedef struct slap_object_class {
-       LDAPObjectClass         soc_oclass;
+       LDAPObjectClass                 soc_oclass;
+       struct berval                   soc_cname;
        struct slap_object_class        **soc_sups;
        AttributeType                           **soc_required;
        AttributeType                           **soc_allowed;
@@ -488,13 +525,15 @@ typedef struct slap_object_class {
        struct slap_object_class        *soc_next;
 } ObjectClass;
 
-#define        SLAP_OC_ALIAS           0x01
-#define        SLAP_OC_REFERRAL        0x02
-#define        SLAP_OC_SUBENTRY        0x04
-#define        SLAP_OC_DYNAMICOBJECT   0x08
-#define        SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x10
-#define        SLAP_OC__MASK           0x1F
-#define        SLAP_OC__END            0x20
+#define        SLAP_OC_ALIAS           0x0001
+#define        SLAP_OC_REFERRAL        0x0002
+#define        SLAP_OC_SUBENTRY        0x0004
+#define        SLAP_OC_DYNAMICOBJECT   0x0008
+#define        SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x0010
+#define        SLAP_OC__MASK           0x001F
+#define        SLAP_OC__END            0x0020
+#define SLAP_OC_OPERATIONAL    0x4000
+#define SLAP_OC_HIDE           0x8000
 
 #ifdef LDAP_EXTENDED_SCHEMA
 /*
@@ -584,6 +623,7 @@ struct slap_internal_schema {
        AttributeDescription *si_ad_supportedLDAPVersion;
        AttributeDescription *si_ad_supportedSASLMechanisms;
        AttributeDescription *si_ad_supportedFeatures;
+       AttributeDescription *si_ad_monitorContext;
        AttributeDescription *si_ad_vendorName;
        AttributeDescription *si_ad_vendorVersion;
 
@@ -608,6 +648,8 @@ struct slap_internal_schema {
        /* Access Control Internals */
        AttributeDescription *si_ad_entry;
        AttributeDescription *si_ad_children;
+       AttributeDescription *si_ad_saslAuthzTo;
+       AttributeDescription *si_ad_saslAuthzFrom;
 #ifdef SLAPD_ACI_ENABLED
        AttributeDescription *si_ad_aci;
 #endif
@@ -722,6 +764,32 @@ typedef struct slap_filter {
 /* compare routines can return undefined */
 #define SLAPD_COMPARE_UNDEFINED        ((ber_int_t) -1)
 
+typedef struct slap_valuesreturnfilter {
+       ber_tag_t       f_choice;
+
+       union vrf_un_u {
+               /* precomputed result */
+               ber_int_t f_un_result;
+
+               /* DN */
+               char *f_un_dn;
+
+               /* present */
+               AttributeDescription *f_un_desc;
+
+               /* simple value assertion */
+               AttributeAssertion *f_un_ava;
+
+               /* substring assertion */
+               SubstringsAssertion *f_un_ssa;
+
+               /* matching rule assertion */
+               MatchingRuleAssertion *f_un_mra;
+       } f_un;
+
+       struct slap_valuesreturnfilter  *f_next;
+} ValuesReturnFilter;
+
 /*
  * represents an attribute (description + values)
  */
@@ -1007,7 +1075,7 @@ LDAP_SLAPD_V (int) slapMode;
 
 struct slap_replica_info {
        char *ri_host;                          /* supersedes be_replica */
-       struct berval **ri_nsuffix;     /* array of suffixes this replica accepts */
+       BerVarray ri_nsuffix;   /* array of suffixes this replica accepts */
        AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
        int ri_exclude;                 /* 1 => exclude ri_attrs */
 };
@@ -1034,6 +1102,7 @@ struct slap_limits {
 #define SLAP_LIMITS_REGEX      0x0005
 #define SLAP_LIMITS_ANONYMOUS  0x0006
 #define SLAP_LIMITS_USERS      0x0007
+#define SLAP_LIMITS_ANY                0x0008
        regex_t lm_dn_regex;            /* regex data for REGEX */
 
        /*
@@ -1132,7 +1201,9 @@ struct slap_backend_db {
 
 #define SLAP_DISALLOW_BIND_ANON                0x0001U /* no anonymous */
 #define SLAP_DISALLOW_BIND_SIMPLE      0x0002U /* simple authentication */
-#define SLAP_DISALLOW_BIND_KRBV4       0x0004U /* Kerberos V4 authentication */
+#define SLAP_DISALLOW_BIND_SIMPLE_UNPROTECTED \
+                                                                       0x0004U /* unprotected simple auth */
+#define SLAP_DISALLOW_BIND_KRBV4       0x0008U /* Kerberos V4 authentication */
 
 #define SLAP_DISALLOW_TLS_2_ANON       0x0010U /* StartTLS -> Anonymous */
 #define SLAP_DISALLOW_TLS_AUTHC                0x0020U /* TLS while authenticated */
@@ -1148,9 +1219,13 @@ struct slap_backend_db {
        slap_ssf_set_t be_ssf_set;
 
        /* these should be renamed from be_ to bd_ */
-       struct berval **be_suffix;      /* the DN suffixes of data in this backend */
-       struct berval **be_nsuffix;     /* the normalized DN suffixes in this backend */
-       struct berval **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
+       BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
+       BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
+       BerVarray       be_suffixAlias; /* pairs of DN suffix aliases and deref values */
+#ifdef SLAPD_SCHEMA_DN
+       struct berval be_schemadn;      /* per-backend subschema subentry DN */
+       struct berval be_schemandn;     /* normalized subschema DN */
+#endif
        struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
        struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
        struct berval be_rootpw;        /* the magic "root" password for this db        */
@@ -1434,6 +1509,7 @@ typedef struct slap_paged_state {
 typedef struct slap_op {
        unsigned long o_opid;   /* id of this operation */
        unsigned long o_connid; /* id of conn initiating this op */
+       struct slap_conn *o_conn;       /* connection spawning this op */
 
        ber_int_t       o_msgid;        /* msgid of the request */
        ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
@@ -1442,8 +1518,9 @@ typedef struct slap_op {
 
        ldap_pvt_thread_t       o_tid;  /* thread handling this op */
 
-       ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
-       char o_abandon; /* abandon flag */
+       volatile sig_atomic_t o_abandon;        /* abandon flag */
+
+       char o_do_not_cache;    /* don't cache from this op */
 
 #define SLAP_NO_CONTROL 0
 #define SLAP_NONCRITICAL_CONTROL 1
@@ -1452,6 +1529,7 @@ typedef struct slap_op {
        char o_noop;
        char o_subentries;
        char o_subentries_visibility;
+       char o_valuesreturnfilter;
 
        char o_pagedresults;
        ber_int_t o_pagedresults_size;
@@ -1466,9 +1544,11 @@ typedef struct slap_op {
        slap_callback   *o_callback;    /* callback pointers */
        LDAPControl     **o_ctrls;       /* controls */
 
+       void    *o_threadctx;           /* thread pool thread context */
        void    *o_private;     /* anything the backend needs */
 
        LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
+       ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
 } Operation;
 
 #define get_manageDSAit(op)                            ((int)(op)->o_managedsait)
@@ -1511,7 +1591,7 @@ typedef struct slap_conn {
        /* only can be changed by binding thread */
        int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
        struct berval   c_sasl_bind_mech;                       /* mech in progress */
-       struct berval   c_cdn;
+       struct berval   c_sasl_dn;      /* temporary storage */
 
        /* authorization backend */
        Backend *c_authz_backend;
@@ -1540,6 +1620,7 @@ typedef struct slap_conn {
        int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
        void    *c_sasl_context;        /* SASL session context */
        void    *c_sasl_extra;          /* SASL session extra stuff */
+       struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
 
        PagedResultsState c_pagedresults_state; /* paged result state */
 
@@ -1566,19 +1647,6 @@ typedef struct slap_conn {
 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
 #endif
 
-
-#define SASLREGEX_REPLACE 10
-#define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
-#define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
-
-typedef struct sasl_regexp {
-  char *sr_match;                                                      /* regexp match pattern */
-  char *sr_replace;                                                    /* regexp replace pattern */
-  regex_t sr_workspace;                                                /* workspace for regexp engine */
-  regmatch_t sr_strings[SASLREGEX_REPLACE];    /* strings matching $1,$2 ... */
-  int sr_offset[SASLREGEX_REPLACE+2];          /* offsets of $1,$2... in *replace */
-} SaslRegexp_t;
-
 /*
  * listener; need to access it from monitor backend
  */
@@ -1615,6 +1683,12 @@ enum {
 };
 #endif /* SLAPD_MONITOR */
 
+/*
+ * Better know these all around slapd
+ */
+#define SLAP_LDAPDN_PRETTY 0x1
+#define SLAP_LDAPDN_MAXLEN 8192
+
 LDAP_END_DECL
 
 #include "proto-slap.h"