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-2021 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.h" 56 #include "ldap_pvt_thread.h" 57 #include "ldap_queue.h" 58 59 LDAP_BEGIN_DECL 60 61 #ifdef LDAP_DEVEL 62 #define LDAP_COLLECTIVE_ATTRIBUTES 63 #define LDAP_COMP_MATCH 64 #define LDAP_SYNC_TIMESTAMP 65 #define SLAP_CONTROL_X_WHATFAILED 66 #define SLAP_CONFIG_DELETE 67 #ifndef SLAP_SCHEMA_EXPOSE 68 #define SLAP_SCHEMA_EXPOSE 69 #endif 70 #endif 71 72 #define LDAP_DYNAMIC_OBJECTS 73 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE 74 #define SLAP_CONTROL_X_SESSION_TRACKING 75 #define SLAP_DISTPROC 76 77 #ifdef ENABLE_REWRITE 78 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */ 79 #endif 80 81 /* 82 * SLAPD Memory allocation macros 83 * 84 * Unlike ch_*() routines, these routines do not assert() upon 85 * allocation error. They are intended to be used instead of 86 * ch_*() routines where the caller has implemented proper 87 * checking for and handling of allocation errors. 88 * 89 * Patches to convert ch_*() calls to SLAP_*() calls welcomed. 90 */ 91 #define SLAP_MALLOC(s) ber_memalloc((s)) 92 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s)) 93 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s)) 94 #define SLAP_FREE(p) ber_memfree((p)) 95 #define SLAP_VFREE(v) ber_memvfree((void**)(v)) 96 #define SLAP_STRDUP(s) ber_strdup((s)) 97 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l)) 98 99 #ifdef f_next 100 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */ 101 #endif 102 103 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd" 104 #define SLAPD_ANONYMOUS "" 105 106 #ifdef HAVE_TCPD 107 # include <tcpd.h> 108 # define SLAP_STRING_UNKNOWN STRING_UNKNOWN 109 #else /* ! TCP Wrappers */ 110 # define SLAP_STRING_UNKNOWN "unknown" 111 #endif /* ! TCP Wrappers */ 112 113 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h! */ 114 /* These values are used internally by the backends. */ 115 /* SLAP_MOD_SOFTADD allows adding values that already exist without getting 116 * an error as required by modrdn when the new rdn was already an attribute 117 * value itself. 118 */ 119 #define SLAP_MOD_SOFTADD 0x1000 120 /* SLAP_MOD_SOFTDEL allows deleting values if they exist without getting 121 * an error otherwise. 122 */ 123 #define SLAP_MOD_SOFTDEL 0x1001 124 /* SLAP_MOD_ADD_IF_NOT_PRESENT allows adding values unless the attribute 125 * is already present without getting an error. 126 */ 127 #define SLAP_MOD_ADD_IF_NOT_PRESENT 0x1002 128 /* SLAP_MOD_DEL_IF_PRESENT allows deleting values if the attribute 129 * is present, without getting an error otherwise. 130 * The semantics can be obtained using SLAP_MOD_SOFTDEL with NULL values. 131 */ 132 133 #define MAXREMATCHES (100) 134 135 #define SLAP_MAX_WORKER_THREADS (16) 136 137 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1) 138 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1) 139 140 #define SLAP_CONN_MAX_PENDING_DEFAULT 100 141 #define SLAP_CONN_MAX_PENDING_AUTH 1000 142 143 #define SLAP_TEXT_BUFLEN (256) 144 145 /* pseudo error code indicating abandoned operation */ 146 #define SLAPD_ABANDON (-1024) 147 148 /* pseudo error code indicating disconnect */ 149 #define SLAPD_DISCONNECT (-1025) 150 151 /* unknown config file directive */ 152 #define SLAP_CONF_UNKNOWN (-1026) 153 154 /* We assume "C" locale, that is US-ASCII */ 155 #define ASCII_SPACE(c) ( (c) == ' ' ) 156 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' ) 157 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' ) 158 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) ) 159 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' ) 160 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' ) 161 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' ) 162 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \ 163 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) ) 164 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) ) 165 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' ) 166 167 #define SLAP_NIBBLE(c) ((c)&0x0f) 168 #define SLAP_ESCAPE_CHAR ('\\') 169 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] ) 170 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) ) 171 172 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \ 173 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) ) 174 175 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR) 176 /* NOTE: for consistency, this macro must only operate 177 * on normalized/pretty DN, such that ';' is never used 178 * as RDN separator, and all occurrences of ';' must be escaped */ 179 #define DN_SEPARATOR(c) ((c) == ',') 180 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 4514 */ 181 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c)) 182 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"') 183 184 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) ) 185 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' ) 186 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) ) 187 #define OID_SEPARATOR(c) ( (c) == '.' ) 188 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) ) 189 190 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) ) 191 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) ) 192 193 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) ) 194 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' ) 195 196 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) ) 197 198 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \ 199 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \ 200 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \ 201 (c) == '?' || (c) == ' ' || (c) == '=' ) 202 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' ) 203 204 /* must match in schema_init.c */ 205 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12" 206 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34" 207 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27" 208 #define SLAPD_GROUP_ATTR "member" 209 #define SLAPD_GROUP_CLASS "groupOfNames" 210 #define SLAPD_ROLE_ATTR "roleOccupant" 211 #define SLAPD_ROLE_CLASS "organizationalRole" 212 213 #define SLAPD_TOP_OID "2.5.6.0" 214 215 LDAP_SLAPD_V (int) slap_debug; 216 217 typedef unsigned long slap_mask_t; 218 219 /* Security Strength Factor */ 220 typedef unsigned slap_ssf_t; 221 222 typedef struct slap_ssf_set { 223 slap_ssf_t sss_ssf; 224 slap_ssf_t sss_transport; 225 slap_ssf_t sss_tls; 226 slap_ssf_t sss_sasl; 227 slap_ssf_t sss_update_ssf; 228 slap_ssf_t sss_update_transport; 229 slap_ssf_t sss_update_tls; 230 slap_ssf_t sss_update_sasl; 231 slap_ssf_t sss_simple_bind; 232 } slap_ssf_set_t; 233 234 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */ 235 #define SLAP_GETDN_AUTHCID 2 236 #define SLAP_GETDN_AUTHZID 4 237 238 /* 239 * Index types 240 */ 241 #define SLAP_INDEX_TYPE 0x00FFUL 242 #define SLAP_INDEX_UNDEFINED 0x0001UL 243 #define SLAP_INDEX_PRESENT 0x0002UL 244 #define SLAP_INDEX_EQUALITY 0x0004UL 245 #define SLAP_INDEX_APPROX 0x0008UL 246 #define SLAP_INDEX_SUBSTR 0x0010UL 247 #define SLAP_INDEX_EXTENDED 0x0020UL 248 249 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY 250 251 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type)) 252 253 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL 254 255 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL ) 256 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL ) 257 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL ) 258 #define SLAP_INDEX_SUBSTR_DEFAULT \ 259 ( SLAP_INDEX_SUBSTR \ 260 | SLAP_INDEX_SUBSTR_INITIAL \ 261 | SLAP_INDEX_SUBSTR_ANY \ 262 | SLAP_INDEX_SUBSTR_FINAL ) 263 264 /* defaults for initial/final substring indices */ 265 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2 266 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4 267 268 /* defaults for any substring indices */ 269 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4 270 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2 271 272 /* default for ordered integer index keys */ 273 #define SLAP_INDEX_INTLEN_DEFAULT 4 274 275 #define SLAP_INDEX_FLAGS 0xF000UL 276 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */ 277 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */ 278 279 /* 280 * there is a single index for each attribute. these prefixes ensure 281 * that there is no collision among keys. 282 */ 283 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */ 284 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */ 285 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */ 286 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^' 287 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$' 288 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */ 289 290 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30" 291 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3" 292 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37" 293 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31" 294 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16" 295 296 /* 297 * represents schema information for a database 298 */ 299 enum { 300 SLAP_SCHERR_OUTOFMEM = 1, 301 SLAP_SCHERR_CLASS_NOT_FOUND, 302 SLAP_SCHERR_CLASS_BAD_USAGE, 303 SLAP_SCHERR_CLASS_BAD_SUP, 304 SLAP_SCHERR_CLASS_DUP, 305 SLAP_SCHERR_CLASS_INCONSISTENT, 306 SLAP_SCHERR_ATTR_NOT_FOUND, 307 SLAP_SCHERR_ATTR_BAD_MR, 308 SLAP_SCHERR_ATTR_BAD_USAGE, 309 SLAP_SCHERR_ATTR_BAD_SUP, 310 SLAP_SCHERR_ATTR_INCOMPLETE, 311 SLAP_SCHERR_ATTR_DUP, 312 SLAP_SCHERR_ATTR_INCONSISTENT, 313 SLAP_SCHERR_MR_NOT_FOUND, 314 SLAP_SCHERR_MR_INCOMPLETE, 315 SLAP_SCHERR_MR_DUP, 316 SLAP_SCHERR_SYN_NOT_FOUND, 317 SLAP_SCHERR_SYN_DUP, 318 SLAP_SCHERR_SYN_SUP_NOT_FOUND, 319 SLAP_SCHERR_SYN_SUBST_NOT_SPECIFIED, 320 SLAP_SCHERR_SYN_SUBST_NOT_FOUND, 321 SLAP_SCHERR_NO_NAME, 322 SLAP_SCHERR_NOT_SUPPORTED, 323 SLAP_SCHERR_BAD_DESCR, 324 SLAP_SCHERR_OIDM, 325 SLAP_SCHERR_CR_DUP, 326 SLAP_SCHERR_CR_BAD_STRUCT, 327 SLAP_SCHERR_CR_BAD_AUX, 328 SLAP_SCHERR_CR_BAD_AT, 329 330 SLAP_SCHERR_LAST 331 }; 332 333 /* forward declarations */ 334 typedef struct Syntax Syntax; 335 typedef struct MatchingRule MatchingRule; 336 typedef struct MatchingRuleUse MatchingRuleUse; 337 typedef struct MatchingRuleAssertion MatchingRuleAssertion; 338 typedef struct OidMacro OidMacro; 339 typedef struct ObjectClass ObjectClass; 340 typedef struct AttributeType AttributeType; 341 typedef struct AttributeDescription AttributeDescription; 342 typedef struct AttributeName AttributeName; 343 typedef struct ContentRule ContentRule; 344 345 typedef struct AttributeAssertion AttributeAssertion; 346 typedef struct SubstringsAssertion SubstringsAssertion; 347 typedef struct Filter Filter; 348 typedef struct ValuesReturnFilter ValuesReturnFilter; 349 typedef struct Attribute Attribute; 350 #ifdef LDAP_COMP_MATCH 351 typedef struct ComponentData ComponentData; 352 typedef struct ComponentFilter ComponentFilter; 353 #endif 354 355 typedef struct Entry Entry; 356 typedef struct Modification Modification; 357 typedef struct Modifications Modifications; 358 typedef struct LDAPModList LDAPModList; 359 360 typedef struct BackendInfo BackendInfo; /* per backend type */ 361 typedef struct BackendDB BackendDB; /* per backend database */ 362 363 typedef struct Connection Connection; 364 typedef struct Operation Operation; 365 typedef struct SlapReply SlapReply; 366 /* end of forward declarations */ 367 368 typedef union Sockaddr { 369 struct sockaddr sa_addr; 370 struct sockaddr_in sa_in_addr; 371 #ifdef LDAP_PF_INET6 372 struct sockaddr_storage sa_storage; 373 struct sockaddr_in6 sa_in6_addr; 374 #endif 375 #ifdef LDAP_PF_LOCAL 376 struct sockaddr_un sa_un_addr; 377 #endif 378 } Sockaddr; 379 380 #ifdef LDAP_PF_INET6 381 extern int slap_inet4or6; 382 #endif 383 384 struct OidMacro { 385 struct berval som_oid; 386 BerVarray som_names; 387 BerVarray som_subs; 388 #define SLAP_OM_HARDCODE 0x10000U /* This is hardcoded schema */ 389 int som_flags; 390 LDAP_STAILQ_ENTRY(OidMacro) som_next; 391 }; 392 393 typedef int slap_syntax_validate_func LDAP_P(( 394 Syntax *syntax, 395 struct berval * in)); 396 397 typedef int slap_syntax_transform_func LDAP_P(( 398 Syntax *syntax, 399 struct berval * in, 400 struct berval * out, 401 void *memctx)); 402 403 #ifdef LDAP_COMP_MATCH 404 typedef void* slap_component_transform_func LDAP_P(( 405 struct berval * in )); 406 struct ComponentDesc; 407 #endif 408 409 struct Syntax { 410 LDAPSyntax ssyn_syn; 411 #define ssyn_oid ssyn_syn.syn_oid 412 #define ssyn_desc ssyn_syn.syn_desc 413 #define ssyn_extensions ssyn_syn.syn_extensions 414 /* 415 * Note: the former 416 ber_len_t ssyn_oidlen; 417 * has been replaced by a struct berval that uses the value 418 * provided by ssyn_syn.syn_oid; a macro that expands to 419 * the bv_len field of the berval is provided for backward 420 * compatibility. CAUTION: NEVER FREE THE BERVAL 421 */ 422 struct berval ssyn_bvoid; 423 #define ssyn_oidlen ssyn_bvoid.bv_len 424 425 unsigned int ssyn_flags; 426 427 #define SLAP_SYNTAX_NONE 0x0000U 428 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */ 429 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */ 430 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */ 431 #ifdef SLAP_SCHEMA_EXPOSE 432 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */ 433 #else 434 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */ 435 #endif 436 #define SLAP_SYNTAX_HARDCODE 0x10000U /* This is hardcoded schema */ 437 #define SLAP_SYNTAX_DN 0x20000U /* Treat like a DN */ 438 439 Syntax **ssyn_sups; 440 441 slap_syntax_validate_func *ssyn_validate; 442 slap_syntax_transform_func *ssyn_pretty; 443 444 #ifdef SLAPD_BINARY_CONVERSION 445 /* convert to and from binary */ 446 slap_syntax_transform_func *ssyn_ber2str; 447 slap_syntax_transform_func *ssyn_str2ber; 448 #endif 449 #ifdef LDAP_COMP_MATCH 450 slap_component_transform_func *ssyn_attr2comp; 451 struct ComponentDesc* ssync_comp_syntax; 452 #endif 453 454 LDAP_STAILQ_ENTRY(Syntax) ssyn_next; 455 }; 456 457 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0) 458 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB) 459 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY) 460 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER) 461 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE) 462 463 typedef struct slap_syntax_defs_rec { 464 char *sd_desc; 465 int sd_flags; 466 char **sd_sups; 467 slap_syntax_validate_func *sd_validate; 468 slap_syntax_transform_func *sd_pretty; 469 #ifdef SLAPD_BINARY_CONVERSION 470 slap_syntax_transform_func *sd_ber2str; 471 slap_syntax_transform_func *sd_str2ber; 472 #endif 473 } slap_syntax_defs_rec; 474 475 /* X -> Y Converter */ 476 typedef int slap_mr_convert_func LDAP_P(( 477 struct berval * in, 478 struct berval * out, 479 void *memctx )); 480 481 /* Normalizer */ 482 typedef int slap_mr_normalize_func LDAP_P(( 483 slap_mask_t use, 484 Syntax *syntax, /* NULL if in is asserted value */ 485 MatchingRule *mr, 486 struct berval *in, 487 struct berval *out, 488 void *memctx )); 489 490 /* Match (compare) function */ 491 typedef int slap_mr_match_func LDAP_P(( 492 int *match, 493 slap_mask_t use, 494 Syntax *syntax, /* syntax of stored value */ 495 MatchingRule *mr, 496 struct berval *value, 497 void *assertValue )); 498 499 /* Index generation function */ 500 typedef int slap_mr_indexer_func LDAP_P(( 501 slap_mask_t use, 502 slap_mask_t mask, 503 Syntax *syntax, /* syntax of stored value */ 504 MatchingRule *mr, 505 struct berval *prefix, 506 BerVarray values, 507 BerVarray *keys, 508 void *memctx )); 509 510 /* Filter index function */ 511 typedef int slap_mr_filter_func LDAP_P(( 512 slap_mask_t use, 513 slap_mask_t mask, 514 Syntax *syntax, /* syntax of stored value */ 515 MatchingRule *mr, 516 struct berval *prefix, 517 void *assertValue, 518 BerVarray *keys, 519 void *memctx )); 520 521 struct MatchingRule { 522 LDAPMatchingRule smr_mrule; 523 MatchingRuleUse *smr_mru; 524 /* RFC 4512 string representation */ 525 struct berval smr_str; 526 /* 527 * Note: the former 528 * ber_len_t smr_oidlen; 529 * has been replaced by a struct berval that uses the value 530 * provided by smr_mrule.mr_oid; a macro that expands to 531 * the bv_len field of the berval is provided for backward 532 * compatibility. CAUTION: NEVER FREE THE BERVAL 533 */ 534 struct berval smr_bvoid; 535 #define smr_oidlen smr_bvoid.bv_len 536 537 slap_mask_t smr_usage; 538 539 #ifdef SLAP_SCHEMA_EXPOSE 540 #define SLAP_MR_HIDE 0x0000U 541 #else 542 #define SLAP_MR_HIDE 0x8000U 543 #endif 544 545 #define SLAP_MR_MUTATION_NORMALIZER 0x4000U 546 547 #define SLAP_MR_TYPE_MASK 0x0F00U 548 #define SLAP_MR_SUBTYPE_MASK 0x00F0U 549 #define SLAP_MR_USAGE 0x000FU 550 551 #define SLAP_MR_NONE 0x0000U 552 #define SLAP_MR_EQUALITY 0x0100U 553 #define SLAP_MR_ORDERING 0x0200U 554 #define SLAP_MR_SUBSTR 0x0400U 555 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */ 556 #define SLAP_MR_ORDERED_INDEX 0x1000U 557 #ifdef LDAP_COMP_MATCH 558 #define SLAP_MR_COMPONENT 0x2000U 559 #endif 560 561 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U ) 562 563 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U ) 564 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U ) 565 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U ) 566 567 568 /* 569 * The asserted value, depending on the particular usage, 570 * is expected to conform to either the assertion syntax 571 * or the attribute syntax. In some cases, the syntax of 572 * the value is known. If so, these flags indicate which 573 * syntax the value is expected to conform to. If not, 574 * neither of these flags is set (until the syntax of the 575 * provided value is determined). If the value is of the 576 * attribute syntax, the flag is changed once a value of 577 * the assertion syntax is derived from the provided value. 578 */ 579 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U 580 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U 581 #define SLAP_MR_VALUE_OF_SYNTAX (SLAP_MR_VALUE_OF_ASSERTION_SYNTAX|SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX) 582 #define SLAP_MR_DENORMALIZE (SLAP_MR_MUTATION_NORMALIZER) 583 584 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \ 585 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX ) 586 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \ 587 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX ) 588 #ifdef LDAP_DEBUG 589 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \ 590 ((usage) & SLAP_MR_VALUE_OF_SYNTAX) 591 #else 592 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1) 593 #endif 594 #define SLAP_MR_IS_DENORMALIZE( usage ) \ 595 ((usage) & SLAP_MR_DENORMALIZE ) 596 597 /* either or both the asserted value or attribute value 598 * may be provided in normalized form 599 */ 600 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U 601 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U 602 603 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \ 604 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)) 605 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \ 606 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH) 607 608 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \ 609 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \ 610 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) 611 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \ 612 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \ 613 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH) 614 615 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \ 616 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH ) 617 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \ 618 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH ) 619 620 Syntax *smr_syntax; 621 slap_mr_convert_func *smr_convert; 622 slap_mr_normalize_func *smr_normalize; 623 slap_mr_match_func *smr_match; 624 slap_mr_indexer_func *smr_indexer; 625 slap_mr_filter_func *smr_filter; 626 627 /* 628 * null terminated array of syntaxes compatible with this syntax 629 * note: when MS_EXT is set, this MUST NOT contain the assertion 630 * syntax of the rule. When MS_EXT is not set, it MAY. 631 */ 632 Syntax **smr_compat_syntaxes; 633 634 /* 635 * For equality rules, refers to an associated approximate rule. 636 * For non-equality rules, refers to an associated equality rule. 637 */ 638 MatchingRule *smr_associated; 639 640 #define SLAP_MR_ASSOCIATED(mr,amr) \ 641 (((mr) == (amr)) || ((mr)->smr_associated == (amr))) 642 643 LDAP_SLIST_ENTRY(MatchingRule) smr_next; 644 645 #define smr_oid smr_mrule.mr_oid 646 #define smr_names smr_mrule.mr_names 647 #define smr_desc smr_mrule.mr_desc 648 #define smr_obsolete smr_mrule.mr_obsolete 649 #define smr_syntax_oid smr_mrule.mr_syntax_oid 650 #define smr_extensions smr_mrule.mr_extensions 651 }; 652 653 struct MatchingRuleUse { 654 LDAPMatchingRuleUse smru_mruleuse; 655 MatchingRule *smru_mr; 656 /* RFC 4512 string representation */ 657 struct berval smru_str; 658 659 LDAP_SLIST_ENTRY(MatchingRuleUse) smru_next; 660 661 #define smru_oid smru_mruleuse.mru_oid 662 #define smru_names smru_mruleuse.mru_names 663 #define smru_desc smru_mruleuse.mru_desc 664 #define smru_obsolete smru_mruleuse.mru_obsolete 665 #define smru_applies_oids smru_mruleuse.mru_applies_oids 666 667 #define smru_usage smru_mr->smr_usage 668 } /* MatchingRuleUse */ ; 669 670 typedef struct slap_mrule_defs_rec { 671 char * mrd_desc; 672 slap_mask_t mrd_usage; 673 char ** mrd_compat_syntaxes; 674 slap_mr_convert_func * mrd_convert; 675 slap_mr_normalize_func * mrd_normalize; 676 slap_mr_match_func * mrd_match; 677 slap_mr_indexer_func * mrd_indexer; 678 slap_mr_filter_func * mrd_filter; 679 680 /* For equality rule, this may refer to an associated approximate rule */ 681 /* For non-equality rule, this may refer to an associated equality rule */ 682 char * mrd_associated; 683 } slap_mrule_defs_rec; 684 685 typedef int (AttributeTypeSchemaCheckFN)( 686 BackendDB *be, 687 Entry *e, 688 Attribute *attr, 689 const char** text, 690 char *textbuf, size_t textlen ); 691 692 struct AttributeType { 693 LDAPAttributeType sat_atype; 694 struct berval sat_cname; 695 AttributeType *sat_sup; 696 AttributeType **sat_subtypes; 697 MatchingRule *sat_equality; 698 MatchingRule *sat_approx; 699 MatchingRule *sat_ordering; 700 MatchingRule *sat_substr; 701 Syntax *sat_syntax; 702 703 AttributeTypeSchemaCheckFN *sat_check; 704 char *sat_oidmacro; /* attribute OID */ 705 char *sat_soidmacro; /* syntax OID */ 706 707 #define SLAP_AT_NONE 0x0000U 708 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */ 709 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */ 710 #ifdef SLAP_SCHEMA_EXPOSE 711 #define SLAP_AT_HIDE 0x0000U /* publish everything */ 712 #else 713 #define SLAP_AT_HIDE 0x8000U /* hide attribute */ 714 #endif 715 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */ 716 717 #define SLAP_AT_MANAGEABLE 0x0800U /* no-user-mod can be by-passed */ 718 719 /* Note: ORDERED values have an ordering specifically set by the 720 * user, denoted by the {x} ordering prefix on the values. 721 * 722 * SORTED values are simply sorted by memcmp. SORTED values can 723 * be efficiently located by binary search. ORDERED values have no 724 * such advantage. An attribute cannot have both properties. 725 */ 726 #define SLAP_AT_ORDERED_VAL 0x0001U /* values are ordered */ 727 #define SLAP_AT_ORDERED_SIB 0x0002U /* siblings are ordered */ 728 #define SLAP_AT_ORDERED 0x0003U /* value has order index */ 729 730 #define SLAP_AT_SORTED_VAL 0x0010U /* values should be sorted */ 731 732 #define SLAP_AT_HARDCODE 0x10000U /* hardcoded schema */ 733 #define SLAP_AT_DELETED 0x20000U 734 735 slap_mask_t sat_flags; 736 737 LDAP_STAILQ_ENTRY(AttributeType) sat_next; 738 739 #define sat_oid sat_atype.at_oid 740 #define sat_names sat_atype.at_names 741 #define sat_desc sat_atype.at_desc 742 #define sat_obsolete sat_atype.at_obsolete 743 #define sat_sup_oid sat_atype.at_sup_oid 744 #define sat_equality_oid sat_atype.at_equality_oid 745 #define sat_ordering_oid sat_atype.at_ordering_oid 746 #define sat_substr_oid sat_atype.at_substr_oid 747 #define sat_syntax_oid sat_atype.at_syntax_oid 748 #define sat_single_value sat_atype.at_single_value 749 #define sat_collective sat_atype.at_collective 750 #define sat_no_user_mod sat_atype.at_no_user_mod 751 #define sat_usage sat_atype.at_usage 752 #define sat_extensions sat_atype.at_extensions 753 754 AttributeDescription *sat_ad; 755 ldap_pvt_thread_mutex_t sat_ad_mutex; 756 }; 757 758 #define is_at_operational(at) ((at)->sat_usage) 759 #define is_at_single_value(at) ((at)->sat_single_value) 760 #define is_at_collective(at) ((at)->sat_collective) 761 #define is_at_obsolete(at) ((at)->sat_obsolete) 762 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod) 763 764 typedef int (ObjectClassSchemaCheckFN)( 765 BackendDB *be, 766 Entry *e, 767 ObjectClass *oc, 768 const char** text, 769 char *textbuf, size_t textlen ); 770 771 struct ObjectClass { 772 LDAPObjectClass soc_oclass; 773 struct berval soc_cname; 774 ObjectClass **soc_sups; 775 AttributeType **soc_required; 776 AttributeType **soc_allowed; 777 ObjectClassSchemaCheckFN *soc_check; 778 char *soc_oidmacro; 779 slap_mask_t soc_flags; 780 #define soc_oid soc_oclass.oc_oid 781 #define soc_names soc_oclass.oc_names 782 #define soc_desc soc_oclass.oc_desc 783 #define soc_obsolete soc_oclass.oc_obsolete 784 #define soc_sup_oids soc_oclass.oc_sup_oids 785 #define soc_kind soc_oclass.oc_kind 786 #define soc_at_oids_must soc_oclass.oc_at_oids_must 787 #define soc_at_oids_may soc_oclass.oc_at_oids_may 788 #define soc_extensions soc_oclass.oc_extensions 789 790 LDAP_STAILQ_ENTRY(ObjectClass) soc_next; 791 }; 792 793 #define SLAP_OCF_SET_FLAGS 0x1 794 #define SLAP_OCF_CHECK_SUP 0x2 795 #define SLAP_OCF_MASK (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP) 796 797 #define SLAP_OC_ALIAS 0x0001 798 #define SLAP_OC_REFERRAL 0x0002 799 #define SLAP_OC_SUBENTRY 0x0004 800 #define SLAP_OC_DYNAMICOBJECT 0x0008 801 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010 802 #define SLAP_OC_GLUE 0x0020 803 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040 804 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080 805 #define SLAP_OC__MASK 0x00FF 806 #define SLAP_OC__END 0x0100 807 #define SLAP_OC_OPERATIONAL 0x4000 808 #ifdef SLAP_SCHEMA_EXPOSE 809 #define SLAP_OC_HIDE 0x0000 810 #else 811 #define SLAP_OC_HIDE 0x8000 812 #endif 813 #define SLAP_OC_HARDCODE 0x10000U /* This is hardcoded schema */ 814 #define SLAP_OC_DELETED 0x20000U 815 816 /* 817 * DIT content rule 818 */ 819 struct ContentRule { 820 LDAPContentRule scr_crule; 821 ObjectClass *scr_sclass; 822 ObjectClass **scr_auxiliaries; /* optional */ 823 AttributeType **scr_required; /* optional */ 824 AttributeType **scr_allowed; /* optional */ 825 AttributeType **scr_precluded; /* optional */ 826 #define scr_oid scr_crule.cr_oid 827 #define scr_names scr_crule.cr_names 828 #define scr_desc scr_crule.cr_desc 829 #define scr_obsolete scr_crule.cr_obsolete 830 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux 831 #define scr_at_oids_must scr_crule.cr_at_oids_must 832 #define scr_at_oids_may scr_crule.cr_at_oids_may 833 #define scr_at_oids_not scr_crule.cr_at_oids_not 834 835 char *scr_oidmacro; 836 #define SLAP_CR_HARDCODE 0x10000U 837 int scr_flags; 838 839 LDAP_STAILQ_ENTRY( ContentRule ) scr_next; 840 }; 841 842 /* Represents a recognized attribute description ( type + options ). */ 843 struct AttributeDescription { 844 AttributeDescription *ad_next; 845 AttributeType *ad_type; /* attribute type, must be specified */ 846 struct berval ad_cname; /* canonical name, must be specified */ 847 struct berval ad_tags; /* empty if no tagging options */ 848 unsigned ad_flags; 849 #define SLAP_DESC_NONE 0x00U 850 #define SLAP_DESC_BINARY 0x01U 851 #define SLAP_DESC_TAG_RANGE 0x80U 852 #define SLAP_DESC_TEMPORARY 0x1000U 853 unsigned ad_index; 854 }; 855 856 /* flags to slap_*2undef_ad to register undefined (0, the default) 857 * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional 858 * SLAP_AD_NOINSERT is to lookup without insert */ 859 #define SLAP_AD_UNDEF 0x00U 860 #define SLAP_AD_PROXIED 0x01U 861 #define SLAP_AD_NOINSERT 0x02U 862 863 #define SLAP_AN_OCEXCLUDE 0x01 864 #define SLAP_AN_OCINITED 0x02 865 866 struct AttributeName { 867 struct berval an_name; 868 AttributeDescription *an_desc; 869 int an_flags; 870 ObjectClass *an_oc; 871 }; 872 873 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 ) 874 #define slap_ad_is_tag_range(ad) \ 875 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 ) 876 #define slap_ad_is_binary(ad) \ 877 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 ) 878 879 /* 880 * pointers to schema elements used internally 881 */ 882 struct slap_internal_schema { 883 /* objectClass */ 884 ObjectClass *si_oc_top; 885 ObjectClass *si_oc_extensibleObject; 886 ObjectClass *si_oc_alias; 887 ObjectClass *si_oc_referral; 888 ObjectClass *si_oc_rootdse; 889 ObjectClass *si_oc_subentry; 890 ObjectClass *si_oc_subschema; 891 ObjectClass *si_oc_collectiveAttributeSubentry; 892 ObjectClass *si_oc_dynamicObject; 893 894 ObjectClass *si_oc_glue; 895 ObjectClass *si_oc_syncConsumerSubentry; 896 ObjectClass *si_oc_syncProviderSubentry; 897 898 /* objectClass attribute descriptions */ 899 AttributeDescription *si_ad_objectClass; 900 901 /* operational attribute descriptions */ 902 AttributeDescription *si_ad_structuralObjectClass; 903 AttributeDescription *si_ad_creatorsName; 904 AttributeDescription *si_ad_createTimestamp; 905 AttributeDescription *si_ad_modifiersName; 906 AttributeDescription *si_ad_modifyTimestamp; 907 AttributeDescription *si_ad_hasSubordinates; 908 AttributeDescription *si_ad_subschemaSubentry; 909 AttributeDescription *si_ad_collectiveSubentries; 910 AttributeDescription *si_ad_collectiveExclusions; 911 AttributeDescription *si_ad_entryDN; 912 AttributeDescription *si_ad_entryUUID; 913 AttributeDescription *si_ad_entryCSN; 914 AttributeDescription *si_ad_namingCSN; 915 916 AttributeDescription *si_ad_dseType; 917 AttributeDescription *si_ad_syncreplCookie; 918 AttributeDescription *si_ad_syncTimestamp; 919 AttributeDescription *si_ad_contextCSN; 920 921 /* root DSE attribute descriptions */ 922 AttributeDescription *si_ad_altServer; 923 AttributeDescription *si_ad_namingContexts; 924 AttributeDescription *si_ad_supportedControl; 925 AttributeDescription *si_ad_supportedExtension; 926 AttributeDescription *si_ad_supportedLDAPVersion; 927 AttributeDescription *si_ad_supportedSASLMechanisms; 928 AttributeDescription *si_ad_supportedFeatures; 929 AttributeDescription *si_ad_monitorContext; 930 AttributeDescription *si_ad_vendorName; 931 AttributeDescription *si_ad_vendorVersion; 932 AttributeDescription *si_ad_configContext; 933 934 /* subentry attribute descriptions */ 935 AttributeDescription *si_ad_administrativeRole; 936 AttributeDescription *si_ad_subtreeSpecification; 937 938 /* subschema subentry attribute descriptions */ 939 AttributeDescription *si_ad_attributeTypes; 940 AttributeDescription *si_ad_ditContentRules; 941 AttributeDescription *si_ad_ditStructureRules; 942 AttributeDescription *si_ad_ldapSyntaxes; 943 AttributeDescription *si_ad_matchingRules; 944 AttributeDescription *si_ad_matchingRuleUse; 945 AttributeDescription *si_ad_nameForms; 946 AttributeDescription *si_ad_objectClasses; 947 948 /* Aliases & Referrals */ 949 AttributeDescription *si_ad_aliasedObjectName; 950 AttributeDescription *si_ad_ref; 951 952 /* Access Control Internals */ 953 AttributeDescription *si_ad_entry; 954 AttributeDescription *si_ad_children; 955 AttributeDescription *si_ad_saslAuthzTo; 956 AttributeDescription *si_ad_saslAuthzFrom; 957 958 /* dynamic entries */ 959 AttributeDescription *si_ad_entryTtl; 960 AttributeDescription *si_ad_dynamicSubtrees; 961 962 /* Other attributes descriptions */ 963 AttributeDescription *si_ad_distinguishedName; 964 AttributeDescription *si_ad_name; 965 AttributeDescription *si_ad_cn; 966 AttributeDescription *si_ad_uid; 967 AttributeDescription *si_ad_uidNumber; 968 AttributeDescription *si_ad_gidNumber; 969 AttributeDescription *si_ad_userPassword; 970 AttributeDescription *si_ad_labeledURI; 971 #ifdef SLAPD_AUTHPASSWD 972 AttributeDescription *si_ad_authPassword; 973 AttributeDescription *si_ad_authPasswordSchemes; 974 #endif 975 AttributeDescription *si_ad_description; 976 AttributeDescription *si_ad_seeAlso; 977 978 /* Undefined Attribute Type */ 979 AttributeType *si_at_undefined; 980 981 /* "Proxied" Attribute Type */ 982 AttributeType *si_at_proxied; 983 984 /* Matching Rules */ 985 MatchingRule *si_mr_distinguishedNameMatch; 986 MatchingRule *si_mr_dnSubtreeMatch; 987 MatchingRule *si_mr_dnOneLevelMatch; 988 MatchingRule *si_mr_dnSubordinateMatch; 989 MatchingRule *si_mr_dnSuperiorMatch; 990 MatchingRule *si_mr_caseExactMatch; 991 MatchingRule *si_mr_caseExactSubstringsMatch; 992 MatchingRule *si_mr_caseExactIA5Match; 993 MatchingRule *si_mr_integerMatch; 994 MatchingRule *si_mr_integerFirstComponentMatch; 995 MatchingRule *si_mr_objectIdentifierFirstComponentMatch; 996 MatchingRule *si_mr_caseIgnoreMatch; 997 MatchingRule *si_mr_caseIgnoreListMatch; 998 999 /* Syntaxes */ 1000 Syntax *si_syn_directoryString; 1001 Syntax *si_syn_distinguishedName; 1002 Syntax *si_syn_integer; 1003 Syntax *si_syn_octetString; 1004 1005 /* Schema Syntaxes */ 1006 Syntax *si_syn_attributeTypeDesc; 1007 Syntax *si_syn_ditContentRuleDesc; 1008 Syntax *si_syn_ditStructureRuleDesc; 1009 Syntax *si_syn_ldapSyntaxDesc; 1010 Syntax *si_syn_matchingRuleDesc; 1011 Syntax *si_syn_matchingRuleUseDesc; 1012 Syntax *si_syn_nameFormDesc; 1013 Syntax *si_syn_objectClassDesc; 1014 }; 1015 1016 struct AttributeAssertion { 1017 AttributeDescription *aa_desc; 1018 struct berval aa_value; 1019 #ifdef LDAP_COMP_MATCH 1020 ComponentFilter *aa_cf; /* for attribute aliasing */ 1021 #endif 1022 }; 1023 #ifdef LDAP_COMP_MATCH 1024 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL, NULL } 1025 #else 1026 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL } 1027 #endif 1028 1029 struct SubstringsAssertion { 1030 AttributeDescription *sa_desc; 1031 struct berval sa_initial; 1032 struct berval *sa_any; 1033 struct berval sa_final; 1034 }; 1035 1036 struct MatchingRuleAssertion { 1037 AttributeDescription *ma_desc; /* optional */ 1038 struct berval ma_value; /* required */ 1039 MatchingRule *ma_rule; /* optional */ 1040 struct berval ma_rule_text; /* optional */ 1041 int ma_dnattrs; /* boolean */ 1042 #ifdef LDAP_COMP_MATCH 1043 ComponentFilter *ma_cf; /* component filter */ 1044 #endif 1045 }; 1046 1047 /* 1048 * represents a search filter 1049 */ 1050 struct Filter { 1051 ber_tag_t f_choice; /* values taken from ldap.h, plus: */ 1052 #define SLAPD_FILTER_COMPUTED 0 1053 #define SLAPD_FILTER_MASK 0x7fff 1054 #define SLAPD_FILTER_UNDEFINED 0x8000 1055 1056 union f_un_u { 1057 /* precomputed result */ 1058 ber_int_t f_un_result; 1059 1060 /* present */ 1061 AttributeDescription *f_un_desc; 1062 1063 /* simple value assertion */ 1064 AttributeAssertion *f_un_ava; 1065 1066 /* substring assertion */ 1067 SubstringsAssertion *f_un_ssa; 1068 1069 /* matching rule assertion */ 1070 MatchingRuleAssertion *f_un_mra; 1071 1072 #define f_desc f_un.f_un_desc 1073 #define f_ava f_un.f_un_ava 1074 #define f_av_desc f_un.f_un_ava->aa_desc 1075 #define f_av_value f_un.f_un_ava->aa_value 1076 #define f_sub f_un.f_un_ssa 1077 #define f_sub_desc f_un.f_un_ssa->sa_desc 1078 #define f_sub_initial f_un.f_un_ssa->sa_initial 1079 #define f_sub_any f_un.f_un_ssa->sa_any 1080 #define f_sub_final f_un.f_un_ssa->sa_final 1081 #define f_mra f_un.f_un_mra 1082 #define f_mr_rule f_un.f_un_mra->ma_rule 1083 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text 1084 #define f_mr_desc f_un.f_un_mra->ma_desc 1085 #define f_mr_value f_un.f_un_mra->ma_value 1086 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs 1087 1088 /* and, or, not */ 1089 Filter *f_un_complex; 1090 } f_un; 1091 1092 #define f_result f_un.f_un_result 1093 #define f_and f_un.f_un_complex 1094 #define f_or f_un.f_un_complex 1095 #define f_not f_un.f_un_complex 1096 #define f_list f_un.f_un_complex 1097 1098 Filter *f_next; 1099 }; 1100 1101 /* compare routines can return undefined */ 1102 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1) 1103 1104 struct ValuesReturnFilter { 1105 ber_tag_t vrf_choice; 1106 1107 union vrf_un_u { 1108 /* precomputed result */ 1109 ber_int_t vrf_un_result; 1110 1111 /* DN */ 1112 char *vrf_un_dn; 1113 1114 /* present */ 1115 AttributeDescription *vrf_un_desc; 1116 1117 /* simple value assertion */ 1118 AttributeAssertion *vrf_un_ava; 1119 1120 /* substring assertion */ 1121 SubstringsAssertion *vrf_un_ssa; 1122 1123 /* matching rule assertion */ 1124 MatchingRuleAssertion *vrf_un_mra; 1125 1126 #define vrf_result vrf_un.vrf_un_result 1127 #define vrf_dn vrf_un.vrf_un_dn 1128 #define vrf_desc vrf_un.vrf_un_desc 1129 #define vrf_ava vrf_un.vrf_un_ava 1130 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc 1131 #define vrf_av_value vrf_un.vrf_un_ava->aa_value 1132 #define vrf_ssa vrf_un.vrf_un_ssa 1133 #define vrf_sub vrf_un.vrf_un_ssa 1134 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc 1135 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial 1136 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any 1137 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final 1138 #define vrf_mra vrf_un.vrf_un_mra 1139 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule 1140 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text 1141 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc 1142 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value 1143 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs 1144 1145 1146 } vrf_un; 1147 1148 ValuesReturnFilter *vrf_next; 1149 }; 1150 1151 /* 1152 * represents an attribute (description + values) 1153 * desc, vals, nvals, numvals fields must align with Modification 1154 */ 1155 struct Attribute { 1156 AttributeDescription *a_desc; 1157 BerVarray a_vals; /* preserved values */ 1158 BerVarray a_nvals; /* normalized values */ 1159 unsigned a_numvals; /* number of vals */ 1160 unsigned a_flags; 1161 #define SLAP_ATTR_IXADD 0x1U 1162 #define SLAP_ATTR_IXDEL 0x2U 1163 #define SLAP_ATTR_DONT_FREE_DATA 0x4U 1164 #define SLAP_ATTR_DONT_FREE_VALS 0x8U 1165 #define SLAP_ATTR_SORTED_VALS 0x10U /* values are sorted */ 1166 1167 /* These flags persist across an attr_dup() */ 1168 #define SLAP_ATTR_PERSISTENT_FLAGS \ 1169 SLAP_ATTR_SORTED_VALS 1170 1171 Attribute *a_next; 1172 #ifdef LDAP_COMP_MATCH 1173 ComponentData *a_comp_data; /* component values */ 1174 #endif 1175 }; 1176 1177 1178 /* 1179 * the id used in the indexes to refer to an entry 1180 */ 1181 typedef unsigned long ID; 1182 #define NOID ((ID)~0) 1183 1184 typedef struct EntryHeader { 1185 struct berval bv; 1186 char *data; 1187 int nattrs; 1188 int nvals; 1189 } EntryHeader; 1190 1191 /* 1192 * represents an entry in core 1193 */ 1194 struct Entry { 1195 /* 1196 * The ID field should only be changed before entry is 1197 * inserted into a cache. The ID value is backend 1198 * specific. 1199 */ 1200 ID e_id; 1201 1202 struct berval e_name; /* name (DN) of this entry */ 1203 struct berval e_nname; /* normalized name (DN) of this entry */ 1204 1205 /* for migration purposes */ 1206 #define e_dn e_name.bv_val 1207 #define e_ndn e_nname.bv_val 1208 1209 Attribute *e_attrs; /* list of attributes + values */ 1210 1211 slap_mask_t e_ocflags; 1212 1213 struct berval e_bv; /* For entry_encode/entry_decode */ 1214 1215 /* for use by the backend for any purpose */ 1216 void* e_private; 1217 }; 1218 1219 /* 1220 * A list of LDAPMods 1221 * desc, values, nvalues, numvals must align with Attribute 1222 */ 1223 struct Modification { 1224 AttributeDescription *sm_desc; 1225 BerVarray sm_values; 1226 BerVarray sm_nvalues; 1227 unsigned sm_numvals; 1228 short sm_op; 1229 short sm_flags; 1230 /* Set for internal mods, will bypass ACL checks. Only needed when 1231 * running as non-root user, for user modifiable attributes. 1232 */ 1233 #define SLAP_MOD_INTERNAL 0x01 1234 #define SLAP_MOD_MANAGING 0x02 1235 struct berval sm_type; 1236 }; 1237 1238 struct Modifications { 1239 Modification sml_mod; 1240 #define sml_op sml_mod.sm_op 1241 #define sml_flags sml_mod.sm_flags 1242 #define sml_desc sml_mod.sm_desc 1243 #define sml_type sml_mod.sm_type 1244 #define sml_values sml_mod.sm_values 1245 #define sml_nvalues sml_mod.sm_nvalues 1246 #define sml_numvals sml_mod.sm_numvals 1247 Modifications *sml_next; 1248 }; 1249 1250 /* 1251 * represents an access control list 1252 */ 1253 typedef enum slap_access_t { 1254 ACL_INVALID_ACCESS = -1, 1255 ACL_NONE = 0, 1256 ACL_DISCLOSE, 1257 ACL_AUTH, 1258 ACL_COMPARE, 1259 ACL_SEARCH, 1260 ACL_READ, 1261 ACL_WRITE_, 1262 ACL_MANAGE, 1263 1264 /* always leave at end of levels but not greater than ACL_LEVEL_MASK */ 1265 ACL_LAST, 1266 1267 /* ACL level mask and modifiers */ 1268 ACL_LEVEL_MASK = 0x000f, 1269 ACL_QUALIFIER1 = 0x0100, 1270 ACL_QUALIFIER2 = 0x0200, 1271 ACL_QUALIFIER3 = 0x0400, 1272 ACL_QUALIFIER4 = 0x0800, 1273 ACL_QUALIFIER_MASK = 0x0f00, 1274 1275 /* write granularity */ 1276 ACL_WADD = ACL_WRITE_|ACL_QUALIFIER1, 1277 ACL_WDEL = ACL_WRITE_|ACL_QUALIFIER2, 1278 1279 ACL_WRITE = ACL_WADD|ACL_WDEL 1280 } slap_access_t; 1281 1282 typedef enum slap_control_e { 1283 ACL_INVALID_CONTROL = 0, 1284 ACL_STOP, 1285 ACL_CONTINUE, 1286 ACL_BREAK 1287 } slap_control_t; 1288 1289 typedef enum slap_style_e { 1290 ACL_STYLE_REGEX = 0, 1291 ACL_STYLE_EXPAND, 1292 ACL_STYLE_BASE, 1293 ACL_STYLE_ONE, 1294 ACL_STYLE_SUBTREE, 1295 ACL_STYLE_CHILDREN, 1296 ACL_STYLE_LEVEL, 1297 ACL_STYLE_ATTROF, 1298 ACL_STYLE_ANONYMOUS, 1299 ACL_STYLE_USERS, 1300 ACL_STYLE_SELF, 1301 ACL_STYLE_IP, 1302 ACL_STYLE_IPV6, 1303 ACL_STYLE_PATH, 1304 1305 ACL_STYLE_NONE 1306 } slap_style_t; 1307 1308 typedef struct AuthorizationInformation { 1309 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */ 1310 struct berval sai_mech; /* SASL Mechanism */ 1311 struct berval sai_dn; /* DN for reporting purposes */ 1312 struct berval sai_ndn; /* Normalized DN */ 1313 1314 /* Security Strength Factors */ 1315 slap_ssf_t sai_ssf; /* Overall SSF */ 1316 slap_ssf_t sai_transport_ssf; /* Transport SSF */ 1317 slap_ssf_t sai_tls_ssf; /* TLS SSF */ 1318 slap_ssf_t sai_sasl_ssf; /* SASL SSF */ 1319 } AuthorizationInformation; 1320 1321 #ifdef SLAP_DYNACL 1322 1323 /* 1324 * "dynamic" ACL infrastructure (for ACIs and more) 1325 */ 1326 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno, 1327 const char *opts, slap_style_t, const char *, void **privp )); 1328 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv )); 1329 typedef int (slap_dynacl_mask) LDAP_P(( 1330 void *priv, 1331 Operation *op, 1332 Entry *e, 1333 AttributeDescription *desc, 1334 struct berval *val, 1335 int nmatch, 1336 regmatch_t *matches, 1337 slap_access_t *grant, 1338 slap_access_t *deny )); 1339 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv )); 1340 1341 typedef struct slap_dynacl_t { 1342 char *da_name; 1343 slap_dynacl_parse *da_parse; 1344 slap_dynacl_unparse *da_unparse; 1345 slap_dynacl_mask *da_mask; 1346 slap_dynacl_destroy *da_destroy; 1347 1348 void *da_private; 1349 struct slap_dynacl_t *da_next; 1350 } slap_dynacl_t; 1351 #endif /* SLAP_DYNACL */ 1352 1353 /* the DN portion of the "by" part */ 1354 typedef struct slap_dn_access { 1355 /* DN pattern */ 1356 AuthorizationInformation a_dnauthz; 1357 #define a_pat a_dnauthz.sai_dn 1358 1359 slap_style_t a_style; 1360 int a_level; 1361 int a_self_level; 1362 AttributeDescription *a_at; 1363 int a_self; 1364 int a_expand; 1365 } slap_dn_access; 1366 1367 /* the "by" part */ 1368 typedef struct Access { 1369 slap_control_t a_type; 1370 1371 /* strip qualifiers */ 1372 #define ACL_LEVEL(p) ((p) & ACL_LEVEL_MASK) 1373 #define ACL_QUALIFIERS(p) ((p) & ~ACL_LEVEL_MASK) 1374 1375 #define ACL_ACCESS2PRIV(access) ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access))) 1376 1377 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE ) 1378 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE ) 1379 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH ) 1380 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE ) 1381 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH ) 1382 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ ) 1383 #define ACL_PRIV_WADD ACL_ACCESS2PRIV( ACL_WADD ) 1384 #define ACL_PRIV_WDEL ACL_ACCESS2PRIV( ACL_WDEL ) 1385 #define ACL_PRIV_WRITE ( ACL_PRIV_WADD | ACL_PRIV_WDEL ) 1386 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE ) 1387 1388 /* NOTE: always use the highest level; current: 0x00ffUL */ 1389 #define ACL_PRIV_MASK ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK) 1390 1391 /* priv flags */ 1392 #define ACL_PRIV_LEVEL 0x1000UL 1393 #define ACL_PRIV_ADDITIVE 0x2000UL 1394 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL 1395 1396 /* invalid privs */ 1397 #define ACL_PRIV_INVALID 0x0UL 1398 1399 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p)) 1400 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0) 1401 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0) 1402 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0) 1403 1404 #define ACL_INIT(m) ACL_PRIV_ASSIGN((m), ACL_PRIV_NONE) 1405 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN((m), ACL_PRIV_INVALID) 1406 1407 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a)) 1408 1409 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID) 1410 1411 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL) 1412 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE) 1413 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE) 1414 1415 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL) 1416 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE) 1417 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE) 1418 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH) 1419 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE) 1420 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH) 1421 #define ACL_LVL_WADD (ACL_PRIV_WADD|ACL_LVL_READ) 1422 #define ACL_LVL_WDEL (ACL_PRIV_WDEL|ACL_LVL_READ) 1423 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ) 1424 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE) 1425 1426 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK)) 1427 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE) 1428 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE) 1429 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH) 1430 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE) 1431 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH) 1432 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ) 1433 #define ACL_LVL_IS_WADD(m) ACL_LVL((m),ACL_LVL_WADD) 1434 #define ACL_LVL_IS_WDEL(m) ACL_LVL((m),ACL_LVL_WDEL) 1435 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE) 1436 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE) 1437 1438 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE) 1439 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE) 1440 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH) 1441 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE) 1442 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH) 1443 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ) 1444 #define ACL_LVL_ASSIGN_WADD(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WADD) 1445 #define ACL_LVL_ASSIGN_WDEL(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL) 1446 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE) 1447 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE) 1448 1449 slap_mask_t a_access_mask; 1450 1451 /* DN pattern */ 1452 slap_dn_access a_dn; 1453 #define a_dn_pat a_dn.a_dnauthz.sai_dn 1454 #define a_dn_at a_dn.a_at 1455 #define a_dn_self a_dn.a_self 1456 1457 /* real DN pattern */ 1458 slap_dn_access a_realdn; 1459 #define a_realdn_pat a_realdn.a_dnauthz.sai_dn 1460 #define a_realdn_at a_realdn.a_at 1461 #define a_realdn_self a_realdn.a_self 1462 1463 /* used for ssf stuff 1464 * NOTE: the ssf stuff in a_realdn is ignored */ 1465 #define a_authz a_dn.a_dnauthz 1466 1467 /* connection related stuff */ 1468 slap_style_t a_peername_style; 1469 struct berval a_peername_pat; 1470 #ifdef LDAP_PF_INET6 1471 union { 1472 struct in6_addr ax6; 1473 unsigned long ax; 1474 } ax_peername_addr, 1475 ax_peername_mask; 1476 #define a_peername_addr6 ax_peername_addr.ax6 1477 #define a_peername_addr ax_peername_addr.ax 1478 #define a_peername_mask6 ax_peername_mask.ax6 1479 #define a_peername_mask ax_peername_mask.ax 1480 /* apparently, only s6_addr is portable; 1481 * define a portable address mask comparison */ 1482 #define slap_addr6_mask(val, msk, asr) ( \ 1483 (((val)->s6_addr[0] & (msk)->s6_addr[0]) == (asr)->s6_addr[0]) \ 1484 && (((val)->s6_addr[1] & (msk)->s6_addr[1]) == (asr)->s6_addr[1]) \ 1485 && (((val)->s6_addr[2] & (msk)->s6_addr[2]) == (asr)->s6_addr[2]) \ 1486 && (((val)->s6_addr[3] & (msk)->s6_addr[3]) == (asr)->s6_addr[3]) \ 1487 && (((val)->s6_addr[4] & (msk)->s6_addr[4]) == (asr)->s6_addr[4]) \ 1488 && (((val)->s6_addr[5] & (msk)->s6_addr[5]) == (asr)->s6_addr[5]) \ 1489 && (((val)->s6_addr[6] & (msk)->s6_addr[6]) == (asr)->s6_addr[6]) \ 1490 && (((val)->s6_addr[7] & (msk)->s6_addr[7]) == (asr)->s6_addr[7]) \ 1491 && (((val)->s6_addr[8] & (msk)->s6_addr[8]) == (asr)->s6_addr[8]) \ 1492 && (((val)->s6_addr[9] & (msk)->s6_addr[9]) == (asr)->s6_addr[9]) \ 1493 && (((val)->s6_addr[10] & (msk)->s6_addr[10]) == (asr)->s6_addr[10]) \ 1494 && (((val)->s6_addr[11] & (msk)->s6_addr[11]) == (asr)->s6_addr[11]) \ 1495 && (((val)->s6_addr[12] & (msk)->s6_addr[12]) == (asr)->s6_addr[12]) \ 1496 && (((val)->s6_addr[13] & (msk)->s6_addr[13]) == (asr)->s6_addr[13]) \ 1497 && (((val)->s6_addr[14] & (msk)->s6_addr[14]) == (asr)->s6_addr[14]) \ 1498 && (((val)->s6_addr[15] & (msk)->s6_addr[15]) == (asr)->s6_addr[15]) \ 1499 ) 1500 #else /* ! LDAP_PF_INET6 */ 1501 unsigned long a_peername_addr, 1502 a_peername_mask; 1503 #endif /* ! LDAP_PF_INET6 */ 1504 int a_peername_port; 1505 1506 slap_style_t a_sockname_style; 1507 struct berval a_sockname_pat; 1508 1509 slap_style_t a_domain_style; 1510 struct berval a_domain_pat; 1511 int a_domain_expand; 1512 1513 slap_style_t a_sockurl_style; 1514 struct berval a_sockurl_pat; 1515 slap_style_t a_set_style; 1516 struct berval a_set_pat; 1517 1518 #ifdef SLAP_DYNACL 1519 slap_dynacl_t *a_dynacl; 1520 #endif /* SLAP_DYNACL */ 1521 1522 /* ACL Groups */ 1523 slap_style_t a_group_style; 1524 struct berval a_group_pat; 1525 ObjectClass *a_group_oc; 1526 AttributeDescription *a_group_at; 1527 1528 struct Access *a_next; 1529 } Access; 1530 1531 /* the "to" part */ 1532 typedef struct AccessControl { 1533 /* "to" part: the entries this acl applies to */ 1534 Filter *acl_filter; 1535 slap_style_t acl_dn_style; 1536 regex_t acl_dn_re; 1537 struct berval acl_dn_pat; 1538 AttributeName *acl_attrs; 1539 MatchingRule *acl_attrval_mr; 1540 slap_style_t acl_attrval_style; 1541 regex_t acl_attrval_re; 1542 struct berval acl_attrval; 1543 1544 /* "by" part: list of who has what access to the entries */ 1545 Access *acl_access; 1546 1547 struct AccessControl *acl_next; 1548 } AccessControl; 1549 1550 typedef struct AccessControlState { 1551 /* Access state */ 1552 1553 /* The stored state is valid when requesting as_access access 1554 * to the as_desc attributes. */ 1555 AttributeDescription *as_desc; 1556 slap_access_t as_access; 1557 1558 /* Value dependent acl where processing can restart */ 1559 AccessControl *as_vd_acl; 1560 int as_vd_acl_present; 1561 int as_vd_acl_count; 1562 slap_mask_t as_vd_mask; 1563 1564 /* The cached result after evaluating a value independent attr. 1565 * Only valid when != -1 and as_vd_acl == NULL */ 1566 int as_result; 1567 1568 /* True if started to process frontend ACLs */ 1569 int as_fe_done; 1570 } AccessControlState; 1571 #define ACL_STATE_INIT { NULL, ACL_NONE, NULL, 0, 0, ACL_PRIV_NONE, -1, 0 } 1572 1573 typedef struct AclRegexMatches { 1574 int dn_count; 1575 regmatch_t dn_data[MAXREMATCHES]; 1576 int val_count; 1577 regmatch_t val_data[MAXREMATCHES]; 1578 } AclRegexMatches; 1579 1580 /* 1581 * Backend-info 1582 * represents a backend 1583 */ 1584 1585 typedef LDAP_STAILQ_HEAD(BeI, BackendInfo) slap_bi_head; 1586 typedef LDAP_STAILQ_HEAD(BeDB, BackendDB) slap_be_head; 1587 1588 LDAP_SLAPD_V (int) nBackendInfo; 1589 LDAP_SLAPD_V (int) nBackendDB; 1590 LDAP_SLAPD_V (slap_bi_head) backendInfo; 1591 LDAP_SLAPD_V (slap_be_head) backendDB; 1592 LDAP_SLAPD_V (BackendDB *) frontendDB; 1593 1594 LDAP_SLAPD_V (int) slapMode; 1595 #define SLAP_UNDEFINED_MODE 0x0000 1596 #define SLAP_SERVER_MODE 0x0001 1597 #define SLAP_TOOL_MODE 0x0002 1598 #define SLAP_MODE 0x0003 1599 1600 #define SLAP_TRUNCATE_MODE 0x0100 1601 #define SLAP_TOOL_READMAIN 0x0200 1602 #define SLAP_TOOL_READONLY 0x0400 1603 #define SLAP_TOOL_QUICK 0x0800 1604 #define SLAP_TOOL_NO_SCHEMA_CHECK 0x1000 1605 #define SLAP_TOOL_VALUE_CHECK 0x2000 1606 1607 #define SLAP_SERVER_RUNNING 0x8000 1608 1609 #define SB_TLS_DEFAULT (-1) 1610 #define SB_TLS_OFF 0 1611 #define SB_TLS_ON 1 1612 #define SB_TLS_CRITICAL 2 1613 1614 typedef struct slap_keepalive { 1615 int sk_idle; 1616 int sk_probes; 1617 int sk_interval; 1618 } slap_keepalive; 1619 1620 typedef struct slap_bindconf { 1621 struct berval sb_uri; 1622 int sb_version; 1623 int sb_tls; 1624 int sb_method; 1625 int sb_timeout_api; 1626 int sb_timeout_net; 1627 struct berval sb_binddn; 1628 struct berval sb_cred; 1629 struct berval sb_saslmech; 1630 char *sb_secprops; 1631 struct berval sb_realm; 1632 struct berval sb_authcId; 1633 struct berval sb_authzId; 1634 slap_keepalive sb_keepalive; 1635 #ifdef HAVE_TLS 1636 void *sb_tls_ctx; 1637 char *sb_tls_cert; 1638 char *sb_tls_key; 1639 char *sb_tls_cacert; 1640 char *sb_tls_cacertdir; 1641 char *sb_tls_reqcert; 1642 char *sb_tls_reqsan; 1643 char *sb_tls_cipher_suite; 1644 char *sb_tls_protocol_min; 1645 char *sb_tls_ecname; 1646 #ifdef HAVE_OPENSSL_CRL 1647 char *sb_tls_crlcheck; 1648 #endif 1649 int sb_tls_do_init; 1650 #endif 1651 } slap_bindconf; 1652 1653 typedef struct slap_verbmasks { 1654 struct berval word; 1655 const slap_mask_t mask; 1656 } slap_verbmasks; 1657 1658 typedef struct slap_cf_aux_table { 1659 struct berval key; 1660 int off; 1661 char type; 1662 char quote; 1663 void *aux; 1664 } slap_cf_aux_table; 1665 1666 typedef int 1667 slap_cf_aux_table_parse_x LDAP_P(( 1668 struct berval *val, 1669 void *bc, 1670 slap_cf_aux_table *tab0, 1671 const char *tabmsg, 1672 int unparse )); 1673 1674 #define SLAP_LIMIT_TIME 1 1675 #define SLAP_LIMIT_SIZE 2 1676 1677 struct slap_limits_set { 1678 /* time limits */ 1679 int lms_t_soft; 1680 int lms_t_hard; 1681 1682 /* size limits */ 1683 int lms_s_soft; 1684 int lms_s_hard; 1685 int lms_s_unchecked; 1686 int lms_s_pr; 1687 int lms_s_pr_hide; 1688 int lms_s_pr_total; 1689 }; 1690 1691 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */ 1692 #define SLAP_NO_LIMIT -1 1693 #define SLAP_MAX_LIMIT 2147483647 1694 1695 struct slap_limits { 1696 unsigned lm_flags; /* type of pattern */ 1697 /* Values must match lmpats[] in limits.c */ 1698 #define SLAP_LIMITS_UNDEFINED 0x0000U 1699 #define SLAP_LIMITS_EXACT 0x0001U 1700 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT 1701 #define SLAP_LIMITS_ONE 0x0002U 1702 #define SLAP_LIMITS_SUBTREE 0x0003U 1703 #define SLAP_LIMITS_CHILDREN 0x0004U 1704 #define SLAP_LIMITS_REGEX 0x0005U 1705 #define SLAP_LIMITS_ANONYMOUS 0x0006U 1706 #define SLAP_LIMITS_USERS 0x0007U 1707 #define SLAP_LIMITS_ANY 0x0008U 1708 #define SLAP_LIMITS_MASK 0x000FU 1709 1710 #define SLAP_LIMITS_TYPE_SELF 0x0000U 1711 #define SLAP_LIMITS_TYPE_DN SLAP_LIMITS_TYPE_SELF 1712 #define SLAP_LIMITS_TYPE_GROUP 0x0010U 1713 #define SLAP_LIMITS_TYPE_THIS 0x0020U 1714 #define SLAP_LIMITS_TYPE_MASK 0x00F0U 1715 1716 regex_t lm_regex; /* regex data for REGEX */ 1717 1718 /* 1719 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN; 1720 * pattern for REGEX; NULL for ANONYMOUS, USERS 1721 */ 1722 struct berval lm_pat; 1723 1724 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP, 1725 * lm_group_oc is objectClass and lm_group_at is attributeType 1726 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK 1727 * can only be SLAP_LIMITS_EXACT */ 1728 ObjectClass *lm_group_oc; 1729 AttributeDescription *lm_group_ad; 1730 1731 struct slap_limits_set lm_limits; 1732 }; 1733 1734 /* temporary aliases */ 1735 typedef BackendDB Backend; 1736 #define nbackends nBackendDB 1737 #define backends backendDB 1738 1739 /* 1740 * syncinfo structure for syncrepl 1741 */ 1742 1743 struct syncinfo_s; 1744 1745 #define SLAP_SYNC_RID_MAX 999 1746 #define SLAP_SYNC_SID_MAX 4095 /* based on liblutil/csn.c field width */ 1747 1748 /* fake conn connid constructed as rid; real connids start 1749 * at SLAPD_SYNC_CONN_OFFSET */ 1750 #define SLAPD_SYNC_SYNCCONN_OFFSET (SLAP_SYNC_RID_MAX + 1) 1751 #define SLAPD_SYNC_IS_SYNCCONN(connid) ((connid) < SLAPD_SYNC_SYNCCONN_OFFSET) 1752 #define SLAPD_SYNC_RID2SYNCCONN(rid) (rid) 1753 1754 #define SLAP_SYNCUUID_SET_SIZE 256 1755 1756 struct sync_cookie { 1757 BerVarray ctxcsn; 1758 int *sids; 1759 int numcsns; 1760 int rid; 1761 struct berval octet_str; 1762 int sid; 1763 LDAP_STAILQ_ENTRY(sync_cookie) sc_next; 1764 }; 1765 1766 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie ); 1767 1768 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry ); 1769 1770 #ifndef SLAP_MAX_CIDS 1771 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */ 1772 #endif 1773 1774 struct ConfigOCs; /* config.h */ 1775 1776 struct BackendDB { 1777 BackendInfo *bd_info; /* pointer to shared backend info */ 1778 BackendDB *bd_self; /* pointer to this struct */ 1779 1780 /* fields in this structure (and routines acting on this structure) 1781 should be renamed from be_ to bd_ */ 1782 1783 /* BackendInfo accessors */ 1784 #define be_config bd_info->bi_db_config 1785 #define be_type bd_info->bi_type 1786 1787 #define be_bind bd_info->bi_op_bind 1788 #define be_unbind bd_info->bi_op_unbind 1789 #define be_add bd_info->bi_op_add 1790 #define be_compare bd_info->bi_op_compare 1791 #define be_delete bd_info->bi_op_delete 1792 #define be_modify bd_info->bi_op_modify 1793 #define be_modrdn bd_info->bi_op_modrdn 1794 #define be_search bd_info->bi_op_search 1795 #define be_abandon bd_info->bi_op_abandon 1796 1797 #define be_extended bd_info->bi_extended 1798 #define be_cancel bd_info->bi_op_cancel 1799 1800 #define be_chk_referrals bd_info->bi_chk_referrals 1801 #define be_chk_controls bd_info->bi_chk_controls 1802 #define be_fetch bd_info->bi_entry_get_rw 1803 #define be_release bd_info->bi_entry_release_rw 1804 #define be_group bd_info->bi_acl_group 1805 #define be_attribute bd_info->bi_acl_attribute 1806 #define be_operational bd_info->bi_operational 1807 1808 /* 1809 * define to honor hasSubordinates operational attribute in search filters 1810 * (in previous use there was a flaw with back-bdb; now it is fixed). 1811 */ 1812 #define be_has_subordinates bd_info->bi_has_subordinates 1813 1814 #define be_connection_init bd_info->bi_connection_init 1815 #define be_connection_destroy bd_info->bi_connection_destroy 1816 1817 #ifdef SLAPD_TOOLS 1818 #define be_entry_open bd_info->bi_tool_entry_open 1819 #define be_entry_close bd_info->bi_tool_entry_close 1820 #define be_entry_first bd_info->bi_tool_entry_first 1821 #define be_entry_first_x bd_info->bi_tool_entry_first_x 1822 #define be_entry_next bd_info->bi_tool_entry_next 1823 #define be_entry_reindex bd_info->bi_tool_entry_reindex 1824 #define be_entry_get bd_info->bi_tool_entry_get 1825 #define be_entry_put bd_info->bi_tool_entry_put 1826 #define be_sync bd_info->bi_tool_sync 1827 #define be_dn2id_get bd_info->bi_tool_dn2id_get 1828 #define be_entry_modify bd_info->bi_tool_entry_modify 1829 #endif 1830 1831 /* supported controls */ 1832 /* note: set to 0 if the database does not support the control; 1833 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */ 1834 char be_ctrls[SLAP_MAX_CIDS + 1]; 1835 1836 /* Database flags */ 1837 #define SLAP_DBFLAG_NOLASTMOD 0x0001U 1838 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U 1839 #define SLAP_DBFLAG_HIDDEN 0x0004U 1840 #define SLAP_DBFLAG_ONE_SUFFIX 0x0008U 1841 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */ 1842 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */ 1843 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */ 1844 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */ 1845 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */ 1846 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */ 1847 #define SLAP_DBFLAG_DYNAMIC 0x0400U /* this db allows dynamicObjects */ 1848 #define SLAP_DBFLAG_MONITORING 0x0800U /* custom monitoring enabled */ 1849 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */ 1850 #define SLAP_DBFLAG_SINGLE_SHADOW 0x4000U /* a single-provider shadow */ 1851 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */ 1852 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */ 1853 #define SLAP_DBFLAG_SHADOW_MASK (SLAP_DBFLAG_SHADOW|SLAP_DBFLAG_SINGLE_SHADOW|SLAP_DBFLAG_SYNC_SHADOW|SLAP_DBFLAG_SLURP_SHADOW) 1854 #define SLAP_DBFLAG_CLEAN 0x10000U /* was cleanly shutdown */ 1855 #define SLAP_DBFLAG_ACL_ADD 0x20000U /* check attr ACLs on adds */ 1856 #define SLAP_DBFLAG_SYNC_SUBENTRY 0x40000U /* use subentry for context */ 1857 #define SLAP_DBFLAG_MULTI_SHADOW 0x80000U /* uses multi-provider */ 1858 slap_mask_t be_flags; 1859 #define SLAP_DBFLAGS(be) ((be)->be_flags) 1860 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD) 1861 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be)) 1862 #define SLAP_DBHIDDEN(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_HIDDEN) 1863 #define SLAP_DB_ONE_SUFFIX(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_ONE_SUFFIX) 1864 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY) 1865 #define SLAP_ISGLOBALOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY) 1866 #define SLAP_DBMONITORING(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_MONITORING) 1867 #define SLAP_NO_SCHEMA_CHECK(be) \ 1868 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK) 1869 #define SLAP_GLUE_INSTANCE(be) \ 1870 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE) 1871 #define SLAP_GLUE_SUBORDINATE(be) \ 1872 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE) 1873 #define SLAP_GLUE_LINKED(be) \ 1874 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED) 1875 #define SLAP_GLUE_ADVERTISE(be) \ 1876 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE) 1877 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW) 1878 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW) 1879 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW) 1880 #define SLAP_SINGLE_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SINGLE_SHADOW) 1881 #define SLAP_MULTIMASTER(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_MULTI_SHADOW) 1882 #define SLAP_DBCLEAN(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_CLEAN) 1883 #define SLAP_DBACL_ADD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_ACL_ADD) 1884 #define SLAP_SYNC_SUBENTRY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SUBENTRY) 1885 1886 slap_mask_t be_restrictops; /* restriction operations */ 1887 #define SLAP_RESTRICT_OP_ADD 0x0001U 1888 #define SLAP_RESTRICT_OP_BIND 0x0002U 1889 #define SLAP_RESTRICT_OP_COMPARE 0x0004U 1890 #define SLAP_RESTRICT_OP_DELETE 0x0008U 1891 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U 1892 #define SLAP_RESTRICT_OP_MODIFY 0x0020U 1893 #define SLAP_RESTRICT_OP_RENAME 0x0040U 1894 #define SLAP_RESTRICT_OP_SEARCH 0x0080U 1895 #define SLAP_RESTRICT_OP_MASK 0x00FFU 1896 1897 #define SLAP_RESTRICT_READONLY 0x80000000U 1898 1899 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U 1900 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U 1901 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U 1902 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U 1903 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U 1904 1905 #define SLAP_RESTRICT_OP_READS \ 1906 ( SLAP_RESTRICT_OP_COMPARE \ 1907 | SLAP_RESTRICT_OP_SEARCH ) 1908 #define SLAP_RESTRICT_OP_WRITES \ 1909 ( SLAP_RESTRICT_OP_ADD \ 1910 | SLAP_RESTRICT_OP_DELETE \ 1911 | SLAP_RESTRICT_OP_MODIFY \ 1912 | SLAP_RESTRICT_OP_RENAME ) 1913 #define SLAP_RESTRICT_OP_ALL \ 1914 ( SLAP_RESTRICT_OP_READS \ 1915 | SLAP_RESTRICT_OP_WRITES \ 1916 | SLAP_RESTRICT_OP_BIND \ 1917 | SLAP_RESTRICT_OP_EXTENDED ) 1918 1919 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */ 1920 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */ 1921 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */ 1922 1923 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */ 1924 #define SLAP_ALLOW_PROXY_AUTHZ_ANON 0x0010U /* allow anonymous proxyAuthz */ 1925 1926 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */ 1927 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */ 1928 1929 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */ 1930 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */ 1931 1932 #define SLAP_DISALLOW_PROXY_AUTHZ_N_CRIT 0x0100U 1933 #define SLAP_DISALLOW_DONTUSECOPY_N_CRIT 0x0200U 1934 1935 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U 1936 1937 slap_mask_t be_requires; /* pre-operation requirements */ 1938 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */ 1939 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */ 1940 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */ 1941 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */ 1942 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */ 1943 1944 /* Required Security Strength Factor */ 1945 slap_ssf_set_t be_ssf_set; 1946 1947 BerVarray be_suffix; /* the DN suffixes of data in this backend */ 1948 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */ 1949 struct berval be_schemadn; /* per-backend subschema subentry DN */ 1950 struct berval be_schemandn; /* normalized subschema DN */ 1951 struct berval be_rootdn; /* the magic "root" name (DN) for this db */ 1952 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */ 1953 struct berval be_rootpw; /* the magic "root" password for this db */ 1954 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */ 1955 #define be_sizelimit be_def_limit.lms_s_soft 1956 #define be_timelimit be_def_limit.lms_t_soft 1957 struct slap_limits_set be_def_limit; /* default limits */ 1958 struct slap_limits **be_limits; /* regex-based size and time limits */ 1959 AccessControl *be_acl; /* access control list for this backend */ 1960 slap_access_t be_dfltaccess; /* access given if no acl matches */ 1961 AttributeName *be_extra_anlist; /* attributes that need to be added to search requests (ITS#6513) */ 1962 1963 /* Consumer Information */ 1964 struct berval be_update_ndn; /* allowed to make changes (in replicas) */ 1965 BerVarray be_update_refs; /* where to refer modifying clients to */ 1966 struct be_pcl *be_pending_csn_list; 1967 ldap_pvt_thread_mutex_t be_pcl_mutex; 1968 struct syncinfo_s *be_syncinfo; /* For syncrepl */ 1969 1970 void *be_pb; /* Netscape plugin */ 1971 struct ConfigOCs *be_cf_ocs; 1972 1973 void *be_private; /* anything the backend database needs */ 1974 LDAP_STAILQ_ENTRY(BackendDB) be_next; 1975 }; 1976 1977 /* Backend function typedefs */ 1978 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi)); 1979 typedef BI_bi_func BI_init; 1980 typedef BI_bi_func BI_open; 1981 typedef BI_bi_func BI_close; 1982 typedef BI_bi_func BI_destroy; 1983 typedef int (BI_config) LDAP_P((BackendInfo *bi, 1984 const char *fname, int lineno, 1985 int argc, char **argv)); 1986 1987 typedef struct config_reply_s ConfigReply; /* config.h */ 1988 typedef int (BI_db_func) LDAP_P((Backend *bd, ConfigReply *cr)); 1989 typedef BI_db_func BI_db_init; 1990 typedef BI_db_func BI_db_open; 1991 typedef BI_db_func BI_db_close; 1992 typedef BI_db_func BI_db_destroy; 1993 typedef int (BI_db_config) LDAP_P((Backend *bd, 1994 const char *fname, int lineno, 1995 int argc, char **argv)); 1996 1997 typedef struct req_bind_s { 1998 int rb_method; 1999 struct berval rb_cred; 2000 struct berval rb_edn; 2001 slap_ssf_t rb_ssf; 2002 struct berval rb_mech; 2003 } req_bind_s; 2004 2005 typedef struct req_search_s { 2006 int rs_scope; 2007 int rs_deref; 2008 int rs_slimit; 2009 int rs_tlimit; 2010 /* NULL means be_isroot evaluated to TRUE */ 2011 struct slap_limits_set *rs_limit; 2012 int rs_attrsonly; 2013 AttributeName *rs_attrs; 2014 Filter *rs_filter; 2015 struct berval rs_filterstr; 2016 } req_search_s; 2017 2018 typedef struct req_compare_s { 2019 AttributeAssertion *rs_ava; 2020 } req_compare_s; 2021 2022 typedef struct req_modifications_s { 2023 Modifications *rs_modlist; 2024 char rs_no_opattrs; /* don't att modify operational attrs */ 2025 } req_modifications_s; 2026 2027 typedef struct req_modify_s { 2028 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */ 2029 int rs_increment; 2030 } req_modify_s; 2031 2032 typedef struct req_modrdn_s { 2033 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */ 2034 int rs_deleteoldrdn; 2035 struct berval rs_newrdn; 2036 struct berval rs_nnewrdn; 2037 struct berval *rs_newSup; 2038 struct berval *rs_nnewSup; 2039 } req_modrdn_s; 2040 2041 typedef struct req_add_s { 2042 Modifications *rs_modlist; 2043 Entry *rs_e; 2044 } req_add_s; 2045 2046 typedef struct req_abandon_s { 2047 ber_int_t rs_msgid; 2048 } req_abandon_s; 2049 2050 #ifdef SLAP_SCHEMA_EXPOSE 2051 #define SLAP_EXOP_HIDE 0x0000 2052 #else 2053 #define SLAP_EXOP_HIDE 0x8000 2054 #endif 2055 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */ 2056 2057 typedef struct req_extended_s { 2058 struct berval rs_reqoid; 2059 int rs_flags; 2060 struct berval *rs_reqdata; 2061 } req_extended_s; 2062 2063 typedef struct req_pwdexop_s { 2064 struct req_extended_s rs_extended; 2065 struct berval rs_old; 2066 struct berval rs_new; 2067 Modifications *rs_mods; 2068 Modifications **rs_modtail; 2069 } req_pwdexop_s; 2070 2071 typedef enum slap_reply_e { 2072 REP_RESULT, 2073 REP_SASL, 2074 REP_EXTENDED, 2075 REP_SEARCH, 2076 REP_SEARCHREF, 2077 REP_INTERMEDIATE, 2078 REP_GLUE_RESULT 2079 } slap_reply_t; 2080 2081 typedef struct rep_sasl_s { 2082 struct berval *r_sasldata; 2083 } rep_sasl_s; 2084 2085 typedef struct rep_extended_s { 2086 const char *r_rspoid; 2087 struct berval *r_rspdata; 2088 } rep_extended_s; 2089 2090 typedef struct rep_search_s { 2091 Entry *r_entry; 2092 slap_mask_t r_attr_flags; 2093 #define SLAP_ATTRS_UNDEFINED (0x00U) 2094 #define SLAP_OPATTRS_NO (0x01U) 2095 #define SLAP_OPATTRS_YES (0x02U) 2096 #define SLAP_USERATTRS_NO (0x10U) 2097 #define SLAP_USERATTRS_YES (0x20U) 2098 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES)) 2099 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES) 2100 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES)) 2101 #define SLAP_USERATTRS(f) \ 2102 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES) 2103 2104 Attribute *r_operational_attrs; 2105 AttributeName *r_attrs; 2106 int r_nentries; 2107 BerVarray r_v2ref; 2108 } rep_search_s; 2109 2110 struct SlapReply { 2111 slap_reply_t sr_type; 2112 ber_tag_t sr_tag; 2113 ber_int_t sr_msgid; 2114 ber_int_t sr_err; 2115 const char *sr_matched; 2116 const char *sr_text; 2117 BerVarray sr_ref; 2118 LDAPControl **sr_ctrls; 2119 union sr_u { 2120 rep_search_s sru_search; 2121 rep_sasl_s sru_sasl; 2122 rep_extended_s sru_extended; 2123 } sr_un; 2124 slap_mask_t sr_flags; 2125 #define REP_ENTRY_MODIFIABLE ((slap_mask_t) 0x0001U) 2126 #define REP_ENTRY_MUSTBEFREED ((slap_mask_t) 0x0002U) 2127 #define REP_ENTRY_MUSTRELEASE ((slap_mask_t) 0x0004U) 2128 #define REP_ENTRY_MASK (REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTFLUSH) 2129 #define REP_ENTRY_MUSTFLUSH (REP_ENTRY_MUSTBEFREED|REP_ENTRY_MUSTRELEASE) 2130 2131 #define REP_MATCHED_MUSTBEFREED ((slap_mask_t) 0x0010U) 2132 #define REP_MATCHED_MASK (REP_MATCHED_MUSTBEFREED) 2133 2134 #define REP_REF_MUSTBEFREED ((slap_mask_t) 0x0020U) 2135 #define REP_REF_MASK (REP_REF_MUSTBEFREED) 2136 2137 #define REP_CTRLS_MUSTBEFREED ((slap_mask_t) 0x0040U) 2138 #define REP_CTRLS_MASK (REP_CTRLS_MUSTBEFREED) 2139 2140 #define REP_NO_ENTRYDN ((slap_mask_t) 0x1000U) 2141 #define REP_NO_SUBSCHEMA ((slap_mask_t) 0x2000U) 2142 #define REP_NO_OPERATIONALS (REP_NO_ENTRYDN|REP_NO_SUBSCHEMA) 2143 }; 2144 2145 /* short hands for response members */ 2146 #define sr_attrs sr_un.sru_search.r_attrs 2147 #define sr_entry sr_un.sru_search.r_entry 2148 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs 2149 #define sr_attr_flags sr_un.sru_search.r_attr_flags 2150 #define sr_v2ref sr_un.sru_search.r_v2ref 2151 #define sr_nentries sr_un.sru_search.r_nentries 2152 #define sr_rspoid sr_un.sru_extended.r_rspoid 2153 #define sr_rspdata sr_un.sru_extended.r_rspdata 2154 #define sr_sasldata sr_un.sru_sasl.r_sasldata 2155 2156 typedef int (BI_op_func) LDAP_P(( Operation *op, SlapReply *rs )); 2157 typedef BI_op_func BI_op_bind; 2158 typedef BI_op_func BI_op_unbind; 2159 typedef BI_op_func BI_op_search; 2160 typedef BI_op_func BI_op_compare; 2161 typedef BI_op_func BI_op_modify; 2162 typedef BI_op_func BI_op_modrdn; 2163 typedef BI_op_func BI_op_add; 2164 typedef BI_op_func BI_op_delete; 2165 typedef BI_op_func BI_op_abandon; 2166 typedef BI_op_func BI_op_extended; 2167 typedef BI_op_func BI_op_cancel; 2168 typedef BI_op_func BI_chk_referrals; 2169 typedef BI_op_func BI_chk_controls; 2170 typedef int (BI_entry_release_rw) 2171 LDAP_P(( Operation *op, Entry *e, int rw )); 2172 typedef int (BI_entry_get_rw) LDAP_P(( Operation *op, struct berval *ndn, 2173 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e )); 2174 typedef int (BI_operational) LDAP_P(( Operation *op, SlapReply *rs )); 2175 typedef int (BI_has_subordinates) LDAP_P(( Operation *op, 2176 Entry *e, int *hasSubs )); 2177 typedef int (BI_access_allowed) LDAP_P(( Operation *op, Entry *e, 2178 AttributeDescription *desc, struct berval *val, slap_access_t access, 2179 AccessControlState *state, slap_mask_t *maskp )); 2180 typedef int (BI_acl_group) LDAP_P(( Operation *op, Entry *target, 2181 struct berval *gr_ndn, struct berval *op_ndn, 2182 ObjectClass *group_oc, AttributeDescription *group_at )); 2183 typedef int (BI_acl_attribute) LDAP_P(( Operation *op, Entry *target, 2184 struct berval *entry_ndn, AttributeDescription *entry_at, 2185 BerVarray *vals, slap_access_t access )); 2186 2187 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, Connection *c )); 2188 typedef BI_conn_func BI_connection_init; 2189 typedef BI_conn_func BI_connection_destroy; 2190 2191 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode )); 2192 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be )); 2193 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be )); 2194 typedef ID (BI_tool_entry_first_x) LDAP_P(( BackendDB *be, struct berval *base, int scope, Filter *f )); 2195 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be )); 2196 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id )); 2197 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e, 2198 struct berval *text )); 2199 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id, AttributeDescription **adv )); 2200 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be )); 2201 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn )); 2202 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e, 2203 struct berval *text )); 2204 2205 struct BackendInfo { 2206 char *bi_type; /* type of backend */ 2207 2208 /* 2209 * per backend type routines: 2210 * bi_init: called to allocate a backend_info structure, 2211 * called once BEFORE configuration file is read. 2212 * bi_init() initializes this structure hence is 2213 * called directly from be_initialize() 2214 * bi_config: called per 'backend' specific option 2215 * all such options must before any 'database' options 2216 * bi_config() is called only from read_config() 2217 * bi_open: called to open each database, called 2218 * once AFTER configuration file is read but 2219 * BEFORE any bi_db_open() calls. 2220 * bi_open() is called from backend_startup() 2221 * bi_close: called to close each database, called 2222 * once during shutdown after all bi_db_close calls. 2223 * bi_close() is called from backend_shutdown() 2224 * bi_destroy: called to destroy each database, called 2225 * once during shutdown after all bi_db_destroy calls. 2226 * bi_destory() is called from backend_destroy() 2227 */ 2228 BI_init *bi_init; 2229 BI_config *bi_config; 2230 BI_open *bi_open; 2231 BI_close *bi_close; 2232 BI_destroy *bi_destroy; 2233 2234 /* 2235 * per database routines: 2236 * bi_db_init: called to initialize each database, 2237 * called upon reading 'database <type>' 2238 * called only from backend_db_init() 2239 * bi_db_config: called to configure each database, 2240 * called per database to handle per database options 2241 * called only from read_config() 2242 * bi_db_open: called to open each database 2243 * called once per database immediately AFTER bi_open() 2244 * calls but before daemon startup. 2245 * called only by backend_startup() 2246 * bi_db_close: called to close each database 2247 * called once per database during shutdown but BEFORE 2248 * any bi_close call. 2249 * called only by backend_shutdown() 2250 * bi_db_destroy: called to destroy each database 2251 * called once per database during shutdown AFTER all 2252 * bi_close calls but before bi_destory calls. 2253 * called only by backend_destory() 2254 */ 2255 BI_db_init *bi_db_init; 2256 BI_db_config *bi_db_config; 2257 BI_db_open *bi_db_open; 2258 BI_db_close *bi_db_close; 2259 BI_db_destroy *bi_db_destroy; 2260 2261 /* LDAP Operations Handling Routines */ 2262 BI_op_bind *bi_op_bind; 2263 BI_op_unbind *bi_op_unbind; 2264 BI_op_search *bi_op_search; 2265 BI_op_compare *bi_op_compare; 2266 BI_op_modify *bi_op_modify; 2267 BI_op_modrdn *bi_op_modrdn; 2268 BI_op_add *bi_op_add; 2269 BI_op_delete *bi_op_delete; 2270 BI_op_abandon *bi_op_abandon; 2271 2272 /* Extended Operations Helper */ 2273 BI_op_extended *bi_extended; 2274 BI_op_cancel *bi_op_cancel; 2275 2276 /* Auxilary Functions */ 2277 BI_operational *bi_operational; 2278 BI_chk_referrals *bi_chk_referrals; 2279 BI_chk_controls *bi_chk_controls; 2280 BI_entry_get_rw *bi_entry_get_rw; 2281 BI_entry_release_rw *bi_entry_release_rw; 2282 2283 BI_has_subordinates *bi_has_subordinates; 2284 BI_access_allowed *bi_access_allowed; 2285 BI_acl_group *bi_acl_group; 2286 BI_acl_attribute *bi_acl_attribute; 2287 2288 BI_connection_init *bi_connection_init; 2289 BI_connection_destroy *bi_connection_destroy; 2290 2291 /* hooks for slap tools */ 2292 BI_tool_entry_open *bi_tool_entry_open; 2293 BI_tool_entry_close *bi_tool_entry_close; 2294 BI_tool_entry_first *bi_tool_entry_first; /* deprecated */ 2295 BI_tool_entry_first_x *bi_tool_entry_first_x; 2296 BI_tool_entry_next *bi_tool_entry_next; 2297 BI_tool_entry_get *bi_tool_entry_get; 2298 BI_tool_entry_put *bi_tool_entry_put; 2299 BI_tool_entry_reindex *bi_tool_entry_reindex; 2300 BI_tool_sync *bi_tool_sync; 2301 BI_tool_dn2id_get *bi_tool_dn2id_get; 2302 BI_tool_entry_modify *bi_tool_entry_modify; 2303 2304 #define SLAP_INDEX_ADD_OP 0x0001 2305 #define SLAP_INDEX_DELETE_OP 0x0002 2306 2307 slap_mask_t bi_flags; /* backend flags */ 2308 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */ 2309 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */ 2310 #define SLAP_BFLAG_FRONTEND 0x0004U /* the frontendDB */ 2311 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U 2312 #define SLAP_BFLAG_INCREMENT 0x0100U 2313 #define SLAP_BFLAG_ALIASES 0x1000U 2314 #define SLAP_BFLAG_REFERRALS 0x2000U 2315 #define SLAP_BFLAG_SUBENTRIES 0x4000U 2316 #define SLAP_BFLAG_DYNAMIC 0x8000U 2317 2318 /* overlay specific */ 2319 #define SLAPO_BFLAG_SINGLE 0x01000000U 2320 #define SLAPO_BFLAG_DBONLY 0x02000000U 2321 #define SLAPO_BFLAG_GLOBONLY 0x04000000U 2322 #define SLAPO_BFLAG_MASK 0xFF000000U 2323 2324 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags) 2325 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR) 2326 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG) 2327 #define SLAP_FRONTEND(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND) 2328 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT) 2329 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES) 2330 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS) 2331 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES) 2332 #define SLAP_DYNAMIC(be) ((SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC) || (SLAP_DBFLAGS(be) & SLAP_DBFLAG_DYNAMIC)) 2333 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD) 2334 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be)) 2335 2336 /* overlay specific */ 2337 #define SLAPO_SINGLE(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_SINGLE) 2338 #define SLAPO_DBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_DBONLY) 2339 #define SLAPO_GLOBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_GLOBONLY) 2340 2341 char **bi_controls; /* supported controls */ 2342 char bi_ctrls[SLAP_MAX_CIDS + 1]; 2343 2344 unsigned int bi_nDB; /* number of databases of this type */ 2345 struct ConfigOCs *bi_cf_ocs; 2346 char **bi_obsolete_names; 2347 void *bi_extra; /* backend type-specific APIs */ 2348 void *bi_private; /* backend type-specific config data */ 2349 LDAP_STAILQ_ENTRY(BackendInfo) bi_next ; 2350 }; 2351 2352 #define c_authtype c_authz.sai_method 2353 #define c_authmech c_authz.sai_mech 2354 #define c_dn c_authz.sai_dn 2355 #define c_ndn c_authz.sai_ndn 2356 #define c_ssf c_authz.sai_ssf 2357 #define c_transport_ssf c_authz.sai_transport_ssf 2358 #define c_tls_ssf c_authz.sai_tls_ssf 2359 #define c_sasl_ssf c_authz.sai_sasl_ssf 2360 2361 #define o_authtype o_authz.sai_method 2362 #define o_authmech o_authz.sai_mech 2363 #define o_dn o_authz.sai_dn 2364 #define o_ndn o_authz.sai_ndn 2365 #define o_ssf o_authz.sai_ssf 2366 #define o_transport_ssf o_authz.sai_transport_ssf 2367 #define o_tls_ssf o_authz.sai_tls_ssf 2368 #define o_sasl_ssf o_authz.sai_sasl_ssf 2369 2370 typedef int (slap_response)( Operation *, SlapReply * ); 2371 2372 struct slap_callback; 2373 typedef void (slap_writewait)( Operation *, struct slap_callback * ); 2374 2375 typedef struct slap_callback { 2376 struct slap_callback *sc_next; 2377 slap_response *sc_response; 2378 slap_response *sc_cleanup; 2379 void *sc_private; 2380 slap_writewait *sc_writewait; 2381 } slap_callback; 2382 2383 struct slap_overinfo; 2384 2385 typedef enum slap_operation_e { 2386 op_bind = 0, 2387 op_unbind, 2388 op_search, 2389 op_compare, 2390 op_modify, 2391 op_modrdn, 2392 op_add, 2393 op_delete, 2394 op_abandon, 2395 op_extended, 2396 op_cancel, 2397 op_aux_operational, 2398 op_aux_chk_referrals, 2399 op_aux_chk_controls, 2400 op_last 2401 } slap_operation_t; 2402 2403 typedef struct slap_overinst { 2404 BackendInfo on_bi; 2405 slap_response *on_response; 2406 struct slap_overinfo *on_info; 2407 struct slap_overinst *on_next; 2408 } slap_overinst; 2409 2410 typedef struct slap_overinfo { 2411 BackendInfo oi_bi; 2412 BackendInfo *oi_orig; 2413 BackendDB *oi_origdb; 2414 struct slap_overinst *oi_list; 2415 } slap_overinfo; 2416 2417 /* Should successive callbacks in a chain be processed? */ 2418 #define SLAP_CB_BYPASS 0x08800 2419 #define SLAP_CB_CONTINUE 0x08000 2420 2421 /* 2422 * Paged Results state 2423 */ 2424 typedef unsigned long PagedResultsCookie; 2425 typedef struct PagedResultsState { 2426 Backend *ps_be; 2427 ber_int_t ps_size; 2428 int ps_count; 2429 PagedResultsCookie ps_cookie; 2430 struct berval ps_cookieval; 2431 } PagedResultsState; 2432 2433 struct slap_csn_entry { 2434 Operation *ce_op; 2435 struct berval ce_csn; 2436 int ce_sid; 2437 #define SLAP_CSN_PENDING 1 2438 #define SLAP_CSN_COMMIT 2 2439 long ce_state; 2440 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link; 2441 }; 2442 2443 /* 2444 * Caches the result of a backend_group check for ACL evaluation 2445 */ 2446 typedef struct GroupAssertion { 2447 struct GroupAssertion *ga_next; 2448 Backend *ga_be; 2449 ObjectClass *ga_oc; 2450 AttributeDescription *ga_at; 2451 int ga_res; 2452 ber_len_t ga_len; 2453 char ga_ndn[1]; 2454 } GroupAssertion; 2455 2456 struct slap_control_ids { 2457 int sc_LDAPsync; 2458 int sc_assert; 2459 int sc_domainScope; 2460 int sc_dontUseCopy; 2461 int sc_manageDSAit; 2462 int sc_modifyIncrement; 2463 int sc_noOp; 2464 int sc_pagedResults; 2465 int sc_permissiveModify; 2466 int sc_postRead; 2467 int sc_preRead; 2468 int sc_proxyAuthz; 2469 int sc_relax; 2470 int sc_searchOptions; 2471 #ifdef SLAP_CONTROL_X_SORTEDRESULTS 2472 int sc_sortedResults; 2473 #endif 2474 int sc_subentries; 2475 #ifdef SLAP_CONTROL_X_TREE_DELETE 2476 int sc_treeDelete; 2477 #endif 2478 #ifdef LDAP_X_TXN 2479 int sc_txnSpec; 2480 #endif 2481 #ifdef SLAP_CONTROL_X_SESSION_TRACKING 2482 int sc_sessionTracking; 2483 #endif 2484 int sc_valuesReturnFilter; 2485 #ifdef SLAP_CONTROL_X_WHATFAILED 2486 int sc_whatFailed; 2487 #endif 2488 }; 2489 2490 /* 2491 * Operation indices 2492 */ 2493 typedef enum { 2494 SLAP_OP_BIND = 0, 2495 SLAP_OP_UNBIND, 2496 SLAP_OP_SEARCH, 2497 SLAP_OP_COMPARE, 2498 SLAP_OP_MODIFY, 2499 SLAP_OP_MODRDN, 2500 SLAP_OP_ADD, 2501 SLAP_OP_DELETE, 2502 SLAP_OP_ABANDON, 2503 SLAP_OP_EXTENDED, 2504 SLAP_OP_LAST 2505 } slap_op_t; 2506 2507 typedef struct slap_counters_t { 2508 struct slap_counters_t *sc_next; 2509 ldap_pvt_thread_mutex_t sc_mutex; 2510 ldap_pvt_mp_t sc_bytes; 2511 ldap_pvt_mp_t sc_pdu; 2512 ldap_pvt_mp_t sc_entries; 2513 ldap_pvt_mp_t sc_refs; 2514 2515 ldap_pvt_mp_t sc_ops_completed; 2516 ldap_pvt_mp_t sc_ops_initiated; 2517 #ifdef SLAPD_MONITOR 2518 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST]; 2519 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST]; 2520 #endif /* SLAPD_MONITOR */ 2521 } slap_counters_t; 2522 2523 /* 2524 * represents an operation pending from an ldap client 2525 */ 2526 typedef struct Opheader { 2527 unsigned long oh_opid; /* id of this operation */ 2528 unsigned long oh_connid; /* id of conn initiating this op */ 2529 Connection *oh_conn; /* connection spawning this op */ 2530 2531 ber_int_t oh_msgid; /* msgid of the request */ 2532 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */ 2533 2534 ldap_pvt_thread_t oh_tid; /* thread handling this op */ 2535 2536 void *oh_threadctx; /* thread pool thread context */ 2537 void *oh_tmpmemctx; /* slab malloc context */ 2538 BerMemoryFunctions *oh_tmpmfuncs; 2539 2540 slap_counters_t *oh_counters; 2541 2542 char oh_log_prefix[ /* sizeof("conn= op=") + 2*LDAP_PVT_INTTYPE_CHARS(unsigned long) */ SLAP_TEXT_BUFLEN ]; 2543 2544 #ifdef LDAP_SLAPI 2545 void *oh_extensions; /* NS-SLAPI plugin */ 2546 #endif 2547 } Opheader; 2548 2549 typedef union OpRequest { 2550 req_add_s oq_add; 2551 req_bind_s oq_bind; 2552 req_compare_s oq_compare; 2553 req_modify_s oq_modify; 2554 req_modrdn_s oq_modrdn; 2555 req_search_s oq_search; 2556 req_abandon_s oq_abandon; 2557 req_abandon_s oq_cancel; 2558 req_extended_s oq_extended; 2559 req_pwdexop_s oq_pwdexop; 2560 } OpRequest; 2561 2562 /* This is only a header. Actual users should define their own 2563 * structs with the oe_next / oe_key fields at the top and 2564 * whatever else they need following. 2565 */ 2566 typedef struct OpExtra { 2567 LDAP_SLIST_ENTRY(OpExtra) oe_next; 2568 void *oe_key; 2569 } OpExtra; 2570 2571 typedef struct OpExtraDB { 2572 OpExtra oe; 2573 BackendDB *oe_db; 2574 } OpExtraDB; 2575 2576 struct Operation { 2577 Opheader *o_hdr; 2578 2579 #define o_opid o_hdr->oh_opid 2580 #define o_connid o_hdr->oh_connid 2581 #define o_conn o_hdr->oh_conn 2582 #define o_msgid o_hdr->oh_msgid 2583 #define o_protocol o_hdr->oh_protocol 2584 #define o_tid o_hdr->oh_tid 2585 #define o_threadctx o_hdr->oh_threadctx 2586 #define o_tmpmemctx o_hdr->oh_tmpmemctx 2587 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs 2588 #define o_counters o_hdr->oh_counters 2589 2590 #define o_tmpalloc o_tmpmfuncs->bmf_malloc 2591 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc 2592 #define o_tmprealloc o_tmpmfuncs->bmf_realloc 2593 #define o_tmpfree o_tmpmfuncs->bmf_free 2594 2595 #define o_log_prefix o_hdr->oh_log_prefix 2596 2597 ber_tag_t o_tag; /* tag of the request */ 2598 time_t o_time; /* time op was initiated */ 2599 int o_tincr; /* counter for multiple ops with same o_time */ 2600 2601 BackendDB *o_bd; /* backend DB processing this op */ 2602 struct berval o_req_dn; /* DN of target of request */ 2603 struct berval o_req_ndn; 2604 2605 OpRequest o_request; 2606 2607 /* short hands for union members */ 2608 #define oq_add o_request.oq_add 2609 #define oq_bind o_request.oq_bind 2610 #define oq_compare o_request.oq_compare 2611 #define oq_modify o_request.oq_modify 2612 #define oq_modrdn o_request.oq_modrdn 2613 #define oq_search o_request.oq_search 2614 #define oq_abandon o_request.oq_abandon 2615 #define oq_cancel o_request.oq_cancel 2616 #define oq_extended o_request.oq_extended 2617 #define oq_pwdexop o_request.oq_pwdexop 2618 2619 /* short hands for inner request members */ 2620 #define orb_method oq_bind.rb_method 2621 #define orb_cred oq_bind.rb_cred 2622 #define orb_edn oq_bind.rb_edn 2623 #define orb_ssf oq_bind.rb_ssf 2624 #define orb_mech oq_bind.rb_mech 2625 2626 #define ors_scope oq_search.rs_scope 2627 #define ors_deref oq_search.rs_deref 2628 #define ors_slimit oq_search.rs_slimit 2629 #define ors_tlimit oq_search.rs_tlimit 2630 #define ors_limit oq_search.rs_limit 2631 #define ors_attrsonly oq_search.rs_attrsonly 2632 #define ors_attrs oq_search.rs_attrs 2633 #define ors_filter oq_search.rs_filter 2634 #define ors_filterstr oq_search.rs_filterstr 2635 2636 #define orr_modlist oq_modrdn.rs_mods.rs_modlist 2637 #define orr_no_opattrs oq_modrdn.rs_mods.rs_no_opattrs 2638 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn 2639 #define orr_newrdn oq_modrdn.rs_newrdn 2640 #define orr_nnewrdn oq_modrdn.rs_nnewrdn 2641 #define orr_newSup oq_modrdn.rs_newSup 2642 #define orr_nnewSup oq_modrdn.rs_nnewSup 2643 2644 #define orc_ava oq_compare.rs_ava 2645 2646 #define ora_e oq_add.rs_e 2647 #define ora_modlist oq_add.rs_modlist 2648 2649 #define orn_msgid oq_abandon.rs_msgid 2650 2651 #define orm_modlist oq_modify.rs_mods.rs_modlist 2652 #define orm_no_opattrs oq_modify.rs_mods.rs_no_opattrs 2653 #define orm_increment oq_modify.rs_increment 2654 2655 #define ore_reqoid oq_extended.rs_reqoid 2656 #define ore_flags oq_extended.rs_flags 2657 #define ore_reqdata oq_extended.rs_reqdata 2658 volatile sig_atomic_t o_abandon; /* abandon flag */ 2659 volatile sig_atomic_t o_cancel; /* cancel flag */ 2660 #define SLAP_CANCEL_NONE 0x00 2661 #define SLAP_CANCEL_REQ 0x01 2662 #define SLAP_CANCEL_ACK 0x02 2663 #define SLAP_CANCEL_DONE 0x03 2664 2665 GroupAssertion *o_groups; 2666 char o_do_not_cache; /* don't cache groups from this op */ 2667 char o_is_auth_check; /* authorization in progress */ 2668 char o_dont_replicate; 2669 slap_access_t o_acl_priv; 2670 2671 char o_nocaching; 2672 char o_delete_glue_parent; 2673 char o_no_schema_check; 2674 #define get_no_schema_check(op) ((op)->o_no_schema_check) 2675 char o_no_subordinate_glue; 2676 #define get_no_subordinate_glue(op) ((op)->o_no_subordinate_glue) 2677 2678 #define SLAP_CONTROL_NONE 0 2679 #define SLAP_CONTROL_IGNORED 1 2680 #define SLAP_CONTROL_NONCRITICAL 2 2681 #define SLAP_CONTROL_CRITICAL 3 2682 #define SLAP_CONTROL_MASK 3 2683 2684 /* spare bits for simple flags */ 2685 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */ 2686 #define SLAP_CONTROL_DATA0 0x10 2687 #define SLAP_CONTROL_DATA1 0x20 2688 #define SLAP_CONTROL_DATA2 0x40 2689 #define SLAP_CONTROL_DATA3 0x80 2690 2691 #define _SCM(x) ((x) & SLAP_CONTROL_MASK) 2692 2693 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */ 2694 void **o_controls; /* per-control state */ 2695 2696 #define o_dontUseCopy o_ctrlflag[slap_cids.sc_dontUseCopy] 2697 #define get_dontUseCopy(op) _SCM((op)->o_dontUseCopy) 2698 2699 #define o_relax o_ctrlflag[slap_cids.sc_relax] 2700 #define get_relax(op) _SCM((op)->o_relax) 2701 2702 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit] 2703 #define get_manageDSAit(op) _SCM((op)->o_managedsait) 2704 2705 #define o_noop o_ctrlflag[slap_cids.sc_noOp] 2706 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz] 2707 #define o_subentries o_ctrlflag[slap_cids.sc_subentries] 2708 2709 #define get_subentries(op) _SCM((op)->o_subentries) 2710 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries] 2711 2712 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0) 2713 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0) 2714 2715 #define o_assert o_ctrlflag[slap_cids.sc_assert] 2716 #define get_assert(op) ((int)(op)->o_assert) 2717 #define o_assertion o_controls[slap_cids.sc_assert] 2718 #define get_assertion(op) ((op)->o_assertion) 2719 2720 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter] 2721 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter] 2722 2723 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify] 2724 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify) 2725 2726 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope] 2727 #define get_domainScope(op) ((int)(op)->o_domain_scope) 2728 2729 #ifdef SLAP_CONTROL_X_TREE_DELETE 2730 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete] 2731 #define get_treeDelete(op) ((int)(op)->o_tree_delete) 2732 #endif 2733 2734 #define o_preread o_ctrlflag[slap_cids.sc_preRead] 2735 #define o_postread o_ctrlflag[slap_cids.sc_postRead] 2736 2737 #define o_preread_attrs o_controls[slap_cids.sc_preRead] 2738 #define o_postread_attrs o_controls[slap_cids.sc_postRead] 2739 2740 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults] 2741 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults] 2742 #define get_pagedresults(op) ((int)(op)->o_pagedresults) 2743 2744 #ifdef SLAP_CONTROL_X_SORTEDRESULTS 2745 #define o_sortedresults o_ctrlflag[slap_cids.sc_sortedResults] 2746 #endif 2747 2748 #ifdef LDAP_X_TXN 2749 #define o_txnSpec o_ctrlflag[slap_cids.sc_txnSpec] 2750 #endif 2751 2752 #ifdef SLAP_CONTROL_X_SESSION_TRACKING 2753 #define o_session_tracking o_ctrlflag[slap_cids.sc_sessionTracking] 2754 #define o_tracked_sessions o_controls[slap_cids.sc_sessionTracking] 2755 #define get_sessionTracking(op) ((int)(op)->o_session_tracking) 2756 #endif 2757 2758 #ifdef SLAP_CONTROL_X_WHATFAILED 2759 #define o_whatFailed o_ctrlflag[slap_cids.sc_whatFailed] 2760 #define get_whatFailed(op) _SCM((op)->o_whatFailed) 2761 #endif 2762 2763 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync] 2764 2765 AuthorizationInformation o_authz; 2766 2767 BerElement *o_ber; /* ber of the request */ 2768 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */ 2769 slap_callback *o_callback; /* callback pointers */ 2770 LDAPControl **o_ctrls; /* controls */ 2771 struct berval o_csn; 2772 2773 /* DEPRECATE o_private - use o_extra instead */ 2774 void *o_private; /* anything the backend needs */ 2775 LDAP_SLIST_HEAD(o_e, OpExtra) o_extra; /* anything the backend needs */ 2776 2777 LDAP_STAILQ_ENTRY(Operation) o_next; /* next operation in list */ 2778 }; 2779 2780 typedef struct OperationBuffer { 2781 Operation ob_op; 2782 Opheader ob_hdr; 2783 void *ob_controls[SLAP_MAX_CIDS]; 2784 } OperationBuffer; 2785 2786 #define send_ldap_error( op, rs, err, text ) do { \ 2787 (rs)->sr_err = err; (rs)->sr_text = text; \ 2788 ((op)->o_conn->c_send_ldap_result)( op, rs ); \ 2789 } while (0) 2790 #define send_ldap_discon( op, rs, err, text ) do { \ 2791 (rs)->sr_err = err; (rs)->sr_text = text; \ 2792 send_ldap_disconnect( op, rs ); \ 2793 } while (0) 2794 2795 typedef void (SEND_LDAP_RESULT)( 2796 Operation *op, SlapReply *rs); 2797 typedef int (SEND_SEARCH_ENTRY)( 2798 Operation *op, SlapReply *rs); 2799 typedef int (SEND_SEARCH_REFERENCE)( 2800 Operation *op, SlapReply *rs); 2801 typedef void (SEND_LDAP_EXTENDED)( 2802 Operation *op, SlapReply *rs); 2803 typedef void (SEND_LDAP_INTERMEDIATE)( 2804 Operation *op, SlapReply *rs); 2805 2806 #define send_ldap_result( op, rs ) \ 2807 ((op)->o_conn->c_send_ldap_result)( op, rs ) 2808 #define send_search_entry( op, rs ) \ 2809 ((op)->o_conn->c_send_search_entry)( op, rs ) 2810 #define send_search_reference( op, rs ) \ 2811 ((op)->o_conn->c_send_search_reference)( op, rs ) 2812 #define send_ldap_extended( op, rs ) \ 2813 ((op)->o_conn->c_send_ldap_extended)( op, rs ) 2814 #define send_ldap_intermediate( op, rs ) \ 2815 ((op)->o_conn->c_send_ldap_intermediate)( op, rs ) 2816 2817 typedef struct Listener Listener; 2818 2819 /* 2820 * represents a connection from an ldap client 2821 */ 2822 /* structure state (protected by connections_mutex) */ 2823 enum sc_struct_state { 2824 SLAP_C_UNINITIALIZED = 0, /* MUST BE ZERO (0) */ 2825 SLAP_C_UNUSED, 2826 SLAP_C_USED, 2827 SLAP_C_PENDING 2828 }; 2829 2830 /* connection state (protected by c_mutex ) */ 2831 enum sc_conn_state { 2832 SLAP_C_INVALID = 0, /* MUST BE ZERO (0) */ 2833 SLAP_C_INACTIVE, /* zero threads */ 2834 SLAP_C_CLOSING, /* closing */ 2835 SLAP_C_ACTIVE, /* one or more threads */ 2836 SLAP_C_BINDING, /* binding */ 2837 SLAP_C_CLIENT /* outbound client conn */ 2838 }; 2839 struct Connection { 2840 enum sc_struct_state c_struct_state; /* structure management state */ 2841 enum sc_conn_state c_conn_state; /* connection state */ 2842 int c_conn_idx; /* slot in connections array */ 2843 ber_socket_t c_sd; 2844 const char *c_close_reason; /* why connection is closing */ 2845 2846 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */ 2847 Sockbuf *c_sb; /* ber connection stuff */ 2848 2849 /* only can be changed by connect_init */ 2850 time_t c_starttime; /* when the connection was opened */ 2851 time_t c_activitytime; /* when the connection was last used */ 2852 unsigned long c_connid; /* id of this connection for stats*/ 2853 2854 struct berval c_peer_domain; /* DNS name of client */ 2855 struct berval c_peer_name; /* peer name (trans=addr:port) */ 2856 Listener *c_listener; 2857 #define c_listener_url c_listener->sl_url /* listener URL */ 2858 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */ 2859 2860 /* only can be changed by binding thread */ 2861 struct berval c_sasl_bind_mech; /* mech in progress */ 2862 struct berval c_sasl_dn; /* temporary storage */ 2863 struct berval c_sasl_authz_dn; /* SASL proxy authz */ 2864 2865 /* authorization backend */ 2866 Backend *c_authz_backend; 2867 void *c_authz_cookie; 2868 #define SLAP_IS_AUTHZ_BACKEND( op ) \ 2869 ( (op)->o_bd != NULL \ 2870 && (op)->o_bd->be_private != NULL \ 2871 && (op)->o_conn != NULL \ 2872 && (op)->o_conn->c_authz_backend != NULL \ 2873 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \ 2874 || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) ) 2875 2876 AuthorizationInformation c_authz; 2877 2878 ber_int_t c_protocol; /* version of the LDAP protocol used by client */ 2879 2880 LDAP_STAILQ_HEAD(c_o, Operation) c_ops; /* list of operations being processed */ 2881 LDAP_STAILQ_HEAD(c_po, Operation) c_pending_ops; /* list of pending operations */ 2882 2883 ldap_pvt_thread_mutex_t c_write1_mutex; /* only one pdu written at a time */ 2884 ldap_pvt_thread_cond_t c_write1_cv; /* only one pdu written at a time */ 2885 ldap_pvt_thread_mutex_t c_write2_mutex; /* used to wait for sd write-ready */ 2886 ldap_pvt_thread_cond_t c_write2_cv; /* used to wait for sd write-ready*/ 2887 2888 BerElement *c_currentber; /* ber we're attempting to read */ 2889 int c_writers; /* number of writers waiting */ 2890 char c_writing; /* someone is writing */ 2891 2892 char c_sasl_bind_in_progress; /* multi-op bind in progress */ 2893 char c_writewaiter; /* true if blocked on write */ 2894 2895 2896 #define CONN_IS_TLS 1 2897 #define CONN_IS_UDP 2 2898 #define CONN_IS_CLIENT 4 2899 #define CONN_IS_IPC 8 2900 2901 #ifdef LDAP_CONNECTIONLESS 2902 char c_is_udp; /* true if this is (C)LDAP over UDP */ 2903 #endif 2904 #ifdef HAVE_TLS 2905 char c_is_tls; /* true if this LDAP over raw TLS */ 2906 char c_needs_tls_accept; /* true if SSL_accept should be called */ 2907 #endif 2908 char c_sasl_layers; /* true if we need to install SASL i/o handlers */ 2909 char c_sasl_done; /* SASL completed once */ 2910 void *c_sasl_authctx; /* SASL authentication context */ 2911 void *c_sasl_sockctx; /* SASL security layer context */ 2912 void *c_sasl_extra; /* SASL session extra stuff */ 2913 Operation *c_sasl_bindop; /* set to current op if it's a bind */ 2914 2915 #ifdef LDAP_X_TXN 2916 #define CONN_TXN_INACTIVE 0 2917 #define CONN_TXN_SPECIFY 1 2918 #define CONN_TXN_SETTLE -1 2919 int c_txn; 2920 2921 Backend *c_txn_backend; 2922 LDAP_STAILQ_HEAD(c_to, Operation) c_txn_ops; /* list of operations in txn */ 2923 #endif 2924 2925 PagedResultsState c_pagedresults_state; /* paged result state */ 2926 2927 long c_n_ops_received; /* num of ops received (next op_id) */ 2928 long c_n_ops_executing; /* num of ops currently executing */ 2929 long c_n_ops_pending; /* num of ops pending execution */ 2930 long c_n_ops_completed; /* num of ops completed */ 2931 2932 long c_n_get; /* num of get calls */ 2933 long c_n_read; /* num of read calls */ 2934 long c_n_write; /* num of write calls */ 2935 2936 void *c_extensions; /* Netscape plugin */ 2937 2938 /* 2939 * Client connection handling 2940 */ 2941 ldap_pvt_thread_start_t *c_clientfunc; 2942 void *c_clientarg; 2943 2944 /* 2945 * These are the "callbacks" that are available for back-ends to 2946 * supply data back to connected clients that are connected 2947 * through the "front-end". 2948 */ 2949 SEND_LDAP_RESULT *c_send_ldap_result; 2950 SEND_SEARCH_ENTRY *c_send_search_entry; 2951 SEND_SEARCH_REFERENCE *c_send_search_reference; 2952 SEND_LDAP_EXTENDED *c_send_ldap_extended; 2953 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate; 2954 }; 2955 2956 #ifdef LDAP_DEBUG 2957 #ifdef LDAP_SYSLOG 2958 #ifdef LOG_LOCAL4 2959 #define SLAP_DEFAULT_SYSLOG_USER LOG_LOCAL4 2960 #endif /* LOG_LOCAL4 */ 2961 2962 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \ 2963 Log5( (level), ldap_syslog_level, (fmt), (connid), (opid), (arg1), (arg2), (arg3) ) 2964 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level)) 2965 #else /* !LDAP_SYSLOG */ 2966 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \ 2967 do { \ 2968 if ( ldap_debug & (level) ) \ 2969 lutil_debug( ldap_debug, (level), (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\ 2970 } while (0) 2971 #define StatslogTest( level ) (ldap_debug & (level)) 2972 #endif /* !LDAP_SYSLOG */ 2973 #else /* !LDAP_DEBUG */ 2974 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) ((void) 0) 2975 #define StatslogTest( level ) (0) 2976 #endif /* !LDAP_DEBUG */ 2977 2978 /* 2979 * listener; need to access it from monitor backend 2980 */ 2981 struct Listener { 2982 struct berval sl_url; 2983 struct berval sl_name; 2984 mode_t sl_perms; 2985 #ifdef HAVE_TLS 2986 int sl_is_tls; 2987 #endif 2988 #ifdef LDAP_CONNECTIONLESS 2989 int sl_is_udp; /* UDP listener is also data port */ 2990 #endif 2991 int sl_mute; /* Listener is temporarily disabled due to emfile */ 2992 int sl_busy; /* Listener is busy (accept thread activated) */ 2993 ber_socket_t sl_sd; 2994 Sockaddr sl_sa; 2995 #define sl_addr sl_sa.sa_in_addr 2996 #ifdef LDAP_DEVEL 2997 #define LDAP_TCP_BUFFER 2998 #endif 2999 #ifdef LDAP_TCP_BUFFER 3000 int sl_tcp_rmem; /* custom TCP read buffer size */ 3001 int sl_tcp_wmem; /* custom TCP write buffer size */ 3002 #endif 3003 }; 3004 3005 /* 3006 * Better know these all around slapd 3007 */ 3008 #define SLAP_LDAPDN_PRETTY 0x1 3009 #define SLAP_LDAPDN_MAXLEN 8192 3010 3011 /* number of response controls supported */ 3012 #define SLAP_MAX_RESPONSE_CONTROLS 6 3013 3014 #ifdef SLAP_SCHEMA_EXPOSE 3015 #define SLAP_CTRL_HIDE 0x00000000U 3016 #else 3017 #define SLAP_CTRL_HIDE 0x80000000U 3018 #endif 3019 3020 #define SLAP_CTRL_REQUIRES_ROOT 0x40000000U /* for Relax */ 3021 3022 #define SLAP_CTRL_GLOBAL 0x00800000U 3023 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */ 3024 3025 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU 3026 #define SLAP_CTRL_ABANDON 0x00000001U 3027 #define SLAP_CTRL_ADD 0x00002002U 3028 #define SLAP_CTRL_BIND 0x00000004U 3029 #define SLAP_CTRL_COMPARE 0x00001008U 3030 #define SLAP_CTRL_DELETE 0x00002010U 3031 #define SLAP_CTRL_MODIFY 0x00002020U 3032 #define SLAP_CTRL_RENAME 0x00002040U 3033 #define SLAP_CTRL_SEARCH 0x00001080U 3034 #define SLAP_CTRL_UNBIND 0x00000100U 3035 3036 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH) 3037 #define SLAP_CTRL_UPDATE \ 3038 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME) 3039 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE) 3040 3041 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P(( 3042 Operation *op, 3043 SlapReply *rs, 3044 LDAPControl *ctrl )); 3045 3046 typedef int (*SLAP_ENTRY_INFO_FN) LDAP_P(( void *arg, Entry *e )); 3047 3048 #define SLAP_SLAB_SIZE (1024*1024) 3049 #define SLAP_SLAB_STACK 1 3050 3051 #define SLAP_ZONE_ALLOC 1 3052 #undef SLAP_ZONE_ALLOC 3053 3054 #ifdef LDAP_COMP_MATCH 3055 /* 3056 * Extensible Filter Definition 3057 * 3058 * MatchingRuleAssertion := SEQUENCE { 3059 * matchingRule [1] MatchingRuleId OPTIONAL, 3060 * type [2] AttributeDescription OPTIONAL, 3061 * matchValue [3] AssertionValue, 3062 * dnAttributes [4] BOOLEAN DEFAULT FALSE } 3063 * 3064 * Following ComponentFilter is contained in matchValue 3065 * 3066 * ComponentAssertion ::= SEQUENCE { 3067 * component ComponentReference (SIZE(1..MAX)) OPTIONAL 3068 * useDefaultValues BOOLEAN DEFAULT TRUE, 3069 * rule MATCHING-RULE.&id, 3070 * value MATCHING-RULE.&AssertionType } 3071 * 3072 * ComponentFilter ::= CHOICE { 3073 * item [0] ComponentAssertion, 3074 * and [1] SEQUENCE OF ComponentFilter, 3075 * or [2] SEQUENCE OF ComponentFilter, 3076 * not [3] ComponentFilter } 3077 */ 3078 3079 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U) 3080 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U) 3081 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U) 3082 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U) 3083 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U) 3084 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U) 3085 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U) 3086 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U) 3087 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U) 3088 3089 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U) 3090 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U) 3091 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U) 3092 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U) 3093 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U) 3094 3095 typedef struct ComponentId ComponentId; 3096 typedef struct ComponentReference ComponentReference; 3097 typedef struct ComponentAssertion ComponentAssertion; 3098 typedef struct ComponentAssertionValue ComponentAssertionValue; 3099 typedef struct ComponentSyntaxInfo ComponentSyntaxInfo; 3100 typedef struct ComponentDesc ComponentDesc; 3101 3102 struct ComponentData { 3103 void *cd_mem_op; /* nibble memory handler */ 3104 ComponentSyntaxInfo** cd_tree; /* component tree */ 3105 }; 3106 3107 struct ComponentId { 3108 int ci_type; 3109 ComponentId *ci_next; 3110 3111 union comp_id_value{ 3112 BerValue ci_identifier; 3113 ber_int_t ci_from_beginning; 3114 ber_int_t ci_count; 3115 ber_int_t ci_from_end; 3116 ber_int_t ci_content; 3117 BerValue ci_select_value; 3118 char ci_all; 3119 } ci_val; 3120 }; 3121 3122 struct ComponentReference { 3123 ComponentId *cr_list; 3124 ComponentId *cr_curr; 3125 struct berval cr_string; 3126 int cr_len; 3127 /* Component Indexing */ 3128 int cr_asn_type_id; 3129 slap_mask_t cr_indexmask; 3130 AttributeDescription* cr_ad; 3131 BerVarray cr_nvals; 3132 ComponentReference* cr_next; 3133 }; 3134 3135 struct ComponentAssertion { 3136 ComponentReference *ca_comp_ref; 3137 ber_int_t ca_use_def; 3138 MatchingRule *ca_ma_rule; 3139 struct berval ca_ma_value; 3140 ComponentData ca_comp_data; /* componentized assertion */ 3141 ComponentFilter *ca_cf; 3142 MatchingRuleAssertion *ca_mra; 3143 }; 3144 3145 struct ComponentFilter { 3146 ber_tag_t cf_choice; 3147 union cf_un_u { 3148 ber_int_t cf_un_result; 3149 ComponentAssertion *cf_un_ca; 3150 ComponentFilter *cf_un_complex; 3151 } cf_un; 3152 3153 #define cf_ca cf_un.cf_un_ca 3154 #define cf_result cf_un.cf_un_result 3155 #define cf_and cf_un.cf_un_complex 3156 #define cf_or cf_un.cf_un_complex 3157 #define cf_not cf_un.cf_un_complex 3158 #define cf_any cf_un.cf_un_complex 3159 3160 ComponentFilter *cf_next; 3161 }; 3162 3163 struct ComponentAssertionValue { 3164 char* cav_buf; 3165 char* cav_ptr; 3166 char* cav_end; 3167 }; 3168 3169 typedef int encoder_func LDAP_P(( 3170 void* b, 3171 void* comp)); 3172 3173 typedef int gser_decoder_func LDAP_P(( 3174 void* mem_op, 3175 void* b, 3176 ComponentSyntaxInfo** comp_syn_info, 3177 int* len, 3178 int mode)); 3179 3180 typedef int comp_free_func LDAP_P(( 3181 void* b)); 3182 3183 typedef int ber_decoder_func LDAP_P(( 3184 void* mem_op, 3185 void* b, 3186 int tag, 3187 int elmtLen, 3188 ComponentSyntaxInfo* comp_syn_info, 3189 int* len, 3190 int mode)); 3191 3192 typedef int ber_tag_decoder_func LDAP_P(( 3193 void* mem_op, 3194 void* b, 3195 ComponentSyntaxInfo* comp_syn_info, 3196 int* len, 3197 int mode)); 3198 3199 typedef void* extract_component_from_id_func LDAP_P(( 3200 void* mem_op, 3201 ComponentReference* cr, 3202 void* comp )); 3203 3204 typedef void* convert_attr_to_comp_func LDAP_P (( 3205 Attribute* a, 3206 Syntax* syn, 3207 struct berval* bv )); 3208 3209 typedef void* alloc_nibble_func LDAP_P (( 3210 int initial_size, 3211 int increment_size )); 3212 3213 typedef void free_nibble_func LDAP_P (( 3214 void* nm )); 3215 3216 typedef void convert_assert_to_comp_func LDAP_P (( 3217 void *mem_op, 3218 ComponentSyntaxInfo* csi_attr, 3219 struct berval* bv, 3220 ComponentSyntaxInfo** csi, 3221 int* len, 3222 int mode )); 3223 3224 typedef int convert_asn_to_ldap_func LDAP_P (( 3225 ComponentSyntaxInfo* csi, 3226 struct berval *bv )); 3227 3228 typedef void free_component_func LDAP_P (( 3229 void* mem_op)); 3230 3231 typedef int test_component_func LDAP_P (( 3232 void* attr_mem_op, 3233 void* assert_mem_op, 3234 ComponentSyntaxInfo* csi, 3235 ComponentAssertion* ca)); 3236 3237 typedef void* test_membership_func LDAP_P (( 3238 void* in )); 3239 3240 typedef void* get_component_info_func LDAP_P (( 3241 int in )); 3242 3243 typedef int component_encoder_func LDAP_P (( 3244 void* mem_op, 3245 ComponentSyntaxInfo* csi, 3246 struct berval* nvals )); 3247 3248 typedef int allcomponent_matching_func LDAP_P(( 3249 char* oid, 3250 ComponentSyntaxInfo* comp1, 3251 ComponentSyntaxInfo* comp)); 3252 3253 struct ComponentDesc { 3254 /* Don't change the order of following four fields */ 3255 int cd_tag; 3256 AttributeType *cd_comp_type; 3257 struct berval cd_ad_type; /* ad_type, ad_cname */ 3258 struct berval cd_ad_cname; /* ad_type, ad_cname */ 3259 unsigned cd_flags; /* ad_flags */ 3260 int cd_type; 3261 int cd_type_id; 3262 encoder_func *cd_ldap_encoder; 3263 encoder_func *cd_gser_encoder; 3264 encoder_func *cd_ber_encoder; 3265 gser_decoder_func *cd_gser_decoder; 3266 ber_decoder_func *cd_ber_decoder; 3267 comp_free_func *cd_free; 3268 extract_component_from_id_func* cd_extract_i; 3269 allcomponent_matching_func *cd_all_match; 3270 }; 3271 3272 struct ComponentSyntaxInfo { 3273 Syntax *csi_syntax; 3274 ComponentDesc *csi_comp_desc; 3275 }; 3276 3277 #endif /* LDAP_COMP_MATCH */ 3278 3279 #ifdef SLAP_ZONE_ALLOC 3280 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */ 3281 #define SLAP_ZONE_SHIFT 19 3282 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */ 3283 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */ 3284 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */ 3285 #define SLAP_ZONE_ZOBLOCK 256 3286 3287 struct zone_object { 3288 void *zo_ptr; 3289 int zo_siz; 3290 int zo_idx; 3291 int zo_blockhead; 3292 LDAP_LIST_ENTRY(zone_object) zo_link; 3293 }; 3294 3295 struct zone_latency_history { 3296 double zlh_latency; 3297 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next; 3298 }; 3299 3300 struct zone_heap { 3301 int zh_fd; 3302 int zh_zonesize; 3303 int zh_zoneorder; 3304 int zh_numzones; 3305 int zh_maxzones; 3306 int zh_deltazones; 3307 void **zh_zones; 3308 ldap_pvt_thread_rdwr_t *zh_znlock; 3309 Avlnode *zh_zonetree; 3310 unsigned char ***zh_maps; 3311 int *zh_seqno; 3312 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free; 3313 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool; 3314 ldap_pvt_thread_mutex_t zh_mutex; 3315 ldap_pvt_thread_rdwr_t zh_lock; 3316 double zh_ema_latency; 3317 unsigned long zh_ema_samples; 3318 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history ) 3319 zh_latency_history_queue; 3320 int zh_latency_history_qlen; 3321 int zh_latency_jump; 3322 int zh_swapping; 3323 }; 3324 #endif 3325 3326 #define SLAP_BACKEND_INIT_MODULE(b) \ 3327 static BackendInfo bi; \ 3328 int \ 3329 init_module( int argc, char *argv[] ) \ 3330 { \ 3331 bi.bi_type = #b ; \ 3332 bi.bi_init = b ## _back_initialize; \ 3333 backend_add( &bi ); \ 3334 return 0; \ 3335 } 3336 3337 typedef int (OV_init)(void); 3338 typedef struct slap_oinit_t { 3339 const char *ov_type; 3340 OV_init *ov_init; 3341 } OverlayInit; 3342 3343 LDAP_END_DECL 3344 3345 #include "proto-slap.h" 3346 3347 #endif /* _SLAP_H_ */ 3348