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