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 <stdlib.h>
   7
   8 #ifndef LDAP_SYSLOG
   9 #define LDAP_SYSLOG 1
  10 #endif
  11
  12 #include <sys/types.h>
  13 #include <ac/syslog.h>
  14 #include <ac/regex.h>
  15
  16 #undef NDEBUG
  17 #include <assert.h>
  18
  19 #include "avl.h"
  20
  21 #ifndef ldap_debug
  22 #define ldap_debug slap_debug
  23 #endif
  24
  25 #include "ldap_log.h"
  26
  27 #include "../../libraries/liblber/lber-int.h"
  28 #include "ldap.h"
  29
  30 #include "lthread.h"
  31 #include "lthread_rdwr.h"
  32 #include "ldif.h"
  33 #ifdef f_next
  34 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
  35 #endif
  36
  37 #define DN_DNS  0
  38 #define DN_X500 1
  39
  40 #define ON      1
  41 #define OFF     (-1)
  42 #define UNDEFINED 0
  43
  44 #define MAXREMATCHES 10
  45
  46 #define DNSEPARATOR(c)  ((c) == ',' || (c) == ';')
  47 #define SEPARATOR(c)    ((c) == ',' || (c) == ';' || (c) == '+')
  48 #define SPACE(c)        ((c) == ' ' || (c) == '\n')
  49 #define NEEDSESCAPE(c)  ((c) == '\\' || (c) == '"')
  50
  51 LDAP_BEGIN_DECL
  52
  53 extern int slap_debug;
  54
  55 struct slap_op;
  56 struct slap_conn;
  57
  58 /*
  59  * represents an attribute value assertion (i.e., attr=value)
  60  */
  61 typedef struct ava {
  62         char            *ava_type;
  63         struct berval   ava_value;
  64 } Ava;
  65
  66 /*
  67  * represents a search filter
  68  */
  69 typedef struct filter {
  70         unsigned long   f_choice;       /* values taken from ldap.h */
  71
  72         union {
  73                 /* present */
  74                 char            *f_un_type;
  75
  76                 /* equality, lessorequal, greaterorequal, approx */
  77                 Ava             f_un_ava;
  78
  79                 /* and, or, not */
  80                 struct filter   *f_un_complex;
  81
  82                 /* substrings */
  83                 struct sub {
  84                         char    *f_un_sub_type;
  85                         char    *f_un_sub_initial;
  86                         char    **f_un_sub_any;
  87                         char    *f_un_sub_final;
  88                 } f_un_sub;
  89         } f_un;
  90 #define f_type          f_un.f_un_type
  91 #define f_ava           f_un.f_un_ava
  92 #define f_avtype        f_un.f_un_ava.ava_type
  93 #define f_avvalue       f_un.f_un_ava.ava_value
  94 #define f_and           f_un.f_un_complex
  95 #define f_or            f_un.f_un_complex
  96 #define f_not           f_un.f_un_complex
  97 #define f_list          f_un.f_un_complex
  98 #define f_sub           f_un.f_un_sub
  99 #define f_sub_type      f_un.f_un_sub.f_un_sub_type
 100 #define f_sub_initial   f_un.f_un_sub.f_un_sub_initial
 101 #define f_sub_any       f_un.f_un_sub.f_un_sub_any
 102 #define f_sub_final     f_un.f_un_sub.f_un_sub_final
 103
 104         struct filter   *f_next;
 105 } Filter;
 106
 107 /*
 108  * represents an attribute (type + values + syntax)
 109  */
 110 typedef struct attr {
 111         char            *a_type;
 112         struct berval   **a_vals;
 113         int             a_syntax;
 114         struct attr     *a_next;
 115 } Attribute;
 116
 117 /*
 118  * the attr_syntax() routine returns one of these values
 119  * telling what kind of syntax an attribute supports.
 120  */
 121 #define SYNTAX_CIS      0x01    /* case insensitive string              */
 122 #define SYNTAX_CES      0x02    /* case sensitive string                */
 123 #define SYNTAX_BIN      0x04    /* binary data                          */
 124 #define SYNTAX_TEL      0x08    /* telephone number string              */
 125 #define SYNTAX_DN       0x10    /* dn string                            */
 126
 127 /*
 128  * the id used in the indexes to refer to an entry
 129  */
 130 typedef unsigned long   ID;
 131 #define NOID    ((unsigned long)-1)
 132
 133 /*
 134  * represents an entry in core
 135  */
 136 typedef struct entry {
 137         char            *e_dn;          /* DN of this entry               */
 138         char            *e_ndn;         /* normalized DN of this entry    */
 139         Attribute       *e_attrs;       /* list of attributes + values    */
 140
 141         ID              e_id;           /* id of this entry - this should */
 142                                         /* really be private to back-ldbm */
 143         char            e_state;        /* for the cache                  */
 144
 145         pthread_rdwr_t  e_rdwr; /* reader/writer lock             */
 146
 147 #define ENTRY_STATE_DELETED     1
 148 #define ENTRY_STATE_CREATING    2
 149         int             e_refcnt;       /* # threads ref'ing this entry   */
 150         struct entry    *e_lrunext;     /* for cache lru list             */
 151         struct entry    *e_lruprev;
 152 } Entry;
 153
 154 /*
 155  * represents an access control list
 156  */
 157
 158 /* the "by" part */
 159 struct access {
 160 #define ACL_NONE        0x01
 161 #define ACL_COMPARE     0x02
 162 #define ACL_SEARCH      0x04
 163 #define ACL_READ        0x08
 164 #define ACL_WRITE       0x10
 165 #define ACL_SELF        0x40
 166         int                     a_access;
 167
 168         char            *a_dnpat;
 169         char            *a_addrpat;
 170         char            *a_domainpat;
 171         char            *a_dnattr;
 172
 173 #ifdef SLAPD_ACLGROUPS
 174         char            *a_group;
 175         char            *a_objectclassvalue;
 176         char            *a_groupattrname;
 177 #endif
 178         struct access   *a_next;
 179 };
 180
 181 /* the "to" part */
 182 struct acl {
 183         /* "to" part: the entries this acl applies to */
 184         Filter          *acl_filter;
 185         regex_t         acl_dnre;
 186         char            *acl_dnpat;
 187         char            **acl_attrs;
 188
 189         /* "by" part: list of who has what access to the entries */
 190         struct access   *acl_access;
 191
 192         struct acl      *acl_next;
 193 };
 194
 195 /*
 196  * A list of LDAPMods
 197  */
 198 typedef struct ldapmodlist {
 199         struct ldapmod ml_mod;
 200         struct ldapmodlist *ml_next;
 201 #define ml_op           ml_mod.mod_op
 202 #define ml_type         ml_mod.mod_type
 203 #define ml_values       ml_mod.mod_values
 204 #define ml_bvalues      ml_mod.mod_bvalues
 205 } LDAPModList;
 206
 207 /*
 208  * represents schema information for a database
 209  */
 210
 211 struct objclass {
 212         char            *oc_name;
 213         char            **oc_required;
 214         char            **oc_allowed;
 215         struct objclass *oc_next;
 216 };
 217
 218 /*
 219  * represents a "database"
 220  */
 221
 222 typedef struct backend Backend;
 223 struct backend {
 224         char    **be_suffix;    /* the DN suffixes of data in this backend */
 225         char    **be_suffixAlias;       /* the DN suffix aliases of data in this backend */
 226         char    *be_root_dn;    /* the magic "root" dn for this db      */
 227         char    *be_root_ndn;   /* the magic "root" normalized dn for this db   */
 228         char    *be_root_pw;    /* the magic "root" password for this db        */
 229         int     be_readonly;    /* 1 => db is in "read only" mode          */
 230         int     be_maxDerefDepth;       /* limit for depth of an alias deref  */
 231         int     be_sizelimit;   /* size limit for this backend             */
 232         int     be_timelimit;   /* time limit for this backend             */
 233         struct acl *be_acl;     /* access control list for this backend    */
 234         int     be_dfltaccess;  /* access given if no acl matches          */
 235         char    **be_replica;   /* replicas of this backend (in master)    */
 236         char    *be_replogfile; /* replication log file (in master)        */
 237         char    *be_update_ndn; /* allowed to make changes (in replicas)   */
 238         int     be_lastmod;     /* keep track of lastmodified{by,time}     */
 239         char    *be_type;       /* type of database                        */
 240
 241         void    *be_private;    /* anything the backend needs              */
 242
 243         /* backend routines */
 244         int     (*be_bind)   LDAP_P((Backend *be,
 245                 struct slap_conn *c, struct slap_op *o,
 246                 char *dn, int method, struct berval *cred, char** edn ));
 247         void    (*be_unbind) LDAP_P((Backend *be,
 248                 struct slap_conn *c, struct slap_op *o ));
 249         int     (*be_search) LDAP_P((Backend *be,
 250                 struct slap_conn *c, struct slap_op *o,
 251                 char *base, int scope, int deref, int slimit, int tlimit,
 252                 Filter *f, char *filterstr, char **attrs, int attrsonly));
 253         int     (*be_compare)LDAP_P((Backend *be,
 254                 struct slap_conn *c, struct slap_op *o,
 255                 char *dn, Ava *ava));
 256         int     (*be_modify) LDAP_P((Backend *be,
 257                 struct slap_conn *c, struct slap_op *o,
 258                 char *dn, LDAPModList *m));
 259         int     (*be_modrdn) LDAP_P((Backend *be,
 260                 struct slap_conn *c, struct slap_op *o,
 261                 char *dn, char *newrdn, int deleteoldrdn ));
 262         int     (*be_add)    LDAP_P((Backend *be,
 263                 struct slap_conn *c, struct slap_op *o,
 264                 Entry *e));
 265         int     (*be_delete) LDAP_P((Backend *be,
 266                 struct slap_conn *c, struct slap_op *o,
 267                 char *dn));
 268         /* Bug: be_abandon in unused! */
 269         void    (*be_abandon)LDAP_P((Backend *be,
 270                 struct slap_conn *c, struct slap_op *o,
 271                 int msgid));
 272         void    (*be_config) LDAP_P((Backend *be,
 273                 char *fname, int lineno, int argc, char **argv ));
 274         void    (*be_init)   LDAP_P((Backend *be));
 275         void    (*be_close)  LDAP_P((Backend *be));
 276
 277 #ifdef SLAPD_ACLGROUPS
 278         int     (*be_group)  LDAP_P((Backend *be, Entry *e,
 279                 char *bdn, char *edn,
 280                 char *objectclassValue, char *groupattrName ));
 281 #endif
 282 };
 283
 284 /*
 285  * represents an operation pending from an ldap client
 286  */
 287
 288 typedef struct slap_op {
 289         BerElement      *o_ber;         /* ber of the request             */
 290         long            o_msgid;        /* msgid of the request           */
 291         unsigned long   o_tag;          /* tag of the request             */
 292         time_t          o_time;         /* time op was initiated          */
 293         char            *o_dn;          /* dn bound when op was initiated */
 294         char            *o_ndn;         /* normalized dn bound when op was initiated */
 295         int             o_authtype;     /* auth method used to bind dn    */
 296                                         /* values taken from ldap.h       */
 297                                         /* LDAP_AUTH_*                    */
 298         int             o_opid;         /* id of this operation           */
 299         int             o_connid;       /* id of conn initiating this op  */
 300 #ifdef LDAP_CONNECTIONLESS
 301         int             o_cldap;        /* != 0 if this came in via CLDAP */
 302         struct sockaddr o_clientaddr;   /* client address if via CLDAP    */
 303         char            o_searchbase;   /* search base if via CLDAP       */
 304 #endif
 305         struct slap_op  *o_next;        /* next operation pending         */
 306         pthread_t       o_tid;          /* thread handling this op        */
 307         int             o_abandon;      /* signals op has been abandoned  */
 308         pthread_mutex_t o_abandonmutex; /* signals op has been abandoned  */
 309
 310         int             o_private;      /* anything the backend needs     */
 311 } Operation;
 312
 313 /*
 314  * represents a connection from an ldap client
 315  */
 316
 317 typedef struct slap_conn {
 318         Sockbuf         c_sb;           /* ber connection stuff           */
 319         char            *c_cdn;         /* DN provided by the client */
 320         char            *c_dn;          /* DN bound to this conn  */
 321         pthread_mutex_t c_dnmutex;      /* mutex for c_dn field           */
 322         int             c_protocol;     /* version of the LDAP protocol used by client */
 323         int             c_authtype;     /* auth method used to bind c_dn  */
 324 #ifdef LDAP_COMPAT
 325         int             c_version;      /* for compatibility w/2.0, 3.0   */
 326 #endif
 327         char            *c_addr;        /* address of client on this conn */
 328         char            *c_domain;      /* domain of client on this conn  */
 329         Operation       *c_ops;         /* list of pending operations     */
 330         pthread_mutex_t c_opsmutex;     /* mutex for c_ops list & stats   */
 331         pthread_mutex_t c_pdumutex;     /* only one pdu written at a time */
 332         pthread_cond_t  c_wcv;          /* used to wait for sd write-ready*/
 333         int             c_gettingber;   /* in the middle of ber_get_next  */
 334         BerElement      *c_currentber;  /* ber we're getting              */
 335         int             c_writewaiter;  /* signals write-ready sd waiter  */
 336         int             c_pduwaiters;   /* signals threads waiting 4 pdu  */
 337         time_t          c_starttime;    /* when the connection was opened */
 338         int             c_connid;       /* id of this connection for stats*/
 339         int             c_opsinitiated; /* # ops initiated/next op id     */
 340         int             c_opscompleted; /* # ops completed                */
 341 } Connection;
 342
 343 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
 344 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
 345         { \
 346                 if ( ldap_debug & level ) \
 347                         fprintf( stderr, fmt, connid, opid, arg1, arg2, arg3 );\
 348                 if ( ldap_syslog & level ) \
 349                         syslog( ldap_syslog_level, fmt, connid, opid, arg1, \
 350                             arg2, arg3 ); \
 351         }
 352 #else
 353 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
 354 #endif
 355
 356 #include "proto-slap.h"
 357
 358 LDAP_END_DECL
 359
 360 #endif /* _slap_h_ */