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