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

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