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