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

   1 /* slap.h - stand alone ldap server include file */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2003 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
  17  * All rights reserved.
  18  *
  19  * Redistribution and use in source and binary forms are permitted
  20  * provided that this notice is preserved and that due credit is given
  21  * to the University of Michigan at Ann Arbor. The name of the University
  22  * may not be used to endorse or promote products derived from this
  23  * software without specific prior written permission. This software
  24  * is provided ``as is'' without express or implied warranty.
  25  */
  26
  27 #ifndef _SLAP_H_
  28 #define _SLAP_H_
  29
  30 #include "ldap_defaults.h"
  31
  32 #include <stdio.h>
  33 #include <ac/stdlib.h>
  34
  35 #include <sys/types.h>
  36 #include <ac/syslog.h>
  37 #include <ac/regex.h>
  38 #include <ac/signal.h>
  39 #include <ac/socket.h>
  40 #include <ac/time.h>
  41 #include <ac/param.h>
  42
  43 #include "avl.h"
  44
  45 #ifndef ldap_debug
  46 #define ldap_debug slap_debug
  47 #endif
  48
  49 #include "ldap_log.h"
  50
  51 #include <ldap.h>
  52 #include <ldap_schema.h>
  53
  54 #include "lber_pvt.h"
  55 #include "ldap_pvt_thread.h"
  56 #include "ldap_queue.h"
  57
  58 LDAP_BEGIN_DECL
  59 /*
  60  * SLAPD Memory allocation macros
  61  *
  62  * Unlike ch_*() routines, these routines do not assert() upon
  63  * allocation error.  They are intended to be used instead of
  64  * ch_*() routines where the caller has implemented proper
  65  * checking for and handling of allocation errors.
  66  *
  67  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
  68  */
  69 #define SLAP_MALLOC(s)      ber_memalloc((s))
  70 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
  71 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
  72 #define SLAP_FREE(p)        ber_memfree((p))
  73 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
  74 #define SLAP_STRDUP(s)      ber_strdup((s))
  75 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
  76
  77 #ifdef f_next
  78 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  79 #endif
  80
  81 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
  82 #define SLAPD_ANONYMOUS "cn=anonymous"
  83
  84 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
  85  * This is a value used internally by the backends. It is needed to allow
  86  * adding values that already exist without getting an error as required by
  87  * modrdn when the new rdn was already an attribute value itself.
  88  */
  89 #define SLAP_MOD_SOFTADD        0x1000
  90
  91 #define MAXREMATCHES (100)
  92
  93 #define SLAP_MAX_WORKER_THREADS         (16)
  94
  95 #define SLAP_MAX_SYNCREPL_THREADS       (8)
  96
  97 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
  98 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
  99
 100 #define SLAP_CONN_MAX_PENDING_DEFAULT   100
 101 #define SLAP_CONN_MAX_PENDING_AUTH      1000
 102
 103 #define SLAP_TEXT_BUFLEN (256)
 104
 105 /* psuedo error code indicating abandoned operation */
 106 #define SLAPD_ABANDON (-1)
 107
 108 /* psuedo error code indicating disconnect */
 109 #define SLAPD_DISCONNECT (-2)
 110
 111
 112 /* We assume "C" locale, that is US-ASCII */
 113 #define ASCII_SPACE(c)  ( (c) == ' ' )
 114 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
 115 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
 116 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
 117 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
 118 #define ASCII_HEXLOWER(c)       ( (c) >= 'a' && (c) <= 'f' )
 119 #define ASCII_HEXUPPER(c)       ( (c) >= 'A' && (c) <= 'F' )
 120 #define ASCII_HEX(c)    ( ASCII_DIGIT(c) || \
 121         ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
 122 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
 123 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
 124
 125 #define SLAP_NIBBLE(c) ((c)&0x0f)
 126 #define SLAP_ESCAPE_CHAR ('\\')
 127 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
 128 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
 129
 130 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
 131         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
 132
 133 #define DN_ESCAPE(c)    ((c) == SLAP_ESCAPE_CHAR)
 134 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
 135 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
 136 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
 137 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
 138
 139 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
 140 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
 141 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
 142 #define OID_SEPARATOR(c)        ( (c) == '.' )
 143 #define OID_CHAR(c)     ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
 144
 145 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
 146 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || (c) == '.' )
 147
 148 #define AD_LEADCHAR(c)  ( ATTR_CHAR(c) )
 149 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
 150
 151 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
 152
 153 #define SLAP_PRINTABLE(c)       ( ASCII_ALNUM(c) || (c) == '\'' || \
 154         (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
 155         (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
 156         (c) == '?' || (c) == ' ' || (c) == '=' )
 157 #define SLAP_PRINTABLES(c)      ( SLAP_PRINTABLE(c) || (c) == '$' )
 158
 159 /* must match in schema_init.c */
 160 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
 161 #define SLAPD_NAMEUID_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.34"
 162 #define SLAPD_INTEGER_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.27"
 163 #define SLAPD_GROUP_ATTR                "member"
 164 #define SLAPD_GROUP_CLASS               "groupOfNames"
 165 #define SLAPD_ROLE_ATTR                 "roleOccupant"
 166 #define SLAPD_ROLE_CLASS                "organizationalRole"
 167
 168 #ifdef SLAPD_ACI_ENABLED
 169 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
 170 #endif
 171
 172 /* change this to "OpenLDAPset" */
 173 #define SLAPD_ACI_SET_ATTR              "template"
 174
 175 #define SLAPD_TOP_OID                   "2.5.6.0"
 176
 177 LDAP_SLAPD_V (int) slap_debug;
 178
 179 typedef unsigned long slap_mask_t;
 180
 181 /* Security Strength Factor */
 182 typedef unsigned slap_ssf_t;
 183
 184 typedef struct slap_ssf_set {
 185         slap_ssf_t sss_ssf;
 186         slap_ssf_t sss_transport;
 187         slap_ssf_t sss_tls;
 188         slap_ssf_t sss_sasl;
 189         slap_ssf_t sss_update_ssf;
 190         slap_ssf_t sss_update_transport;
 191         slap_ssf_t sss_update_tls;
 192         slap_ssf_t sss_update_sasl;
 193         slap_ssf_t sss_simple_bind;
 194 } slap_ssf_set_t;
 195
 196 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
 197 #define SLAP_GETDN_AUTHCID 2
 198 #define SLAP_GETDN_AUTHZID 4
 199
 200 /*
 201  * Index types
 202  */
 203 #define SLAP_INDEX_TYPE           0x00FFUL
 204 #define SLAP_INDEX_UNDEFINED      0x0001UL
 205 #define SLAP_INDEX_PRESENT        0x0002UL
 206 #define SLAP_INDEX_EQUALITY       0x0004UL
 207 #define SLAP_INDEX_APPROX         0x0008UL
 208 #define SLAP_INDEX_SUBSTR         0x0010UL
 209 #define SLAP_INDEX_EXTENDED               0x0020UL
 210
 211 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
 212
 213 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type))
 214
 215 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
 216
 217 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
 218 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
 219 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
 220 #define SLAP_INDEX_SUBSTR_DEFAULT \
 221         ( SLAP_INDEX_SUBSTR \
 222         | SLAP_INDEX_SUBSTR_INITIAL \
 223         | SLAP_INDEX_SUBSTR_ANY \
 224         | SLAP_INDEX_SUBSTR_FINAL )
 225
 226 #define SLAP_INDEX_SUBSTR_MINLEN        2
 227 #define SLAP_INDEX_SUBSTR_MAXLEN        4
 228 #define SLAP_INDEX_SUBSTR_STEP  2
 229
 230 #define SLAP_INDEX_FLAGS         0xF000UL
 231 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
 232 #define SLAP_INDEX_NOTAGS        0x2000UL /* don't use index w/ tags */
 233
 234 /*
 235  * there is a single index for each attribute.  these prefixes ensure
 236  * that there is no collision among keys.
 237  */
 238 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
 239 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
 240 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
 241 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
 242 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
 243 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
 244
 245 #define SLAP_SYNTAX_MATCHINGRULES_OID    "1.3.6.1.4.1.1466.115.121.1.30"
 246 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID   "1.3.6.1.4.1.1466.115.121.1.3"
 247 #define SLAP_SYNTAX_OBJECTCLASSES_OID    "1.3.6.1.4.1.1466.115.121.1.37"
 248 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
 249 #define SLAP_SYNTAX_CONTENTRULE_OID              "1.3.6.1.4.1.1466.115.121.1.16"
 250
 251 /*
 252  * represents schema information for a database
 253  */
 254 #define SLAP_SCHERR_OUTOFMEM                    1
 255 #define SLAP_SCHERR_CLASS_NOT_FOUND             2
 256 #define SLAP_SCHERR_CLASS_BAD_USAGE             3
 257 #define SLAP_SCHERR_CLASS_BAD_SUP               4
 258 #define SLAP_SCHERR_CLASS_DUP                   5
 259 #define SLAP_SCHERR_ATTR_NOT_FOUND              6
 260 #define SLAP_SCHERR_ATTR_BAD_MR                 7
 261 #define SLAP_SCHERR_ATTR_BAD_USAGE              8
 262 #define SLAP_SCHERR_ATTR_BAD_SUP                9
 263 #define SLAP_SCHERR_ATTR_INCOMPLETE             10
 264 #define SLAP_SCHERR_ATTR_DUP                    11
 265 #define SLAP_SCHERR_MR_NOT_FOUND                12
 266 #define SLAP_SCHERR_MR_INCOMPLETE               13
 267 #define SLAP_SCHERR_MR_DUP                              14
 268 #define SLAP_SCHERR_SYN_NOT_FOUND               15
 269 #define SLAP_SCHERR_SYN_DUP                             16
 270 #define SLAP_SCHERR_NO_NAME                             17
 271 #define SLAP_SCHERR_NOT_SUPPORTED               18
 272 #define SLAP_SCHERR_BAD_DESCR                   19
 273 #define SLAP_SCHERR_OIDM                                20
 274 #define SLAP_SCHERR_CR_DUP                              21
 275 #define SLAP_SCHERR_CR_BAD_STRUCT               22
 276 #define SLAP_SCHERR_CR_BAD_AUX                  23
 277 #define SLAP_SCHERR_CR_BAD_AT                   24
 278 #define SLAP_SCHERR_LAST                                SLAP_SCHERR_CR_BAD_AT
 279
 280 typedef union slap_sockaddr {
 281         struct sockaddr sa_addr;
 282         struct sockaddr_in sa_in_addr;
 283 #ifdef LDAP_PF_INET6
 284         struct sockaddr_storage sa_storage;
 285         struct sockaddr_in6 sa_in6_addr;
 286 #endif
 287 #ifdef LDAP_PF_LOCAL
 288         struct sockaddr_un sa_un_addr;
 289 #endif
 290 } Sockaddr;
 291
 292 #ifdef LDAP_PF_INET6
 293 extern int slap_inet4or6;
 294 #endif
 295
 296 typedef struct slap_oid_macro {
 297         struct berval som_oid;
 298         char **som_names;
 299         LDAP_SLIST_ENTRY(slap_oid_macro) som_next;
 300 } OidMacro;
 301
 302 /* forward declarations */
 303 struct slap_syntax;
 304 struct slap_matching_rule;
 305
 306 typedef int slap_syntax_validate_func LDAP_P((
 307         struct slap_syntax *syntax,
 308         struct berval * in));
 309
 310 typedef int slap_syntax_transform_func LDAP_P((
 311         struct slap_syntax *syntax,
 312         struct berval * in,
 313         struct berval * out,
 314         void *memctx));
 315
 316 typedef struct slap_syntax {
 317         LDAPSyntax                      ssyn_syn;
 318 #define ssyn_oid                ssyn_syn.syn_oid
 319 #define ssyn_desc               ssyn_syn.syn_desc
 320 #define ssyn_extensions ssyn_syn.syn_extensions
 321         /*
 322          * Note: the former
 323         ber_len_t       ssyn_oidlen;
 324          * has been replaced by a struct berval that uses the value
 325          * provided by ssyn_syn.syn_oid; a macro that expands to
 326          * the bv_len field of the berval is provided for backward
 327          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 328          */
 329         struct berval   ssyn_bvoid;
 330 #define ssyn_oidlen     ssyn_bvoid.bv_len
 331
 332         unsigned int ssyn_flags;
 333
 334 #define SLAP_SYNTAX_NONE        0x0000U
 335 #define SLAP_SYNTAX_BLOB        0x0001U /* syntax treated as blob (audio) */
 336 #define SLAP_SYNTAX_BINARY      0x0002U /* binary transfer required (certificate) */
 337 #define SLAP_SYNTAX_BER         0x0004U /* stored in BER encoding (certificate) */
 338 #ifdef LDAP_DEVEL
 339 #define SLAP_SYNTAX_HIDE        0x0000U /* publish everything */
 340 #else
 341 #define SLAP_SYNTAX_HIDE        0x8000U /* hide (do not publish) */
 342 #endif
 343
 344         slap_syntax_validate_func       *ssyn_validate;
 345         slap_syntax_transform_func      *ssyn_pretty;
 346
 347 #ifdef SLAPD_BINARY_CONVERSION
 348         /* convert to and from binary */
 349         slap_syntax_transform_func      *ssyn_ber2str;
 350         slap_syntax_transform_func      *ssyn_str2ber;
 351 #endif
 352
 353         LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
 354 } Syntax;
 355
 356 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
 357 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
 358 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
 359 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
 360 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
 361
 362 typedef struct slap_syntax_defs_rec {
 363         char *sd_desc;
 364         int sd_flags;
 365         slap_syntax_validate_func *sd_validate;
 366         slap_syntax_transform_func *sd_pretty;
 367 #ifdef SLAPD_BINARY_CONVERSION
 368         slap_syntax_transform_func *sd_ber2str;
 369         slap_syntax_transform_func *sd_str2ber;
 370 #endif
 371 } slap_syntax_defs_rec;
 372
 373 /* X -> Y Converter */
 374 typedef int slap_mr_convert_func LDAP_P((
 375         struct berval * in,
 376         struct berval * out,
 377         void *memctx ));
 378
 379 /* Normalizer */
 380 typedef int slap_mr_normalize_func LDAP_P((
 381         slap_mask_t use,
 382         struct slap_syntax *syntax, /* NULL if in is asserted value */
 383         struct slap_matching_rule *mr,
 384         struct berval * in,
 385         struct berval * out,
 386         void *memctx ));
 387
 388 /* Match (compare) function */
 389 typedef int slap_mr_match_func LDAP_P((
 390         int *match,
 391         slap_mask_t use,
 392         struct slap_syntax *syntax,     /* syntax of stored value */
 393         struct slap_matching_rule *mr,
 394         struct berval * value,
 395         void * assertValue ));
 396
 397 /* Index generation function */
 398 typedef int slap_mr_indexer_func LDAP_P((
 399         slap_mask_t use,
 400         slap_mask_t mask,
 401         struct slap_syntax *syntax,     /* syntax of stored value */
 402         struct slap_matching_rule *mr,
 403         struct berval *prefix,
 404         BerVarray values,
 405         BerVarray *keys,
 406         void *memctx ));
 407
 408 /* Filter index function */
 409 typedef int slap_mr_filter_func LDAP_P((
 410         slap_mask_t use,
 411         slap_mask_t mask,
 412         struct slap_syntax *syntax,     /* syntax of stored value */
 413         struct slap_matching_rule *mr,
 414         struct berval *prefix,
 415         void * assertValue,
 416         BerVarray *keys,
 417         void *memctx ));
 418
 419 typedef struct slap_matching_rule_use MatchingRuleUse;
 420
 421 typedef struct slap_matching_rule {
 422         LDAPMatchingRule                smr_mrule;
 423         MatchingRuleUse                 *smr_mru;
 424         /* RFC2252 string representation */
 425         struct berval                   smr_str;
 426         /*
 427          * Note: the former
 428          *                      ber_len_t       smr_oidlen;
 429          * has been replaced by a struct berval that uses the value
 430          * provided by smr_mrule.mr_oid; a macro that expands to
 431          * the bv_len field of the berval is provided for backward
 432          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 433          */
 434         struct berval                   smr_bvoid;
 435 #define smr_oidlen                      smr_bvoid.bv_len
 436
 437         slap_mask_t                             smr_usage;
 438
 439 #ifdef LDAP_DEVEL
 440 #define SLAP_MR_HIDE                    0x0000U
 441 #else
 442 #define SLAP_MR_HIDE                    0x8000U
 443 #endif
 444
 445 #define SLAP_MR_TYPE_MASK               0x0F00U
 446 #define SLAP_MR_SUBTYPE_MASK    0x00F0U
 447 #define SLAP_MR_USAGE                   0x000FU
 448
 449 #define SLAP_MR_NONE                    0x0000U
 450 #define SLAP_MR_EQUALITY                0x0100U
 451 #define SLAP_MR_ORDERING                0x0200U
 452 #define SLAP_MR_SUBSTR                  0x0400U
 453 #define SLAP_MR_EXT                             0x0800U /* implicitly extensible */
 454
 455 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
 456
 457 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0010U )
 458 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0020U )
 459 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0040U )
 460
 461
 462 /*
 463  * The asserted value, depending on the particular usage,
 464  * is expected to conform to either the assertion syntax
 465  * or the attribute syntax.   In some cases, the syntax of
 466  * the value is known.  If so, these flags indicate which
 467  * syntax the value is expected to conform to.  If not,
 468  * neither of these flags is set (until the syntax of the
 469  * provided value is determined).  If the value is of the
 470  * attribute syntax, the flag is changed once a value of
 471  * the assertion syntax is derived from the provided value.
 472  */
 473 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX       0x0001U
 474 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX       0x0002U
 475 #define SLAP_MR_VALUE_OF_SYNTAX                         0x0003U
 476
 477 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
 478         ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
 479 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
 480         ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
 481 #ifdef LDAP_DEBUG
 482 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
 483         ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
 484 #else
 485 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage )     (1)
 486 #endif
 487
 488 /* either or both the asserted value or attribute value
 489  * may be provided in normalized form
 490  */
 491 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH         0x0004U
 492 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH        0x0008U
 493
 494 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
 495         (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
 496 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
 497         ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
 498
 499 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
 500         (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
 501                 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
 502 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
 503         (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
 504                 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
 505
 506 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
 507         ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
 508 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
 509         ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
 510
 511         Syntax                                  *smr_syntax;
 512         slap_mr_convert_func    *smr_convert;
 513         slap_mr_normalize_func  *smr_normalize;
 514         slap_mr_match_func              *smr_match;
 515         slap_mr_indexer_func    *smr_indexer;
 516         slap_mr_filter_func             *smr_filter;
 517
 518         /*
 519          * null terminated array of syntaxes compatible with this syntax
 520          * note: when MS_EXT is set, this MUST NOT contain the assertion
 521          * syntax of the rule.  When MS_EXT is not set, it MAY.
 522          */
 523         Syntax                                  **smr_compat_syntaxes;
 524
 525         /*
 526          * For equality rules, refers to an associated approximate rule.
 527          * For non-equality rules, refers to an associated equality rule.
 528          */
 529         struct slap_matching_rule       *smr_associated;
 530
 531 #define SLAP_MR_ASSOCIATED(mr,amr)      (((mr) == (amr)) || \
 532         ((mr)->smr_associated == (amr)))
 533
 534         LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
 535
 536 #define smr_oid                         smr_mrule.mr_oid
 537 #define smr_names                       smr_mrule.mr_names
 538 #define smr_desc                        smr_mrule.mr_desc
 539 #define smr_obsolete            smr_mrule.mr_obsolete
 540 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
 541 #define smr_extensions          smr_mrule.mr_extensions
 542 } MatchingRule;
 543
 544 struct slap_matching_rule_use {
 545         LDAPMatchingRuleUse             smru_mruleuse;
 546         MatchingRule                    *smru_mr;
 547         /* RFC2252 string representation */
 548         struct berval                   smru_str;
 549
 550         LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
 551
 552 #define smru_oid                        smru_mruleuse.mru_oid
 553 #define smru_names                      smru_mruleuse.mru_names
 554 #define smru_desc                       smru_mruleuse.mru_desc
 555 #define smru_obsolete                   smru_mruleuse.mru_obsolete
 556 #define smru_applies_oids               smru_mruleuse.mru_applies_oids
 557
 558 #define smru_usage                      smru_mr->smr_usage
 559 } /* MatchingRuleUse */ ;
 560
 561 typedef struct slap_mrule_defs_rec {
 562         char *                                          mrd_desc;
 563         slap_mask_t                                     mrd_usage;
 564         char **                                         mrd_compat_syntaxes;
 565         slap_mr_convert_func *          mrd_convert;
 566         slap_mr_normalize_func *        mrd_normalize;
 567         slap_mr_match_func *            mrd_match;
 568         slap_mr_indexer_func *          mrd_indexer;
 569         slap_mr_filter_func *           mrd_filter;
 570
 571         /* For equality rule, this may refer to an associated approximate rule */
 572         /* For non-equality rule, this may refer to an associated equality rule */
 573         char *                                          mrd_associated;
 574 } slap_mrule_defs_rec;
 575
 576 struct slap_backend_db;
 577 struct slap_entry;
 578 struct slap_attr;
 579
 580 typedef int (AttributeTypeSchemaCheckFN)(
 581         struct slap_backend_db *be,
 582         struct slap_entry *e,
 583         struct slap_attr *attr,
 584         const char** text,
 585         char *textbuf, size_t textlen );
 586
 587 typedef struct slap_attribute_type {
 588         LDAPAttributeType               sat_atype;
 589         struct berval                   sat_cname;
 590         struct slap_attribute_type      *sat_sup;
 591         struct slap_attribute_type      **sat_subtypes;
 592         MatchingRule                    *sat_equality;
 593         MatchingRule                    *sat_approx;
 594         MatchingRule                    *sat_ordering;
 595         MatchingRule                    *sat_substr;
 596         Syntax                                  *sat_syntax;
 597
 598         AttributeTypeSchemaCheckFN      *sat_check;
 599
 600 #define SLAP_AT_NONE            0x0000U
 601 #define SLAP_AT_ABSTRACT        0x0100U /* cannot be instantiated */
 602 #define SLAP_AT_FINAL           0x0200U /* cannot be subtyped */
 603 #ifdef LDAP_DEVEL
 604 #define SLAP_AT_HIDE            0x0000U /* publish everything */
 605 #else
 606 #define SLAP_AT_HIDE            0x8000U /* hide attribute */
 607 #endif
 608         slap_mask_t                                     sat_flags;
 609
 610         LDAP_SLIST_ENTRY(slap_attribute_type) sat_next;
 611
 612 #define sat_oid                         sat_atype.at_oid
 613 #define sat_names                       sat_atype.at_names
 614 #define sat_desc                        sat_atype.at_desc
 615 #define sat_obsolete            sat_atype.at_obsolete
 616 #define sat_sup_oid                     sat_atype.at_sup_oid
 617 #define sat_equality_oid        sat_atype.at_equality_oid
 618 #define sat_ordering_oid        sat_atype.at_ordering_oid
 619 #define sat_substr_oid          sat_atype.at_substr_oid
 620 #define sat_syntax_oid          sat_atype.at_syntax_oid
 621 #define sat_single_value        sat_atype.at_single_value
 622 #define sat_collective          sat_atype.at_collective
 623 #define sat_no_user_mod         sat_atype.at_no_user_mod
 624 #define sat_usage                       sat_atype.at_usage
 625 #define sat_extensions          sat_atype.at_extensions
 626
 627         struct slap_attr_desc           *sat_ad;
 628         ldap_pvt_thread_mutex_t         sat_ad_mutex;
 629 } AttributeType;
 630
 631 #define is_at_operational(at)   ((at)->sat_usage)
 632 #define is_at_single_value(at)  ((at)->sat_single_value)
 633 #define is_at_collective(at)    ((at)->sat_collective)
 634 #define is_at_obsolete(at)              ((at)->sat_obsolete)
 635 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
 636
 637 struct slap_object_class;
 638
 639 typedef int (ObjectClassSchemaCheckFN)(
 640         struct slap_backend_db *be,
 641         struct slap_entry *e,
 642         struct slap_object_class *oc,
 643         const char** text,
 644         char *textbuf, size_t textlen );
 645
 646 typedef struct slap_object_class {
 647         LDAPObjectClass                 soc_oclass;
 648         struct berval                   soc_cname;
 649         struct slap_object_class        **soc_sups;
 650         AttributeType                           **soc_required;
 651         AttributeType                           **soc_allowed;
 652         ObjectClassSchemaCheckFN        *soc_check;
 653         slap_mask_t                                     soc_flags;
 654 #define soc_oid                         soc_oclass.oc_oid
 655 #define soc_names                       soc_oclass.oc_names
 656 #define soc_desc                        soc_oclass.oc_desc
 657 #define soc_obsolete            soc_oclass.oc_obsolete
 658 #define soc_sup_oids            soc_oclass.oc_sup_oids
 659 #define soc_kind                        soc_oclass.oc_kind
 660 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 661 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 662 #define soc_extensions          soc_oclass.oc_extensions
 663
 664         LDAP_SLIST_ENTRY(slap_object_class) soc_next;
 665 } ObjectClass;
 666
 667 #define SLAP_OC_ALIAS           0x0001
 668 #define SLAP_OC_REFERRAL        0x0002
 669 #define SLAP_OC_SUBENTRY        0x0004
 670 #define SLAP_OC_DYNAMICOBJECT   0x0008
 671 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x0010
 672 #define SLAP_OC_GLUE            0x0020
 673 #define SLAP_OC_SYNCPROVIDERSUBENTRY            0x0040
 674 #define SLAP_OC_SYNCCONSUMERSUBENTRY            0x0080
 675 #define SLAP_OC__MASK           0x00FF
 676 #define SLAP_OC__END            0x0100
 677 #define SLAP_OC_OPERATIONAL     0x4000
 678 #ifdef LDAP_DEVEL
 679 #define SLAP_OC_HIDE            0x0000
 680 #else
 681 #define SLAP_OC_HIDE            0x8000
 682 #endif
 683
 684 /*
 685  * DIT content rule
 686  */
 687 typedef struct slap_content_rule {
 688         LDAPContentRule         scr_crule;
 689         ObjectClass                     *scr_sclass;
 690         ObjectClass                     **scr_auxiliaries;      /* optional */
 691         AttributeType           **scr_required;         /* optional */
 692         AttributeType           **scr_allowed;          /* optional */
 693         AttributeType           **scr_precluded;        /* optional */
 694 #define scr_oid                         scr_crule.cr_oid
 695 #define scr_names                       scr_crule.cr_names
 696 #define scr_desc                        scr_crule.cr_desc
 697 #define scr_obsolete            scr_crule.cr_obsolete
 698 #define scr_oc_oids_aux         scr_crule.cr_oc_oids_aux
 699 #define scr_at_oids_must        scr_crule.cr_at_oids_must
 700 #define scr_at_oids_may         scr_crule.cr_at_oids_may
 701 #define scr_at_oids_not         scr_crule.cr_at_oids_not
 702
 703         LDAP_SLIST_ENTRY( slap_content_rule ) scr_next;
 704 } ContentRule;
 705
 706 /* Represents a recognized attribute description ( type + options ). */
 707 typedef struct slap_attr_desc {
 708         struct slap_attr_desc *ad_next;
 709         AttributeType *ad_type;         /* attribute type, must be specified */
 710         struct berval ad_cname;         /* canonical name, must be specified */
 711         struct berval ad_tags;          /* empty if no tagging options */
 712         unsigned ad_flags;
 713 #define SLAP_DESC_NONE                  0x00U
 714 #define SLAP_DESC_BINARY                0x01U
 715 #define SLAP_DESC_TAG_RANGE             0x80U
 716 } AttributeDescription;
 717
 718 typedef struct slap_attr_name {
 719         struct berval an_name;
 720         AttributeDescription *an_desc;
 721         ObjectClass *an_oc;
 722 } AttributeName;
 723
 724 #define slap_ad_is_tagged(ad)                   ( (ad)->ad_tags.bv_len != 0 )
 725 #define slap_ad_is_tag_range(ad)        \
 726         ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
 727 #define slap_ad_is_binary(ad)           \
 728         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
 729
 730 /*
 731  * pointers to schema elements used internally
 732  */
 733 struct slap_internal_schema {
 734         /* objectClass */
 735         ObjectClass *si_oc_top;
 736         ObjectClass *si_oc_extensibleObject;
 737         ObjectClass *si_oc_alias;
 738         ObjectClass *si_oc_referral;
 739         ObjectClass *si_oc_rootdse;
 740         ObjectClass *si_oc_subentry;
 741         ObjectClass *si_oc_subschema;
 742         ObjectClass *si_oc_collectiveAttributeSubentry;
 743         ObjectClass *si_oc_dynamicObject;
 744
 745         ObjectClass *si_oc_glue;
 746         ObjectClass *si_oc_syncConsumerSubentry;
 747         ObjectClass *si_oc_syncProviderSubentry;
 748
 749         /* objectClass attribute descriptions */
 750         AttributeDescription *si_ad_objectClass;
 751
 752         /* operational attribute descriptions */
 753         AttributeDescription *si_ad_structuralObjectClass;
 754         AttributeDescription *si_ad_creatorsName;
 755         AttributeDescription *si_ad_createTimestamp;
 756         AttributeDescription *si_ad_modifiersName;
 757         AttributeDescription *si_ad_modifyTimestamp;
 758         AttributeDescription *si_ad_hasSubordinates;
 759         AttributeDescription *si_ad_subschemaSubentry;
 760         AttributeDescription *si_ad_collectiveSubentries;
 761         AttributeDescription *si_ad_collectiveExclusions;
 762         AttributeDescription *si_ad_entryUUID;
 763         AttributeDescription *si_ad_entryCSN;
 764         AttributeDescription *si_ad_namingCSN;
 765         AttributeDescription *si_ad_superiorUUID;
 766
 767         /* LDAP cache specific operational attribute */
 768         AttributeDescription *si_ad_queryid;
 769
 770         AttributeDescription *si_ad_dseType;
 771         AttributeDescription *si_ad_syncreplCookie;
 772         AttributeDescription *si_ad_contextCSN;
 773
 774         /* root DSE attribute descriptions */
 775         AttributeDescription *si_ad_altServer;
 776         AttributeDescription *si_ad_namingContexts;
 777         AttributeDescription *si_ad_supportedControl;
 778         AttributeDescription *si_ad_supportedExtension;
 779         AttributeDescription *si_ad_supportedLDAPVersion;
 780         AttributeDescription *si_ad_supportedSASLMechanisms;
 781         AttributeDescription *si_ad_supportedFeatures;
 782         AttributeDescription *si_ad_monitorContext;
 783         AttributeDescription *si_ad_vendorName;
 784         AttributeDescription *si_ad_vendorVersion;
 785
 786         /* subentry attribute descriptions */
 787         AttributeDescription *si_ad_administrativeRole;
 788         AttributeDescription *si_ad_subtreeSpecification;
 789
 790         /* subschema subentry attribute descriptions */
 791         AttributeDescription *si_ad_ditStructureRules;
 792         AttributeDescription *si_ad_ditContentRules;
 793         AttributeDescription *si_ad_nameForms;
 794         AttributeDescription *si_ad_objectClasses;
 795         AttributeDescription *si_ad_attributeTypes;
 796         AttributeDescription *si_ad_ldapSyntaxes;
 797         AttributeDescription *si_ad_matchingRules;
 798         AttributeDescription *si_ad_matchingRuleUse;
 799
 800         /* Aliases & Referrals */
 801         AttributeDescription *si_ad_aliasedObjectName;
 802         AttributeDescription *si_ad_ref;
 803
 804         /* Access Control Internals */
 805         AttributeDescription *si_ad_entry;
 806         AttributeDescription *si_ad_children;
 807         AttributeDescription *si_ad_saslAuthzTo;
 808         AttributeDescription *si_ad_saslAuthzFrom;
 809 #ifdef SLAPD_ACI_ENABLED
 810         AttributeDescription *si_ad_aci;
 811 #endif
 812
 813         /* dynamic entries */
 814         AttributeDescription *si_ad_entryTtl;
 815         AttributeDescription *si_ad_dynamicSubtrees;
 816
 817         /* Other attributes descriptions */
 818         AttributeDescription *si_ad_distinguishedName;
 819         AttributeDescription *si_ad_name;
 820         AttributeDescription *si_ad_cn;
 821         AttributeDescription *si_ad_userPassword;
 822         AttributeDescription *si_ad_labeledURI;
 823 #ifdef SLAPD_AUTHPASSWD
 824         AttributeDescription *si_ad_authPassword;
 825 #endif
 826 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 827         AttributeDescription *si_ad_krbName;
 828 #endif
 829
 830         /* Undefined Attribute Type */
 831         AttributeType   *si_at_undefined;
 832
 833         /* Matching Rules */
 834         MatchingRule    *si_mr_distinguishedNameMatch;
 835         MatchingRule    *si_mr_caseExactMatch;
 836         MatchingRule    *si_mr_caseExactSubstringsMatch;
 837         MatchingRule    *si_mr_caseExactIA5Match;
 838         MatchingRule    *si_mr_integerMatch;
 839         MatchingRule    *si_mr_integerFirstComponentMatch;
 840         MatchingRule    *si_mr_objectIdentifierFirstComponentMatch;
 841
 842         /* Syntaxes */
 843         Syntax          *si_syn_directoryString;
 844         Syntax          *si_syn_distinguishedName;
 845         Syntax          *si_syn_integer;
 846         Syntax          *si_syn_octetString;
 847 };
 848
 849 typedef struct slap_attr_assertion {
 850         AttributeDescription    *aa_desc;
 851         struct berval aa_value;
 852 } AttributeAssertion;
 853
 854 typedef struct slap_ss_assertion {
 855         AttributeDescription    *sa_desc;
 856         struct berval           sa_initial;
 857         struct berval           *sa_any;
 858         struct berval           sa_final;
 859 } SubstringsAssertion;
 860
 861 typedef struct slap_mr_assertion {
 862         MatchingRule            *ma_rule;       /* optional */
 863         struct berval           ma_rule_text;  /* optional */
 864         AttributeDescription    *ma_desc;       /* optional */
 865         int                                             ma_dnattrs; /* boolean */
 866         struct berval           ma_value;       /* required */
 867 } MatchingRuleAssertion;
 868
 869 /*
 870  * represents a search filter
 871  */
 872 typedef struct slap_filter {
 873         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 874 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
 875 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
 876 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
 877
 878         union f_un_u {
 879                 /* precomputed result */
 880                 ber_int_t f_un_result;
 881
 882                 /* DN */
 883                 struct berval *f_un_dn;
 884
 885                 /* present */
 886                 AttributeDescription *f_un_desc;
 887
 888                 /* simple value assertion */
 889                 AttributeAssertion *f_un_ava;
 890
 891                 /* substring assertion */
 892                 SubstringsAssertion *f_un_ssa;
 893
 894                 /* matching rule assertion */
 895                 MatchingRuleAssertion *f_un_mra;
 896
 897 #define f_dn                    f_un.f_un_dn
 898 #define f_desc                  f_un.f_un_desc
 899 #define f_ava                   f_un.f_un_ava
 900 #define f_av_desc               f_un.f_un_ava->aa_desc
 901 #define f_av_value              f_un.f_un_ava->aa_value
 902 #define f_sub                   f_un.f_un_ssa
 903 #define f_sub_desc              f_un.f_un_ssa->sa_desc
 904 #define f_sub_initial   f_un.f_un_ssa->sa_initial
 905 #define f_sub_any               f_un.f_un_ssa->sa_any
 906 #define f_sub_final             f_un.f_un_ssa->sa_final
 907 #define f_mra                   f_un.f_un_mra
 908 #define f_mr_rule               f_un.f_un_mra->ma_rule
 909 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
 910 #define f_mr_desc               f_un.f_un_mra->ma_desc
 911 #define f_mr_value              f_un.f_un_mra->ma_value
 912 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
 913
 914                 /* and, or, not */
 915                 struct slap_filter *f_un_complex;
 916         } f_un;
 917
 918 #define f_result        f_un.f_un_result
 919 #define f_and           f_un.f_un_complex
 920 #define f_or            f_un.f_un_complex
 921 #define f_not           f_un.f_un_complex
 922 #define f_list          f_un.f_un_complex
 923
 924         struct slap_filter      *f_next;
 925 } Filter;
 926
 927 /* compare routines can return undefined */
 928 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
 929
 930 typedef struct slap_valuesreturnfilter {
 931         ber_tag_t       vrf_choice;
 932
 933         union vrf_un_u {
 934                 /* precomputed result */
 935                 ber_int_t vrf_un_result;
 936
 937                 /* DN */
 938                 char *vrf_un_dn;
 939
 940                 /* present */
 941                 AttributeDescription *vrf_un_desc;
 942
 943                 /* simple value assertion */
 944                 AttributeAssertion *vrf_un_ava;
 945
 946                 /* substring assertion */
 947                 SubstringsAssertion *vrf_un_ssa;
 948
 949                 /* matching rule assertion */
 950                 MatchingRuleAssertion *vrf_un_mra;
 951
 952 #define vrf_result              vrf_un.vrf_un_result
 953 #define vrf_dn                  vrf_un.vrf_un_dn
 954 #define vrf_desc                vrf_un.vrf_un_desc
 955 #define vrf_ava                 vrf_un.vrf_un_ava
 956 #define vrf_av_desc             vrf_un.vrf_un_ava->aa_desc
 957 #define vrf_av_value    vrf_un.vrf_un_ava->aa_value
 958 #define vrf_ssa                 vrf_un.vrf_un_ssa
 959 #define vrf_sub                 vrf_un.vrf_un_ssa
 960 #define vrf_sub_desc    vrf_un.vrf_un_ssa->sa_desc
 961 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
 962 #define vrf_sub_any             vrf_un.vrf_un_ssa->sa_any
 963 #define vrf_sub_final   vrf_un.vrf_un_ssa->sa_final
 964 #define vrf_mra                 vrf_un.vrf_un_mra
 965 #define vrf_mr_rule             vrf_un.vrf_un_mra->ma_rule
 966 #define vrf_mr_rule_text        vrf_un.vrf_un_mra->ma_rule_text
 967 #define vrf_mr_desc             vrf_un.vrf_un_mra->ma_desc
 968 #define vrf_mr_value            vrf_un.vrf_un_mra->ma_value
 969 #define vrf_mr_dnattrs  vrf_un.vrf_un_mra->ma_dnattrs
 970
 971
 972         } vrf_un;
 973
 974         struct slap_valuesreturnfilter  *vrf_next;
 975 } ValuesReturnFilter;
 976
 977 /*
 978  * represents an attribute (description + values)
 979  */
 980 typedef struct slap_attr {
 981         AttributeDescription *a_desc;
 982         BerVarray       a_vals;         /* preserved values */
 983         BerVarray       a_nvals;        /* normalized values */
 984         struct slap_attr *a_next;
 985         unsigned a_flags;
 986 #define SLAP_ATTR_IXADD         0x1U
 987 #define SLAP_ATTR_IXDEL         0x2U
 988 } Attribute;
 989
 990
 991 /*
 992  * the id used in the indexes to refer to an entry
 993  */
 994 typedef unsigned long   ID;
 995 #define NOID    ((ID)~0)
 996
 997 /*
 998  * represents an entry in core
 999  */
1000 typedef struct slap_entry {
1001         /*
1002          * The ID field should only be changed before entry is
1003          * inserted into a cache.  The ID value is backend
1004          * specific.
1005          */
1006         ID              e_id;
1007
1008         struct berval e_name;   /* name (DN) of this entry */
1009         struct berval e_nname;  /* normalized name (DN) of this entry */
1010
1011         /* for migration purposes */
1012 #define e_dn e_name.bv_val
1013 #define e_ndn e_nname.bv_val
1014
1015         Attribute       *e_attrs;       /* list of attributes + values */
1016
1017         slap_mask_t     e_ocflags;
1018
1019         struct berval   e_bv;           /* For entry_encode/entry_decode */
1020
1021         /* for use by the backend for any purpose */
1022         void*   e_private;
1023 } Entry;
1024
1025 /*
1026  * A list of LDAPMods
1027  */
1028 typedef struct slap_mod {
1029         int sm_op;
1030         AttributeDescription *sm_desc;
1031         struct berval sm_type;
1032         BerVarray sm_values;
1033 #define sm_bvalues sm_values
1034         BerVarray sm_nvalues;
1035 } Modification;
1036
1037 typedef struct slap_mod_list {
1038         Modification sml_mod;
1039 #define sml_op          sml_mod.sm_op
1040 #define sml_desc        sml_mod.sm_desc
1041 #define sml_type        sml_mod.sm_type
1042 #define sml_bvalues     sml_mod.sm_values
1043 #define sml_values      sml_mod.sm_values
1044 #define sml_nvalues     sml_mod.sm_nvalues
1045         struct slap_mod_list *sml_next;
1046 } Modifications;
1047
1048 typedef struct slap_ldap_modlist {
1049         LDAPMod ml_mod;
1050         struct slap_ldap_modlist *ml_next;
1051 #define ml_op           ml_mod.mod_op
1052 #define ml_type         ml_mod.mod_type
1053 #define ml_values       ml_mod.mod_values
1054 #define ml_bvalues      ml_mod.mod_values
1055 } LDAPModList;
1056
1057 /*
1058  * represents an access control list
1059  */
1060 typedef enum slap_access_e {
1061         ACL_INVALID_ACCESS = -1,
1062         ACL_NONE = 0,
1063         ACL_AUTH,
1064         ACL_COMPARE,
1065         ACL_SEARCH,
1066         ACL_READ,
1067         ACL_WRITE
1068 } slap_access_t;
1069
1070 typedef enum slap_control_e {
1071         ACL_INVALID_CONTROL     = 0,
1072         ACL_STOP,
1073         ACL_CONTINUE,
1074         ACL_BREAK
1075 } slap_control_t;
1076
1077 typedef enum slap_style_e {
1078         ACL_STYLE_REGEX = 0,
1079         ACL_STYLE_BASE,
1080         ACL_STYLE_ONE,
1081         ACL_STYLE_SUBTREE,
1082         ACL_STYLE_CHILDREN,
1083         ACL_STYLE_ATTROF
1084 } slap_style_t;
1085
1086 typedef struct slap_authz_info {
1087         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
1088         struct berval   sai_mech;               /* SASL Mechanism */
1089         struct berval   sai_dn;                 /* DN for reporting purposes */
1090         struct berval   sai_ndn;                /* Normalized DN */
1091
1092         /* Security Strength Factors */
1093         slap_ssf_t      sai_ssf;                        /* Overall SSF */
1094         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
1095         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
1096         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
1097 } AuthorizationInformation;
1098
1099 /* the "by" part */
1100 typedef struct slap_access {
1101         slap_control_t a_type;
1102
1103 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
1104
1105 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
1106 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
1107 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
1108 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
1109 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
1110 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
1111
1112 #define ACL_PRIV_MASK                   0x00ffUL
1113
1114 /* priv flags */
1115 #define ACL_PRIV_LEVEL                  0x1000UL
1116 #define ACL_PRIV_ADDITIVE               0x2000UL
1117 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
1118
1119 /* invalid privs */
1120 #define ACL_PRIV_INVALID                0x0UL
1121
1122 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
1123 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
1124 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
1125 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
1126
1127 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1128 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1129
1130 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1131
1132 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
1133
1134 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1135 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1136 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1137
1138 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1139 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
1140 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1141 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1142 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
1143 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
1144
1145 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1146 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1147 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1148 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
1149 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
1150 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1151 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1152
1153 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1154 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1155 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1156 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1157 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1158 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1159
1160         slap_mask_t     a_access_mask;
1161
1162         AuthorizationInformation        a_authz;
1163 #define a_dn_pat        a_authz.sai_dn
1164
1165         slap_style_t a_dn_style;
1166         AttributeDescription    *a_dn_at;
1167         int                     a_dn_self;
1168         int                     a_dn_expand;
1169
1170         slap_style_t a_peername_style;
1171         struct berval   a_peername_pat;
1172         slap_style_t a_sockname_style;
1173         struct berval   a_sockname_pat;
1174
1175         slap_style_t a_domain_style;
1176         struct berval   a_domain_pat;
1177         int             a_domain_expand;
1178
1179         slap_style_t a_sockurl_style;
1180         struct berval   a_sockurl_pat;
1181         slap_style_t a_set_style;
1182         struct berval   a_set_pat;
1183
1184 #ifdef SLAPD_ACI_ENABLED
1185         AttributeDescription    *a_aci_at;
1186 #endif
1187
1188         /* ACL Groups */
1189         slap_style_t a_group_style;
1190         struct berval   a_group_pat;
1191         ObjectClass                             *a_group_oc;
1192         AttributeDescription    *a_group_at;
1193
1194         struct slap_access      *a_next;
1195 } Access;
1196
1197 /* the "to" part */
1198 typedef struct slap_acl {
1199         /* "to" part: the entries this acl applies to */
1200         Filter          *acl_filter;
1201         slap_style_t acl_dn_style;
1202         regex_t         acl_dn_re;
1203         struct berval   acl_dn_pat;
1204         AttributeName   *acl_attrs;
1205         slap_style_t    acl_attrval_style;
1206         regex_t         acl_attrval_re;
1207         struct berval   acl_attrval;
1208
1209         /* "by" part: list of who has what access to the entries */
1210         Access  *acl_access;
1211
1212         struct slap_acl *acl_next;
1213 } AccessControl;
1214
1215 typedef struct slap_acl_state {
1216         unsigned as_recorded;
1217 #define ACL_STATE_NOT_RECORDED                  0x0
1218 #define ACL_STATE_RECORDED_VD                   0x1
1219 #define ACL_STATE_RECORDED_NV                   0x2
1220 #define ACL_STATE_RECORDED                              0x3
1221
1222         /* Access state */
1223         AccessControl *as_vd_acl;
1224         AccessControl *as_vi_acl;
1225         slap_mask_t as_vd_acl_mask;
1226         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1227         int as_vd_acl_count;
1228
1229         Access *as_vd_access;
1230         int as_vd_access_count;
1231
1232         int as_result;
1233         AttributeDescription *as_vd_ad;
1234 } AccessControlState;
1235 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1236         { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1237
1238 /*
1239  * Backend-info
1240  * represents a backend
1241  */
1242
1243 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1244 typedef struct slap_backend_db BackendDB;               /* per backend database */
1245
1246 LDAP_SLAPD_V (int) nBackendInfo;
1247 LDAP_SLAPD_V (int) nBackendDB;
1248 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1249 LDAP_SLAPD_V (BackendDB *) backendDB;
1250
1251 LDAP_SLAPD_V (int) slapMode;
1252 #define SLAP_UNDEFINED_MODE     0x0000
1253 #define SLAP_SERVER_MODE        0x0001
1254 #define SLAP_TOOL_MODE          0x0002
1255 #define SLAP_MODE                       0x0003
1256
1257 #define SLAP_TRUNCATE_MODE      0x0100
1258 #define SLAP_TOOL_READMAIN      0x0200
1259 #define SLAP_TOOL_READONLY      0x0400
1260
1261 struct slap_replica_info {
1262         char *ri_host;                          /* supersedes be_replica */
1263         BerVarray ri_nsuffix;   /* array of suffixes this replica accepts */
1264         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1265         int ri_exclude;                 /* 1 => exclude ri_attrs */
1266 };
1267
1268 struct slap_limits_set {
1269         /* time limits */
1270         int     lms_t_soft;
1271         int     lms_t_hard;
1272
1273         /* size limits */
1274         int     lms_s_soft;
1275         int     lms_s_hard;
1276         int     lms_s_unchecked;
1277         int     lms_s_pr;
1278         int     lms_s_pr_hide;
1279 };
1280
1281 struct slap_limits {
1282         int     lm_type;        /* type of pattern */
1283 #define SLAP_LIMITS_UNDEFINED   0x0000
1284 #define SLAP_LIMITS_EXACT       0x0001
1285 #define SLAP_LIMITS_BASE        SLAP_LIMITS_EXACT
1286 #define SLAP_LIMITS_ONE         0x0002
1287 #define SLAP_LIMITS_SUBTREE     0x0003
1288 #define SLAP_LIMITS_CHILDREN    0x0004
1289 #define SLAP_LIMITS_REGEX       0x0005
1290 #define SLAP_LIMITS_ANONYMOUS   0x0006
1291 #define SLAP_LIMITS_USERS       0x0007
1292 #define SLAP_LIMITS_ANY         0x0008
1293         regex_t lm_dn_regex;            /* regex data for REGEX */
1294
1295         /*
1296          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1297          * pattern for REGEX; NULL for ANONYMOUS, USERS
1298          */
1299         struct berval lm_dn_pat;
1300
1301         struct slap_limits_set  lm_limits;
1302 };
1303
1304 /* temporary aliases */
1305 typedef BackendDB Backend;
1306 #define nbackends nBackendDB
1307 #define backends backendDB
1308
1309 /*
1310  * syncinfo structure for syncrepl
1311  */
1312
1313 #define SLAP_SYNC_SID_SIZE      3
1314 #define SLAP_SYNC_RID_SIZE      3
1315 #define SLAP_SYNCUUID_SET_SIZE 256
1316
1317 struct nonpresent_entry {
1318         struct berval *npe_name;
1319         struct berval *npe_nname;
1320         LDAP_LIST_ENTRY(nonpresent_entry) npe_link;
1321 };
1322
1323 struct sync_cookie {
1324         struct berval *ctxcsn;
1325         long sid;
1326         struct berval *octet_str;
1327         long rid;
1328         LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1329 };
1330
1331 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1332
1333 typedef struct syncinfo_s {
1334         struct slap_backend_db *si_be;
1335         long                            si_rid;
1336         char                            *si_provideruri;
1337         BerVarray                       si_provideruri_bv;
1338 #define SYNCINFO_TLS_OFF                0
1339 #define SYNCINFO_TLS_ON                 1
1340 #define SYNCINFO_TLS_CRITICAL   2
1341         int                                     si_tls;
1342                 struct berval           si_updatedn;
1343         int                                     si_bindmethod;
1344         char                            *si_binddn;
1345         char                            *si_passwd;
1346         char                            *si_saslmech;
1347         char                            *si_secprops;
1348         char                            *si_realm;
1349         char                            *si_authcId;
1350         char                            *si_authzId;
1351                 int                                     si_schemachecking;
1352         Filter                          *si_filter;
1353         struct berval           si_filterstr;
1354         struct berval           si_base;
1355         int                                     si_scope;
1356         int                                     si_attrsonly;
1357         char                            **si_attrs;
1358         int                                     si_type;
1359         time_t                          si_interval;
1360                 struct sync_cookie      si_syncCookie;
1361         int                                     si_manageDSAit;
1362         int                                     si_slimit;
1363                 int                                     si_tlimit;
1364                 struct berval           si_syncUUID_ndn;
1365         Avlnode                         *si_presentlist;
1366                 LDAP                            *si_ld;
1367                 LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist;
1368                 LDAP_STAILQ_ENTRY( syncinfo_s ) si_next;
1369 } syncinfo_t;
1370
1371 struct slap_backend_db {
1372         BackendInfo     *bd_info;       /* pointer to shared backend info */
1373
1374         /* BackendInfo accessors */
1375 #define         be_config       bd_info->bi_db_config
1376 #define         be_type         bd_info->bi_type
1377
1378 #define         be_bind         bd_info->bi_op_bind
1379 #define         be_unbind       bd_info->bi_op_unbind
1380 #define         be_add          bd_info->bi_op_add
1381 #define         be_compare      bd_info->bi_op_compare
1382 #define         be_delete       bd_info->bi_op_delete
1383 #define         be_modify       bd_info->bi_op_modify
1384 #define         be_modrdn       bd_info->bi_op_modrdn
1385 #define         be_search       bd_info->bi_op_search
1386 #define         be_abandon      bd_info->bi_op_abandon
1387 #define         be_cancel       bd_info->bi_op_cancel
1388
1389 #define         be_extended     bd_info->bi_extended
1390
1391 #define         be_fetch        bd_info->bi_entry_get_rw
1392 #define         be_release      bd_info->bi_entry_release_rw
1393 #define         be_chk_referrals        bd_info->bi_chk_referrals
1394 #define         be_group        bd_info->bi_acl_group
1395 #define         be_attribute    bd_info->bi_acl_attribute
1396 #define         be_operational  bd_info->bi_operational
1397
1398 /*
1399  * define to honor hasSubordinates operational attribute in search filters
1400  * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1401  * is fixed).
1402  */
1403 #define         be_has_subordinates bd_info->bi_has_subordinates
1404
1405 #define         be_controls     bd_info->bi_controls
1406
1407 #define         be_connection_init      bd_info->bi_connection_init
1408 #define         be_connection_destroy   bd_info->bi_connection_destroy
1409
1410 #ifdef SLAPD_TOOLS
1411 #define         be_entry_open bd_info->bi_tool_entry_open
1412 #define         be_entry_close bd_info->bi_tool_entry_close
1413 #define         be_entry_first bd_info->bi_tool_entry_first
1414 #define         be_entry_next bd_info->bi_tool_entry_next
1415 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1416 #define         be_entry_get bd_info->bi_tool_entry_get
1417 #define         be_entry_put bd_info->bi_tool_entry_put
1418 #define         be_sync bd_info->bi_tool_sync
1419 #define         be_dn2id_get bd_info->bi_tool_dn2id_get
1420 #define         be_id2entry_get bd_info->bi_tool_id2entry_get
1421 #define         be_entry_modify bd_info->bi_tool_entry_modify
1422 #endif
1423
1424 #define SLAP_BFLAG_NOLASTMOD            0x0001U
1425 #define SLAP_BFLAG_NO_SCHEMA_CHECK      0x0002U
1426 #define SLAP_BFLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
1427 #define SLAP_BFLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
1428 #define SLAP_BFLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
1429 #define SLAP_BFLAG_MONITOR                      0x0080U /* a monitor backend */
1430 #define SLAP_BFLAG_INCREMENT            0x0100U
1431 #define SLAP_BFLAG_ALIASES                      0x1000U
1432 #define SLAP_BFLAG_REFERRALS            0x2000U
1433 #define SLAP_BFLAG_SUBENTRIES           0x4000U
1434 #define SLAP_BFLAG_DYNAMIC                      0x8000U
1435         slap_mask_t     be_flags;
1436 #define SLAP_LASTMOD(be)        (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1437 #define SLAP_NO_SCHEMA_CHECK(be)        (((be)->be_flags & SLAP_BFLAG_NO_SCHEMA_CHECK))
1438 #define SLAP_GLUE_INSTANCE(be)  ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE)
1439 #define SLAP_GLUE_SUBORDINATE(be) \
1440         ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)
1441 #define SLAP_GLUE_LINKED(be)    ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED)
1442
1443 #define SLAP_MONITOR(be)        ((be)->be_flags & SLAP_BFLAG_MONITOR)
1444 #define SLAP_INCREMENT(be)      ((be)->be_flags & SLAP_BFLAG_INCREMENT)
1445
1446 #define SLAP_ALIASES(be)        ((be)->be_flags & SLAP_BFLAG_ALIASES)
1447 #define SLAP_REFERRALS(be)      ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1448 #define SLAP_SUBENTRIES(be)     ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1449 #define SLAP_DYNAMIC(be)        ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1450
1451
1452         slap_mask_t     be_restrictops;         /* restriction operations */
1453 #define SLAP_RESTRICT_OP_ADD            0x0001U
1454 #define SLAP_RESTRICT_OP_BIND           0x0002U
1455 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1456 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1457 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1458 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1459 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1460 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1461
1462 #define SLAP_RESTRICT_OP_READS  \
1463         ( SLAP_RESTRICT_OP_COMPARE      \
1464         | SLAP_RESTRICT_OP_SEARCH )
1465 #define SLAP_RESTRICT_OP_WRITES \
1466         ( SLAP_RESTRICT_OP_ADD    \
1467         | SLAP_RESTRICT_OP_DELETE \
1468         | SLAP_RESTRICT_OP_MODIFY \
1469         | SLAP_RESTRICT_OP_RENAME )
1470
1471 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1472 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1473 #define SLAP_ALLOW_BIND_ANON_DN         0x0004U /* dn should be empty */
1474
1475 #define SLAP_ALLOW_UPDATE_ANON          0x0008U /* allow anonymous updates */
1476
1477 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1478 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1479 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1480
1481 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1482 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1483
1484 #define SLAP_DISALLOW_AUX_WO_CR         0x4000U
1485
1486         slap_mask_t     be_requires;    /* pre-operation requirements */
1487 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1488 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1489 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1490 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1491 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1492
1493         /* Required Security Strength Factor */
1494         slap_ssf_set_t be_ssf_set;
1495
1496         /* these should be renamed from be_ to bd_ */
1497         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1498         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1499         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1500         struct berval be_schemandn;     /* normalized subschema DN */
1501         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1502         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1503         struct berval be_rootpw;        /* the magic "root" password for this db        */
1504         unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1505 #define be_sizelimit    be_def_limit.lms_s_soft
1506 #define be_timelimit    be_def_limit.lms_t_soft
1507         struct slap_limits_set be_def_limit; /* default limits */
1508         struct slap_limits **be_limits; /* regex-based size and time limits */
1509         AccessControl *be_acl;  /* access control list for this backend    */
1510         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1511         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1512         char    *be_replogfile; /* replication log file (in master)        */
1513         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1514         BerVarray       be_update_refs; /* where to refer modifying clients to */
1515         char    *be_realm;
1516         void    *be_private;    /* anything the backend database needs     */
1517
1518         void    *be_pb;         /* Netscape plugin */
1519         LDAP_TAILQ_HEAD( pcl, slap_csn_entry )  be_pending_csn_list;
1520         ldap_pvt_thread_mutex_t                                 be_pcl_mutex;
1521         struct berval                                                   be_context_csn;
1522         ldap_pvt_thread_mutex_t                                 be_context_csn_mutex;
1523         LDAP_STAILQ_HEAD( be_si, syncinfo_s )   be_syncinfo; /* For syncrepl */
1524 };
1525
1526 struct slap_conn;
1527 struct slap_op;
1528
1529 /* Backend function typedefs */
1530 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1531 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1532         const char *fname, int lineno,
1533         int argc, char **argv));
1534 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1535 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1536 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1537
1538 typedef int (BI_db_init) LDAP_P((Backend *bd));
1539 typedef int (BI_db_config) LDAP_P((Backend *bd,
1540         const char *fname, int lineno,
1541         int argc, char **argv));
1542 typedef int (BI_db_open) LDAP_P((Backend *bd));
1543 typedef int (BI_db_close) LDAP_P((Backend *bd));
1544 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1545
1546 typedef struct req_bind_s {
1547         int rb_method;
1548         struct berval rb_cred;
1549         struct berval rb_edn;
1550         slap_ssf_t rb_ssf;
1551 } req_bind_s;
1552
1553 typedef struct req_search_s {
1554         int rs_scope;
1555         int rs_deref;
1556         int rs_slimit;
1557         int rs_tlimit;
1558         int rs_attrsonly;
1559         AttributeName *rs_attrs;
1560         Filter *rs_filter;
1561         struct berval rs_filterstr;
1562 } req_search_s;
1563
1564 typedef struct req_compare_s {
1565         AttributeAssertion *rs_ava;
1566 } req_compare_s;
1567
1568 typedef struct req_modify_s {
1569         Modifications *rs_modlist;
1570 } req_modify_s;
1571
1572 typedef struct req_modrdn_s {
1573         struct berval rs_newrdn;
1574         struct berval rs_nnewrdn;
1575         struct berval *rs_newSup;
1576         struct berval *rs_nnewSup;
1577         int rs_deleteoldrdn;
1578 } req_modrdn_s;
1579
1580 typedef struct req_add_s {
1581         Entry *rs_e;
1582 } req_add_s;
1583
1584 typedef struct req_abandon_s {
1585         ber_int_t rs_msgid;
1586 } req_abandon_s;
1587
1588 typedef struct req_extended_s {
1589         struct berval rs_reqoid;
1590         struct berval *rs_reqdata;
1591 } req_extended_s;
1592
1593 typedef enum slap_reply_e {
1594         REP_RESULT,
1595         REP_SASL,
1596         REP_EXTENDED,
1597         REP_SEARCH,
1598         REP_SEARCHREF,
1599         REP_INTERMEDIATE
1600 } slap_reply_t;
1601
1602 typedef struct rep_sasl_s {
1603         struct berval *r_sasldata;
1604 } rep_sasl_s;
1605
1606 typedef struct rep_extended_s {
1607         const char *r_rspoid;
1608         struct berval *r_rspdata;
1609 } rep_extended_s;
1610
1611 typedef struct rep_search_s {
1612         Entry *r_entry;
1613         AttributeName *r_attrs;
1614         int r_nentries;
1615         BerVarray r_v2ref;
1616 } rep_search_s;
1617
1618 typedef struct slap_rep {
1619         slap_reply_t sr_type;
1620         ber_tag_t sr_tag;
1621         ber_int_t sr_msgid;
1622         ber_int_t sr_err;
1623         const char *sr_matched;
1624         const char *sr_text;
1625         BerVarray sr_ref;
1626         LDAPControl **sr_ctrls;
1627         union sr_u {
1628                 rep_sasl_s sru_sasl;
1629                 rep_extended_s sru_extended;
1630                 rep_search_s sru_search;
1631         } sr_un;
1632 } SlapReply;
1633
1634 /* short hands for response members */
1635 #define sr_attrs sr_un.sru_search.r_attrs
1636 #define sr_entry sr_un.sru_search.r_entry
1637 #define sr_v2ref sr_un.sru_search.r_v2ref
1638 #define sr_nentries sr_un.sru_search.r_nentries
1639 #define sr_rspoid sr_un.sru_extended.r_rspoid
1640 #define sr_rspdata sr_un.sru_extended.r_rspdata
1641 #define sr_sasldata sr_un.sru_sasl.r_sasldata
1642
1643 typedef int (BI_op_bind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1644 typedef int (BI_op_unbind) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1645 typedef int (BI_op_search) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1646 typedef int (BI_op_compare) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1647 typedef int (BI_op_modify) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1648 typedef int (BI_op_modrdn) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1649 typedef int (BI_op_add) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1650 typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1651 typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1652 typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1653 typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1654 typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw ));
1655 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
1656         ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
1657 typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
1658 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap ));
1659 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs ));
1660
1661 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1662                 struct slap_conn *c));
1663 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1664                 struct slap_conn *c));
1665
1666 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1667 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1668 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1669 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1670 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1671 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1672                         struct berval *text ));
1673 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1674 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1675 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
1676 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
1677 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
1678                         struct berval *text ));
1679
1680 struct slap_backend_info {
1681         char    *bi_type; /* type of backend */
1682
1683         /*
1684          * per backend type routines:
1685          * bi_init: called to allocate a backend_info structure,
1686          *              called once BEFORE configuration file is read.
1687          *              bi_init() initializes this structure hence is
1688          *              called directly from be_initialize()
1689          * bi_config: called per 'backend' specific option
1690          *              all such options must before any 'database' options
1691          *              bi_config() is called only from read_config()
1692          * bi_open: called to open each database, called
1693          *              once AFTER configuration file is read but
1694          *              BEFORE any bi_db_open() calls.
1695          *              bi_open() is called from backend_startup()
1696          * bi_close: called to close each database, called
1697          *              once during shutdown after all bi_db_close calls.
1698          *              bi_close() is called from backend_shutdown()
1699          * bi_destroy: called to destroy each database, called
1700          *              once during shutdown after all bi_db_destroy calls.
1701          *              bi_destory() is called from backend_destroy()
1702          */
1703         BI_init *bi_init;
1704         BI_config       *bi_config;
1705         BI_open *bi_open;
1706         BI_close        *bi_close;
1707         BI_destroy      *bi_destroy;
1708
1709         /*
1710          * per database routines:
1711          * bi_db_init: called to initialize each database,
1712          *      called upon reading 'database <type>'
1713          *      called only from backend_db_init()
1714          * bi_db_config: called to configure each database,
1715          *  called per database to handle per database options
1716          *      called only from read_config()
1717          * bi_db_open: called to open each database
1718          *      called once per database immediately AFTER bi_open()
1719          *      calls but before daemon startup.
1720          *  called only by backend_startup()
1721          * bi_db_close: called to close each database
1722          *      called once per database during shutdown but BEFORE
1723          *  any bi_close call.
1724          *  called only by backend_shutdown()
1725          * bi_db_destroy: called to destroy each database
1726          *  called once per database during shutdown AFTER all
1727          *  bi_close calls but before bi_destory calls.
1728          *  called only by backend_destory()
1729          */
1730         BI_db_init      *bi_db_init;
1731         BI_db_config    *bi_db_config;
1732         BI_db_open      *bi_db_open;
1733         BI_db_close     *bi_db_close;
1734         BI_db_destroy   *bi_db_destroy;
1735
1736         /* LDAP Operations Handling Routines */
1737         BI_op_bind      *bi_op_bind;
1738         BI_op_unbind    *bi_op_unbind;
1739         BI_op_search    *bi_op_search;
1740         BI_op_compare   *bi_op_compare;
1741         BI_op_modify    *bi_op_modify;
1742         BI_op_modrdn    *bi_op_modrdn;
1743         BI_op_add       *bi_op_add;
1744         BI_op_delete    *bi_op_delete;
1745         BI_op_abandon   *bi_op_abandon;
1746         BI_op_cancel    *bi_op_cancel;
1747
1748         /* Extended Operations Helper */
1749         BI_op_extended  *bi_extended;
1750
1751         /* Auxilary Functions */
1752         BI_entry_get_rw         *bi_entry_get_rw;
1753         BI_entry_release_rw     *bi_entry_release_rw;
1754         BI_chk_referrals        *bi_chk_referrals;
1755
1756         BI_operational  *bi_operational;
1757         BI_has_subordinates     *bi_has_subordinates;
1758
1759         BI_connection_init      *bi_connection_init;
1760         BI_connection_destroy   *bi_connection_destroy;
1761
1762         /* hooks for slap tools */
1763         BI_tool_entry_open              *bi_tool_entry_open;
1764         BI_tool_entry_close             *bi_tool_entry_close;
1765         BI_tool_entry_first             *bi_tool_entry_first;
1766         BI_tool_entry_next              *bi_tool_entry_next;
1767         BI_tool_entry_get               *bi_tool_entry_get;
1768         BI_tool_entry_put               *bi_tool_entry_put;
1769         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1770         BI_tool_sync                    *bi_tool_sync;
1771         BI_tool_dn2id_get               *bi_tool_dn2id_get;
1772         BI_tool_id2entry_get    *bi_tool_id2entry_get;
1773         BI_tool_entry_modify    *bi_tool_entry_modify;
1774
1775 #define SLAP_INDEX_ADD_OP               0x0001
1776 #define SLAP_INDEX_DELETE_OP    0x0002
1777
1778         char **bi_controls;             /* supported controls */
1779
1780         unsigned int bi_nDB;    /* number of databases of this type */
1781         void    *bi_private;    /* anything the backend type needs */
1782 };
1783
1784 #define c_authtype      c_authz.sai_method
1785 #define c_authmech      c_authz.sai_mech
1786 #define c_dn            c_authz.sai_dn
1787 #define c_ndn           c_authz.sai_ndn
1788 #define c_ssf                   c_authz.sai_ssf
1789 #define c_transport_ssf c_authz.sai_transport_ssf
1790 #define c_tls_ssf               c_authz.sai_tls_ssf
1791 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1792
1793 #define o_authtype      o_authz.sai_method
1794 #define o_authmech      o_authz.sai_mech
1795 #define o_dn            o_authz.sai_dn
1796 #define o_ndn           o_authz.sai_ndn
1797 #define o_ssf                   o_authz.sai_ssf
1798 #define o_transport_ssf o_authz.sai_transport_ssf
1799 #define o_tls_ssf               o_authz.sai_tls_ssf
1800 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1801
1802 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
1803
1804 typedef struct slap_callback {
1805         slap_response *sc_response;
1806         void *sc_private;
1807 } slap_callback;
1808
1809 struct slap_overinfo;
1810
1811 typedef struct slap_overinst {
1812         BackendInfo on_bi;
1813         slap_response *on_response;
1814         struct slap_overinfo *on_info;
1815         struct slap_overinst *on_next;
1816 } slap_overinst;
1817
1818 typedef struct slap_overinfo {
1819         BackendInfo oi_bi;
1820         BackendDB oi_bd;
1821         slap_overinst *oi_list;
1822 } slap_overinfo;
1823
1824 /* Should successive callbacks in a chain be processed? */
1825 #define SLAP_CB_CONTINUE        0x8000
1826
1827 /*
1828  * Paged Results state
1829  */
1830 typedef unsigned long PagedResultsCookie;
1831 typedef struct slap_paged_state {
1832         Backend *ps_be;
1833         PagedResultsCookie ps_cookie;
1834         ID ps_id;
1835 } PagedResultsState;
1836
1837
1838 #define LDAP_PSEARCH_BY_ADD                     0x01
1839 #define LDAP_PSEARCH_BY_DELETE          0x02
1840 #define LDAP_PSEARCH_BY_PREMODIFY       0x03
1841 #define LDAP_PSEARCH_BY_MODIFY          0x04
1842 #define LDAP_PSEARCH_BY_SCOPEOUT        0x05
1843
1844 struct psid_entry {
1845         struct slap_op *ps_op;
1846         LDAP_LIST_ENTRY(psid_entry) ps_link;
1847 };
1848
1849 struct slog_entry {
1850         struct berval sl_uuid;
1851         struct berval sl_name;
1852         struct berval sl_csn;
1853         LDAP_STAILQ_ENTRY(slog_entry) sl_link;
1854 };
1855
1856 /* session lists */
1857 struct slap_session_entry {
1858         int se_id;
1859         int se_size;
1860         struct berval se_spec;
1861         LDAP_LIST_ENTRY( slap_session_entry ) se_link;
1862 };
1863
1864 struct slap_csn_entry {
1865         struct berval *csn;
1866         unsigned long opid;
1867         unsigned long connid;
1868 #define SLAP_CSN_PENDING        1
1869 #define SLAP_CSN_COMMIT         2
1870         long state;
1871         LDAP_TAILQ_ENTRY (slap_csn_entry) csn_link;
1872 };
1873
1874 /*
1875  * Caches the result of a backend_group check for ACL evaluation
1876  */
1877 typedef struct slap_gacl {
1878         struct slap_gacl *ga_next;
1879         Backend *ga_be;
1880         ObjectClass *ga_oc;
1881         AttributeDescription *ga_at;
1882         int ga_res;
1883         ber_len_t ga_len;
1884         char ga_ndn[1];
1885 } GroupAssertion;
1886
1887 /*
1888  * represents an operation pending from an ldap client
1889  */
1890 typedef struct slap_op {
1891         unsigned long o_opid;   /* id of this operation */
1892         unsigned long o_connid; /* id of conn initiating this op */
1893         struct slap_conn *o_conn;       /* connection spawning this op */
1894         BackendDB       *o_bd;  /* backend DB processing this op */
1895
1896         ber_int_t       o_msgid;        /* msgid of the request */
1897         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1898         ber_tag_t       o_tag;          /* tag of the request */
1899         time_t          o_time;         /* time op was initiated */
1900
1901         struct berval   o_req_dn;       /* DN of target of request */
1902         struct berval   o_req_ndn;
1903
1904         union o_req_u {
1905                 req_add_s oq_add;
1906                 req_bind_s oq_bind;
1907                 req_compare_s oq_compare;
1908                 req_modify_s oq_modify;
1909                 req_modrdn_s oq_modrdn;
1910                 req_search_s oq_search;
1911                 req_abandon_s oq_abandon;
1912                 req_abandon_s oq_cancel;
1913                 req_extended_s oq_extended;
1914         } o_request;
1915
1916 /* short hands for union members */
1917 #define oq_add o_request.oq_add
1918 #define oq_bind o_request.oq_bind
1919 #define oq_compare o_request.oq_compare
1920 #define oq_modify o_request.oq_modify
1921 #define oq_modrdn o_request.oq_modrdn
1922 #define oq_search o_request.oq_search
1923 #define oq_abandon o_request.oq_abandon
1924 #define oq_cancel o_request.oq_cancel
1925 #define oq_extended o_request.oq_extended
1926
1927 /* short hands for inner request members */
1928 #define orb_method oq_bind.rb_method
1929 #define orb_cred oq_bind.rb_cred
1930 #define orb_edn oq_bind.rb_edn
1931 #define orb_ssf oq_bind.rb_ssf
1932
1933 #define ors_scope oq_search.rs_scope
1934 #define ors_deref oq_search.rs_deref
1935 #define ors_slimit oq_search.rs_slimit
1936 #define ors_tlimit oq_search.rs_tlimit
1937 #define ors_attrsonly oq_search.rs_attrsonly
1938 #define ors_attrs oq_search.rs_attrs
1939 #define ors_filter oq_search.rs_filter
1940 #define ors_filterstr oq_search.rs_filterstr
1941
1942 #define orr_newrdn oq_modrdn.rs_newrdn
1943 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
1944 #define orr_newSup oq_modrdn.rs_newSup
1945 #define orr_nnewSup oq_modrdn.rs_nnewSup
1946 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
1947
1948 #define orc_ava oq_compare.rs_ava
1949 #define ora_e oq_add.rs_e
1950 #define orn_msgid oq_abandon.rs_msgid
1951 #define orm_modlist oq_modify.rs_modlist
1952
1953 #define ore_reqoid oq_extended.rs_reqoid
1954 #define ore_reqdata oq_extended.rs_reqdata
1955
1956         ldap_pvt_thread_t       o_tid;  /* thread handling this op */
1957
1958         volatile sig_atomic_t o_abandon;        /* abandon flag */
1959         volatile sig_atomic_t o_cancel;         /* cancel flag */
1960 #define SLAP_CANCEL_NONE                                0x00
1961 #define SLAP_CANCEL_REQ                                 0x01
1962 #define SLAP_CANCEL_ACK                                 0x02
1963 #define SLAP_CANCEL_DONE                                0x03
1964
1965         GroupAssertion *o_groups;
1966         char o_do_not_cache;    /* don't cache groups from this op */
1967         char o_is_auth_check;   /* authorization in progress */
1968
1969 #define SLAP_NO_CONTROL 0
1970 #define SLAP_NONCRITICAL_CONTROL 1
1971 #define SLAP_CRITICAL_CONTROL 2
1972         char o_managedsait;
1973 #define get_manageDSAit(op)                             ((int)(op)->o_managedsait)
1974
1975         char o_noop;
1976         char o_proxy_authz;
1977
1978         char o_subentries;
1979 #define get_subentries(op)                              ((int)(op)->o_subentries)
1980         char o_subentries_visibility;
1981 #define get_subentries_visibility(op)   ((int)(op)->o_subentries_visibility)
1982
1983         char o_assert;
1984 #define get_assert(op)                                  ((int)(op)->o_assert)
1985
1986         char o_valuesreturnfilter;
1987
1988 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
1989         char o_permissive_modify;
1990 #define get_permissiveModify(op)                ((int)(op)->o_permissive_modify)
1991 #else
1992 #define get_permissiveModify(op)                (0)
1993 #endif
1994
1995 #ifdef LDAP_CONTROL_X_DOMAIN_SCOPE
1996         char o_domain_scope;
1997 #define get_domainScope(op)                             ((int)(op)->o_domain_scope)
1998 #else
1999 #define get_domainScope(op)                             (0)
2000 #endif
2001
2002         char o_preread;
2003         char o_postread;
2004         AttributeName *o_preread_attrs;
2005         AttributeName *o_postread_attrs;
2006
2007 #ifdef LDAP_CONTROL_PAGEDRESULTS
2008         char o_pagedresults;
2009 #define get_pagedresults(op)                    ((int)(op)->o_pagedresults)
2010         ber_int_t o_pagedresults_size;
2011         PagedResultsState o_pagedresults_state;
2012 #else
2013 #define get_pagedresults(op)                    (0)
2014 #endif
2015
2016         char o_sync;
2017         char o_sync_mode;
2018 #define SLAP_SYNC_NONE                                  (0x0)
2019 #define SLAP_SYNC_REFRESH                               (0x1)
2020 #define SLAP_SYNC_PERSIST                               (0x2)
2021 #define SLAP_SYNC_REFRESH_AND_PERSIST   (0x3)
2022         struct sync_cookie      o_sync_state;
2023         int                                     o_sync_rhint;
2024         struct berval           o_sync_cid;
2025         int                                     o_sync_slog_size;
2026         struct berval           o_sync_csn;
2027         struct berval           o_sync_slog_omitcsn;
2028         int                                     o_sync_slog_len;
2029         LDAP_STAILQ_HEAD(sl, slog_entry) o_sync_slog_list;
2030
2031         int o_ps_entries;
2032         int     o_no_psearch;
2033         LDAP_LIST_ENTRY(slap_op) o_ps_link;
2034         LDAP_LIST_HEAD(pe, psid_entry) o_pm_list;
2035
2036         AuthorizationInformation o_authz;
2037
2038         BerElement      *o_ber;         /* ber of the request */
2039         BerElement      *o_res_ber;     /* ber of the CLDAP reply or readback control */
2040         slap_callback *o_callback;      /* callback pointers */
2041         LDAPControl     **o_ctrls;       /* controls */
2042
2043         void    *o_threadctx;           /* thread pool thread context */
2044         void    *o_tmpmemctx;           /* slab malloc context */
2045         BerMemoryFunctions *o_tmpmfuncs;
2046 #define o_tmpalloc      o_tmpmfuncs->bmf_malloc
2047 #define o_tmpcalloc     o_tmpmfuncs->bmf_calloc
2048 #define o_tmprealloc    o_tmpmfuncs->bmf_realloc
2049 #define o_tmpfree       o_tmpmfuncs->bmf_free
2050         void    *o_private;     /* anything the backend needs */
2051
2052         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
2053
2054         Filter *o_assertion; /* Assert control filter */
2055 #define get_assertion(op)                               ((op)->o_assertion)
2056
2057         ValuesReturnFilter *o_vrFilter; /* ValuesReturnFilter */
2058
2059         int o_nocaching;
2060
2061 #ifdef LDAP_SLAPI
2062         void    *o_pb;                  /* NS-SLAPI plugin */
2063         void    *o_extensions;          /* NS-SLAPI plugin */
2064 #endif
2065 } Operation;
2066
2067 #define send_ldap_error( op, rs, err, text ) do { \
2068                 (rs)->sr_err = err; (rs)->sr_text = text; \
2069                 (op->o_conn->c_send_ldap_result)( op, rs ); \
2070         } while (0)
2071 #define send_ldap_discon( op, rs, err, text ) do { \
2072                 (rs)->sr_err = err; (rs)->sr_text = text; \
2073                 send_ldap_disconnect( op, rs ); \
2074         } while (0)
2075
2076 typedef void (SEND_LDAP_RESULT)(
2077         struct slap_op *op, struct slap_rep *rs);
2078 typedef int (SEND_SEARCH_ENTRY)(
2079         struct slap_op *op, struct slap_rep *rs);
2080 typedef int (SEND_SEARCH_REFERENCE)(
2081         struct slap_op *op, struct slap_rep *rs);
2082 typedef void (SEND_LDAP_EXTENDED)(
2083         struct slap_op *op, struct slap_rep *rs);
2084 typedef void (SEND_LDAP_INTERMEDIATE)(
2085         struct slap_op *op, struct slap_rep *rs);
2086
2087 #define send_ldap_result( op, rs ) \
2088         (op->o_conn->c_send_ldap_result)( op, rs )
2089 #define send_search_entry( op, rs ) \
2090         (op->o_conn->c_send_search_entry)( op, rs )
2091 #define send_search_reference( op, rs ) \
2092         (op->o_conn->c_send_search_reference)( op, rs )
2093 #define send_ldap_extended( op, rs ) \
2094         (op->o_conn->c_send_ldap_extended)( op, rs )
2095 #define send_ldap_intermediate( op, rs ) \
2096         (op->o_conn->c_send_ldap_intermediate)( op, rs )
2097
2098 typedef struct slap_listener Listener;
2099
2100 /*
2101  * represents a connection from an ldap client
2102  */
2103 typedef struct slap_conn {
2104         int                     c_struct_state; /* structure management state */
2105         int                     c_conn_state;   /* connection state */
2106
2107         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2108         Sockbuf         *c_sb;                  /* ber connection stuff           */
2109
2110         /* only can be changed by connect_init */
2111         time_t          c_starttime;    /* when the connection was opened */
2112         time_t          c_activitytime; /* when the connection was last used */
2113         unsigned long           c_connid;       /* id of this connection for stats*/
2114
2115         struct berval   c_peer_domain;  /* DNS name of client */
2116         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
2117         Listener        *c_listener;
2118 #define c_listener_url c_listener->sl_url       /* listener URL */
2119 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2120
2121         /* only can be changed by binding thread */
2122         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
2123         struct berval   c_sasl_bind_mech;                       /* mech in progress */
2124         struct berval   c_sasl_dn;      /* temporary storage */
2125
2126         /* authorization backend */
2127         Backend *c_authz_backend;
2128
2129         AuthorizationInformation c_authz;
2130
2131         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
2132
2133         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
2134         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
2135
2136         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
2137         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
2138
2139         BerElement      *c_currentber;  /* ber we're attempting to read */
2140         int             c_writewaiter;  /* true if writer is waiting */
2141
2142 #define CONN_IS_TLS     1
2143 #define CONN_IS_UDP     2
2144 #define CONN_IS_CLIENT  3
2145
2146 #ifdef LDAP_CONNECTIONLESS
2147         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
2148 #endif
2149 #ifdef HAVE_TLS
2150         int     c_is_tls;               /* true if this LDAP over raw TLS */
2151         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
2152 #endif
2153         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
2154         int     c_sasl_done;            /* SASL completed once */
2155         void    *c_sasl_authctx;        /* SASL authentication context */
2156         void    *c_sasl_sockctx;        /* SASL security layer context */
2157         void    *c_sasl_extra;          /* SASL session extra stuff */
2158         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
2159
2160         PagedResultsState c_pagedresults_state; /* paged result state */
2161
2162         long    c_n_ops_received;       /* num of ops received (next op_id) */
2163         long    c_n_ops_executing;      /* num of ops currently executing */
2164         long    c_n_ops_pending;        /* num of ops pending execution */
2165         long    c_n_ops_completed;      /* num of ops completed */
2166
2167         long    c_n_get;                /* num of get calls */
2168         long    c_n_read;               /* num of read calls */
2169         long    c_n_write;              /* num of write calls */
2170
2171         void    *c_pb;                  /* Netscape plugin */
2172         void    *c_extensions;          /* Netscape plugin */
2173
2174         /*
2175          * Client connection handling
2176          */
2177         ldap_pvt_thread_start_t *c_clientfunc;
2178         void    *c_clientarg;
2179
2180         /*
2181          * These are the "callbacks" that are available for back-ends to
2182          * supply data back to connected clients that are connected
2183          * through the "front-end".
2184          */
2185         SEND_LDAP_RESULT *c_send_ldap_result;
2186         SEND_SEARCH_ENTRY *c_send_search_entry;
2187         SEND_SEARCH_REFERENCE *c_send_search_reference;
2188         SEND_LDAP_EXTENDED *c_send_ldap_extended;
2189 #ifdef LDAP_RES_INTERMEDIATE
2190         SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2191 #endif
2192
2193 } Connection;
2194
2195 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2196 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2197         do { \
2198                 if ( ldap_debug & (level) ) \
2199                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2200                 if ( ldap_syslog & (level) ) \
2201                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2202                                 (arg2), (arg3) ); \
2203         } while (0)
2204 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2205 #elif defined(LDAP_DEBUG)
2206 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2207         do { \
2208                 if ( ldap_debug & (level) ) \
2209                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2210         } while (0)
2211 #define StatslogTest( level ) (ldap_debug & (level))
2212 #else
2213 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2214 #define StatslogTest( level ) (0)
2215 #endif
2216
2217 /*
2218  * listener; need to access it from monitor backend
2219  */
2220 struct slap_listener {
2221         struct berval sl_url;
2222         struct berval sl_name;
2223         mode_t  sl_perms;
2224 #ifdef HAVE_TLS
2225         int             sl_is_tls;
2226 #endif
2227 #ifdef LDAP_CONNECTIONLESS
2228         int     sl_is_udp;              /* UDP listener is also data port */
2229 #endif
2230         int     sl_is_mute;     /* Listening is temporarily disabled */
2231         ber_socket_t sl_sd;
2232         Sockaddr sl_sa;
2233 #define sl_addr sl_sa.sa_in_addr
2234 };
2235
2236 #ifdef SLAPD_MONITOR
2237 /*
2238  * Operation indices
2239  */
2240 enum {
2241         SLAP_OP_BIND = 0,
2242         SLAP_OP_UNBIND,
2243         SLAP_OP_ADD,
2244         SLAP_OP_DELETE,
2245         SLAP_OP_MODRDN,
2246         SLAP_OP_MODIFY,
2247         SLAP_OP_COMPARE,
2248         SLAP_OP_SEARCH,
2249         SLAP_OP_ABANDON,
2250         SLAP_OP_EXTENDED,
2251         SLAP_OP_LAST
2252 };
2253 #endif /* SLAPD_MONITOR */
2254
2255 /*
2256  * Better know these all around slapd
2257  */
2258 #define SLAP_LDAPDN_PRETTY 0x1
2259 #define SLAP_LDAPDN_MAXLEN 8192
2260
2261 /* number of response controls supported */
2262 #define SLAP_MAX_RESPONSE_CONTROLS   6
2263
2264 #ifdef LDAP_DEVEL
2265 #define SLAP_CTRL_HIDE                          0x00000000U
2266 #else
2267 #define SLAP_CTRL_HIDE                          0x80000000U
2268 #endif
2269
2270 #define SLAP_CTRL_FRONTEND                      0x00800000U
2271 #define SLAP_CTRL_FRONTEND_SEARCH       0x00010000U     /* for NOOP */
2272
2273 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
2274 #define SLAP_CTRL_ABANDON                       0x00000001U
2275 #define SLAP_CTRL_ADD                           0x00002002U
2276 #define SLAP_CTRL_BIND                          0x00000004U
2277 #define SLAP_CTRL_COMPARE                       0x00001008U
2278 #define SLAP_CTRL_DELETE                        0x00002010U
2279 #define SLAP_CTRL_MODIFY                        0x00002020U
2280 #define SLAP_CTRL_RENAME                        0x00002040U
2281 #define SLAP_CTRL_SEARCH                        0x00001080U
2282 #define SLAP_CTRL_UNBIND                        0x00000100U
2283
2284 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2285 #define SLAP_CTRL_UPDATE \
2286         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2287 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2288
2289 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2290         Operation *op,
2291         SlapReply *rs,
2292         LDAPControl *ctrl ));
2293
2294 LDAP_END_DECL
2295
2296 #include "proto-slap.h"
2297
2298 #endif /* _SLAP_H_ */