git.sur5r.net Git - openldap/blob - servers/slapd/slap.h

   1 /* slap.h - stand alone ldap server include file */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 #ifndef _SLAP_H_
   9 #define _SLAP_H_
  10
  11 #include "ldap_defaults.h"
  12
  13 #include <stdio.h>
  14 #include <ac/stdlib.h>
  15
  16 #include <sys/types.h>
  17 #include <ac/syslog.h>
  18 #include <ac/regex.h>
  19 #include <ac/signal.h>
  20 #include <ac/socket.h>
  21 #include <ac/time.h>
  22 #include <ac/param.h>
  23
  24 #include "avl.h"
  25
  26 #ifndef ldap_debug
  27 #define ldap_debug slap_debug
  28 #endif
  29
  30 #include "ldap_log.h"
  31
  32 #include <ldap.h>
  33 #include <ldap_schema.h>
  34
  35 #include "ldap_pvt_thread.h"
  36 #include "ldap_queue.h"
  37
  38 LDAP_BEGIN_DECL
  39 /*
  40  * SLAPD Memory allocation macros
  41  *
  42  * Unlike ch_*() routines, these routines do not assert() upon
  43  * allocation error.  They are intended to be used instead of
  44  * ch_*() routines where the caller has implemented proper
  45  * checking for and handling of allocation errors.
  46  *
  47  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
  48  */
  49 #define SLAP_MALLOC(s)      ber_memalloc((s))
  50 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
  51 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
  52 #define SLAP_FREE(p)        ber_memfree((p))
  53 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
  54 #define SLAP_STRDUP(s)      ber_strdup((s))
  55 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
  56
  57 #ifdef f_next
  58 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  59 #endif
  60
  61 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
  62 #define SLAPD_ANONYMOUS "cn=anonymous"
  63
  64 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
  65  *
  66  * This is a value used internally by the backends. It is needed to allow
  67  * adding values that already exist without getting an error as required by
  68  * modrdn when the new rdn was already an attribute value itself.
  69  * JCG 05/1999 (gomez@engr.sgi.com)
  70  */
  71 #define SLAP_MOD_SOFTADD        0x1000
  72
  73 #define MAXREMATCHES (100)
  74
  75 #define SLAP_MAX_WORKER_THREADS         (32)
  76
  77 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
  78 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
  79
  80 #define SLAP_TEXT_BUFLEN (256)
  81
  82 /* psuedo error code indicating abandoned operation */
  83 #define SLAPD_ABANDON (-1)
  84
  85 /* psuedo error code indicating disconnect */
  86 #define SLAPD_DISCONNECT (-2)
  87
  88
  89 /* We assume "C" locale, that is US-ASCII */
  90 #define ASCII_SPACE(c)  ( (c) == ' ' )
  91 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
  92 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
  93 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
  94 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
  95 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
  96 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
  97
  98 #define SLAP_NIBBLE(c) ((c)&0x0f)
  99 #define SLAP_ESCAPE_CHAR ('\\')
 100 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
 101 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
 102
 103 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
 104         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
 105
 106 #define DN_ESCAPE(c)    ((c) == SLAP_ESCAPE_CHAR)
 107 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
 108 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
 109 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
 110 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
 111
 112 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
 113 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
 114 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
 115 #define OID_SEPARATOR(c)        ( (c) == '.' )
 116 #define OID_CHAR(c)     ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
 117
 118 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
 119 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || (c) == '.' )
 120
 121 #define AD_LEADCHAR(c)  ( ATTR_CHAR(c) )
 122 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
 123
 124 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
 125
 126 #define SLAP_PRINTABLE(c)       ( ASCII_ALNUM(c) || (c) == '\'' || \
 127         (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
 128         (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
 129         (c) == '?' || (c) == ' ' || (c) == '=' )
 130 #define SLAP_PRINTABLES(c)      ( SLAP_PRINTABLE(c) || (c) == '$' )
 131
 132 /* must match in schema_init.c */
 133 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
 134 #define SLAPD_NAMEUID_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.34"
 135 #define SLAPD_GROUP_ATTR                "member"
 136 #define SLAPD_GROUP_CLASS               "groupOfNames"
 137 #define SLAPD_ROLE_ATTR                 "roleOccupant"
 138 #define SLAPD_ROLE_CLASS                "organizationalRole"
 139
 140 #ifdef SLAPD_ACI_ENABLED
 141 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
 142 #endif
 143
 144 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
 145
 146 /* change this to "OpenLDAPset" */
 147 #define SLAPD_ACI_SET_ATTR              "template"
 148
 149 #define SLAPD_TOP_OID                   "2.5.6.0"
 150
 151 LDAP_SLAPD_V (int) slap_debug;
 152
 153 typedef unsigned long slap_mask_t;
 154
 155 /* Security Strength Factor */
 156 typedef unsigned slap_ssf_t;
 157
 158 typedef struct slap_ssf_set {
 159         slap_ssf_t sss_ssf;
 160         slap_ssf_t sss_transport;
 161         slap_ssf_t sss_tls;
 162         slap_ssf_t sss_sasl;
 163         slap_ssf_t sss_update_ssf;
 164         slap_ssf_t sss_update_transport;
 165         slap_ssf_t sss_update_tls;
 166         slap_ssf_t sss_update_sasl;
 167 } slap_ssf_set_t;
 168
 169 /*
 170  * Index types
 171  */
 172 #define SLAP_INDEX_TYPE           0x00FFUL
 173 #define SLAP_INDEX_UNDEFINED      0x0001UL
 174 #define SLAP_INDEX_PRESENT        0x0002UL
 175 #define SLAP_INDEX_EQUALITY       0x0004UL
 176 #define SLAP_INDEX_APPROX         0x0008UL
 177 #define SLAP_INDEX_SUBSTR         0x0010UL
 178 #define SLAP_INDEX_EXTENDED               0x0020UL
 179
 180 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
 181
 182 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type))
 183
 184 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
 185
 186 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
 187 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
 188 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
 189 #define SLAP_INDEX_SUBSTR_DEFAULT \
 190         ( SLAP_INDEX_SUBSTR \
 191         | SLAP_INDEX_SUBSTR_INITIAL \
 192         | SLAP_INDEX_SUBSTR_ANY \
 193         | SLAP_INDEX_SUBSTR_FINAL )
 194
 195 #define SLAP_INDEX_SUBSTR_MINLEN        2
 196 #define SLAP_INDEX_SUBSTR_MAXLEN        4
 197 #define SLAP_INDEX_SUBSTR_STEP  2
 198
 199 #define SLAP_INDEX_FLAGS         0xF000UL
 200 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
 201 #define SLAP_INDEX_NOLANG        0x2000UL /* don't use index w/ lang */
 202
 203 /*
 204  * there is a single index for each attribute.  these prefixes ensure
 205  * that there is no collision among keys.
 206  */
 207 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
 208 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
 209 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
 210 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
 211 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
 212 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
 213
 214 #define SLAP_SYNTAX_MATCHINGRULES_OID   "1.3.6.1.4.1.1466.115.121.1.30"
 215 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID  "1.3.6.1.4.1.1466.115.121.1.3"
 216 #define SLAP_SYNTAX_OBJECTCLASSES_OID   "1.3.6.1.4.1.1466.115.121.1.37"
 217
 218 /*
 219  * represents schema information for a database
 220  */
 221 #define SLAP_SCHERR_OUTOFMEM                    1
 222 #define SLAP_SCHERR_CLASS_NOT_FOUND             2
 223 #define SLAP_SCHERR_CLASS_BAD_USAGE             3
 224 #define SLAP_SCHERR_CLASS_BAD_SUP               4
 225 #define SLAP_SCHERR_CLASS_DUP                   5
 226 #define SLAP_SCHERR_ATTR_NOT_FOUND              6
 227 #define SLAP_SCHERR_ATTR_BAD_USAGE              7
 228 #define SLAP_SCHERR_ATTR_BAD_SUP                8
 229 #define SLAP_SCHERR_ATTR_INCOMPLETE             9
 230 #define SLAP_SCHERR_ATTR_DUP                    10
 231 #define SLAP_SCHERR_MR_NOT_FOUND                11
 232 #define SLAP_SCHERR_MR_INCOMPLETE               12
 233 #define SLAP_SCHERR_MR_DUP                              13
 234 #define SLAP_SCHERR_SYN_NOT_FOUND               14
 235 #define SLAP_SCHERR_SYN_DUP                             15
 236 #define SLAP_SCHERR_NO_NAME                             16
 237 #define SLAP_SCHERR_NOT_SUPPORTED               17
 238 #define SLAP_SCHERR_BAD_DESCR                   18
 239 #define SLAP_SCHERR_OIDM                                19
 240 #define SLAP_SCHERR_LAST                                SLAP_SCHERR_OIDM
 241
 242 typedef union slap_sockaddr {
 243         struct sockaddr sa_addr;
 244         struct sockaddr_in sa_in_addr;
 245 #ifdef LDAP_PF_INET6
 246         struct sockaddr_in6 sa_in6_addr;
 247 #endif
 248 #ifdef LDAP_PF_LOCAL
 249         struct sockaddr_un sa_un_addr;
 250 #endif
 251 } Sockaddr;
 252
 253 typedef struct slap_oid_macro {
 254         struct berval som_oid;
 255         char **som_names;
 256         struct slap_oid_macro *som_next;
 257 } OidMacro;
 258
 259 /* forward declarations */
 260 struct slap_syntax;
 261 struct slap_matching_rule;
 262
 263 typedef int slap_syntax_validate_func LDAP_P((
 264         struct slap_syntax *syntax,
 265         struct berval * in));
 266
 267 typedef int slap_syntax_transform_func LDAP_P((
 268         struct slap_syntax *syntax,
 269         struct berval * in,
 270         struct berval * out));
 271
 272 typedef struct slap_syntax {
 273         LDAPSyntax                      ssyn_syn;
 274 #define ssyn_oid                ssyn_syn.syn_oid
 275 #define ssyn_desc               ssyn_syn.syn_desc
 276 #define ssyn_extensions         ssyn_syn.syn_extensions
 277         ber_len_t       ssyn_oidlen;
 278
 279         unsigned int ssyn_flags;
 280
 281 #define SLAP_SYNTAX_NONE        0x0000U
 282 #define SLAP_SYNTAX_BLOB        0x0001U /* syntax treated as blob (audio) */
 283 #define SLAP_SYNTAX_BINARY      0x0002U /* binary transfer required (certificate) */
 284 #define SLAP_SYNTAX_BER         0x0004U /* stored in BER encoding (certificate) */
 285 #define SLAP_SYNTAX_HIDE        0x8000U /* hide (do not publish) */
 286
 287         slap_syntax_validate_func       *ssyn_validate;
 288         slap_syntax_transform_func      *ssyn_normalize;
 289         slap_syntax_transform_func      *ssyn_pretty;
 290
 291 #ifdef SLAPD_BINARY_CONVERSION
 292         /* convert to and from binary */
 293         slap_syntax_transform_func      *ssyn_ber2str;
 294         slap_syntax_transform_func      *ssyn_str2ber;
 295 #endif
 296
 297         struct slap_syntax              *ssyn_next;
 298 } Syntax;
 299
 300 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
 301 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
 302 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
 303 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
 304 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
 305
 306 /* X -> Y Converter */
 307 typedef int slap_mr_convert_func LDAP_P((
 308         struct berval * in,
 309         struct berval * out ));
 310
 311 /* Normalizer */
 312 typedef int slap_mr_normalize_func LDAP_P((
 313         slap_mask_t use,
 314         struct slap_syntax *syntax, /* NULL if in is asserted value */
 315         struct slap_matching_rule *mr,
 316         struct berval * in,
 317         struct berval * out ));
 318
 319 /* Match (compare) function */
 320 typedef int slap_mr_match_func LDAP_P((
 321         int *match,
 322         slap_mask_t use,
 323         struct slap_syntax *syntax,     /* syntax of stored value */
 324         struct slap_matching_rule *mr,
 325         struct berval * value,
 326         void * assertValue ));
 327
 328 /* Index generation function */
 329 typedef int slap_mr_indexer_func LDAP_P((
 330         slap_mask_t use,
 331         slap_mask_t mask,
 332         struct slap_syntax *syntax,     /* syntax of stored value */
 333         struct slap_matching_rule *mr,
 334         struct berval *prefix,
 335         BerVarray values,
 336         BerVarray *keys ));
 337
 338 /* Filter index function */
 339 typedef int slap_mr_filter_func LDAP_P((
 340         slap_mask_t use,
 341         slap_mask_t mask,
 342         struct slap_syntax *syntax,     /* syntax of stored value */
 343         struct slap_matching_rule *mr,
 344         struct berval *prefix,
 345         void * assertValue,
 346         BerVarray *keys ));
 347
 348 typedef struct slap_matching_rule {
 349         LDAPMatchingRule                smr_mrule;
 350         ber_len_t                               smr_oidlen;
 351         slap_mask_t                             smr_usage;
 352
 353 #define SLAP_MR_HIDE                    0x8000U
 354
 355 #define SLAP_MR_TYPE_MASK               0x0F00U
 356 #define SLAP_MR_SUBTYPE_MASK    0x00F0U
 357 #define SLAP_MR_USAGE                   0x000FU
 358
 359 #define SLAP_MR_NONE                    0x0000U
 360 #define SLAP_MR_EQUALITY                0x0100U
 361 #define SLAP_MR_ORDERING                0x0200U
 362 #define SLAP_MR_SUBSTR                  0x0400U
 363 #define SLAP_MR_EXT                             0x0800U
 364
 365 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
 366 #define SLAP_MR_DN_FOLD                 0x0008U
 367
 368 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0010U )
 369 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0020U )
 370 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0040U )
 371
 372 /*
 373  * normally the provided value is expected to conform to
 374  * assertion syntax specified in the matching rule, however
 375  * at times (such as during individual value modification),
 376  * the provided value is expected to conform to the
 377  * attribute's value syntax.
 378  */
 379 #define SLAP_MR_ASSERTION_SYNTAX_MATCH                  0x0000U
 380 #define SLAP_MR_VALUE_SYNTAX_MATCH                              0x0001U
 381 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH    0x0003U
 382
 383 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
 384         (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
 385 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
 386         ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
 387
 388 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
 389         (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
 390                 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
 391 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
 392         (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
 393                 == SLAP_MR_VALUE_SYNTAX_MATCH)
 394
 395         Syntax                                  *smr_syntax;
 396         slap_mr_convert_func    *smr_convert;
 397         slap_mr_normalize_func  *smr_normalize;
 398         slap_mr_match_func              *smr_match;
 399         slap_mr_indexer_func    *smr_indexer;
 400         slap_mr_filter_func             *smr_filter;
 401
 402         struct slap_matching_rule       *smr_associated;
 403         struct slap_matching_rule       *smr_next;
 404
 405 #define smr_oid                         smr_mrule.mr_oid
 406 #define smr_names                       smr_mrule.mr_names
 407 #define smr_desc                        smr_mrule.mr_desc
 408 #define smr_obsolete            smr_mrule.mr_obsolete
 409 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
 410 #define smr_extensions          smr_mrule.mr_extensions
 411 } MatchingRule;
 412
 413 struct slap_backend_db;
 414 struct slap_entry;
 415 struct slap_attr;
 416
 417 typedef int (AttributeTypeSchemaCheckFN)(
 418         struct slap_backend_db *be,
 419         struct slap_entry *e,
 420         struct slap_attr *attr,
 421         const char** text,
 422         char *textbuf, size_t textlen );
 423
 424 typedef struct slap_attribute_type {
 425         LDAPAttributeType               sat_atype;
 426         struct berval                   sat_cname;
 427         struct slap_attribute_type      *sat_sup;
 428         struct slap_attribute_type      **sat_subtypes;
 429         MatchingRule                    *sat_equality;
 430         MatchingRule                    *sat_approx;
 431         MatchingRule                    *sat_ordering;
 432         MatchingRule                    *sat_substr;
 433         Syntax                                  *sat_syntax;
 434
 435         AttributeTypeSchemaCheckFN      *sat_check;
 436
 437 #define SLAP_AT_NONE            0x0000U
 438 #define SLAP_AT_ABSTRACT        0x0100U /* cannot be instantiated */
 439 #define SLAP_AT_FINAL           0x0200U /* cannot be subtyped */
 440 #define SLAP_AT_HIDE            0x8000U /* hide attribute */
 441         slap_mask_t                                     sat_flags;
 442
 443         struct slap_attribute_type      *sat_next;
 444
 445 #define sat_oid                         sat_atype.at_oid
 446 #define sat_names                       sat_atype.at_names
 447 #define sat_desc                        sat_atype.at_desc
 448 #define sat_obsolete            sat_atype.at_obsolete
 449 #define sat_sup_oid                     sat_atype.at_sup_oid
 450 #define sat_equality_oid        sat_atype.at_equality_oid
 451 #define sat_ordering_oid        sat_atype.at_ordering_oid
 452 #define sat_substr_oid          sat_atype.at_substr_oid
 453 #define sat_syntax_oid          sat_atype.at_syntax_oid
 454 #define sat_single_value        sat_atype.at_single_value
 455 #define sat_collective          sat_atype.at_collective
 456 #define sat_no_user_mod         sat_atype.at_no_user_mod
 457 #define sat_usage                       sat_atype.at_usage
 458 #define sat_extensions          sat_atype.at_extensions
 459
 460         struct slap_attr_desc           *sat_ad;
 461         ldap_pvt_thread_mutex_t         sat_ad_mutex;
 462 } AttributeType;
 463
 464 #define is_at_operational(at)   ((at)->sat_usage)
 465 #define is_at_single_value(at)  ((at)->sat_single_value)
 466 #define is_at_collective(at)    ((at)->sat_collective)
 467 #define is_at_obsolete(at)              ((at)->sat_obsolete)
 468 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
 469
 470 struct slap_object_class;
 471
 472 typedef int (ObjectClassSchemaCheckFN)(
 473         struct slap_backend_db *be,
 474         struct slap_entry *e,
 475         struct slap_object_class *oc,
 476         const char** text,
 477         char *textbuf, size_t textlen );
 478
 479 typedef struct slap_object_class {
 480         LDAPObjectClass         soc_oclass;
 481         struct slap_object_class        **soc_sups;
 482         AttributeType                           **soc_required;
 483         AttributeType                           **soc_allowed;
 484         ObjectClassSchemaCheckFN        *soc_check;
 485         slap_mask_t                                     soc_flags;
 486 #define soc_oid                         soc_oclass.oc_oid
 487 #define soc_names                       soc_oclass.oc_names
 488 #define soc_desc                        soc_oclass.oc_desc
 489 #define soc_obsolete            soc_oclass.oc_obsolete
 490 #define soc_sup_oids            soc_oclass.oc_sup_oids
 491 #define soc_kind                        soc_oclass.oc_kind
 492 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 493 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 494 #define soc_extensions          soc_oclass.oc_extensions
 495
 496         struct slap_object_class        *soc_next;
 497 } ObjectClass;
 498
 499 #define SLAP_OC_ALIAS           0x0001
 500 #define SLAP_OC_REFERRAL        0x0002
 501 #define SLAP_OC_SUBENTRY        0x0004
 502 #define SLAP_OC_DYNAMICOBJECT   0x0008
 503 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x0010
 504 #define SLAP_OC__MASK           0x001F
 505 #define SLAP_OC__END            0x0020
 506 #define SLAP_OC_OPERATIONAL     0x4000
 507 #define SLAP_OC_HIDE            0x8000
 508
 509 #ifdef LDAP_EXTENDED_SCHEMA
 510 /*
 511  * DIT content rule
 512  */
 513 typedef struct slap_content_rule {
 514         LDAPContentRule         scr_crule;
 515         ObjectClass                     *scr_sclass;
 516         ObjectClass                     **scr_auxiliaries;      /* optional */
 517         AttributeType           **scr_required;         /* optional */
 518         AttributeType           **scr_allowed;          /* optional */
 519         AttributeType           **scr_precluded;        /* optional */
 520 #define scr_oid                 scr_crule.cr_oid
 521 #define scr_names               scr_crule.cr_names
 522 #define scr_desc                scr_crule.cr_desc
 523 #define scr_obsolete            soc_oclass.cr_obsolete
 524 #define scr_cr_oids_aux         soc_oclass.cr_oc_oids_aux
 525 #define scr_cr_oids_must        soc_oclass.cr_at_oids_must
 526 #define scr_cr_oids_may         soc_oclass.cr_at_oids_may
 527 #define scr_cr_oids_not         soc_oclass.cr_at_oids_not
 528 } ContentRule;
 529 #endif
 530
 531 /*
 532  * represents a recognized attribute description ( type + options )
 533  */
 534 typedef struct slap_attr_desc {
 535         struct slap_attr_desc *ad_next;
 536         AttributeType *ad_type;         /* attribute type, must be specified */
 537         struct berval ad_cname;         /* canonical name, must be specified */
 538         struct berval ad_lang;          /* empty if no language tags */
 539         unsigned ad_flags;
 540 #define SLAP_DESC_NONE                  0x00U
 541 #define SLAP_DESC_BINARY                0x01U
 542 #define SLAP_DESC_LANG_RANGE    0x80U
 543 } AttributeDescription;
 544
 545 typedef struct slap_attr_name {
 546         struct berval an_name;
 547         AttributeDescription *an_desc;
 548         ObjectClass *an_oc;
 549 } AttributeName;
 550
 551 #define slap_ad_is_lang(ad)                     ( (ad)->ad_lang.bv_len != 0 )
 552 #define slap_ad_is_lang_range(ad)       \
 553         ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
 554 #define slap_ad_is_binary(ad)           \
 555         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
 556
 557 /*
 558  * pointers to schema elements used internally
 559  */
 560 struct slap_internal_schema {
 561         /* objectClass */
 562         ObjectClass *si_oc_top;
 563         ObjectClass *si_oc_extensibleObject;
 564         ObjectClass *si_oc_alias;
 565         ObjectClass *si_oc_referral;
 566         ObjectClass *si_oc_rootdse;
 567         ObjectClass *si_oc_subentry;
 568         ObjectClass *si_oc_subschema;
 569         ObjectClass *si_oc_monitor;
 570         ObjectClass *si_oc_collectiveAttributeSubentry;
 571         ObjectClass *si_oc_dynamicObject;
 572
 573         /* objectClass attribute descriptions */
 574         AttributeDescription *si_ad_objectClass;
 575
 576         /* operational attribute descriptions */
 577         AttributeDescription *si_ad_structuralObjectClass;
 578         AttributeDescription *si_ad_creatorsName;
 579         AttributeDescription *si_ad_createTimestamp;
 580         AttributeDescription *si_ad_modifiersName;
 581         AttributeDescription *si_ad_modifyTimestamp;
 582         AttributeDescription *si_ad_hasSubordinates;
 583         AttributeDescription *si_ad_subschemaSubentry;
 584         AttributeDescription *si_ad_collectiveSubentries;
 585         AttributeDescription *si_ad_collectiveExclusions;
 586         AttributeDescription *si_ad_entryUUID;
 587         AttributeDescription *si_ad_entryCSN;
 588
 589         /* root DSE attribute descriptions */
 590         AttributeDescription *si_ad_altServer;
 591         AttributeDescription *si_ad_namingContexts;
 592         AttributeDescription *si_ad_supportedControl;
 593         AttributeDescription *si_ad_supportedExtension;
 594         AttributeDescription *si_ad_supportedLDAPVersion;
 595         AttributeDescription *si_ad_supportedSASLMechanisms;
 596         AttributeDescription *si_ad_supportedFeatures;
 597         AttributeDescription *si_ad_vendorName;
 598         AttributeDescription *si_ad_vendorVersion;
 599
 600         /* subentry attribute descriptions */
 601         AttributeDescription *si_ad_administrativeRole;
 602         AttributeDescription *si_ad_subtreeSpecification;
 603
 604         /* subschema subentry attribute descriptions */
 605         AttributeDescription *si_ad_ditStructureRules;
 606         AttributeDescription *si_ad_ditContentRules;
 607         AttributeDescription *si_ad_nameForms;
 608         AttributeDescription *si_ad_objectClasses;
 609         AttributeDescription *si_ad_attributeTypes;
 610         AttributeDescription *si_ad_ldapSyntaxes;
 611         AttributeDescription *si_ad_matchingRules;
 612         AttributeDescription *si_ad_matchingRuleUse;
 613
 614         /* Aliases & Referrals */
 615         AttributeDescription *si_ad_aliasedObjectName;
 616         AttributeDescription *si_ad_ref;
 617
 618         /* Access Control Internals */
 619         AttributeDescription *si_ad_entry;
 620         AttributeDescription *si_ad_children;
 621         AttributeDescription *si_ad_saslAuthzTo;
 622         AttributeDescription *si_ad_saslAuthzFrom;
 623 #ifdef SLAPD_ACI_ENABLED
 624         AttributeDescription *si_ad_aci;
 625 #endif
 626
 627         /* dynamic entries */
 628         AttributeDescription *si_ad_entryTtl;
 629         AttributeDescription *si_ad_dynamicSubtrees;
 630
 631         /* Other attributes descriptions */
 632         AttributeDescription *si_ad_distinguishedName;
 633         AttributeDescription *si_ad_name;
 634         AttributeDescription *si_ad_cn;
 635         AttributeDescription *si_ad_userPassword;
 636 #ifdef SLAPD_AUTHPASSWD
 637         AttributeDescription *si_ad_authPassword;
 638 #endif
 639 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 640         AttributeDescription *si_ad_krbName;
 641 #endif
 642
 643         /* Undefined Attribute Type */
 644         AttributeType   *si_at_undefined;
 645
 646         /* Matching Rules */
 647         MatchingRule    *si_mr_distinguishedNameMatch;
 648         MatchingRule    *si_mr_integerMatch;
 649
 650         /* Syntaxes */
 651         Syntax          *si_syn_octetString;
 652         Syntax          *si_syn_distinguishedName;
 653         Syntax          *si_syn_integer;
 654 };
 655
 656 typedef struct slap_attr_assertion {
 657         AttributeDescription    *aa_desc;
 658         struct berval aa_value;
 659 } AttributeAssertion;
 660
 661 typedef struct slap_ss_assertion {
 662         AttributeDescription    *sa_desc;
 663         struct berval           sa_initial;
 664         struct berval           *sa_any;
 665         struct berval           sa_final;
 666 } SubstringsAssertion;
 667
 668 typedef struct slap_mr_assertion {
 669         MatchingRule            *ma_rule;       /* optional */
 670         struct berval           ma_rule_text;  /* optional */
 671         AttributeDescription    *ma_desc;       /* optional */
 672         int                                             ma_dnattrs; /* boolean */
 673         struct berval           ma_value;       /* required */
 674 } MatchingRuleAssertion;
 675
 676 /*
 677  * represents a search filter
 678  */
 679 typedef struct slap_filter {
 680         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 681 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
 682 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
 683 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
 684
 685         union f_un_u {
 686                 /* precomputed result */
 687                 ber_int_t f_un_result;
 688
 689                 /* DN */
 690                 struct berval *f_un_dn;
 691
 692                 /* present */
 693                 AttributeDescription *f_un_desc;
 694
 695                 /* simple value assertion */
 696                 AttributeAssertion *f_un_ava;
 697
 698                 /* substring assertion */
 699                 SubstringsAssertion *f_un_ssa;
 700
 701                 /* matching rule assertion */
 702                 MatchingRuleAssertion *f_un_mra;
 703
 704 #define f_dn                    f_un.f_un_dn
 705 #define f_desc                  f_un.f_un_desc
 706 #define f_ava                   f_un.f_un_ava
 707 #define f_av_desc               f_un.f_un_ava->aa_desc
 708 #define f_av_value              f_un.f_un_ava->aa_value
 709 #define f_sub                   f_un.f_un_ssa
 710 #define f_sub_desc              f_un.f_un_ssa->sa_desc
 711 #define f_sub_initial   f_un.f_un_ssa->sa_initial
 712 #define f_sub_any               f_un.f_un_ssa->sa_any
 713 #define f_sub_final             f_un.f_un_ssa->sa_final
 714 #define f_mra                   f_un.f_un_mra
 715 #define f_mr_rule               f_un.f_un_mra->ma_rule
 716 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
 717 #define f_mr_desc               f_un.f_un_mra->ma_desc
 718 #define f_mr_value              f_un.f_un_mra->ma_value
 719 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
 720
 721                 /* and, or, not */
 722                 struct slap_filter *f_un_complex;
 723         } f_un;
 724
 725 #define f_result        f_un.f_un_result
 726 #define f_and           f_un.f_un_complex
 727 #define f_or            f_un.f_un_complex
 728 #define f_not           f_un.f_un_complex
 729 #define f_list          f_un.f_un_complex
 730
 731         struct slap_filter      *f_next;
 732 } Filter;
 733
 734 /* compare routines can return undefined */
 735 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
 736
 737 typedef struct slap_valuesreturnfilter {
 738         ber_tag_t       f_choice;
 739
 740         union vrf_un_u {
 741                 /* precomputed result */
 742                 ber_int_t f_un_result;
 743
 744                 /* DN */
 745                 char *f_un_dn;
 746
 747                 /* present */
 748                 AttributeDescription *f_un_desc;
 749
 750                 /* simple value assertion */
 751                 AttributeAssertion *f_un_ava;
 752
 753                 /* substring assertion */
 754                 SubstringsAssertion *f_un_ssa;
 755
 756                 /* matching rule assertion */
 757                 MatchingRuleAssertion *f_un_mra;
 758         } f_un;
 759
 760         struct slap_valuesreturnfilter  *f_next;
 761 } ValuesReturnFilter;
 762
 763 /*
 764  * represents an attribute (description + values)
 765  */
 766 typedef struct slap_attr {
 767         AttributeDescription *a_desc;
 768         BerVarray       a_vals;
 769         struct slap_attr        *a_next;
 770         unsigned a_flags;
 771 #define SLAP_ATTR_IXADD         0x1U
 772 #define SLAP_ATTR_IXDEL         0x2U
 773 } Attribute;
 774
 775
 776 /*
 777  * the id used in the indexes to refer to an entry
 778  */
 779 typedef unsigned long   ID;
 780 #define NOID    ((ID)~0)
 781
 782 /*
 783  * represents an entry in core
 784  */
 785 typedef struct slap_entry {
 786         /*
 787          * The ID field should only be changed before entry is
 788          * inserted into a cache.  The ID value is backend
 789          * specific.
 790          */
 791         ID              e_id;
 792
 793         struct berval e_name;   /* name (DN) of this entry */
 794         struct berval e_nname;  /* normalized name (DN) of this entry */
 795
 796         /* for migration purposes */
 797 #define e_dn e_name.bv_val
 798 #define e_ndn e_nname.bv_val
 799
 800         Attribute       *e_attrs;       /* list of attributes + values */
 801
 802         slap_mask_t     e_ocflags;
 803
 804         struct berval   e_bv;           /* For entry_encode/entry_decode */
 805
 806         /* for use by the backend for any purpose */
 807         void*   e_private;
 808 } Entry;
 809
 810 /*
 811  * A list of LDAPMods
 812  */
 813 typedef struct slap_mod {
 814         int sm_op;
 815         AttributeDescription *sm_desc;
 816         struct berval sm_type;
 817         BerVarray sm_bvalues;
 818 } Modification;
 819
 820 typedef struct slap_mod_list {
 821         Modification sml_mod;
 822 #define sml_op          sml_mod.sm_op
 823 #define sml_desc        sml_mod.sm_desc
 824 #define sml_type        sml_mod.sm_type
 825 #define sml_bvalues     sml_mod.sm_bvalues
 826         struct slap_mod_list *sml_next;
 827 } Modifications;
 828
 829 typedef struct slap_ldap_modlist {
 830         LDAPMod ml_mod;
 831         struct slap_ldap_modlist *ml_next;
 832 #define ml_op           ml_mod.mod_op
 833 #define ml_type         ml_mod.mod_type
 834 #define ml_values       ml_mod.mod_values
 835 #define ml_bvalues      ml_mod.mod_bvalues
 836 } LDAPModList;
 837
 838 /*
 839  * represents an access control list
 840  */
 841 typedef enum slap_access_e {
 842         ACL_INVALID_ACCESS = -1,
 843         ACL_NONE = 0,
 844         ACL_AUTH,
 845         ACL_COMPARE,
 846         ACL_SEARCH,
 847         ACL_READ,
 848         ACL_WRITE
 849 } slap_access_t;
 850
 851 typedef enum slap_control_e {
 852         ACL_INVALID_CONTROL     = 0,
 853         ACL_STOP,
 854         ACL_CONTINUE,
 855         ACL_BREAK
 856 } slap_control_t;
 857
 858 typedef enum slap_style_e {
 859         ACL_STYLE_REGEX = 0,
 860         ACL_STYLE_BASE,
 861         ACL_STYLE_ONE,
 862         ACL_STYLE_SUBTREE,
 863         ACL_STYLE_CHILDREN,
 864         ACL_STYLE_ATTROF,
 865
 866         /* alternate names */
 867         ACL_STYLE_EXACT = ACL_STYLE_BASE
 868 } slap_style_t;
 869
 870 typedef struct slap_authz_info {
 871         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
 872         struct berval   sai_mech;               /* SASL Mechanism */
 873         struct berval   sai_dn;                 /* DN for reporting purposes */
 874         struct berval   sai_ndn;                /* Normalized DN */
 875
 876         /* Security Strength Factors */
 877         slap_ssf_t      sai_ssf;                        /* Overall SSF */
 878         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
 879         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
 880         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
 881 } AuthorizationInformation;
 882
 883 /* the "by" part */
 884 typedef struct slap_access {
 885         slap_control_t a_type;
 886
 887 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
 888
 889 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
 890 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
 891 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
 892 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
 893 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
 894 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
 895
 896 #define ACL_PRIV_MASK                   0x00ffUL
 897
 898 /* priv flags */
 899 #define ACL_PRIV_LEVEL                  0x1000UL
 900 #define ACL_PRIV_ADDITIVE               0x2000UL
 901 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
 902
 903 /* invalid privs */
 904 #define ACL_PRIV_INVALID                0x0UL
 905
 906 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
 907 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
 908 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
 909 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
 910
 911 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
 912 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
 913
 914 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
 915
 916 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
 917
 918 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
 919 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
 920 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
 921
 922 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
 923 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
 924 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
 925 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
 926 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
 927 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
 928
 929 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
 930 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
 931 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
 932 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
 933 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
 934 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
 935 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
 936
 937 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
 938 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
 939 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
 940 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
 941 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
 942 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
 943
 944         slap_mask_t     a_access_mask;
 945
 946         AuthorizationInformation        a_authz;
 947 #define a_dn_pat        a_authz.sai_dn
 948
 949         slap_style_t a_dn_style;
 950         AttributeDescription    *a_dn_at;
 951         int                     a_dn_self;
 952         int                     a_dn_expand;
 953
 954         slap_style_t a_peername_style;
 955         struct berval   a_peername_pat;
 956         slap_style_t a_sockname_style;
 957         struct berval   a_sockname_pat;
 958
 959         slap_style_t a_domain_style;
 960         struct berval   a_domain_pat;
 961         int             a_domain_expand;
 962
 963         slap_style_t a_sockurl_style;
 964         struct berval   a_sockurl_pat;
 965         slap_style_t a_set_style;
 966         struct berval   a_set_pat;
 967
 968 #ifdef SLAPD_ACI_ENABLED
 969         AttributeDescription    *a_aci_at;
 970 #endif
 971
 972         /* ACL Groups */
 973         slap_style_t a_group_style;
 974         struct berval   a_group_pat;
 975         ObjectClass                             *a_group_oc;
 976         AttributeDescription    *a_group_at;
 977
 978         struct slap_access      *a_next;
 979 } Access;
 980
 981 /* the "to" part */
 982 typedef struct slap_acl {
 983         /* "to" part: the entries this acl applies to */
 984         Filter          *acl_filter;
 985         slap_style_t acl_dn_style;
 986         regex_t         acl_dn_re;
 987         struct berval   acl_dn_pat;
 988         AttributeName   *acl_attrs;
 989
 990         /* "by" part: list of who has what access to the entries */
 991         Access  *acl_access;
 992
 993         struct slap_acl *acl_next;
 994 } AccessControl;
 995
 996 typedef struct slap_acl_state {
 997         unsigned as_recorded;
 998 #define ACL_STATE_NOT_RECORDED                  0x0
 999 #define ACL_STATE_RECORDED_VD                   0x1
1000 #define ACL_STATE_RECORDED_NV                   0x2
1001 #define ACL_STATE_RECORDED                              0x3
1002
1003         /* Access state */
1004         AccessControl *as_vd_acl;
1005         slap_mask_t as_vd_acl_mask;
1006         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1007         int as_vd_acl_count;
1008
1009         Access *as_vd_access;
1010         int as_vd_access_count;
1011
1012         int as_result;
1013 } AccessControlState;
1014 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
1015
1016 /*
1017  * replog moddn param structure
1018  */
1019 struct slap_replog_moddn {
1020         struct berval *newrdn;
1021         int     deloldrdn;
1022         struct berval *newsup;
1023 };
1024
1025 /*
1026  * Backend-info
1027  * represents a backend
1028  */
1029
1030 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1031 typedef struct slap_backend_db BackendDB;               /* per backend database */
1032
1033 LDAP_SLAPD_V (int) nBackendInfo;
1034 LDAP_SLAPD_V (int) nBackendDB;
1035 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1036 LDAP_SLAPD_V (BackendDB *) backendDB;
1037
1038 LDAP_SLAPD_V (int) slapMode;
1039 #define SLAP_UNDEFINED_MODE     0x0000
1040 #define SLAP_SERVER_MODE        0x0001
1041 #define SLAP_TOOL_MODE          0x0002
1042 #define SLAP_MODE                       0x0003
1043
1044 #define SLAP_TRUNCATE_MODE      0x0100
1045
1046 struct slap_replica_info {
1047         char *ri_host;                          /* supersedes be_replica */
1048         BerVarray ri_nsuffix;   /* array of suffixes this replica accepts */
1049         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1050         int ri_exclude;                 /* 1 => exclude ri_attrs */
1051 };
1052
1053 struct slap_limits_set {
1054         /* time limits */
1055         int     lms_t_soft;
1056         int     lms_t_hard;
1057
1058         /* size limits */
1059         int     lms_s_soft;
1060         int     lms_s_hard;
1061         int     lms_s_unchecked;
1062 };
1063
1064 struct slap_limits {
1065         int     lm_type;        /* type of pattern */
1066 #define SLAP_LIMITS_UNDEFINED   0x0000
1067 #define SLAP_LIMITS_EXACT       0x0001
1068 #define SLAP_LIMITS_BASE        SLAP_LIMITS_EXACT
1069 #define SLAP_LIMITS_ONE         0x0002
1070 #define SLAP_LIMITS_SUBTREE     0x0003
1071 #define SLAP_LIMITS_CHILDREN    0x0004
1072 #define SLAP_LIMITS_REGEX       0x0005
1073 #define SLAP_LIMITS_ANONYMOUS   0x0006
1074 #define SLAP_LIMITS_USERS       0x0007
1075 #define SLAP_LIMITS_ANY         0x0008
1076         regex_t lm_dn_regex;            /* regex data for REGEX */
1077
1078         /*
1079          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1080          * pattern for REGEX; NULL for ANONYMOUS, USERS
1081          */
1082         struct berval lm_dn_pat;
1083
1084         struct slap_limits_set  lm_limits;
1085 };
1086
1087 /* temporary aliases */
1088 typedef BackendDB Backend;
1089 #define nbackends nBackendDB
1090 #define backends backendDB
1091
1092 struct slap_backend_db {
1093         BackendInfo     *bd_info;       /* pointer to shared backend info */
1094
1095         /* BackendInfo accessors */
1096 #define         be_config       bd_info->bi_db_config
1097 #define         be_type         bd_info->bi_type
1098
1099 #define         be_bind         bd_info->bi_op_bind
1100 #define         be_unbind       bd_info->bi_op_unbind
1101 #define         be_add          bd_info->bi_op_add
1102 #define         be_compare      bd_info->bi_op_compare
1103 #define         be_delete       bd_info->bi_op_delete
1104 #define         be_modify       bd_info->bi_op_modify
1105 #define         be_modrdn       bd_info->bi_op_modrdn
1106 #define         be_search       bd_info->bi_op_search
1107
1108 #define         be_extended     bd_info->bi_extended
1109
1110 #define         be_release      bd_info->bi_entry_release_rw
1111 #define         be_chk_referrals        bd_info->bi_chk_referrals
1112 #define         be_group        bd_info->bi_acl_group
1113 #define         be_attribute    bd_info->bi_acl_attribute
1114 #define         be_operational  bd_info->bi_operational
1115
1116 #define         be_controls     bd_info->bi_controls
1117
1118 #define         be_connection_init      bd_info->bi_connection_init
1119 #define         be_connection_destroy   bd_info->bi_connection_destroy
1120
1121 #ifdef SLAPD_TOOLS
1122 #define         be_entry_open bd_info->bi_tool_entry_open
1123 #define         be_entry_close bd_info->bi_tool_entry_close
1124 #define         be_entry_first bd_info->bi_tool_entry_first
1125 #define         be_entry_next bd_info->bi_tool_entry_next
1126 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1127 #define         be_entry_get bd_info->bi_tool_entry_get
1128 #define         be_entry_put bd_info->bi_tool_entry_put
1129 #define         be_sync bd_info->bi_tool_sync
1130 #endif
1131
1132 #define SLAP_BFLAG_NOLASTMOD            0x0001U
1133 #define SLAP_BFLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
1134 #define SLAP_BFLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
1135 #define SLAP_BFLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
1136 #define SLAP_BFLAG_ALIASES              0x0100U
1137 #define SLAP_BFLAG_REFERRALS    0x0200U
1138 #define SLAP_BFLAG_SUBENTRIES   0x0400U
1139 #define SLAP_BFLAG_MONITOR              0x1000U
1140 #define SLAP_BFLAG_DYNAMIC              0x2000U
1141         slap_mask_t     be_flags;
1142 #define SLAP_LASTMOD(be)        (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1143 #define SLAP_ALIASES(be)        ((be)->be_flags & SLAP_BFLAG_ALIASES)
1144 #define SLAP_REFERRALS(be)      ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1145 #define SLAP_SUBENTRIES(be)     ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1146 #define SLAP_MONITOR(be)        ((be)->be_flags & SLAP_BFLAG_MONITOR)
1147 #define SLAP_DYNAMIC(be)        ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1148
1149         slap_mask_t     be_restrictops;         /* restriction operations */
1150 #define SLAP_RESTRICT_OP_ADD            0x0001U
1151 #define SLAP_RESTRICT_OP_BIND           0x0002U
1152 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1153 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1154 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1155 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1156 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1157 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1158
1159 #define SLAP_RESTRICT_OP_READS  \
1160         ( SLAP_RESTRICT_OP_COMPARE    \
1161         | SLAP_RESTRICT_OP_SEARCH )
1162 #define SLAP_RESTRICT_OP_WRITES \
1163         ( SLAP_RESTRICT_OP_ADD    \
1164         | SLAP_RESTRICT_OP_DELETE \
1165         | SLAP_RESTRICT_OP_MODIFY \
1166         | SLAP_RESTRICT_OP_RENAME )
1167
1168 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1169 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1170 #define SLAP_ALLOW_BIND_ANON_DN         0x0003U /* dn should be empty */
1171
1172 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1173 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1174 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1175
1176 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1177 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1178
1179         slap_mask_t     be_requires;    /* pre-operation requirements */
1180 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1181 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1182 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1183 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1184 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1185
1186         /* Required Security Strength Factor */
1187         slap_ssf_set_t be_ssf_set;
1188
1189         /* these should be renamed from be_ to bd_ */
1190         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1191         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1192         BerVarray       be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1193         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1194         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1195         struct berval be_rootpw;        /* the magic "root" password for this db        */
1196         unsigned int be_max_deref_depth;       /* limit for depth of an alias deref  */
1197 #define be_sizelimit    be_def_limit.lms_s_soft
1198 #define be_timelimit    be_def_limit.lms_t_soft
1199         struct slap_limits_set be_def_limit; /* default limits */
1200         struct slap_limits **be_limits; /* regex-based size and time limits */
1201         AccessControl *be_acl;  /* access control list for this backend    */
1202         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1203         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1204         char    *be_replogfile; /* replication log file (in master)        */
1205         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1206         BerVarray       be_update_refs; /* where to refer modifying clients to */
1207         char    *be_realm;
1208         void    *be_private;    /* anything the backend database needs     */
1209 };
1210
1211 struct slap_conn;
1212 struct slap_op;
1213
1214 /* Backend function typedefs */
1215 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1216 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1217         const char *fname, int lineno,
1218         int argc, char **argv));
1219 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1220 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1221 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1222
1223 typedef int (BI_db_init) LDAP_P((Backend *bd));
1224 typedef int (BI_db_config) LDAP_P((Backend *bd,
1225         const char *fname, int lineno,
1226         int argc, char **argv));
1227 typedef int (BI_db_open) LDAP_P((Backend *bd));
1228 typedef int (BI_db_close) LDAP_P((Backend *bd));
1229 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1230
1231 typedef int (BI_op_bind)  LDAP_P(( BackendDB *bd,
1232                 struct slap_conn *c, struct slap_op *o,
1233                 struct berval *dn, struct berval *ndn, int method,
1234                 struct berval *cred, struct berval *edn ));
1235 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1236                 struct slap_conn *c, struct slap_op *o ));
1237 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1238                 struct slap_conn *c, struct slap_op *o,
1239                 struct berval *base, struct berval *nbase,
1240                 int scope, int deref,
1241                 int slimit, int tlimit,
1242                 Filter *f, struct berval *filterstr,
1243                 AttributeName *attrs, int attrsonly));
1244 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1245                 struct slap_conn *c, struct slap_op *o,
1246                 struct berval *dn, struct berval *ndn,
1247                 AttributeAssertion *ava));
1248 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1249                 struct slap_conn *c, struct slap_op *o,
1250                 struct berval *dn, struct berval *ndn,
1251                 Modifications *m));
1252 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1253                 struct slap_conn *c, struct slap_op *o,
1254                 struct berval *dn, struct berval *ndn,
1255                 struct berval *newrdn, struct berval *nnewrdn,
1256                 int deleteoldrdn,
1257                 struct berval *newSup, struct berval *nnewSup ));
1258 typedef int (BI_op_add)    LDAP_P((BackendDB *bd,
1259                 struct slap_conn *c, struct slap_op *o,
1260                 Entry *e));
1261 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1262                 struct slap_conn *c, struct slap_op *o,
1263                 struct berval *dn, struct berval *ndn));
1264 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1265                 struct slap_conn *c, struct slap_op *o,
1266                 ber_int_t msgid));
1267
1268 typedef int (BI_op_extended) LDAP_P((
1269     BackendDB           *be,
1270     struct slap_conn    *conn,
1271     struct slap_op              *op,
1272         const char              *reqoid,
1273     struct berval * reqdata,
1274         char            **rspoid,
1275     struct berval ** rspdata,
1276         LDAPControl *** rspctrls,
1277         const char **   text,
1278         BerVarray *refs ));
1279
1280 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1281                 struct slap_conn *c, struct slap_op *o,
1282                 Entry *e, int rw));
1283
1284 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1285                 struct slap_conn *c, struct slap_op *o,
1286                 struct berval *dn, struct berval *ndn,
1287                 const char **text ));
1288
1289 typedef int (BI_acl_group)  LDAP_P((Backend *bd,
1290                 struct slap_conn *c, struct slap_op *o,
1291                 Entry *e,
1292                 struct berval *bdn,
1293                 struct berval *edn,
1294                 ObjectClass *group_oc,
1295                 AttributeDescription *group_at ));
1296
1297 typedef int (BI_acl_attribute)  LDAP_P((Backend *bd,
1298                 struct slap_conn *c, struct slap_op *o,
1299                 Entry *e, struct berval *edn,
1300                 AttributeDescription *entry_at,
1301                 BerVarray *vals ));
1302
1303 typedef int (BI_operational)  LDAP_P((Backend *bd,
1304                 struct slap_conn *c, struct slap_op *o,
1305                 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1306
1307 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1308                 struct slap_conn *c));
1309 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1310                 struct slap_conn *c));
1311
1312 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1313 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1314 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1315 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1316 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1317 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1318                         struct berval *text ));
1319 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1320 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1321
1322 struct slap_backend_info {
1323         char    *bi_type; /* type of backend */
1324
1325         /*
1326          * per backend type routines:
1327          * bi_init: called to allocate a backend_info structure,
1328          *              called once BEFORE configuration file is read.
1329          *              bi_init() initializes this structure hence is
1330          *              called directly from be_initialize()
1331          * bi_config: called per 'backend' specific option
1332          *              all such options must before any 'database' options
1333          *              bi_config() is called only from read_config()
1334          * bi_open: called to open each database, called
1335          *              once AFTER configuration file is read but
1336          *              BEFORE any bi_db_open() calls.
1337          *              bi_open() is called from backend_startup()
1338          * bi_close: called to close each database, called
1339          *              once during shutdown after all bi_db_close calls.
1340          *              bi_close() is called from backend_shutdown()
1341          * bi_destroy: called to destroy each database, called
1342          *              once during shutdown after all bi_db_destroy calls.
1343          *              bi_destory() is called from backend_destroy()
1344          */
1345         BI_init *bi_init;
1346         BI_config       *bi_config;
1347         BI_open *bi_open;
1348         BI_close        *bi_close;
1349         BI_destroy      *bi_destroy;
1350
1351         /*
1352          * per database routines:
1353          * bi_db_init: called to initialize each database,
1354          *      called upon reading 'database <type>'
1355          *      called only from backend_db_init()
1356          * bi_db_config: called to configure each database,
1357          *  called per database to handle per database options
1358          *      called only from read_config()
1359          * bi_db_open: called to open each database
1360          *      called once per database immediately AFTER bi_open()
1361          *      calls but before daemon startup.
1362          *  called only by backend_startup()
1363          * bi_db_close: called to close each database
1364          *      called once per database during shutdown but BEFORE
1365          *  any bi_close call.
1366          *  called only by backend_shutdown()
1367          * bi_db_destroy: called to destroy each database
1368          *  called once per database during shutdown AFTER all
1369          *  bi_close calls but before bi_destory calls.
1370          *  called only by backend_destory()
1371          */
1372         BI_db_init      *bi_db_init;
1373         BI_db_config    *bi_db_config;
1374         BI_db_open      *bi_db_open;
1375         BI_db_close     *bi_db_close;
1376         BI_db_destroy   *bi_db_destroy;
1377
1378         /* LDAP Operations Handling Routines */
1379         BI_op_bind      *bi_op_bind;
1380         BI_op_unbind    *bi_op_unbind;
1381         BI_op_search    *bi_op_search;
1382         BI_op_compare   *bi_op_compare;
1383         BI_op_modify    *bi_op_modify;
1384         BI_op_modrdn    *bi_op_modrdn;
1385         BI_op_add       *bi_op_add;
1386         BI_op_delete    *bi_op_delete;
1387         BI_op_abandon   *bi_op_abandon;
1388
1389         /* Extended Operations Helper */
1390         BI_op_extended  *bi_extended;
1391
1392         /* Auxilary Functions */
1393         BI_entry_release_rw     *bi_entry_release_rw;
1394         BI_chk_referrals        *bi_chk_referrals;
1395
1396         BI_acl_group    *bi_acl_group;
1397         BI_acl_attribute        *bi_acl_attribute;
1398
1399         BI_operational  *bi_operational;
1400
1401         BI_connection_init      *bi_connection_init;
1402         BI_connection_destroy   *bi_connection_destroy;
1403
1404         /* hooks for slap tools */
1405         BI_tool_entry_open      *bi_tool_entry_open;
1406         BI_tool_entry_close     *bi_tool_entry_close;
1407         BI_tool_entry_first     *bi_tool_entry_first;
1408         BI_tool_entry_next      *bi_tool_entry_next;
1409         BI_tool_entry_get       *bi_tool_entry_get;
1410         BI_tool_entry_put       *bi_tool_entry_put;
1411         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1412         BI_tool_sync            *bi_tool_sync;
1413
1414 #define SLAP_INDEX_ADD_OP               0x0001
1415 #define SLAP_INDEX_DELETE_OP    0x0002
1416
1417         char **bi_controls;             /* supported controls */
1418
1419         unsigned int bi_nDB;    /* number of databases of this type */
1420         void    *bi_private;    /* anything the backend type needs */
1421 };
1422
1423 #define c_authtype      c_authz.sai_method
1424 #define c_authmech      c_authz.sai_mech
1425 #define c_dn            c_authz.sai_dn
1426 #define c_ndn           c_authz.sai_ndn
1427 #define c_ssf                   c_authz.sai_ssf
1428 #define c_transport_ssf c_authz.sai_transport_ssf
1429 #define c_tls_ssf               c_authz.sai_tls_ssf
1430 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1431
1432 #define o_authtype      o_authz.sai_method
1433 #define o_authmech      o_authz.sai_mech
1434 #define o_dn            o_authz.sai_dn
1435 #define o_ndn           o_authz.sai_ndn
1436 #define o_ssf                   o_authz.sai_ssf
1437 #define o_transport_ssf o_authz.sai_transport_ssf
1438 #define o_tls_ssf               o_authz.sai_tls_ssf
1439 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1440
1441 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1442         ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1443         BerVarray, const char *, struct berval *,
1444         struct berval *, LDAPControl ** );
1445
1446 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1447         ber_int_t, const char *, const char *, BerVarray,
1448         LDAPControl **, int nentries);
1449
1450 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1451         struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1452
1453 typedef struct slap_callback {
1454         slap_response *sc_response;
1455         slap_sresult *sc_sresult;
1456         slap_sendentry *sc_sendentry;
1457         void *sc_private;
1458 } slap_callback;
1459
1460 /*
1461  * Paged Results state
1462  */
1463 typedef unsigned long PagedResultsCookie;
1464 typedef struct slap_paged_state {
1465         Backend *ps_be;
1466         PagedResultsCookie ps_cookie;
1467         ID ps_id;
1468 } PagedResultsState;
1469
1470 /*
1471  * represents an operation pending from an ldap client
1472  */
1473 typedef struct slap_op {
1474         unsigned long o_opid;   /* id of this operation */
1475         unsigned long o_connid; /* id of conn initiating this op */
1476
1477         ber_int_t       o_msgid;        /* msgid of the request */
1478         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1479         ber_tag_t       o_tag;          /* tag of the request */
1480         time_t          o_time;         /* time op was initiated */
1481
1482         ldap_pvt_thread_t       o_tid;  /* thread handling this op */
1483
1484         volatile sig_atomic_t o_abandon;        /* abandon flag */
1485
1486 #define SLAP_NO_CONTROL 0
1487 #define SLAP_NONCRITICAL_CONTROL 1
1488 #define SLAP_CRITICAL_CONTROL 2
1489         char o_managedsait;
1490         char o_noop;
1491         char o_subentries;
1492         char o_subentries_visibility;
1493         char o_valuesreturnfilter;
1494
1495         char o_pagedresults;
1496         ber_int_t o_pagedresults_size;
1497         PagedResultsState o_pagedresults_state;
1498
1499 #ifdef LDAP_CONNECTIONLESS
1500         Sockaddr        o_peeraddr;     /* UDP peer address               */
1501 #endif
1502         AuthorizationInformation o_authz;
1503
1504         BerElement      *o_ber;         /* ber of the request             */
1505         slap_callback   *o_callback;    /* callback pointers */
1506         LDAPControl     **o_ctrls;       /* controls */
1507
1508         void    *o_private;     /* anything the backend needs */
1509
1510         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
1511         ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1512 } Operation;
1513
1514 #define get_manageDSAit(op)                             ((int)(op)->o_managedsait)
1515 #define get_subentries(op)                              ((int)(op)->o_subentries)
1516 #define get_subentries_visibility(op)   ((int)(op)->o_subentries_visibility)
1517
1518 /*
1519  * Caches the result of a backend_group check for ACL evaluation
1520  */
1521 typedef struct slap_gacl {
1522         struct slap_gacl *ga_next;
1523         Backend *ga_be;
1524         ObjectClass *ga_oc;
1525         AttributeDescription *ga_at;
1526         int ga_res;
1527         ber_len_t ga_len;
1528         char ga_ndn[1];
1529 } GroupAssertion;
1530
1531 /*
1532  * represents a connection from an ldap client
1533  */
1534 typedef struct slap_conn {
1535         int                     c_struct_state; /* structure management state */
1536         int                     c_conn_state;   /* connection state */
1537
1538         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1539         Sockbuf         *c_sb;                  /* ber connection stuff           */
1540
1541         /* only can be changed by connect_init */
1542         time_t          c_starttime;    /* when the connection was opened */
1543         time_t          c_activitytime; /* when the connection was last used */
1544         unsigned long           c_connid;       /* id of this connection for stats*/
1545
1546         struct berval   c_listener_url; /* listener URL */
1547         struct berval   c_peer_domain;  /* DNS name of client */
1548         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
1549         struct berval   c_sock_name;    /* sock name (trans=addr:port) */
1550
1551         /* only can be changed by binding thread */
1552         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
1553         struct berval   c_sasl_bind_mech;                       /* mech in progress */
1554         struct berval   c_sasl_dn;      /* temporary storage */
1555
1556         /* authorization backend */
1557         Backend *c_authz_backend;
1558
1559         AuthorizationInformation c_authz;
1560         GroupAssertion *c_groups;
1561
1562         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
1563
1564         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
1565         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
1566
1567         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
1568         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
1569
1570         BerElement      *c_currentber;  /* ber we're attempting to read */
1571         int             c_writewaiter;  /* true if writer is waiting */
1572
1573 #ifdef LDAP_CONNECTIONLESS
1574         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
1575 #endif
1576 #ifdef HAVE_TLS
1577         int     c_is_tls;               /* true if this LDAP over raw TLS */
1578         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
1579 #endif
1580         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
1581         void    *c_sasl_context;        /* SASL session context */
1582         void    *c_sasl_extra;          /* SASL session extra stuff */
1583
1584         PagedResultsState c_pagedresults_state; /* paged result state */
1585
1586         long    c_n_ops_received;       /* num of ops received (next op_id) */
1587         long    c_n_ops_executing;      /* num of ops currently executing */
1588         long    c_n_ops_pending;        /* num of ops pending execution */
1589         long    c_n_ops_completed;      /* num of ops completed */
1590
1591         long    c_n_get;                /* num of get calls */
1592         long    c_n_read;               /* num of read calls */
1593         long    c_n_write;              /* num of write calls */
1594 } Connection;
1595
1596 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1597 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
1598         do { \
1599                 if ( ldap_debug & (level) ) \
1600                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1601                 if ( ldap_syslog & (level) ) \
1602                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1603                                 (arg2), (arg3) ); \
1604         } while (0)
1605 #else
1606 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1607 #endif
1608
1609 /*
1610  * listener; need to access it from monitor backend
1611  */
1612 typedef struct slap_listener {
1613         char* sl_url;
1614         char* sl_name;
1615 #ifdef HAVE_TLS
1616         int             sl_is_tls;
1617 #endif
1618 #ifdef LDAP_CONNECTIONLESS
1619         int     sl_is_udp;              /* UDP listener is also data port */
1620 #endif
1621         ber_socket_t sl_sd;
1622         Sockaddr sl_sa;
1623 #define sl_addr sl_sa.sa_in_addr
1624 } Listener;
1625
1626 #ifdef SLAPD_MONITOR
1627 /*
1628  * Operation indices
1629  */
1630 enum {
1631         SLAP_OP_BIND = 0,
1632         SLAP_OP_UNBIND,
1633         SLAP_OP_ADD,
1634         SLAP_OP_DELETE,
1635         SLAP_OP_MODRDN,
1636         SLAP_OP_MODIFY,
1637         SLAP_OP_COMPARE,
1638         SLAP_OP_SEARCH,
1639         SLAP_OP_ABANDON,
1640         SLAP_OP_EXTENDED,
1641         SLAP_OP_LAST
1642 };
1643 #endif /* SLAPD_MONITOR */
1644
1645 LDAP_END_DECL
1646
1647 #include "proto-slap.h"
1648
1649 #endif /* _SLAP_H_ */