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-1999 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 #ifndef _SLDAPD_H_
   9 #define _SLDAPD_H_
  10
  11 #include "ldap_defaults.h"
  12
  13 #include <ac/stdlib.h>
  14
  15 #include <sys/types.h>
  16 #include <ac/syslog.h>
  17 #include <ac/regex.h>
  18 #include <ac/socket.h>
  19 #include <ac/time.h>
  20 #include <ac/param.h>
  21
  22 #ifdef HAVE_CYRUS_SASL
  23 #include <sasl.h>
  24 #endif
  25
  26 #include "avl.h"
  27
  28 #ifndef ldap_debug
  29 #define ldap_debug slap_debug
  30 #endif
  31
  32
  33 #include "ldap_log.h"
  34
  35 #include <ldap.h>
  36 #include <ldap_schema.h>
  37
  38 #include "ldap_pvt_thread.h"
  39 #include "ldif.h"
  40
  41 LDAP_BEGIN_DECL
  42
  43 #ifdef f_next
  44 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  45 #endif
  46
  47 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
  48
  49 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
  50  *
  51  * This is a value used internally by the backends. It is needed to allow
  52  * adding values that already exist without getting an error as required by
  53  * modrdn when the new rdn was already an attribute value itself.
  54  * JCG 05/1999 (gomez@engr.sgi.com)
  55  */
  56 #define LDAP_MOD_SOFTADD        0x1000
  57
  58 #define ON      1
  59 #define OFF     (-1)
  60 #define UNDEFINED 0
  61
  62 #define MAXREMATCHES 10
  63
  64 /* psuedo error code to indicating abandoned operation */
  65 #define SLAPD_ABANDON -1
  66
  67 /* XXYYZ: these macros assume 'x' is an ASCII x */
  68 #define DNSEPARATOR(c)  ((c) == ',' || (c) == ';')
  69 #define SEPARATOR(c)    ((c) == ',' || (c) == ';' || (c) == '+')
  70 #define SPACE(c)        ((c) == ' ' || (c) == '\n')
  71
  72 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
  73 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
  74 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
  75 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
  76 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
  77
  78 #define LEADKEYCHAR(c)  ( ASCII_ALPHA(c) )
  79 #define KEYCHAR(c)      ( ASCII_ALNUM(c) || (c) == '-' )
  80 #define LEADOIDCHAR(c)  ( ASCII_DIGIT(c) )
  81 #define OIDCHAR(c)      ( ASCII_DIGIT(c) || (c) == '.' )
  82
  83 #define LEADATTRCHAR(c) ( LEADKEYCHAR(c) || LEADOIDCHAR(c) )
  84 #define ATTRCHAR(c)     ( KEYCHAR((c)) || (c) == '.' )
  85
  86 #define NEEDSESCAPE(c)  ((c) == '\\' || (c) == '"')
  87
  88 #define SLAPD_ACI_DEFAULT_ATTR          "aci"
  89
  90 /* schema needed by slapd */
  91 #define SLAPD_OID_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
  92 #define SLAPD_OID_ACI_SYNTAX "1.3.6.1.4.1.4203.2.1" /* experimental */
  93
  94 LIBSLAPD_F (int) slap_debug;
  95
  96 /*
  97  * Index types
  98  */
  99 #define SLAP_INDEX_PRESENCE      0x0001U
 100 #define SLAP_INDEX_EQUALITY      0x0002U
 101 #define SLAP_INDEX_APPROX        0x0004U
 102 #define SLAP_INDEX_SUB           0x0008U
 103 #define SLAP_INDEX_UNKNOWN       0x0010U
 104 #define SLAP_INDEX_FROMINIT      0x8000U        /* psuedo type */
 105
 106
 107 /*
 108  * represents schema information for a database
 109  */
 110 #define SLAP_SCHERR_OUTOFMEM            1
 111 #define SLAP_SCHERR_CLASS_NOT_FOUND     2
 112 #define SLAP_SCHERR_ATTR_NOT_FOUND      3
 113 #define SLAP_SCHERR_DUP_CLASS           4
 114 #define SLAP_SCHERR_DUP_ATTR            5
 115 #define SLAP_SCHERR_DUP_SYNTAX          6
 116 #define SLAP_SCHERR_DUP_RULE            7
 117 #define SLAP_SCHERR_NO_NAME             8
 118 #define SLAP_SCHERR_ATTR_INCOMPLETE     9
 119 #define SLAP_SCHERR_MR_NOT_FOUND        10
 120 #define SLAP_SCHERR_SYN_NOT_FOUND       11
 121 #define SLAP_SCHERR_MR_INCOMPLETE       12
 122
 123 typedef struct slap_oid_macro {
 124         char *som_name;
 125         char *som_oid;
 126         int som_oidlen;
 127         struct slap_oid_macro *som_next;
 128 } OidMacro;
 129
 130 /* forward declarations */
 131 struct slap_syntax;
 132 struct slap_matching_rule;
 133
 134
 135 typedef int slap_syntax_validate_func LDAP_P((
 136         struct slap_syntax *syntax,
 137         struct berval * in));
 138
 139 typedef int slap_syntax_transform_func LDAP_P((
 140         struct slap_syntax *syntax,
 141         struct berval * in,
 142         struct berval ** out));
 143
 144 typedef struct slap_syntax {
 145         LDAP_SYNTAX                     ssyn_syn;
 146         int     ssyn_flags;
 147
 148 #define SLAP_SYNTAX_NONE        0
 149 #define SLAP_SYNTAX_BINARY      1
 150
 151         slap_syntax_validate_func       *ssyn_validate;
 152
 153         /* convert to and from binary */
 154         slap_syntax_transform_func      *ssyn_ber2str;
 155         slap_syntax_transform_func      *ssyn_str2ber;
 156
 157         struct slap_syntax              *ssyn_next;
 158 #define ssyn_oid                        ssyn_syn.syn_oid
 159 #define ssyn_desc                       ssyn_syn.syn_desc
 160 } Syntax;
 161
 162 /* XXX -> UCS-2 Converter */
 163 typedef int slap_mr_convert_func LDAP_P((
 164         struct berval * in,
 165         struct berval ** out ));
 166
 167 /* Normalizer */
 168 typedef int slap_mr_normalize_func LDAP_P((
 169         struct slap_syntax *syntax, /* NULL if in is asserted value */
 170         struct slap_matching_rule *mr,
 171         struct berval * in,
 172         struct berval ** out ));
 173
 174 /* Match (compare) function */
 175 typedef int slap_mr_match_func LDAP_P((
 176         struct slap_syntax *syntax,     /* syntax of stored value */
 177         struct slap_matching_rule *mr,
 178         struct berval * value,
 179         struct berval * assertValue ));
 180
 181 /* Index generation function */
 182 typedef int slap_mr_indexer_func LDAP_P((
 183         struct slap_syntax *syntax,     /* syntax of stored value */
 184         struct slap_matching_rule *mr,
 185         struct berval **values,
 186         struct berval **keys ));
 187
 188 struct slap_filter;     /* forward declaration */
 189 /* Filter index function */
 190 typedef int slap_mr_filter_func LDAP_P((
 191         struct slap_syntax *syntax,     /* syntax of stored value */
 192         struct slap_matching_rule *mr,
 193         struct slap_filter *filter,
 194         struct berval **keys ));
 195
 196 typedef struct slap_matching_rule {
 197         LDAP_MATCHING_RULE              smr_mrule;
 198         Syntax                                  *smr_syntax;
 199         slap_mr_convert_func    *smr_convert;
 200         slap_mr_normalize_func  *smr_normalize;
 201         slap_mr_match_func              *smr_match;
 202         slap_mr_indexer_func    *smr_indexer;
 203         slap_mr_filter_func             *smr_filter;
 204         struct slap_matching_rule       *smr_next;
 205 #define smr_oid                         smr_mrule.mr_oid
 206 #define smr_names                       smr_mrule.mr_names
 207 #define smr_desc                        smr_mrule.mr_desc
 208 #define smr_obsolete            smr_mrule.mr_obsolete
 209 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
 210 } MatchingRule;
 211
 212 typedef struct slap_attribute_type {
 213         LDAP_ATTRIBUTE_TYPE             sat_atype;
 214         struct slap_attribute_type      *sat_sup;
 215         struct slap_attribute_type      **sat_subtypes;
 216         MatchingRule                    *sat_equality;
 217         MatchingRule                    *sat_ordering;
 218         MatchingRule                    *sat_substr;
 219         Syntax                          *sat_syntax;
 220         /* The next one is created to help in the transition */
 221         int                             sat_syntax_compat;
 222         struct slap_attribute_type      *sat_next;
 223 #define sat_oid                 sat_atype.at_oid
 224 #define sat_names               sat_atype.at_names
 225 #define sat_desc                sat_atype.at_desc
 226 #define sat_obsolete            sat_atype.at_obsolete
 227 #define sat_sup_oid             sat_atype.at_sup_oid
 228 #define sat_equality_oid        sat_atype.at_equality_oid
 229 #define sat_ordering_oid        sat_atype.at_ordering_oid
 230 #define sat_substr_oid          sat_atype.at_substr_oid
 231 #define sat_syntax_oid          sat_atype.at_syntax_oid
 232 #define sat_single_value        sat_atype.at_single_value
 233 #define sat_collective          sat_atype.at_collective
 234 #define sat_no_user_mod         sat_atype.at_no_user_mod
 235 #define sat_usage               sat_atype.at_usage
 236 } AttributeType;
 237
 238 typedef struct slap_object_class {
 239         LDAP_OBJECT_CLASS               soc_oclass;
 240         struct slap_object_class        **soc_sups;
 241         AttributeType                   **soc_required;
 242         AttributeType                   **soc_allowed;
 243         struct slap_object_class        *soc_next;
 244 #define soc_oid                 soc_oclass.oc_oid
 245 #define soc_names               soc_oclass.oc_names
 246 #define soc_desc                soc_oclass.oc_desc
 247 #define soc_obsolete            soc_oclass.oc_obsolete
 248 #define soc_sup_oids            soc_oclass.oc_sup_oids
 249 #define soc_kind                soc_oclass.oc_kind
 250 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 251 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 252 } ObjectClass;
 253
 254
 255 struct slap_op;
 256 struct slap_conn;
 257
 258 struct replog_moddn {
 259         char *newrdn;
 260         int     deloldrdn;
 261         char *newsup;
 262 };
 263
 264 /*
 265  * represents an attribute value assertion (i.e., attr;option=value)
 266  */
 267 typedef struct slap_ava {
 268         char            *ava_type;      /* attribute description */
 269         struct berval   ava_value;
 270 } Ava;
 271
 272 /*
 273  * represents an matching rule assertion
 274  */
 275 typedef struct slap_mra {
 276         char    *mra_rule;      /* optional */
 277         char    *mra_type;      /* attribute description -- optional */
 278         int             mra_dnattrs;
 279         struct berval   *mra_value;
 280 } Mra;
 281
 282 /*
 283  * represents a search filter
 284  */
 285 typedef struct slap_filter {
 286         ber_tag_t       f_choice;       /* values taken from ldap.h */
 287
 288         union f_un_u {
 289                 /* present */
 290                 char            *f_un_type;
 291
 292                 /* equality, lessorequal, greaterorequal, approx */
 293                 Ava             f_un_ava;
 294
 295                 /* extensible */
 296                 Mra             f_un_fra;
 297
 298                 /* and, or, not */
 299                 struct slap_filter      *f_un_complex;
 300
 301                 /* substrings */
 302                 struct sub {
 303                         char    *f_un_sub_type;
 304
 305                         struct berval   *f_un_sub_initial;
 306                         struct berval   **f_un_sub_any;
 307                         struct berval   *f_un_sub_final;
 308                 } f_un_sub;
 309         } f_un;
 310
 311 #define f_dn            f_un.f_un_type  /* used for DN indices */
 312 #define f_type          f_un.f_un_type
 313 #define f_ava           f_un.f_un_ava
 314 #define f_avtype        f_un.f_un_ava.ava_type
 315 #define f_avvalue       f_un.f_un_ava.ava_value
 316 #define f_mra           f_un.f_un_mra
 317 #define f_mrtype        f_un.f_un_mra.mra_type
 318 #define f_mrvalue       f_un.f_un_mra.mra_value
 319 #define f_mrdnaddrs     f_un.f_un_mra.mra_dnattrs
 320 #define f_and           f_un.f_un_complex
 321 #define f_or            f_un.f_un_complex
 322 #define f_not           f_un.f_un_complex
 323 #define f_list          f_un.f_un_complex
 324 #define f_sub           f_un.f_un_sub
 325 #define f_sub_type      f_un.f_un_sub.f_un_sub_type
 326 #define f_sub_initial   f_un.f_un_sub.f_un_sub_initial
 327 #define f_sub_any       f_un.f_un_sub.f_un_sub_any
 328 #define f_sub_final     f_un.f_un_sub.f_un_sub_final
 329
 330         struct slap_filter      *f_next;
 331 } Filter;
 332
 333 /*
 334  * represents an attribute (type + values + syntax)
 335  */
 336 typedef struct slap_attr {
 337         char            *a_type;        /* description */
 338         struct berval   **a_vals;
 339 #ifndef SLAPD_SCHEMA_NOT_COMPAT
 340         int             a_syntax;
 341 #endif
 342         struct slap_attr        *a_next;
 343 } Attribute;
 344
 345 #ifndef SLAPD_SCHEMA_NOT_COMPAT
 346 /*
 347  * the attr_syntax() routine returns one of these values
 348  * telling what kind of syntax an attribute supports.
 349  */
 350 #define SYNTAX_CIS      0x01    /* case insensitive string              */
 351 #define SYNTAX_CES      0x02    /* case sensitive string                */
 352 #define SYNTAX_BIN      0x04    /* binary data                          */
 353 #define SYNTAX_TEL      0x08    /* telephone number string              */
 354 #define SYNTAX_DN       0x10    /* dn string                            */
 355 #endif
 356
 357 /*
 358  * the id used in the indexes to refer to an entry
 359  */
 360 typedef unsigned long   ID;
 361 #define NOID    ((ID)~0)
 362
 363 /*
 364  * represents an entry in core
 365  */
 366 typedef struct slap_entry {
 367         /*
 368          * The ID field should only be changed before entry is
 369          * inserted into a cache.  The ID value is backend
 370          * specific.
 371          */
 372         ID              e_id;
 373
 374         char            *e_dn;          /* DN of this entry */
 375         char            *e_ndn;         /* normalized DN of this entry */
 376         Attribute       *e_attrs;       /* list of attributes + values */
 377
 378         /* for use by the backend for any purpose */
 379         void*   e_private;
 380 } Entry;
 381
 382 /*
 383  * represents an access control list
 384  */
 385
 386 typedef enum slap_access_e {
 387         ACL_INVALID_ACCESS = -1,
 388         ACL_NONE = 0,
 389         ACL_AUTH,
 390         ACL_COMPARE,
 391         ACL_SEARCH,
 392         ACL_READ,
 393         ACL_WRITE
 394 } slap_access_t;
 395
 396 typedef enum slap_control_e {
 397         ACL_INVALID_CONTROL     = 0,
 398         ACL_STOP,
 399         ACL_CONTINUE,
 400         ACL_BREAK
 401 } slap_control_t;
 402
 403 typedef unsigned long slap_access_mask_t;
 404
 405 /* the "by" part */
 406 typedef struct slap_access {
 407         slap_control_t a_type;
 408
 409 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
 410
 411 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
 412 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
 413 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
 414 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
 415 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
 416 #define ACL_PRIV_WRITE                  ACL_ACCESS2PRIV( ACL_WRITE )
 417
 418 #define ACL_PRIV_MASK                   0x00ffUL
 419
 420 /* priv flags */
 421 #define ACL_PRIV_LEVEL                  0x1000UL
 422 #define ACL_PRIV_ADDITIVE               0x2000UL
 423 #define ACL_PRIV_SUBSTRACTIVE   0x4000UL
 424
 425 /* invalid privs */
 426 #define ACL_PRIV_INVALID                0x0UL
 427
 428 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
 429 #define ACL_PRIV_ASSIGN(m,p)    do { (m)  =  (p); } while(0)
 430 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
 431 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
 432
 433 #define ACL_INIT(m)                             ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
 434 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
 435
 436 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
 437
 438 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
 439
 440 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
 441 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
 442 #define ACL_IS_SUBTRACTIVE(m)   ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
 443
 444 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
 445 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_NONE)
 446 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
 447 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
 448 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
 449 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
 450
 451 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
 452 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
 453 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
 454 #define ACL_LVL_IS_COMPARE(m)   ACL_LVL((m),ACL_LVL_COMPARE)
 455 #define ACL_LVL_IS_SEARCH(m)    ACL_LVL((m),ACL_LVL_SEARCH)
 456 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
 457 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
 458
 459 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
 460 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
 461 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
 462 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
 463 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
 464 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
 465
 466         slap_access_mask_t      a_mask;
 467
 468         char            *a_dn_pat;
 469 #ifdef SLAPD_SCHEMA_NOT_COMPAT
 470         AttributeType   *a_dn_at;
 471 #else
 472         char            *a_dn_at;
 473 #endif
 474         int                     a_dn_self;
 475
 476         char            *a_peername_pat;
 477         char            *a_sockname_pat;
 478
 479         char            *a_domain_pat;
 480         char            *a_sockurl_pat;
 481
 482 #ifdef SLAPD_ACI_ENABLED
 483 #ifdef SLAPD_SCHEMA_NOT_COMPAT
 484         AttributeType   *a_aci_at;
 485 #else
 486         char            *a_aci_at;
 487 #endif
 488 #endif
 489
 490         /* ACL Groups */
 491         char            *a_group_pat;
 492         char            *a_group_oc;
 493 #ifdef SLAPD_SCHEMA_NOT_COMPAT
 494         AttributeType   *a_group_at;
 495 #else
 496         char            *a_group_at;
 497 #endif
 498
 499         struct slap_access      *a_next;
 500 } Access;
 501
 502 /* the "to" part */
 503 typedef struct slap_acl {
 504         /* "to" part: the entries this acl applies to */
 505         Filter          *acl_filter;
 506         regex_t         acl_dn_re;
 507         char            *acl_dn_pat;
 508         char            **acl_attrs;
 509
 510         /* "by" part: list of who has what access to the entries */
 511         Access  *acl_access;
 512
 513         struct slap_acl *acl_next;
 514 } AccessControl;
 515
 516 /*
 517  * A list of LDAPMods
 518  */
 519 typedef struct ldapmodlist {
 520         struct ldapmod ml_mod;
 521         struct ldapmodlist *ml_next;
 522 #define ml_op           ml_mod.mod_op
 523 #define ml_type         ml_mod.mod_type
 524 #define ml_values       ml_mod.mod_values
 525 #define ml_bvalues      ml_mod.mod_bvalues
 526 } LDAPModList;
 527
 528 /*
 529  * Backend-info
 530  * represents a backend
 531  */
 532
 533 typedef struct slap_backend_info BackendInfo;   /* per backend type */
 534 typedef struct slap_backend_db BackendDB;               /* per backend database */
 535
 536 LIBSLAPD_F (int) nBackendInfo;
 537 LIBSLAPD_F (int) nBackendDB;
 538 LIBSLAPD_F (BackendInfo *) backendInfo;
 539 LIBSLAPD_F (BackendDB *) backendDB;
 540
 541 LIBSLAPD_F (int) slapMode;
 542 #define SLAP_UNDEFINED_MODE     0x0000
 543 #define SLAP_SERVER_MODE        0x0001
 544 #define SLAP_TOOL_MODE          0x0002
 545 #define SLAP_MODE                       0x0003
 546
 547 #define SLAP_TRUNCATE_MODE      0x0100
 548 #ifdef SLAPD_BDB2
 549 #define SLAP_TIMED_MODE         0x1000
 550 #endif
 551 #define SLAP_TOOLID_MODE    4
 552
 553 /* temporary aliases */
 554 typedef BackendDB Backend;
 555 #define nbackends nBackendDB
 556 #define backends backendDB
 557
 558 struct slap_backend_db {
 559         BackendInfo     *bd_info;       /* pointer to shared backend info */
 560
 561         /* BackendInfo accessors */
 562 #define         be_config       bd_info->bi_db_config
 563 #define         be_type         bd_info->bi_type
 564
 565 #define         be_bind         bd_info->bi_op_bind
 566 #define         be_unbind       bd_info->bi_op_unbind
 567 #define         be_add          bd_info->bi_op_add
 568 #define         be_compare      bd_info->bi_op_compare
 569 #define         be_delete       bd_info->bi_op_delete
 570 #define         be_modify       bd_info->bi_op_modify
 571 #define         be_modrdn       bd_info->bi_op_modrdn
 572 #define         be_search       bd_info->bi_op_search
 573
 574 #define         be_extended     bd_info->bi_extended
 575
 576 #define         be_release      bd_info->bi_entry_release_rw
 577 #define         be_group        bd_info->bi_acl_group
 578
 579 #define         be_controls     bd_info->bi_controls
 580
 581 #define         be_connection_init      bd_info->bi_connection_init
 582 #define         be_connection_destroy   bd_info->bi_connection_destroy
 583
 584 #ifdef SLAPD_TOOLS
 585 #define         be_entry_open bd_info->bi_tool_entry_open
 586 #define         be_entry_close bd_info->bi_tool_entry_close
 587 #define         be_entry_first bd_info->bi_tool_entry_first
 588 #define         be_entry_next bd_info->bi_tool_entry_next
 589 #define         be_entry_get bd_info->bi_tool_entry_get
 590 #define         be_entry_put bd_info->bi_tool_entry_put
 591 #define         be_index_attr bd_info->bi_tool_index_attr
 592 #define         be_index_change bd_info->bi_tool_index_change
 593 #define         be_sync bd_info->bi_tool_sync
 594 #endif
 595
 596 #ifdef HAVE_CYRUS_SASL
 597 #define         be_sasl_authorize bd_info->bi_sasl_authorize
 598 #define         be_sasl_getsecret bd_info->bi_sasl_getsecret
 599 #define         be_sasl_putsecret bd_info->bi_sasl_putsecret
 600 #endif
 601
 602         /* these should be renamed from be_ to bd_ */
 603         char    **be_suffix;    /* the DN suffixes of data in this backend */
 604         char    **be_nsuffix;   /* the normalized DN suffixes in this backend */
 605         char    **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
 606         char    *be_root_dn;    /* the magic "root" dn for this db      */
 607         char    *be_root_ndn;   /* the magic "root" normalized dn for this db   */
 608         struct berval be_root_pw;       /* the magic "root" password for this db        */
 609         int     be_readonly;    /* 1 => db is in "read only" mode          */
 610         unsigned int be_max_deref_depth;       /* limit for depth of an alias deref  */
 611         int     be_sizelimit;   /* size limit for this backend             */
 612         int     be_timelimit;   /* time limit for this backend             */
 613         AccessControl *be_acl;  /* access control list for this backend    */
 614         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
 615         char    **be_replica;   /* replicas of this backend (in master)    */
 616         char    *be_replogfile; /* replication log file (in master)        */
 617         char    *be_update_ndn; /* allowed to make changes (in replicas) */
 618         struct berval **be_update_refs; /* where to refer modifying clients to */
 619         int     be_lastmod;     /* keep track of lastmodified{by,time}     */
 620
 621         char    *be_realm;
 622
 623         void    *be_private;    /* anything the backend database needs     */
 624 };
 625
 626 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
 627     Backend             *be,
 628     struct slap_conn            *conn,
 629     struct slap_op              *op,
 630         char            *reqoid,
 631     struct berval * reqdata,
 632         char            **rspoid,
 633     struct berval ** rspdata,
 634         LDAPControl *** rspctrls,
 635         char ** text,
 636         struct berval *** refs ));
 637
 638 struct slap_backend_info {
 639         char    *bi_type;       /* type of backend */
 640
 641         /*
 642          * per backend type routines:
 643          * bi_init: called to allocate a backend_info structure,
 644          *              called once BEFORE configuration file is read.
 645          *              bi_init() initializes this structure hence is
 646          *              called directly from be_initialize()
 647          * bi_config: called per 'backend' specific option
 648          *              all such options must before any 'database' options
 649          *              bi_config() is called only from read_config()
 650          * bi_open: called to open each database, called
 651          *              once AFTER configuration file is read but
 652          *              BEFORE any bi_db_open() calls.
 653          *              bi_open() is called from backend_startup()
 654          * bi_close: called to close each database, called
 655          *              once during shutdown after all bi_db_close calls.
 656          *              bi_close() is called from backend_shutdown()
 657          * bi_destroy: called to destroy each database, called
 658          *              once during shutdown after all bi_db_destroy calls.
 659          *              bi_destory() is called from backend_destroy()
 660          */
 661         int (*bi_init)  LDAP_P((BackendInfo *bi));
 662         int     (*bi_config) LDAP_P((BackendInfo *bi,
 663                 const char *fname, int lineno, int argc, char **argv ));
 664         int (*bi_open) LDAP_P((BackendInfo *bi));
 665         int (*bi_close) LDAP_P((BackendInfo *bi));
 666         int (*bi_destroy) LDAP_P((BackendInfo *bi));
 667
 668         /*
 669          * per database routines:
 670          * bi_db_init: called to initialize each database,
 671          *      called upon reading 'database <type>'
 672          *      called only from backend_db_init()
 673          * bi_db_config: called to configure each database,
 674          *  called per database to handle per database options
 675          *      called only from read_config()
 676          * bi_db_open: called to open each database
 677          *      called once per database immediately AFTER bi_open()
 678          *      calls but before daemon startup.
 679          *  called only by backend_startup()
 680          * bi_db_close: called to close each database
 681          *      called once per database during shutdown but BEFORE
 682          *  any bi_close call.
 683          *  called only by backend_shutdown()
 684          * bi_db_destroy: called to destroy each database
 685          *  called once per database during shutdown AFTER all
 686          *  bi_close calls but before bi_destory calls.
 687          *  called only by backend_destory()
 688          */
 689         int (*bi_db_init) LDAP_P((Backend *bd));
 690         int     (*bi_db_config) LDAP_P((Backend *bd,
 691                 const char *fname, int lineno, int argc, char **argv ));
 692         int (*bi_db_open) LDAP_P((Backend *bd));
 693         int (*bi_db_close) LDAP_P((Backend *bd));
 694         int (*bi_db_destroy) LDAP_P((Backend *db));
 695
 696         /* LDAP Operations Handling Routines */
 697         int     (*bi_op_bind)  LDAP_P(( BackendDB *bd,
 698                 struct slap_conn *c, struct slap_op *o,
 699                 char *dn, char *ndn, int method, char* mechanism,
 700                 struct berval *cred, char** edn ));
 701         int (*bi_op_unbind) LDAP_P((BackendDB *bd,
 702                 struct slap_conn *c, struct slap_op *o ));
 703         int     (*bi_op_search) LDAP_P((BackendDB *bd,
 704                 struct slap_conn *c, struct slap_op *o,
 705                 char *base, char *nbase, int scope, int deref,
 706                 int slimit, int tlimit,
 707                 Filter *f, char *filterstr, char **attrs,
 708                 int attrsonly));
 709         int     (*bi_op_compare)LDAP_P((BackendDB *bd,
 710                 struct slap_conn *c, struct slap_op *o,
 711                 char *dn, char *ndn, Ava *ava));
 712         int     (*bi_op_modify) LDAP_P((BackendDB *bd,
 713                 struct slap_conn *c, struct slap_op *o,
 714                 char *dn, char *ndn, LDAPModList *m));
 715         int     (*bi_op_modrdn) LDAP_P((BackendDB *bd,
 716                 struct slap_conn *c, struct slap_op *o,
 717                 char *dn, char *ndn, char *newrdn, int deleteoldrdn,
 718                 char *newSuperior));
 719         int     (*bi_op_add)    LDAP_P((BackendDB *bd,
 720                 struct slap_conn *c, struct slap_op *o,
 721                 Entry *e));
 722         int     (*bi_op_delete) LDAP_P((BackendDB *bd,
 723                 struct slap_conn *c, struct slap_op *o,
 724                 char *dn, char *ndn));
 725         int     (*bi_op_abandon) LDAP_P((BackendDB *bd,
 726                 struct slap_conn *c, struct slap_op *o,
 727                 ber_int_t msgid));
 728
 729         /* Extended Operations Helper */
 730         SLAP_EXTENDED_FN bi_extended;
 731
 732         /* Auxilary Functions */
 733         int     (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
 734
 735 #ifdef SLAPD_SCHEMA_NOT_COMPAT
 736         int     (*bi_acl_group)  LDAP_P((Backend *bd,
 737                 Entry *e, const char *bdn, const char *edn,
 738                 const char *objectclassValue,
 739                 AttributeType *group_at ));
 740 #else
 741         int     (*bi_acl_group)  LDAP_P((Backend *bd,
 742                 Entry *e, const char *bdn, const char *edn,
 743                 const char *objectclassValue,
 744                 const char *group_at ));
 745 #endif
 746
 747         int     (*bi_connection_init) LDAP_P((BackendDB *bd,
 748                 struct slap_conn *c));
 749         int     (*bi_connection_destroy) LDAP_P((BackendDB *bd,
 750                 struct slap_conn *c));
 751
 752         /* hooks for slap tools */
 753         int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
 754         int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
 755         ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
 756         ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
 757         Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
 758         ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
 759         int (*bi_tool_index_attr) LDAP_P(( BackendDB *be, char* type ));
 760         int (*bi_tool_index_change) LDAP_P(( BackendDB *be, char* type,
 761                 struct berval **bv, ID id, int op ));
 762         int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
 763
 764 #ifdef HAVE_CYRUS_SASL
 765         int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
 766                 const char *authnid, const char *authzid,
 767                 const char **canon_authzid, const char **errstr ));
 768         int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
 769                 const char *mechanism, const char *authzid,
 770                 const char *realm, sasl_secret_t **secret ));
 771         int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
 772                 const char *mechanism, const char *auth_identity,
 773                 const char *realm, const sasl_secret_t *secret ));
 774 #endif /* HAVE_CYRUS_SASL */
 775
 776 #define SLAP_INDEX_ADD_OP               0x0001
 777 #define SLAP_INDEX_DELETE_OP    0x0002
 778
 779         char **bi_controls;             /* supported controls */
 780
 781         unsigned int bi_nDB;    /* number of databases of this type */
 782         void    *bi_private;    /* anything the backend type needs */
 783 };
 784
 785 /*
 786  * represents an operation pending from an ldap client
 787  */
 788
 789 typedef struct slap_op {
 790         ber_int_t       o_opid;         /* id of this operation           */
 791         ber_int_t       o_msgid;        /* msgid of the request           */
 792
 793         ldap_pvt_thread_t       o_tid;          /* thread handling this op        */
 794
 795         BerElement      *o_ber;         /* ber of the request             */
 796
 797         ber_tag_t       o_tag;          /* tag of the request             */
 798         time_t          o_time;         /* time op was initiated          */
 799
 800         int             o_bind_in_progress;     /* multi-step bind in progress */
 801 #ifdef SLAP_AUTHZID
 802         /* should only be used for reporting purposes */
 803         char    *o_authc_dn;    /* authentication DN */
 804
 805         /* should be used as the DN of the User */
 806         char    *o_authz_dn;    /* authorization DN */
 807         char    *o_authz_ndn;   /* authorizaiton NDN */
 808
 809 #else
 810         char            *o_dn;          /* dn bound when op was initiated */
 811         char            *o_ndn;         /* normalized dn bound when op was initiated */
 812 #endif
 813
 814         ber_int_t       o_protocol;     /* version of the LDAP protocol used by client */
 815         ber_tag_t       o_authtype;     /* auth method used to bind dn    */
 816                                         /* values taken from ldap.h       */
 817                                         /* LDAP_AUTH_*                    */
 818         char            *o_authmech; /* SASL mechanism used to bind dn */
 819
 820         LDAPControl     **o_ctrls;       /* controls */
 821
 822         unsigned long   o_connid; /* id of conn initiating this op  */
 823
 824 #ifdef LDAP_CONNECTIONLESS
 825         int             o_cldap;        /* != 0 if this came in via CLDAP */
 826         struct sockaddr o_clientaddr;   /* client address if via CLDAP    */
 827         char            o_searchbase;   /* search base if via CLDAP       */
 828 #endif
 829
 830         ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon  */
 831         int             o_abandon;      /* abandon flag */
 832
 833         struct slap_op  *o_next;        /* next operation in list         */
 834         void    *o_private;     /* anything the backend needs     */
 835 } Operation;
 836
 837 /*
 838  * represents a connection from an ldap client
 839  */
 840
 841 typedef struct slap_conn {
 842         int                     c_struct_state; /* structure management state */
 843         int                     c_conn_state;   /* connection state */
 844
 845         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
 846         Sockbuf         *c_sb;                  /* ber connection stuff           */
 847
 848         /* only can be changed by connect_init */
 849         time_t          c_starttime;    /* when the connection was opened */
 850         time_t          c_activitytime; /* when the connection was last used */
 851         unsigned long           c_connid;       /* id of this connection for stats*/
 852
 853         char            *c_listener_url;        /* listener URL */
 854         char            *c_peer_domain; /* DNS name of client */
 855         char            *c_peer_name;   /* peer name (trans=addr:port) */
 856         char            *c_sock_name;   /* sock name (trans=addr:port) */
 857
 858         /* only can be changed by binding thread */
 859         int             c_bind_in_progress;     /* multi-op bind in progress */
 860 #ifdef HAVE_CYRUS_SASL
 861         sasl_conn_t     *c_sasl_context;
 862 #endif
 863         void    *c_authstate;   /* SASL state data */
 864
 865         Backend *c_authc_backend;
 866
 867         /* authorization backend */
 868         Backend *c_authz_backend;
 869
 870 #ifdef SLAP_AUTHZID
 871         /* authentication backend */
 872         /* should only be used for reporting purposes */
 873         char    *c_authc_dn;    /* authentication DN */
 874
 875         /* should be used as the DN of the User */
 876         char    *c_authz_dn;    /* authorization DN */
 877         char    *c_authz_ndn;   /* authorization NDN */
 878
 879 #else
 880         char    *c_cdn;         /* DN provided by the client */
 881         char    *c_dn;          /* DN bound to this conn  */
 882 #endif
 883
 884         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
 885         ber_tag_t       c_authtype;/* auth method used to bind c_dn  */
 886         char    *c_authmech;    /* SASL mechanism used to bind c_dn */
 887
 888         Operation       *c_ops;                 /* list of operations being processed */
 889         Operation       *c_pending_ops; /* list of pending operations */
 890
 891         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
 892         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
 893
 894         BerElement      *c_currentber;  /* ber we're attempting to read */
 895         int             c_writewaiter;  /* true if writer is waiting */
 896
 897 #ifdef HAVE_TLS
 898         int     c_is_tls;               /* true if this LDAP over raw TLS */
 899         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
 900 #endif
 901
 902         long    c_n_ops_received;               /* num of ops received (next op_id) */
 903         long    c_n_ops_executing;      /* num of ops currently executing */
 904         long    c_n_ops_pending;                /* num of ops pending execution */
 905         long    c_n_ops_completed;      /* num of ops completed */
 906
 907         long    c_n_get;                /* num of get calls */
 908         long    c_n_read;               /* num of read calls */
 909         long    c_n_write;              /* num of write calls */
 910 } Connection;
 911
 912 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
 913 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
 914         do { \
 915                 if ( ldap_debug & (level) ) \
 916                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
 917                 if ( ldap_syslog & (level) ) \
 918                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
 919                                 (arg2), (arg3) ); \
 920         } while (0)
 921 #else
 922 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
 923 #endif
 924
 925 LDAP_END_DECL
 926
 927 #include "proto-slap.h"
 928
 929 #endif /* _slap_h_ */