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