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