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