git.sur5r.net Git - openldap/blob - servers/slapd/slap.h

   1 /* slap.h - stand alone ldap server include file */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 #ifndef _SLAP_H_
   9 #define _SLAP_H_
  10
  11 #include "ldap_defaults.h"
  12
  13 #include <stdio.h>
  14 #include <ac/stdlib.h>
  15
  16 #include <sys/types.h>
  17 #include <ac/syslog.h>
  18 #include <ac/regex.h>
  19 #include <ac/signal.h>
  20 #include <ac/socket.h>
  21 #include <ac/time.h>
  22 #include <ac/param.h>
  23
  24 #include "avl.h"
  25
  26 #ifndef ldap_debug
  27 #define ldap_debug slap_debug
  28 #endif
  29
  30 #include "ldap_log.h"
  31
  32 #include <ldap.h>
  33 #include <ldap_schema.h>
  34
  35 #include "ldap_pvt_thread.h"
  36 #include "ldap_queue.h"
  37
  38 LDAP_BEGIN_DECL
  39 /*
  40  * SLAPD Memory allocation macros
  41  *
  42  * Unlike ch_*() routines, these routines do not assert() upon
  43  * allocation error.  They are intended to be used instead of
  44  * ch_*() routines where the caller has implemented proper
  45  * checking for and handling of allocation errors.
  46  *
  47  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
  48  */
  49 #define SLAP_MALLOC(s)      ber_memalloc((s))
  50 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
  51 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
  52 #define SLAP_FREE(p)        ber_memfree((p))
  53 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
  54 #define SLAP_STRDUP(s)      ber_strdup((s))
  55 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
  56
  57 #ifdef f_next
  58 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  59 #endif
  60
  61 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
  62 #define SLAPD_ANONYMOUS "cn=anonymous"
  63
  64 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
  65  *
  66  * This is a value used internally by the backends. It is needed to allow
  67  * adding values that already exist without getting an error as required by
  68  * modrdn when the new rdn was already an attribute value itself.
  69  * JCG 05/1999 (gomez@engr.sgi.com)
  70  */
  71 #define SLAP_MOD_SOFTADD        0x1000
  72
  73 #define MAXREMATCHES (100)
  74
  75 #define SLAP_MAX_WORKER_THREADS         (32)
  76
  77 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
  78 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
  79
  80 #define SLAP_TEXT_BUFLEN (256)
  81
  82 /* psuedo error code indicating abandoned operation */
  83 #define SLAPD_ABANDON (-1)
  84
  85 /* psuedo error code indicating disconnect */
  86 #define SLAPD_DISCONNECT (-2)
  87
  88
  89 /* We assume "C" locale, that is US-ASCII */
  90 #define ASCII_SPACE(c)  ( (c) == ' ' )
  91 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
  92 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
  93 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
  94 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
  95 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
  96 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
  97
  98 #define SLAP_NIBBLE(c) ((c)&0x0f)
  99 #define SLAP_ESCAPE_CHAR ('\\')
 100 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
 101 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
 102
 103 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
 104         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
 105
 106 #define DN_ESCAPE(c)    ((c) == SLAP_ESCAPE_CHAR)
 107 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
 108 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
 109 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
 110 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
 111
 112 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
 113 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
 114 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
 115 #define OID_SEPARATOR(c)        ( (c) == '.' )
 116 #define OID_CHAR(c)     ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
 117
 118 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
 119 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || (c) == '.' )
 120
 121 #define AD_LEADCHAR(c)  ( ATTR_CHAR(c) )
 122 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
 123
 124 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
 125
 126 #define SLAP_PRINTABLE(c)       ( ASCII_ALNUM(c) || (c) == '\'' || \
 127         (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
 128         (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
 129         (c) == '?' || (c) == ' ' || (c) == '=' )
 130 #define SLAP_PRINTABLES(c)      ( SLAP_PRINTABLE(c) || (c) == '$' )
 131
 132 /* must match in schema_init.c */
 133 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
 134 #define SLAPD_NAMEUID_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.34"
 135 #define SLAPD_GROUP_ATTR                "member"
 136 #define SLAPD_GROUP_CLASS               "groupOfNames"
 137 #define SLAPD_ROLE_ATTR                 "roleOccupant"
 138 #define SLAPD_ROLE_CLASS                "organizationalRole"
 139
 140 #ifdef SLAPD_ACI_ENABLED
 141 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
 142 #endif
 143
 144 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
 145
 146 /* change this to "OpenLDAPset" */
 147 #define SLAPD_ACI_SET_ATTR              "template"
 148
 149 #define SLAPD_TOP_OID                   "2.5.6.0"
 150
 151 LDAP_SLAPD_V (int) slap_debug;
 152
 153 typedef unsigned long slap_mask_t;
 154
 155 /* Security Strength Factor */
 156 typedef unsigned slap_ssf_t;
 157
 158 typedef struct slap_ssf_set {
 159         slap_ssf_t sss_ssf;
 160         slap_ssf_t sss_transport;
 161         slap_ssf_t sss_tls;
 162         slap_ssf_t sss_sasl;
 163         slap_ssf_t sss_update_ssf;
 164         slap_ssf_t sss_update_transport;
 165         slap_ssf_t sss_update_tls;
 166         slap_ssf_t sss_update_sasl;
 167 } slap_ssf_set_t;
 168
 169 /*
 170  * Index types
 171  */
 172 #define SLAP_INDEX_TYPE           0x00FFUL
 173 #define SLAP_INDEX_UNDEFINED      0x0001UL
 174 #define SLAP_INDEX_PRESENT        0x0002UL
 175 #define SLAP_INDEX_EQUALITY       0x0004UL
 176 #define SLAP_INDEX_APPROX         0x0008UL
 177 #define SLAP_INDEX_SUBSTR         0x0010UL
 178 #define SLAP_INDEX_EXTENDED               0x0020UL
 179
 180 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
 181
 182 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type))
 183
 184 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
 185
 186 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
 187 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
 188 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
 189 #define SLAP_INDEX_SUBSTR_DEFAULT \
 190         ( SLAP_INDEX_SUBSTR \
 191         | SLAP_INDEX_SUBSTR_INITIAL \
 192         | SLAP_INDEX_SUBSTR_ANY \
 193         | SLAP_INDEX_SUBSTR_FINAL )
 194
 195 #define SLAP_INDEX_SUBSTR_MINLEN        2
 196 #define SLAP_INDEX_SUBSTR_MAXLEN        4
 197 #define SLAP_INDEX_SUBSTR_STEP  2
 198
 199 #define SLAP_INDEX_FLAGS         0xF000UL
 200 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
 201 #define SLAP_INDEX_NOLANG        0x2000UL /* don't use index w/ lang */
 202
 203 /*
 204  * there is a single index for each attribute.  these prefixes ensure
 205  * that there is no collision among keys.
 206  */
 207 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
 208 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
 209 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
 210 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
 211 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
 212 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
 213
 214 #define SLAP_SYNTAX_MATCHINGRULES_OID   "1.3.6.1.4.1.1466.115.121.1.30"
 215 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID  "1.3.6.1.4.1.1466.115.121.1.3"
 216 #define SLAP_SYNTAX_OBJECTCLASSES_OID   "1.3.6.1.4.1.1466.115.121.1.37"
 217
 218 /*
 219  * represents schema information for a database
 220  */
 221 #define SLAP_SCHERR_OUTOFMEM            1
 222 #define SLAP_SCHERR_CLASS_NOT_FOUND     2
 223 #define SLAP_SCHERR_CLASS_BAD_USAGE     3
 224 #define SLAP_SCHERR_ATTR_NOT_FOUND      4
 225 #define SLAP_SCHERR_ATTR_BAD_USAGE      5
 226 #define SLAP_SCHERR_DUP_CLASS           6
 227 #define SLAP_SCHERR_DUP_ATTR            7
 228 #define SLAP_SCHERR_DUP_SYNTAX          8
 229 #define SLAP_SCHERR_DUP_RULE            9
 230 #define SLAP_SCHERR_NO_NAME             10
 231 #define SLAP_SCHERR_ATTR_INCOMPLETE     11
 232 #define SLAP_SCHERR_MR_NOT_FOUND        12
 233 #define SLAP_SCHERR_SYN_NOT_FOUND       13
 234 #define SLAP_SCHERR_MR_INCOMPLETE       14
 235 #define SLAP_SCHERR_NOT_SUPPORTED       15
 236 #define SLAP_SCHERR_BAD_DESCR           16
 237 #define SLAP_SCHERR_OIDM                        17
 238 #define SLAP_SCHERR_LAST                        SLAP_SCHERR_OIDM
 239
 240 typedef union slap_sockaddr {
 241         struct sockaddr sa_addr;
 242         struct sockaddr_in sa_in_addr;
 243 #ifdef LDAP_PF_INET6
 244         struct sockaddr_in6 sa_in6_addr;
 245 #endif
 246 #ifdef LDAP_PF_LOCAL
 247         struct sockaddr_un sa_un_addr;
 248 #endif
 249 } Sockaddr;
 250
 251 typedef struct slap_oid_macro {
 252         struct berval som_oid;
 253         char **som_names;
 254         struct slap_oid_macro *som_next;
 255 } OidMacro;
 256
 257 /* forward declarations */
 258 struct slap_syntax;
 259 struct slap_matching_rule;
 260
 261 typedef int slap_syntax_validate_func LDAP_P((
 262         struct slap_syntax *syntax,
 263         struct berval * in));
 264
 265 typedef int slap_syntax_transform_func LDAP_P((
 266         struct slap_syntax *syntax,
 267         struct berval * in,
 268         struct berval * out));
 269
 270 typedef struct slap_syntax {
 271         LDAPSyntax                      ssyn_syn;
 272 #define ssyn_oid                ssyn_syn.syn_oid
 273 #define ssyn_desc               ssyn_syn.syn_desc
 274 #define ssyn_extensions         ssyn_syn.syn_extensions
 275         ber_len_t       ssyn_oidlen;
 276
 277         unsigned int ssyn_flags;
 278
 279 #define SLAP_SYNTAX_NONE        0x0000U
 280 #define SLAP_SYNTAX_BLOB        0x0001U /* syntax treated as blob (audio) */
 281 #define SLAP_SYNTAX_BINARY      0x0002U /* binary transfer required (certificate) */
 282 #define SLAP_SYNTAX_BER         0x0004U /* stored in BER encoding (certificate) */
 283 #define SLAP_SYNTAX_HIDE        0x8000U /* hide (do not publish) */
 284
 285         slap_syntax_validate_func       *ssyn_validate;
 286         slap_syntax_transform_func      *ssyn_normalize;
 287         slap_syntax_transform_func      *ssyn_pretty;
 288
 289 #ifdef SLAPD_BINARY_CONVERSION
 290         /* convert to and from binary */
 291         slap_syntax_transform_func      *ssyn_ber2str;
 292         slap_syntax_transform_func      *ssyn_str2ber;
 293 #endif
 294
 295         struct slap_syntax              *ssyn_next;
 296 } Syntax;
 297
 298 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
 299 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
 300 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
 301 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
 302 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
 303
 304 /* X -> Y Converter */
 305 typedef int slap_mr_convert_func LDAP_P((
 306         struct berval * in,
 307         struct berval * out ));
 308
 309 /* Normalizer */
 310 typedef int slap_mr_normalize_func LDAP_P((
 311         slap_mask_t use,
 312         struct slap_syntax *syntax, /* NULL if in is asserted value */
 313         struct slap_matching_rule *mr,
 314         struct berval * in,
 315         struct berval * out ));
 316
 317 /* Match (compare) function */
 318 typedef int slap_mr_match_func LDAP_P((
 319         int *match,
 320         slap_mask_t use,
 321         struct slap_syntax *syntax,     /* syntax of stored value */
 322         struct slap_matching_rule *mr,
 323         struct berval * value,
 324         void * assertValue ));
 325
 326 /* Index generation function */
 327 typedef int slap_mr_indexer_func LDAP_P((
 328         slap_mask_t use,
 329         slap_mask_t mask,
 330         struct slap_syntax *syntax,     /* syntax of stored value */
 331         struct slap_matching_rule *mr,
 332         struct berval *prefix,
 333         BerVarray values,
 334         BerVarray *keys ));
 335
 336 /* Filter index function */
 337 typedef int slap_mr_filter_func LDAP_P((
 338         slap_mask_t use,
 339         slap_mask_t mask,
 340         struct slap_syntax *syntax,     /* syntax of stored value */
 341         struct slap_matching_rule *mr,
 342         struct berval *prefix,
 343         void * assertValue,
 344         BerVarray *keys ));
 345
 346 typedef struct slap_matching_rule {
 347         LDAPMatchingRule                smr_mrule;
 348         ber_len_t                               smr_oidlen;
 349         slap_mask_t                             smr_usage;
 350
 351 #define SLAP_MR_HIDE                    0x8000U
 352
 353 #define SLAP_MR_TYPE_MASK               0x0F00U
 354 #define SLAP_MR_SUBTYPE_MASK    0x00F0U
 355 #define SLAP_MR_USAGE                   0x000FU
 356
 357 #define SLAP_MR_NONE                    0x0000U
 358 #define SLAP_MR_EQUALITY                0x0100U
 359 #define SLAP_MR_ORDERING                0x0200U
 360 #define SLAP_MR_SUBSTR                  0x0400U
 361 #define SLAP_MR_EXT                             0x0800U
 362
 363 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
 364 #define SLAP_MR_DN_FOLD                 0x0008U
 365
 366 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0010U )
 367 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0020U )
 368 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0040U )
 369
 370 /*
 371  * normally the provided value is expected to conform to
 372  * assertion syntax specified in the matching rule, however
 373  * at times (such as during individual value modification),
 374  * the provided value is expected to conform to the
 375  * attribute's value syntax.
 376  */
 377 #define SLAP_MR_ASSERTION_SYNTAX_MATCH                  0x0000U
 378 #define SLAP_MR_VALUE_SYNTAX_MATCH                              0x0001U
 379 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH    0x0003U
 380
 381 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
 382         (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
 383 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
 384         ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
 385
 386 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
 387         (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
 388                 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
 389 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
 390         (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
 391                 == SLAP_MR_VALUE_SYNTAX_MATCH)
 392
 393         Syntax                                  *smr_syntax;
 394         slap_mr_convert_func    *smr_convert;
 395         slap_mr_normalize_func  *smr_normalize;
 396         slap_mr_match_func              *smr_match;
 397         slap_mr_indexer_func    *smr_indexer;
 398         slap_mr_filter_func             *smr_filter;
 399
 400         struct slap_matching_rule       *smr_associated;
 401         struct slap_matching_rule       *smr_next;
 402
 403 #define smr_oid                         smr_mrule.mr_oid
 404 #define smr_names                       smr_mrule.mr_names
 405 #define smr_desc                        smr_mrule.mr_desc
 406 #define smr_obsolete            smr_mrule.mr_obsolete
 407 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
 408 #define smr_extensions          smr_mrule.mr_extensions
 409 } MatchingRule;
 410
 411 struct slap_backend_db;
 412 struct slap_entry;
 413 struct slap_attr;
 414
 415 typedef int (AttributeTypeSchemaCheckFN)(
 416         struct slap_backend_db *be,
 417         struct slap_entry *e,
 418         struct slap_attr *attr,
 419         const char** text,
 420         char *textbuf, size_t textlen );
 421
 422 typedef struct slap_attribute_type {
 423         LDAPAttributeType               sat_atype;
 424         struct berval                   sat_cname;
 425         struct slap_attribute_type      *sat_sup;
 426         struct slap_attribute_type      **sat_subtypes;
 427         MatchingRule                    *sat_equality;
 428         MatchingRule                    *sat_approx;
 429         MatchingRule                    *sat_ordering;
 430         MatchingRule                    *sat_substr;
 431         Syntax                                  *sat_syntax;
 432
 433         AttributeTypeSchemaCheckFN      *sat_check;
 434
 435 #define SLAP_AT_NONE    0x0000U
 436 #define SLAP_AT_HIDE    0x0001U /* hide attribute */
 437         slap_mask_t                                     sat_flags;
 438
 439         struct slap_attribute_type      *sat_next;
 440
 441 #define sat_oid                         sat_atype.at_oid
 442 #define sat_names                       sat_atype.at_names
 443 #define sat_desc                        sat_atype.at_desc
 444 #define sat_obsolete            sat_atype.at_obsolete
 445 #define sat_sup_oid                     sat_atype.at_sup_oid
 446 #define sat_equality_oid        sat_atype.at_equality_oid
 447 #define sat_ordering_oid        sat_atype.at_ordering_oid
 448 #define sat_substr_oid          sat_atype.at_substr_oid
 449 #define sat_syntax_oid          sat_atype.at_syntax_oid
 450 #define sat_single_value        sat_atype.at_single_value
 451 #define sat_collective          sat_atype.at_collective
 452 #define sat_no_user_mod         sat_atype.at_no_user_mod
 453 #define sat_usage                       sat_atype.at_usage
 454 #define sat_extensions          sat_atype.at_extensions
 455
 456         struct slap_attr_desc           *sat_ad;
 457         ldap_pvt_thread_mutex_t         sat_ad_mutex;
 458 } AttributeType;
 459
 460 #define is_at_operational(at)   ((at)->sat_usage)
 461 #define is_at_single_value(at)  ((at)->sat_single_value)
 462 #define is_at_collective(at)    ((at)->sat_collective)
 463 #define is_at_obsolete(at)              ((at)->sat_obsolete)
 464 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
 465
 466 struct slap_object_class;
 467
 468 typedef int (ObjectClassSchemaCheckFN)(
 469         struct slap_backend_db *be,
 470         struct slap_entry *e,
 471         struct slap_object_class *oc,
 472         const char** text,
 473         char *textbuf, size_t textlen );
 474
 475 typedef struct slap_object_class {
 476         LDAPObjectClass         soc_oclass;
 477         struct slap_object_class        **soc_sups;
 478         AttributeType                           **soc_required;
 479         AttributeType                           **soc_allowed;
 480         ObjectClassSchemaCheckFN        *soc_check;
 481         slap_mask_t                                     soc_flags;
 482 #define soc_oid                         soc_oclass.oc_oid
 483 #define soc_names                       soc_oclass.oc_names
 484 #define soc_desc                        soc_oclass.oc_desc
 485 #define soc_obsolete            soc_oclass.oc_obsolete
 486 #define soc_sup_oids            soc_oclass.oc_sup_oids
 487 #define soc_kind                        soc_oclass.oc_kind
 488 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 489 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 490 #define soc_extensions          soc_oclass.oc_extensions
 491
 492         struct slap_object_class        *soc_next;
 493 } ObjectClass;
 494
 495 #define SLAP_OC_ALIAS           0x01
 496 #define SLAP_OC_REFERRAL        0x02
 497 #define SLAP_OC_SUBENTRY        0x04
 498 #define SLAP_OC_DYNAMICOBJECT   0x08
 499 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x10
 500 #define SLAP_OC__MASK           0x1F
 501 #define SLAP_OC__END            0x20
 502 #define SLAP_OC_HIDE            0x80
 503
 504 #ifdef LDAP_EXTENDED_SCHEMA
 505 /*
 506  * DIT content rule
 507  */
 508 typedef struct slap_content_rule {
 509         LDAPContentRule         scr_crule;
 510         ObjectClass                     *scr_sclass;
 511         ObjectClass                     **scr_auxiliaries;      /* optional */
 512         AttributeType           **scr_required;         /* optional */
 513         AttributeType           **scr_allowed;          /* optional */
 514         AttributeType           **scr_precluded;        /* optional */
 515 #define scr_oid                 scr_crule.cr_oid
 516 #define scr_names               scr_crule.cr_names
 517 #define scr_desc                scr_crule.cr_desc
 518 #define scr_obsolete            soc_oclass.cr_obsolete
 519 #define scr_cr_oids_aux         soc_oclass.cr_oc_oids_aux
 520 #define scr_cr_oids_must        soc_oclass.cr_at_oids_must
 521 #define scr_cr_oids_may         soc_oclass.cr_at_oids_may
 522 #define scr_cr_oids_not         soc_oclass.cr_at_oids_not
 523 } ContentRule;
 524 #endif
 525
 526 /*
 527  * represents a recognized attribute description ( type + options )
 528  */
 529 typedef struct slap_attr_desc {
 530         struct slap_attr_desc *ad_next;
 531         AttributeType *ad_type;         /* attribute type, must be specified */
 532         struct berval ad_cname;         /* canonical name, must be specified */
 533         struct berval ad_lang;          /* empty if no language tags */
 534         unsigned ad_flags;
 535 #define SLAP_DESC_NONE                  0x00U
 536 #define SLAP_DESC_BINARY                0x01U
 537 #define SLAP_DESC_LANG_RANGE    0x80U
 538 } AttributeDescription;
 539
 540 typedef struct slap_attr_name {
 541         struct berval an_name;
 542         AttributeDescription *an_desc;
 543         ObjectClass *an_oc;
 544 } AttributeName;
 545
 546 #define slap_ad_is_lang(ad)                     ( (ad)->ad_lang.bv_len != 0 )
 547 #define slap_ad_is_lang_range(ad)       \
 548         ( ((ad)->ad_flags & SLAP_DESC_LANG_RANGE) ? 1 : 0 )
 549 #define slap_ad_is_binary(ad)           \
 550         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
 551
 552 /*
 553  * pointers to schema elements used internally
 554  */
 555 struct slap_internal_schema {
 556         /* objectClass */
 557         ObjectClass *si_oc_top;
 558         ObjectClass *si_oc_extensibleObject;
 559         ObjectClass *si_oc_alias;
 560         ObjectClass *si_oc_referral;
 561         ObjectClass *si_oc_rootdse;
 562         ObjectClass *si_oc_subentry;
 563         ObjectClass *si_oc_subschema;
 564         ObjectClass *si_oc_monitor;
 565         ObjectClass *si_oc_collectiveAttributeSubentry;
 566         ObjectClass *si_oc_dynamicObject;
 567
 568         /* objectClass attribute descriptions */
 569         AttributeDescription *si_ad_objectClass;
 570
 571         /* operational attribute descriptions */
 572         AttributeDescription *si_ad_structuralObjectClass;
 573         AttributeDescription *si_ad_creatorsName;
 574         AttributeDescription *si_ad_createTimestamp;
 575         AttributeDescription *si_ad_modifiersName;
 576         AttributeDescription *si_ad_modifyTimestamp;
 577         AttributeDescription *si_ad_hasSubordinates;
 578         AttributeDescription *si_ad_subschemaSubentry;
 579         AttributeDescription *si_ad_collectiveSubentries;
 580         AttributeDescription *si_ad_collectiveExclusions;
 581         AttributeDescription *si_ad_entryUUID;
 582         AttributeDescription *si_ad_entryCSN;
 583
 584         /* root DSE attribute descriptions */
 585         AttributeDescription *si_ad_altServer;
 586         AttributeDescription *si_ad_namingContexts;
 587         AttributeDescription *si_ad_supportedControl;
 588         AttributeDescription *si_ad_supportedExtension;
 589         AttributeDescription *si_ad_supportedLDAPVersion;
 590         AttributeDescription *si_ad_supportedSASLMechanisms;
 591         AttributeDescription *si_ad_supportedFeatures;
 592         AttributeDescription *si_ad_vendorName;
 593         AttributeDescription *si_ad_vendorVersion;
 594
 595         /* subentry attribute descriptions */
 596         AttributeDescription *si_ad_administrativeRole;
 597         AttributeDescription *si_ad_subtreeSpecification;
 598
 599         /* subschema subentry attribute descriptions */
 600         AttributeDescription *si_ad_ditStructureRules;
 601         AttributeDescription *si_ad_ditContentRules;
 602         AttributeDescription *si_ad_nameForms;
 603         AttributeDescription *si_ad_objectClasses;
 604         AttributeDescription *si_ad_attributeTypes;
 605         AttributeDescription *si_ad_ldapSyntaxes;
 606         AttributeDescription *si_ad_matchingRules;
 607         AttributeDescription *si_ad_matchingRuleUse;
 608
 609         /* Aliases & Referrals */
 610         AttributeDescription *si_ad_aliasedObjectName;
 611         AttributeDescription *si_ad_ref;
 612
 613         /* Access Control Internals */
 614         AttributeDescription *si_ad_entry;
 615         AttributeDescription *si_ad_children;
 616 #ifdef SLAPD_ACI_ENABLED
 617         AttributeDescription *si_ad_aci;
 618 #endif
 619
 620         /* dynamic entries */
 621         AttributeDescription *si_ad_entryTtl;
 622         AttributeDescription *si_ad_dynamicSubtrees;
 623
 624         /* Other attributes descriptions */
 625         AttributeDescription *si_ad_distinguishedName;
 626         AttributeDescription *si_ad_name;
 627         AttributeDescription *si_ad_cn;
 628         AttributeDescription *si_ad_userPassword;
 629 #ifdef SLAPD_AUTHPASSWD
 630         AttributeDescription *si_ad_authPassword;
 631 #endif
 632 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 633         AttributeDescription *si_ad_krbName;
 634 #endif
 635
 636         /* Undefined Attribute Type */
 637         AttributeType   *si_at_undefined;
 638
 639         /* Matching Rules */
 640         MatchingRule    *si_mr_distinguishedNameMatch;
 641         MatchingRule    *si_mr_integerMatch;
 642
 643         /* Syntaxes */
 644         Syntax          *si_syn_octetString;
 645         Syntax          *si_syn_distinguishedName;
 646         Syntax          *si_syn_integer;
 647 };
 648
 649 typedef struct slap_attr_assertion {
 650         AttributeDescription    *aa_desc;
 651         struct berval aa_value;
 652 } AttributeAssertion;
 653
 654 typedef struct slap_ss_assertion {
 655         AttributeDescription    *sa_desc;
 656         struct berval           sa_initial;
 657         struct berval           *sa_any;
 658         struct berval           sa_final;
 659 } SubstringsAssertion;
 660
 661 typedef struct slap_mr_assertion {
 662         MatchingRule            *ma_rule;       /* optional */
 663         struct berval           ma_rule_text;  /* optional */
 664         AttributeDescription    *ma_desc;       /* optional */
 665         int                                             ma_dnattrs; /* boolean */
 666         struct berval           ma_value;       /* required */
 667 } MatchingRuleAssertion;
 668
 669 /*
 670  * represents a search filter
 671  */
 672 typedef struct slap_filter {
 673         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
 674 #define SLAPD_FILTER_COMPUTED   ((ber_tag_t) -1)
 675 #define SLAPD_FILTER_DN_ONE             ((ber_tag_t) -2)
 676 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
 677
 678         union f_un_u {
 679                 /* precomputed result */
 680                 ber_int_t f_un_result;
 681
 682                 /* DN */
 683                 struct berval *f_un_dn;
 684
 685                 /* present */
 686                 AttributeDescription *f_un_desc;
 687
 688                 /* simple value assertion */
 689                 AttributeAssertion *f_un_ava;
 690
 691                 /* substring assertion */
 692                 SubstringsAssertion *f_un_ssa;
 693
 694                 /* matching rule assertion */
 695                 MatchingRuleAssertion *f_un_mra;
 696
 697 #define f_dn                    f_un.f_un_dn
 698 #define f_desc                  f_un.f_un_desc
 699 #define f_ava                   f_un.f_un_ava
 700 #define f_av_desc               f_un.f_un_ava->aa_desc
 701 #define f_av_value              f_un.f_un_ava->aa_value
 702 #define f_sub                   f_un.f_un_ssa
 703 #define f_sub_desc              f_un.f_un_ssa->sa_desc
 704 #define f_sub_initial   f_un.f_un_ssa->sa_initial
 705 #define f_sub_any               f_un.f_un_ssa->sa_any
 706 #define f_sub_final             f_un.f_un_ssa->sa_final
 707 #define f_mra                   f_un.f_un_mra
 708 #define f_mr_rule               f_un.f_un_mra->ma_rule
 709 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
 710 #define f_mr_desc               f_un.f_un_mra->ma_desc
 711 #define f_mr_value              f_un.f_un_mra->ma_value
 712 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
 713
 714                 /* and, or, not */
 715                 struct slap_filter *f_un_complex;
 716         } f_un;
 717
 718 #define f_result        f_un.f_un_result
 719 #define f_and           f_un.f_un_complex
 720 #define f_or            f_un.f_un_complex
 721 #define f_not           f_un.f_un_complex
 722 #define f_list          f_un.f_un_complex
 723
 724         struct slap_filter      *f_next;
 725 } Filter;
 726
 727 /* compare routines can return undefined */
 728 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
 729
 730 typedef struct slap_valuesreturnfilter {
 731         ber_tag_t       f_choice;
 732
 733         union vrf_un_u {
 734                 /* precomputed result */
 735                 ber_int_t f_un_result;
 736
 737                 /* DN */
 738                 char *f_un_dn;
 739
 740                 /* present */
 741                 AttributeDescription *f_un_desc;
 742
 743                 /* simple value assertion */
 744                 AttributeAssertion *f_un_ava;
 745
 746                 /* substring assertion */
 747                 SubstringsAssertion *f_un_ssa;
 748
 749                 /* matching rule assertion */
 750                 MatchingRuleAssertion *f_un_mra;
 751         } f_un;
 752
 753         struct slap_valuesreturnfilter  *f_next;
 754 } ValuesReturnFilter;
 755
 756 /*
 757  * represents an attribute (description + values)
 758  */
 759 typedef struct slap_attr {
 760         AttributeDescription *a_desc;
 761         BerVarray       a_vals;
 762         struct slap_attr        *a_next;
 763         unsigned a_flags;
 764 #define SLAP_ATTR_IXADD         0x1U
 765 #define SLAP_ATTR_IXDEL         0x2U
 766 } Attribute;
 767
 768
 769 /*
 770  * the id used in the indexes to refer to an entry
 771  */
 772 typedef unsigned long   ID;
 773 #define NOID    ((ID)~0)
 774
 775 /*
 776  * represents an entry in core
 777  */
 778 typedef struct slap_entry {
 779         /*
 780          * The ID field should only be changed before entry is
 781          * inserted into a cache.  The ID value is backend
 782          * specific.
 783          */
 784         ID              e_id;
 785
 786         struct berval e_name;   /* name (DN) of this entry */
 787         struct berval e_nname;  /* normalized name (DN) of this entry */
 788
 789         /* for migration purposes */
 790 #define e_dn e_name.bv_val
 791 #define e_ndn e_nname.bv_val
 792
 793         Attribute       *e_attrs;       /* list of attributes + values */
 794
 795         slap_mask_t     e_ocflags;
 796
 797         struct berval   e_bv;           /* For entry_encode/entry_decode */
 798
 799         /* for use by the backend for any purpose */
 800         void*   e_private;
 801 } Entry;
 802
 803 /*
 804  * A list of LDAPMods
 805  */
 806 typedef struct slap_mod {
 807         int sm_op;
 808         AttributeDescription *sm_desc;
 809         struct berval sm_type;
 810         BerVarray sm_bvalues;
 811 } Modification;
 812
 813 typedef struct slap_mod_list {
 814         Modification sml_mod;
 815 #define sml_op          sml_mod.sm_op
 816 #define sml_desc        sml_mod.sm_desc
 817 #define sml_type        sml_mod.sm_type
 818 #define sml_bvalues     sml_mod.sm_bvalues
 819         struct slap_mod_list *sml_next;
 820 } Modifications;
 821
 822 typedef struct slap_ldap_modlist {
 823         LDAPMod ml_mod;
 824         struct slap_ldap_modlist *ml_next;
 825 #define ml_op           ml_mod.mod_op
 826 #define ml_type         ml_mod.mod_type
 827 #define ml_values       ml_mod.mod_values
 828 #define ml_bvalues      ml_mod.mod_bvalues
 829 } LDAPModList;
 830
 831 /*
 832  * represents an access control list
 833  */
 834 typedef enum slap_access_e {
 835         ACL_INVALID_ACCESS = -1,
 836         ACL_NONE = 0,
 837         ACL_AUTH,
 838         ACL_COMPARE,
 839         ACL_SEARCH,
 840         ACL_READ,
 841         ACL_WRITE
 842 } slap_access_t;
 843
 844 typedef enum slap_control_e {
 845         ACL_INVALID_CONTROL     = 0,
 846         ACL_STOP,
 847         ACL_CONTINUE,
 848         ACL_BREAK
 849 } slap_control_t;
 850
 851 typedef enum slap_style_e {
 852         ACL_STYLE_REGEX = 0,
 853         ACL_STYLE_BASE,
 854         ACL_STYLE_ONE,
 855         ACL_STYLE_SUBTREE,
 856         ACL_STYLE_CHILDREN,
 857         ACL_STYLE_ATTROF,
 858
 859         /* alternate names */
 860         ACL_STYLE_EXACT = ACL_STYLE_BASE
 861 } slap_style_t;
 862
 863 typedef struct slap_authz_info {
 864         ber_tag_t       sai_method;             /* LDAP_AUTH_* from <ldap.h> */
 865         struct berval   sai_mech;               /* SASL Mechanism */
 866         struct berval   sai_dn;                 /* DN for reporting purposes */
 867         struct berval   sai_ndn;                /* Normalized DN */
 868
 869         /* Security Strength Factors */
 870         slap_ssf_t      sai_ssf;                        /* Overall SSF */
 871         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
 872         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
 873         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
 874 } AuthorizationInformation;
 875
 876 /* the "by" part */
 877 typedef struct slap_access {
 878         slap_control_t a_type;
 879
 880 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
 881
 882 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
 883 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
 884 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
 885 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
 886 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
 887 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
 888
 889 #define ACL_PRIV_MASK                   0x00ffUL
 890
 891 /* priv flags */
 892 #define ACL_PRIV_LEVEL                  0x1000UL
 893 #define ACL_PRIV_ADDITIVE               0x2000UL
 894 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
 895
 896 /* invalid privs */
 897 #define ACL_PRIV_INVALID                0x0UL
 898
 899 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
 900 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
 901 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
 902 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
 903
 904 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
 905 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
 906
 907 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
 908
 909 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
 910
 911 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
 912 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
 913 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
 914
 915 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
 916 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
 917 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
 918 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
 919 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
 920 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
 921
 922 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
 923 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
 924 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
 925 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
 926 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
 927 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
 928 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
 929
 930 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
 931 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
 932 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
 933 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
 934 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
 935 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
 936
 937         slap_mask_t     a_access_mask;
 938
 939         AuthorizationInformation        a_authz;
 940 #define a_dn_pat        a_authz.sai_dn
 941
 942         slap_style_t a_dn_style;
 943         AttributeDescription    *a_dn_at;
 944         int                     a_dn_self;
 945         int                     a_dn_expand;
 946
 947         slap_style_t a_peername_style;
 948         struct berval   a_peername_pat;
 949         slap_style_t a_sockname_style;
 950         struct berval   a_sockname_pat;
 951
 952         slap_style_t a_domain_style;
 953         struct berval   a_domain_pat;
 954         int             a_domain_expand;
 955
 956         slap_style_t a_sockurl_style;
 957         struct berval   a_sockurl_pat;
 958         slap_style_t a_set_style;
 959         struct berval   a_set_pat;
 960
 961 #ifdef SLAPD_ACI_ENABLED
 962         AttributeDescription    *a_aci_at;
 963 #endif
 964
 965         /* ACL Groups */
 966         slap_style_t a_group_style;
 967         struct berval   a_group_pat;
 968         ObjectClass                             *a_group_oc;
 969         AttributeDescription    *a_group_at;
 970
 971         struct slap_access      *a_next;
 972 } Access;
 973
 974 /* the "to" part */
 975 typedef struct slap_acl {
 976         /* "to" part: the entries this acl applies to */
 977         Filter          *acl_filter;
 978         slap_style_t acl_dn_style;
 979         regex_t         acl_dn_re;
 980         struct berval   acl_dn_pat;
 981         AttributeName   *acl_attrs;
 982
 983         /* "by" part: list of who has what access to the entries */
 984         Access  *acl_access;
 985
 986         struct slap_acl *acl_next;
 987 } AccessControl;
 988
 989 typedef struct slap_acl_state {
 990         unsigned as_recorded;
 991 #define ACL_STATE_NOT_RECORDED                  0x0
 992 #define ACL_STATE_RECORDED_VD                   0x1
 993 #define ACL_STATE_RECORDED_NV                   0x2
 994 #define ACL_STATE_RECORDED                              0x3
 995
 996         /* Access state */
 997         AccessControl *as_vd_acl;
 998         slap_mask_t as_vd_acl_mask;
 999         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1000         int as_vd_acl_count;
1001
1002         Access *as_vd_access;
1003         int as_vd_access_count;
1004
1005         int as_result;
1006 } AccessControlState;
1007 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, 0UL, { { 0, 0 } }, 0, NULL, 0, 0 }
1008
1009 /*
1010  * replog moddn param structure
1011  */
1012 struct slap_replog_moddn {
1013         struct berval *newrdn;
1014         int     deloldrdn;
1015         struct berval *newsup;
1016 };
1017
1018 /*
1019  * Backend-info
1020  * represents a backend
1021  */
1022
1023 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1024 typedef struct slap_backend_db BackendDB;               /* per backend database */
1025
1026 LDAP_SLAPD_V (int) nBackendInfo;
1027 LDAP_SLAPD_V (int) nBackendDB;
1028 LDAP_SLAPD_V (BackendInfo *) backendInfo;
1029 LDAP_SLAPD_V (BackendDB *) backendDB;
1030
1031 LDAP_SLAPD_V (int) slapMode;
1032 #define SLAP_UNDEFINED_MODE     0x0000
1033 #define SLAP_SERVER_MODE        0x0001
1034 #define SLAP_TOOL_MODE          0x0002
1035 #define SLAP_MODE                       0x0003
1036
1037 #define SLAP_TRUNCATE_MODE      0x0100
1038
1039 struct slap_replica_info {
1040         char *ri_host;                          /* supersedes be_replica */
1041         BerVarray ri_nsuffix;   /* array of suffixes this replica accepts */
1042         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1043         int ri_exclude;                 /* 1 => exclude ri_attrs */
1044 };
1045
1046 struct slap_limits_set {
1047         /* time limits */
1048         int     lms_t_soft;
1049         int     lms_t_hard;
1050
1051         /* size limits */
1052         int     lms_s_soft;
1053         int     lms_s_hard;
1054         int     lms_s_unchecked;
1055 };
1056
1057 struct slap_limits {
1058         int     lm_type;        /* type of pattern */
1059 #define SLAP_LIMITS_UNDEFINED   0x0000
1060 #define SLAP_LIMITS_EXACT       0x0001
1061 #define SLAP_LIMITS_BASE        SLAP_LIMITS_EXACT
1062 #define SLAP_LIMITS_ONE         0x0002
1063 #define SLAP_LIMITS_SUBTREE     0x0003
1064 #define SLAP_LIMITS_CHILDREN    0x0004
1065 #define SLAP_LIMITS_REGEX       0x0005
1066 #define SLAP_LIMITS_ANONYMOUS   0x0006
1067 #define SLAP_LIMITS_USERS       0x0007
1068 #define SLAP_LIMITS_ANY         0x0008
1069         regex_t lm_dn_regex;            /* regex data for REGEX */
1070
1071         /*
1072          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1073          * pattern for REGEX; NULL for ANONYMOUS, USERS
1074          */
1075         struct berval lm_dn_pat;
1076
1077         struct slap_limits_set  lm_limits;
1078 };
1079
1080 /* temporary aliases */
1081 typedef BackendDB Backend;
1082 #define nbackends nBackendDB
1083 #define backends backendDB
1084
1085 struct slap_backend_db {
1086         BackendInfo     *bd_info;       /* pointer to shared backend info */
1087
1088         /* BackendInfo accessors */
1089 #define         be_config       bd_info->bi_db_config
1090 #define         be_type         bd_info->bi_type
1091
1092 #define         be_bind         bd_info->bi_op_bind
1093 #define         be_unbind       bd_info->bi_op_unbind
1094 #define         be_add          bd_info->bi_op_add
1095 #define         be_compare      bd_info->bi_op_compare
1096 #define         be_delete       bd_info->bi_op_delete
1097 #define         be_modify       bd_info->bi_op_modify
1098 #define         be_modrdn       bd_info->bi_op_modrdn
1099 #define         be_search       bd_info->bi_op_search
1100
1101 #define         be_extended     bd_info->bi_extended
1102
1103 #define         be_release      bd_info->bi_entry_release_rw
1104 #define         be_chk_referrals        bd_info->bi_chk_referrals
1105 #define         be_group        bd_info->bi_acl_group
1106 #define         be_attribute    bd_info->bi_acl_attribute
1107 #define         be_operational  bd_info->bi_operational
1108
1109 #define         be_controls     bd_info->bi_controls
1110
1111 #define         be_connection_init      bd_info->bi_connection_init
1112 #define         be_connection_destroy   bd_info->bi_connection_destroy
1113
1114 #ifdef SLAPD_TOOLS
1115 #define         be_entry_open bd_info->bi_tool_entry_open
1116 #define         be_entry_close bd_info->bi_tool_entry_close
1117 #define         be_entry_first bd_info->bi_tool_entry_first
1118 #define         be_entry_next bd_info->bi_tool_entry_next
1119 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1120 #define         be_entry_get bd_info->bi_tool_entry_get
1121 #define         be_entry_put bd_info->bi_tool_entry_put
1122 #define         be_sync bd_info->bi_tool_sync
1123 #endif
1124
1125 #define SLAP_BFLAG_NOLASTMOD            0x0001U
1126 #define SLAP_BFLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
1127 #define SLAP_BFLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
1128 #define SLAP_BFLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
1129 #define SLAP_BFLAG_ALIASES              0x0100U
1130 #define SLAP_BFLAG_REFERRALS    0x0200U
1131 #define SLAP_BFLAG_SUBENTRIES   0x0400U
1132 #define SLAP_BFLAG_MONITOR              0x1000U
1133 #define SLAP_BFLAG_DYNAMIC              0x2000U
1134         slap_mask_t     be_flags;
1135 #define SLAP_LASTMOD(be)        (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD))
1136 #define SLAP_ALIASES(be)        ((be)->be_flags & SLAP_BFLAG_ALIASES)
1137 #define SLAP_REFERRALS(be)      ((be)->be_flags & SLAP_BFLAG_REFERRALS)
1138 #define SLAP_SUBENTRIES(be)     ((be)->be_flags & SLAP_BFLAG_SUBENTRIES)
1139 #define SLAP_MONITOR(be)        ((be)->be_flags & SLAP_BFLAG_MONITOR)
1140 #define SLAP_DYNAMIC(be)        ((be)->be_flags & SLAP_BFLAG_DYNAMIC)
1141
1142         slap_mask_t     be_restrictops;         /* restriction operations */
1143 #define SLAP_RESTRICT_OP_ADD            0x0001U
1144 #define SLAP_RESTRICT_OP_BIND           0x0002U
1145 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1146 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1147 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1148 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1149 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1150 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1151
1152 #define SLAP_RESTRICT_OP_READS  \
1153         ( SLAP_RESTRICT_OP_COMPARE    \
1154         | SLAP_RESTRICT_OP_SEARCH )
1155 #define SLAP_RESTRICT_OP_WRITES \
1156         ( SLAP_RESTRICT_OP_ADD    \
1157         | SLAP_RESTRICT_OP_DELETE \
1158         | SLAP_RESTRICT_OP_MODIFY \
1159         | SLAP_RESTRICT_OP_RENAME )
1160
1161 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1162 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1163 #define SLAP_ALLOW_BIND_ANON_DN         0x0003U /* dn should be empty */
1164
1165 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1166 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1167 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1168
1169 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1170 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1171
1172         slap_mask_t     be_requires;    /* pre-operation requirements */
1173 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1174 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1175 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1176 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1177 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1178
1179         /* Required Security Strength Factor */
1180         slap_ssf_set_t be_ssf_set;
1181
1182         /* these should be renamed from be_ to bd_ */
1183         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1184         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1185         BerVarray       be_suffixAlias; /* pairs of DN suffix aliases and deref values */
1186         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1187         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1188         struct berval be_rootpw;        /* the magic "root" password for this db        */
1189         unsigned int be_max_deref_depth;       /* limit for depth of an alias deref  */
1190 #define be_sizelimit    be_def_limit.lms_s_soft
1191 #define be_timelimit    be_def_limit.lms_t_soft
1192         struct slap_limits_set be_def_limit; /* default limits */
1193         struct slap_limits **be_limits; /* regex-based size and time limits */
1194         AccessControl *be_acl;  /* access control list for this backend    */
1195         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1196         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1197         char    *be_replogfile; /* replication log file (in master)        */
1198         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1199         BerVarray       be_update_refs; /* where to refer modifying clients to */
1200         char    *be_realm;
1201         void    *be_private;    /* anything the backend database needs     */
1202 };
1203
1204 struct slap_conn;
1205 struct slap_op;
1206
1207 /* Backend function typedefs */
1208 typedef int (BI_init) LDAP_P((BackendInfo *bi));
1209 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1210         const char *fname, int lineno,
1211         int argc, char **argv));
1212 typedef int (BI_open) LDAP_P((BackendInfo *bi));
1213 typedef int (BI_close) LDAP_P((BackendInfo *bi));
1214 typedef int (BI_destroy) LDAP_P((BackendInfo *bi));
1215
1216 typedef int (BI_db_init) LDAP_P((Backend *bd));
1217 typedef int (BI_db_config) LDAP_P((Backend *bd,
1218         const char *fname, int lineno,
1219         int argc, char **argv));
1220 typedef int (BI_db_open) LDAP_P((Backend *bd));
1221 typedef int (BI_db_close) LDAP_P((Backend *bd));
1222 typedef int (BI_db_destroy) LDAP_P((Backend *bd));
1223
1224 typedef int (BI_op_bind)  LDAP_P(( BackendDB *bd,
1225                 struct slap_conn *c, struct slap_op *o,
1226                 struct berval *dn, struct berval *ndn, int method,
1227                 struct berval *cred, struct berval *edn ));
1228 typedef int (BI_op_unbind) LDAP_P((BackendDB *bd,
1229                 struct slap_conn *c, struct slap_op *o ));
1230 typedef int (BI_op_search) LDAP_P((BackendDB *bd,
1231                 struct slap_conn *c, struct slap_op *o,
1232                 struct berval *base, struct berval *nbase,
1233                 int scope, int deref,
1234                 int slimit, int tlimit,
1235                 Filter *f, struct berval *filterstr,
1236                 AttributeName *attrs, int attrsonly));
1237 typedef int (BI_op_compare)LDAP_P((BackendDB *bd,
1238                 struct slap_conn *c, struct slap_op *o,
1239                 struct berval *dn, struct berval *ndn,
1240                 AttributeAssertion *ava));
1241 typedef int (BI_op_modify) LDAP_P((BackendDB *bd,
1242                 struct slap_conn *c, struct slap_op *o,
1243                 struct berval *dn, struct berval *ndn,
1244                 Modifications *m));
1245 typedef int (BI_op_modrdn) LDAP_P((BackendDB *bd,
1246                 struct slap_conn *c, struct slap_op *o,
1247                 struct berval *dn, struct berval *ndn,
1248                 struct berval *newrdn, struct berval *nnewrdn,
1249                 int deleteoldrdn,
1250                 struct berval *newSup, struct berval *nnewSup ));
1251 typedef int (BI_op_add)    LDAP_P((BackendDB *bd,
1252                 struct slap_conn *c, struct slap_op *o,
1253                 Entry *e));
1254 typedef int (BI_op_delete) LDAP_P((BackendDB *bd,
1255                 struct slap_conn *c, struct slap_op *o,
1256                 struct berval *dn, struct berval *ndn));
1257 typedef int (BI_op_abandon) LDAP_P((BackendDB *bd,
1258                 struct slap_conn *c, struct slap_op *o,
1259                 ber_int_t msgid));
1260
1261 typedef int (BI_op_extended) LDAP_P((
1262     BackendDB           *be,
1263     struct slap_conn    *conn,
1264     struct slap_op              *op,
1265         const char              *reqoid,
1266     struct berval * reqdata,
1267         char            **rspoid,
1268     struct berval ** rspdata,
1269         LDAPControl *** rspctrls,
1270         const char **   text,
1271         BerVarray *refs ));
1272
1273 typedef int (BI_entry_release_rw) LDAP_P((BackendDB *bd,
1274                 struct slap_conn *c, struct slap_op *o,
1275                 Entry *e, int rw));
1276
1277 typedef int (BI_chk_referrals) LDAP_P((BackendDB *bd,
1278                 struct slap_conn *c, struct slap_op *o,
1279                 struct berval *dn, struct berval *ndn,
1280                 const char **text ));
1281
1282 typedef int (BI_acl_group)  LDAP_P((Backend *bd,
1283                 struct slap_conn *c, struct slap_op *o,
1284                 Entry *e,
1285                 struct berval *bdn,
1286                 struct berval *edn,
1287                 ObjectClass *group_oc,
1288                 AttributeDescription *group_at ));
1289
1290 typedef int (BI_acl_attribute)  LDAP_P((Backend *bd,
1291                 struct slap_conn *c, struct slap_op *o,
1292                 Entry *e, struct berval *edn,
1293                 AttributeDescription *entry_at,
1294                 BerVarray *vals ));
1295
1296 typedef int (BI_operational)  LDAP_P((Backend *bd,
1297                 struct slap_conn *c, struct slap_op *o,
1298                 Entry *e, AttributeName *attrs, int opattrs, Attribute **a ));
1299
1300 typedef int (BI_connection_init) LDAP_P((BackendDB *bd,
1301                 struct slap_conn *c));
1302 typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd,
1303                 struct slap_conn *c));
1304
1305 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1306 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
1307 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
1308 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
1309 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1310 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
1311                         struct berval *text ));
1312 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1313 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
1314
1315 struct slap_backend_info {
1316         char    *bi_type; /* type of backend */
1317
1318         /*
1319          * per backend type routines:
1320          * bi_init: called to allocate a backend_info structure,
1321          *              called once BEFORE configuration file is read.
1322          *              bi_init() initializes this structure hence is
1323          *              called directly from be_initialize()
1324          * bi_config: called per 'backend' specific option
1325          *              all such options must before any 'database' options
1326          *              bi_config() is called only from read_config()
1327          * bi_open: called to open each database, called
1328          *              once AFTER configuration file is read but
1329          *              BEFORE any bi_db_open() calls.
1330          *              bi_open() is called from backend_startup()
1331          * bi_close: called to close each database, called
1332          *              once during shutdown after all bi_db_close calls.
1333          *              bi_close() is called from backend_shutdown()
1334          * bi_destroy: called to destroy each database, called
1335          *              once during shutdown after all bi_db_destroy calls.
1336          *              bi_destory() is called from backend_destroy()
1337          */
1338         BI_init *bi_init;
1339         BI_config       *bi_config;
1340         BI_open *bi_open;
1341         BI_close        *bi_close;
1342         BI_destroy      *bi_destroy;
1343
1344         /*
1345          * per database routines:
1346          * bi_db_init: called to initialize each database,
1347          *      called upon reading 'database <type>'
1348          *      called only from backend_db_init()
1349          * bi_db_config: called to configure each database,
1350          *  called per database to handle per database options
1351          *      called only from read_config()
1352          * bi_db_open: called to open each database
1353          *      called once per database immediately AFTER bi_open()
1354          *      calls but before daemon startup.
1355          *  called only by backend_startup()
1356          * bi_db_close: called to close each database
1357          *      called once per database during shutdown but BEFORE
1358          *  any bi_close call.
1359          *  called only by backend_shutdown()
1360          * bi_db_destroy: called to destroy each database
1361          *  called once per database during shutdown AFTER all
1362          *  bi_close calls but before bi_destory calls.
1363          *  called only by backend_destory()
1364          */
1365         BI_db_init      *bi_db_init;
1366         BI_db_config    *bi_db_config;
1367         BI_db_open      *bi_db_open;
1368         BI_db_close     *bi_db_close;
1369         BI_db_destroy   *bi_db_destroy;
1370
1371         /* LDAP Operations Handling Routines */
1372         BI_op_bind      *bi_op_bind;
1373         BI_op_unbind    *bi_op_unbind;
1374         BI_op_search    *bi_op_search;
1375         BI_op_compare   *bi_op_compare;
1376         BI_op_modify    *bi_op_modify;
1377         BI_op_modrdn    *bi_op_modrdn;
1378         BI_op_add       *bi_op_add;
1379         BI_op_delete    *bi_op_delete;
1380         BI_op_abandon   *bi_op_abandon;
1381
1382         /* Extended Operations Helper */
1383         BI_op_extended  *bi_extended;
1384
1385         /* Auxilary Functions */
1386         BI_entry_release_rw     *bi_entry_release_rw;
1387         BI_chk_referrals        *bi_chk_referrals;
1388
1389         BI_acl_group    *bi_acl_group;
1390         BI_acl_attribute        *bi_acl_attribute;
1391
1392         BI_operational  *bi_operational;
1393
1394         BI_connection_init      *bi_connection_init;
1395         BI_connection_destroy   *bi_connection_destroy;
1396
1397         /* hooks for slap tools */
1398         BI_tool_entry_open      *bi_tool_entry_open;
1399         BI_tool_entry_close     *bi_tool_entry_close;
1400         BI_tool_entry_first     *bi_tool_entry_first;
1401         BI_tool_entry_next      *bi_tool_entry_next;
1402         BI_tool_entry_get       *bi_tool_entry_get;
1403         BI_tool_entry_put       *bi_tool_entry_put;
1404         BI_tool_entry_reindex   *bi_tool_entry_reindex;
1405         BI_tool_sync            *bi_tool_sync;
1406
1407 #define SLAP_INDEX_ADD_OP               0x0001
1408 #define SLAP_INDEX_DELETE_OP    0x0002
1409
1410         char **bi_controls;             /* supported controls */
1411
1412         unsigned int bi_nDB;    /* number of databases of this type */
1413         void    *bi_private;    /* anything the backend type needs */
1414 };
1415
1416 #define c_authtype      c_authz.sai_method
1417 #define c_authmech      c_authz.sai_mech
1418 #define c_dn            c_authz.sai_dn
1419 #define c_ndn           c_authz.sai_ndn
1420 #define c_ssf                   c_authz.sai_ssf
1421 #define c_transport_ssf c_authz.sai_transport_ssf
1422 #define c_tls_ssf               c_authz.sai_tls_ssf
1423 #define c_sasl_ssf              c_authz.sai_sasl_ssf
1424
1425 #define o_authtype      o_authz.sai_method
1426 #define o_authmech      o_authz.sai_mech
1427 #define o_dn            o_authz.sai_dn
1428 #define o_ndn           o_authz.sai_ndn
1429 #define o_ssf                   o_authz.sai_ssf
1430 #define o_transport_ssf o_authz.sai_transport_ssf
1431 #define o_tls_ssf               o_authz.sai_tls_ssf
1432 #define o_sasl_ssf              o_authz.sai_sasl_ssf
1433
1434 typedef void (slap_response)( struct slap_conn *, struct slap_op *,
1435         ber_tag_t, ber_int_t, ber_int_t, const char *, const char *,
1436         BerVarray, const char *, struct berval *,
1437         struct berval *, LDAPControl ** );
1438
1439 typedef void (slap_sresult)( struct slap_conn *, struct slap_op *,
1440         ber_int_t, const char *, const char *, BerVarray,
1441         LDAPControl **, int nentries);
1442
1443 typedef int (slap_sendentry)( BackendDB *, struct slap_conn *,
1444         struct slap_op *, Entry *, AttributeName *, int, LDAPControl **);
1445
1446 typedef struct slap_callback {
1447         slap_response *sc_response;
1448         slap_sresult *sc_sresult;
1449         slap_sendentry *sc_sendentry;
1450         void *sc_private;
1451 } slap_callback;
1452
1453 /*
1454  * Paged Results state
1455  */
1456 typedef unsigned long PagedResultsCookie;
1457 typedef struct slap_paged_state {
1458         Backend *ps_be;
1459         PagedResultsCookie ps_cookie;
1460         ID ps_id;
1461 } PagedResultsState;
1462
1463 /*
1464  * represents an operation pending from an ldap client
1465  */
1466 typedef struct slap_op {
1467         unsigned long o_opid;   /* id of this operation */
1468         unsigned long o_connid; /* id of conn initiating this op */
1469
1470         ber_int_t       o_msgid;        /* msgid of the request */
1471         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
1472         ber_tag_t       o_tag;          /* tag of the request */
1473         time_t          o_time;         /* time op was initiated */
1474
1475         ldap_pvt_thread_t       o_tid;  /* thread handling this op */
1476
1477         volatile sig_atomic_t o_abandon;        /* abandon flag */
1478
1479 #define SLAP_NO_CONTROL 0
1480 #define SLAP_NONCRITICAL_CONTROL 1
1481 #define SLAP_CRITICAL_CONTROL 2
1482         char o_managedsait;
1483         char o_noop;
1484         char o_subentries;
1485         char o_subentries_visibility;
1486         char o_valuesreturnfilter;
1487
1488         char o_pagedresults;
1489         ber_int_t o_pagedresults_size;
1490         PagedResultsState o_pagedresults_state;
1491
1492 #ifdef LDAP_CONNECTIONLESS
1493         Sockaddr        o_peeraddr;     /* UDP peer address               */
1494 #endif
1495         AuthorizationInformation o_authz;
1496
1497         BerElement      *o_ber;         /* ber of the request             */
1498         slap_callback   *o_callback;    /* callback pointers */
1499         LDAPControl     **o_ctrls;       /* controls */
1500
1501         void    *o_private;     /* anything the backend needs */
1502
1503         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
1504         ValuesReturnFilter *vrFilter; /* Structure represents ValuesReturnFilter */
1505 } Operation;
1506
1507 #define get_manageDSAit(op)                             ((int)(op)->o_managedsait)
1508 #define get_subentries(op)                              ((int)(op)->o_subentries)
1509 #define get_subentries_visibility(op)   ((int)(op)->o_subentries_visibility)
1510
1511 /*
1512  * Caches the result of a backend_group check for ACL evaluation
1513  */
1514 typedef struct slap_gacl {
1515         struct slap_gacl *ga_next;
1516         Backend *ga_be;
1517         ObjectClass *ga_oc;
1518         AttributeDescription *ga_at;
1519         int ga_res;
1520         ber_len_t ga_len;
1521         char ga_ndn[1];
1522 } GroupAssertion;
1523
1524 /*
1525  * represents a connection from an ldap client
1526  */
1527 typedef struct slap_conn {
1528         int                     c_struct_state; /* structure management state */
1529         int                     c_conn_state;   /* connection state */
1530
1531         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1532         Sockbuf         *c_sb;                  /* ber connection stuff           */
1533
1534         /* only can be changed by connect_init */
1535         time_t          c_starttime;    /* when the connection was opened */
1536         time_t          c_activitytime; /* when the connection was last used */
1537         unsigned long           c_connid;       /* id of this connection for stats*/
1538
1539         struct berval   c_listener_url; /* listener URL */
1540         struct berval   c_peer_domain;  /* DNS name of client */
1541         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
1542         struct berval   c_sock_name;    /* sock name (trans=addr:port) */
1543
1544         /* only can be changed by binding thread */
1545         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
1546         struct berval   c_sasl_bind_mech;                       /* mech in progress */
1547         struct berval   c_cdn;
1548
1549         /* authorization backend */
1550         Backend *c_authz_backend;
1551
1552         AuthorizationInformation c_authz;
1553         GroupAssertion *c_groups;
1554
1555         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
1556
1557         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
1558         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
1559
1560         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
1561         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
1562
1563         BerElement      *c_currentber;  /* ber we're attempting to read */
1564         int             c_writewaiter;  /* true if writer is waiting */
1565
1566 #ifdef LDAP_CONNECTIONLESS
1567         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
1568 #endif
1569 #ifdef HAVE_TLS
1570         int     c_is_tls;               /* true if this LDAP over raw TLS */
1571         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
1572 #endif
1573         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
1574         void    *c_sasl_context;        /* SASL session context */
1575         void    *c_sasl_extra;          /* SASL session extra stuff */
1576
1577         PagedResultsState c_pagedresults_state; /* paged result state */
1578
1579         long    c_n_ops_received;       /* num of ops received (next op_id) */
1580         long    c_n_ops_executing;      /* num of ops currently executing */
1581         long    c_n_ops_pending;        /* num of ops pending execution */
1582         long    c_n_ops_completed;      /* num of ops completed */
1583
1584         long    c_n_get;                /* num of get calls */
1585         long    c_n_read;               /* num of read calls */
1586         long    c_n_write;              /* num of write calls */
1587 } Connection;
1588
1589 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1590 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
1591         do { \
1592                 if ( ldap_debug & (level) ) \
1593                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1594                 if ( ldap_syslog & (level) ) \
1595                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1596                                 (arg2), (arg3) ); \
1597         } while (0)
1598 #else
1599 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1600 #endif
1601
1602
1603 #define SASLREGEX_REPLACE 10
1604 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1605 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1606
1607 typedef struct sasl_uri {
1608   struct berval dn;
1609   struct berval filter;
1610   int scope;
1611 } SaslUri_t;
1612
1613 typedef struct sasl_regexp {
1614   char *sr_match;                                                       /* regexp match pattern */
1615   SaslUri_t sr_replace;                                                 /* regexp replace pattern */
1616   regex_t sr_workspace;                                         /* workspace for regexp engine */
1617   regmatch_t sr_strings[SASLREGEX_REPLACE];     /* strings matching $1,$2 ... */
1618   int sr_dn_offset[SASLREGEX_REPLACE+2];                /* offsets of $1,$2... in *replace */
1619   int sr_fi_offset[SASLREGEX_REPLACE+2];                /* offsets of $1,$2... in *replace */
1620 } SaslRegexp_t;
1621
1622 /*
1623  * listener; need to access it from monitor backend
1624  */
1625 typedef struct slap_listener {
1626         char* sl_url;
1627         char* sl_name;
1628 #ifdef HAVE_TLS
1629         int             sl_is_tls;
1630 #endif
1631 #ifdef LDAP_CONNECTIONLESS
1632         int     sl_is_udp;              /* UDP listener is also data port */
1633 #endif
1634         ber_socket_t sl_sd;
1635         Sockaddr sl_sa;
1636 #define sl_addr sl_sa.sa_in_addr
1637 } Listener;
1638
1639 #ifdef SLAPD_MONITOR
1640 /*
1641  * Operation indices
1642  */
1643 enum {
1644         SLAP_OP_BIND = 0,
1645         SLAP_OP_UNBIND,
1646         SLAP_OP_ADD,
1647         SLAP_OP_DELETE,
1648         SLAP_OP_MODRDN,
1649         SLAP_OP_MODIFY,
1650         SLAP_OP_COMPARE,
1651         SLAP_OP_SEARCH,
1652         SLAP_OP_ABANDON,
1653         SLAP_OP_EXTENDED,
1654         SLAP_OP_LAST
1655 };
1656 #endif /* SLAPD_MONITOR */
1657
1658 LDAP_END_DECL
1659
1660 #include "proto-slap.h"
1661
1662 #endif /* _SLAP_H_ */