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