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

   1 /* slap.h - stand alone ldap server include file */
   2
   3 #ifndef _SLDAPD_H_
   4 #define _SLDAPD_H_
   5
   6 #include <ac/stdlib.h>
   7
   8 #include <sys/types.h>
   9 #include <ac/syslog.h>
  10 #include <ac/regex.h>
  11 #include <ac/socket.h>
  12 #include <ldap_schema.h>
  13
  14 #include "avl.h"
  15
  16 #ifndef ldap_debug
  17 #define ldap_debug slap_debug
  18 #endif
  19
  20
  21 #include "ldap_log.h"
  22
  23 #include "lber.h"
  24 #include "ldap.h"
  25
  26 #include "ldap_pvt_thread.h"
  27 #include "ldif.h"
  28 #ifdef f_next
  29 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  30 #endif
  31
  32 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
  33  *
  34  * This is a value used internally by the backends. It is needed to allow
  35  * adding values that already exist without getting an error as required by
  36  * modrdn when the new rdn was already an attribute value itself.
  37  * JCG 05/1999 (gomez@engr.sgi.com)
  38  */
  39 #define LDAP_MOD_SOFTADD        0x1000
  40
  41 #define DN_DNS  0
  42 #define DN_X500 1
  43
  44 #define ON      1
  45 #define OFF     (-1)
  46 #define UNDEFINED 0
  47
  48 #define MAXREMATCHES 10
  49
  50 #define DNSEPARATOR(c)  ((c) == ',' || (c) == ';')
  51 #define SEPARATOR(c)    ((c) == ',' || (c) == ';' || (c) == '+')
  52 #define SPACE(c)        ((c) == ' ' || (c) == '\n')
  53 #define NEEDSESCAPE(c)  ((c) == '\\' || (c) == '"')
  54
  55 #define SLAP_SCHERR_OUTOFMEM            1
  56 #define SLAP_SCHERR_CLASS_NOT_FOUND     2
  57 #define SLAP_SCHERR_ATTR_NOT_FOUND      3
  58 #define SLAP_SCHERR_DUP_CLASS           4
  59 #define SLAP_SCHERR_DUP_ATTR            5
  60
  61 LDAP_BEGIN_DECL
  62
  63 extern int slap_debug;
  64
  65 struct slap_op;
  66 struct slap_conn;
  67
  68 /*
  69  * represents an attribute value assertion (i.e., attr=value)
  70  */
  71 typedef struct ava {
  72         char            *ava_type;
  73         struct berval   ava_value;
  74 } Ava;
  75
  76 /*
  77  * represents a search filter
  78  */
  79 typedef struct filter {
  80         unsigned long   f_choice;       /* values taken from ldap.h */
  81
  82         union f_un_u {
  83                 /* present */
  84                 char            *f_un_type;
  85
  86                 /* equality, lessorequal, greaterorequal, approx */
  87                 Ava             f_un_ava;
  88
  89                 /* and, or, not */
  90                 struct filter   *f_un_complex;
  91
  92                 /* substrings */
  93                 struct sub {
  94                         char    *f_un_sub_type;
  95                         char    *f_un_sub_initial;
  96                         char    **f_un_sub_any;
  97                         char    *f_un_sub_final;
  98                 } f_un_sub;
  99         } f_un;
 100 #define f_type          f_un.f_un_type
 101 #define f_ava           f_un.f_un_ava
 102 #define f_avtype        f_un.f_un_ava.ava_type
 103 #define f_avvalue       f_un.f_un_ava.ava_value
 104 #define f_and           f_un.f_un_complex
 105 #define f_or            f_un.f_un_complex
 106 #define f_not           f_un.f_un_complex
 107 #define f_list          f_un.f_un_complex
 108 #define f_sub           f_un.f_un_sub
 109 #define f_sub_type      f_un.f_un_sub.f_un_sub_type
 110 #define f_sub_initial   f_un.f_un_sub.f_un_sub_initial
 111 #define f_sub_any       f_un.f_un_sub.f_un_sub_any
 112 #define f_sub_final     f_un.f_un_sub.f_un_sub_final
 113
 114         struct filter   *f_next;
 115 } Filter;
 116
 117 /*
 118  * represents an attribute (type + values + syntax)
 119  */
 120 typedef struct attr {
 121         char            *a_type;
 122         struct berval   **a_vals;
 123         int             a_syntax;
 124         struct attr     *a_next;
 125 } Attribute;
 126
 127 /*
 128  * the attr_syntax() routine returns one of these values
 129  * telling what kind of syntax an attribute supports.
 130  */
 131 #define SYNTAX_CIS      0x01    /* case insensitive string              */
 132 #define SYNTAX_CES      0x02    /* case sensitive string                */
 133 #define SYNTAX_BIN      0x04    /* binary data                          */
 134 #define SYNTAX_TEL      0x08    /* telephone number string              */
 135 #define SYNTAX_DN       0x10    /* dn string                            */
 136
 137 /*
 138  * the id used in the indexes to refer to an entry
 139  */
 140 typedef unsigned long   ID;
 141 #define NOID    ((unsigned long)-1)
 142
 143 /*
 144  * represents an entry in core
 145  */
 146 typedef struct entry {
 147         /*
 148          * The ID field should only be changed before entry is
 149          * inserted into a cache.  The ID value is backend
 150          * specific.
 151          */
 152         ID              e_id;
 153
 154         char            *e_dn;          /* DN of this entry */
 155         char            *e_ndn;         /* normalized DN of this entry */
 156         Attribute       *e_attrs;       /* list of attributes + values */
 157
 158         /* for use by the backend for any purpose */
 159         void*   e_private;
 160 } Entry;
 161
 162 /*
 163  * represents an access control list
 164  */
 165
 166 /* the "by" part */
 167 struct access {
 168 #define ACL_NONE        0x01
 169 #define ACL_COMPARE     0x02
 170 #define ACL_SEARCH      0x04
 171 #define ACL_READ        0x08
 172 #define ACL_WRITE       0x10
 173 #define ACL_SELF        0x40
 174         int                     a_access;
 175
 176         char            *a_dnpat;
 177         char            *a_addrpat;
 178         char            *a_domainpat;
 179         char            *a_dnattr;
 180
 181 #ifdef SLAPD_ACLGROUPS
 182         char            *a_group;
 183         char            *a_objectclassvalue;
 184         char            *a_groupattrname;
 185 #endif
 186         struct access   *a_next;
 187 };
 188
 189 /* the "to" part */
 190 struct acl {
 191         /* "to" part: the entries this acl applies to */
 192         Filter          *acl_filter;
 193         regex_t         acl_dnre;
 194         char            *acl_dnpat;
 195         char            **acl_attrs;
 196
 197         /* "by" part: list of who has what access to the entries */
 198         struct access   *acl_access;
 199
 200         struct acl      *acl_next;
 201 };
 202
 203 /*
 204  * A list of LDAPMods
 205  */
 206 typedef struct ldapmodlist {
 207         struct ldapmod ml_mod;
 208         struct ldapmodlist *ml_next;
 209 #define ml_op           ml_mod.mod_op
 210 #define ml_type         ml_mod.mod_type
 211 #define ml_values       ml_mod.mod_values
 212 #define ml_bvalues      ml_mod.mod_bvalues
 213 } LDAPModList;
 214
 215 /*
 216  * represents schema information for a database
 217  */
 218 typedef int slap_syntax_check_func LDAP_P((struct berval * val));
 219
 220 typedef struct slap_syntax {
 221         LDAP_SYNTAX                     ssyn_syn;
 222         slap_syntax_check_func          *ssyn_check;
 223 } Syntax;
 224 #define ssyn_oid                        ssyn_syn.syn_oid
 225 #define ssyn_desc                       ssyn_syn.syn_desc
 226
 227 typedef int slap_mr_normalize_func LDAP_P((struct berval * val, struct berval **normalized));
 228 typedef int slap_mr_compare_func LDAP_P((struct berval * val1, struct berval * val2));
 229
 230 typedef struct slap_matching_rule {
 231         LDAP_MATCHING_RULE              smr_mrule;
 232         slap_mr_normalize_func          *smr_normalize;
 233         slap_mr_compare_func            *smr_compare;
 234         Syntax                          smr_syntax;
 235 } MatchingRule;
 236 #define smr_oid                         smr_mrule.mr_oid
 237 #define smr_names                       smr_mrule.mr_names
 238 #define smr_desc                        smr_mrule.mr_desc
 239 #define smr_obsolete                    smr_mrule.mr_obsolete
 240 #define smr_syntax_oid                  smr_mrule.mr_syntax_oid
 241
 242 typedef struct slap_attribute_type {
 243         LDAP_ATTRIBUTE_TYPE             sat_atype;
 244         struct slap_attribute_type      *sat_sup;
 245         struct slap_attribute_type      **sat_subtypes;
 246         MatchingRule                    *sat_equality;
 247         MatchingRule                    *sat_ordering;
 248         MatchingRule                    *sat_substr;
 249         Syntax                          *sat_syntax;
 250         /* The next one is created to help in the transition */
 251         int                             sat_syntax_compat;
 252         struct slap_attribute_type      *sat_next;
 253 } AttributeType;
 254 #define sat_oid                 sat_atype.at_oid
 255 #define sat_names               sat_atype.at_names
 256 #define sat_desc                sat_atype.at_desc
 257 #define sat_obsolete            sat_atype.at_obsolete
 258 #define sat_sup_oid             sat_atype.at_sup_oid
 259 #define sat_equality_oid        sat_atype.at_equality_oid
 260 #define sat_ordering_oid        sat_atype.at_ordering_oid
 261 #define sat_substr_oid          sat_atype.at_substr_oid
 262 #define sat_syntax_oid          sat_atype.at_syntax_oid
 263 #define sat_syntax_len          sat_atype.at_syntax_len
 264 #define sat_single_value        sat_atype.at_single_value
 265 #define sat_collective          sat_atype.at_collective
 266 #define sat_no_user_mods        sat_atype.at_no_user_mods
 267 #define sat_usage               sat_atype.at_usage
 268
 269 typedef struct slap_object_class {
 270         LDAP_OBJECT_CLASS               soc_oclass;
 271         struct slap_object_class        **soc_sups;
 272         AttributeType                   **soc_required;
 273         AttributeType                   **soc_allowed;
 274         struct slap_object_class        *soc_next;
 275 } ObjectClass;
 276 #define soc_oid                 soc_oclass.oc_oid
 277 #define soc_names               soc_oclass.oc_names
 278 #define soc_desc                soc_oclass.oc_desc
 279 #define soc_obsolete            soc_oclass.oc_obsolete
 280 #define soc_sup_oids            soc_oclass.oc_sup_oids
 281 #define soc_kind                soc_oclass.oc_kind
 282 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 283 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 284
 285 /*
 286  * Backend-info
 287  * represents a backend
 288  */
 289
 290 typedef struct backend_info BackendInfo;        /* per backend type */
 291 typedef struct backend_db BackendDB;            /* per backend database */
 292
 293 extern int nBackendInfo;
 294 extern int nBackendDB;
 295 extern BackendInfo      *backendInfo;
 296 extern BackendDB        *backendDB;
 297
 298 extern int                      slapMode;
 299 #define SLAP_UNDEFINED_MODE     0
 300 #define SLAP_SERVER_MODE        1
 301 #define SLAP_TOOL_MODE          2
 302 #ifdef SLAPD_BDB2
 303 #  define SLAP_TIMEDSERVER_MODE  3
 304 #  define SLAP_TOOLID_MODE       4
 305 #endif
 306
 307 /* temporary aliases */
 308 typedef BackendDB Backend;
 309 #define nbackends nBackendDB
 310 #define backends backendDB
 311
 312 struct backend_db {
 313         BackendInfo     *bd_info;       /* pointer to shared backend info */
 314
 315         /* BackendInfo accessors */
 316 #define         be_config       bd_info->bi_db_config
 317 #define         be_type         bd_info->bi_type
 318
 319 #define         be_bind         bd_info->bi_op_bind
 320 #define         be_unbind       bd_info->bi_op_unbind
 321 #define         be_add          bd_info->bi_op_add
 322 #define         be_compare      bd_info->bi_op_compare
 323 #define         be_delete       bd_info->bi_op_delete
 324 #define         be_modify       bd_info->bi_op_modify
 325 #define         be_modrdn       bd_info->bi_op_modrdn
 326 #define         be_search       bd_info->bi_op_search
 327
 328 #define         be_release      bd_info->bi_entry_release_rw
 329 #define         be_group        bd_info->bi_acl_group
 330
 331         /* these should be renamed from be_ to bd_ */
 332         char    **be_suffix;    /* the DN suffixes of data in this backend */
 333         char    **be_nsuffix;   /* the normalized DN suffixes in this backend */
 334         char    **be_suffixAlias;       /* the DN suffix aliases of data in this backend */
 335         char    *be_root_dn;    /* the magic "root" dn for this db      */
 336         char    *be_root_ndn;   /* the magic "root" normalized dn for this db   */
 337         char    *be_root_pw;    /* the magic "root" password for this db        */
 338         int     be_readonly;    /* 1 => db is in "read only" mode          */
 339         int     be_maxDerefDepth;       /* limit for depth of an alias deref  */
 340         int     be_sizelimit;   /* size limit for this backend             */
 341         int     be_timelimit;   /* time limit for this backend             */
 342         struct acl *be_acl;     /* access control list for this backend    */
 343         int     be_dfltaccess;  /* access given if no acl matches          */
 344         char    **be_replica;   /* replicas of this backend (in master)    */
 345         char    *be_replogfile; /* replication log file (in master)        */
 346         char    *be_update_ndn; /* allowed to make changes (in replicas)   */
 347         int     be_lastmod;     /* keep track of lastmodified{by,time}     */
 348
 349         void    *be_private;    /* anything the backend database needs     */
 350 };
 351
 352 struct backend_info {
 353         char    *bi_type;       /* type of backend */
 354
 355         /*
 356          * per backend type routines:
 357          * bi_init: called to allocate a backend_info structure,
 358          *              called once BEFORE configuration file is read.
 359          *              bi_init() initializes this structure hence is
 360          *              called directly from be_initialize()
 361          * bi_config: called per 'backend' specific option
 362          *              all such options must before any 'database' options
 363          *              bi_config() is called only from read_config()
 364          * bi_open: called to open each database, called
 365          *              once AFTER configuration file is read but
 366          *              BEFORE any bi_db_open() calls.
 367          *              bi_open() is called from backend_startup()
 368          * bi_close: called to close each database, called
 369          *              once during shutdown after all bi_db_close calls.
 370          *              bi_close() is called from backend_shutdown()
 371          * bi_destroy: called to destroy each database, called
 372          *              once during shutdown after all bi_db_destroy calls.
 373          *              bi_destory() is called from backend_destroy()
 374          */
 375         int (*bi_init)  LDAP_P((BackendInfo *bi));
 376         int     (*bi_config) LDAP_P((BackendInfo *bi,
 377                 char *fname, int lineno, int argc, char **argv ));
 378         int (*bi_open) LDAP_P((BackendInfo *bi));
 379         int (*bi_close) LDAP_P((BackendInfo *bi));
 380         int (*bi_destroy) LDAP_P((BackendInfo *bi));
 381
 382         /*
 383          * per database routines:
 384          * bi_db_init: called to initialize each database,
 385          *      called upon reading 'database <type>'
 386          *      called only from backend_db_init()
 387          * bi_db_config: called to configure each database,
 388          *  called per database to handle per database options
 389          *      called only from read_config()
 390          * bi_db_open: called to open each database
 391          *      called once per database immediately AFTER bi_open()
 392          *      calls but before daemon startup.
 393          *  called only by backend_startup()
 394          * bi_db_close: called to close each database
 395          *      called once per database during shutdown but BEFORE
 396          *  any bi_close call.
 397          *  called only by backend_shutdown()
 398          * bi_db_destroy: called to destroy each database
 399          *  called once per database during shutdown AFTER all
 400          *  bi_close calls but before bi_destory calls.
 401          *  called only by backend_destory()
 402          */
 403         int (*bi_db_init) LDAP_P((Backend *bd));
 404         int     (*bi_db_config) LDAP_P((Backend *bd,
 405                 char *fname, int lineno, int argc, char **argv ));
 406         int (*bi_db_open) LDAP_P((Backend *bd));
 407         int (*bi_db_close) LDAP_P((Backend *bd));
 408         int (*bi_db_destroy) LDAP_P((Backend *db));
 409
 410         /* LDAP Operations Handling Routines */
 411         int     (*bi_op_bind)  LDAP_P(( BackendDB *bd,
 412                 struct slap_conn *c, struct slap_op *o,
 413                 char *dn, int method, struct berval *cred, char** edn ));
 414         int (*bi_op_unbind) LDAP_P((BackendDB *bd,
 415                 struct slap_conn *c, struct slap_op *o ));
 416         int     (*bi_op_search) LDAP_P((BackendDB *bd,
 417                 struct slap_conn *c, struct slap_op *o,
 418                 char *base, int scope, int deref, int slimit, int tlimit,
 419                 Filter *f, char *filterstr, char **attrs, int attrsonly));
 420         int     (*bi_op_compare)LDAP_P((BackendDB *bd,
 421                 struct slap_conn *c, struct slap_op *o,
 422                 char *dn, Ava *ava));
 423         int     (*bi_op_modify) LDAP_P((BackendDB *bd,
 424                 struct slap_conn *c, struct slap_op *o,
 425                 char *dn, LDAPModList *m));
 426         int     (*bi_op_modrdn) LDAP_P((BackendDB *bd,
 427                 struct slap_conn *c, struct slap_op *o,
 428                 char *dn, char *newrdn, int deleteoldrdn,
 429                 char *newSuperior));
 430         int     (*bi_op_add)    LDAP_P((BackendDB *bd,
 431                 struct slap_conn *c, struct slap_op *o,
 432                 Entry *e));
 433         int     (*bi_op_delete) LDAP_P((BackendDB *bd,
 434                 struct slap_conn *c, struct slap_op *o,
 435                 char *dn));
 436         /* Bug: be_op_abandon in unused! */
 437         int     (*bi_op_abandon) LDAP_P((BackendDB *bd,
 438                 struct slap_conn *c, struct slap_op *o,
 439                 int msgid));
 440
 441         /* Auxilary Functions */
 442         int     (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
 443 #ifdef SLAPD_ACLGROUPS
 444         int     (*bi_acl_group)  LDAP_P((Backend *bd,
 445                 Entry *e, char *bdn, char *edn,
 446                 char *objectclassValue, char *groupattrName ));
 447 #endif
 448
 449         unsigned int bi_nDB;    /* number of databases of this type */
 450         void    *bi_private;    /* anything the backend type needs */
 451 };
 452
 453 /*
 454  * represents an operation pending from an ldap client
 455  */
 456
 457 typedef struct slap_op {
 458         long    o_opid;         /* id of this operation           */
 459         long    o_msgid;        /* msgid of the request           */
 460
 461         ldap_pvt_thread_t       o_tid;          /* thread handling this op        */
 462
 463         BerElement      *o_ber;         /* ber of the request             */
 464
 465         unsigned long   o_tag;          /* tag of the request             */
 466         time_t          o_time;         /* time op was initiated          */
 467         char            *o_dn;          /* dn bound when op was initiated */
 468         char            *o_ndn;         /* normalized dn bound when op was initiated */
 469         int                     o_authtype;     /* auth method used to bind dn    */
 470                                         /* values taken from ldap.h       */
 471                                         /* LDAP_AUTH_*                    */
 472
 473 /*       long   o_connid;       *//* id of conn initiating this op  */
 474
 475 #ifdef LDAP_CONNECTIONLESS
 476         int             o_cldap;        /* != 0 if this came in via CLDAP */
 477         struct sockaddr o_clientaddr;   /* client address if via CLDAP    */
 478         char            o_searchbase;   /* search base if via CLDAP       */
 479 #endif
 480
 481         ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon  */
 482         int             o_abandon;      /* abandon flag */
 483
 484         struct slap_op  *o_next;        /* next operation in list         */
 485         void    *o_private;     /* anything the backend needs     */
 486 } Operation;
 487
 488 /*
 489  * represents a connection from an ldap client
 490  */
 491
 492 typedef struct slap_conn {
 493         int                     c_struct_state; /* structure management state */
 494         int                     c_conn_state;   /* connection state */
 495
 496         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
 497         Sockbuf         *c_sb;                  /* ber connection stuff           */
 498
 499         /* only can be changed by connect_init */
 500         time_t          c_starttime;    /* when the connection was opened */
 501         long            c_connid;       /* id of this connection for stats*/
 502         char            *c_client_addr; /* address of client */
 503         char            *c_client_name; /* name of client */
 504
 505         /* only can be changed by binding thread */
 506         char    *c_cdn;         /* DN provided by the client */
 507         char    *c_dn;          /* DN bound to this conn  */
 508         int             c_protocol;     /* version of the LDAP protocol used by client */
 509         int             c_authtype;     /* auth method used to bind c_dn  */
 510 #ifdef LDAP_COMPAT
 511         int             c_version;      /* for compatibility w/ U-Mich 2.0 & 3.0 */
 512 #endif
 513
 514         Operation       *c_ops;                 /* list of operations being processed */
 515         Operation       *c_pending_ops; /* list of pending operations */
 516
 517         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
 518         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
 519
 520         BerElement      *c_currentber;  /* ber we're attempting to read */
 521         int             c_writewaiter;  /* true if writer is waiting */
 522
 523         long    c_n_ops_received;               /* num of ops received (next op_id) */
 524         long    c_n_ops_executing;      /* num of ops currently executing */
 525         long    c_n_ops_pending;                /* num of ops pending execution */
 526         long    c_n_ops_completed;      /* num of ops completed */
 527 } Connection;
 528
 529 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
 530 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
 531         do { \
 532                 if ( ldap_debug & (level) ) \
 533                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
 534                 if ( ldap_syslog & (level) ) \
 535                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
 536                                 (arg2), (arg3) ); \
 537         } while (0)
 538 #else
 539 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
 540 #endif
 541
 542 #include "proto-slap.h"
 543
 544 LDAP_END_DECL
 545
 546 #endif /* _slap_h_ */