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