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