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

   1 /*
   2  * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
   3  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   4  */
   5 #ifndef _PROTO_SLAP
   6 #define _PROTO_SLAP
   7
   8 #include <ldap_cdefs.h>
   9
  10 LDAP_BEGIN_DECL
  11
  12 /*
  13  * acl.c
  14  */
  15
  16 int access_allowed LDAP_P(( Backend *be, Connection *conn,
  17         Operation *op, Entry *e,
  18         char *attr, struct berval *val, int access ));
  19
  20 AccessControl * acl_get_applicable LDAP_P(( Backend *be,
  21         Operation *op, Entry *e,
  22         char *attr, int nmatches, regmatch_t *matches ));
  23
  24 int acl_access_allowed LDAP_P((
  25         AccessControl *a, Backend *be, Connection *conn, Entry *e,
  26         struct berval *val, Operation *op, int  access, char *edn,
  27         regmatch_t *matches ));
  28
  29 int acl_check_modlist LDAP_P(( Backend *be,
  30         Connection *conn,
  31         Operation *op,
  32         Entry *e,
  33         LDAPModList *ml ));
  34
  35 /*
  36  * aclparse.c
  37  */
  38
  39 void parse_acl LDAP_P(( Backend *be, char *fname, int lineno, int argc, char **argv ));
  40 char * access2str LDAP_P(( int access ));
  41 int str2access LDAP_P(( char *str ));
  42
  43 /*
  44  * attr.c
  45  */
  46
  47 void attr_free LDAP_P(( Attribute *a ));
  48 Attribute *attr_dup LDAP_P(( Attribute *a ));
  49 char * attr_normalize LDAP_P(( char *s ));
  50 int attr_merge_fast LDAP_P(( Entry *e, char *type, struct berval **vals, int  nvals,
  51         int  naddvals, int  *maxvals, Attribute ***a ));
  52 int attr_merge LDAP_P(( Entry *e, char *type, struct berval **vals ));
  53 Attribute * attr_find LDAP_P(( Attribute *a, char *type ));
  54 int attr_delete LDAP_P(( Attribute **attrs, char *type ));
  55 int attr_syntax LDAP_P(( char *type ));
  56 void attr_syntax_config LDAP_P(( char *fname, int lineno, int argc, char **argv ));
  57 AttributeType * at_find LDAP_P(( const char *name ));
  58 int at_find_in_list LDAP_P(( AttributeType *sat, AttributeType **list ));
  59 int at_append_to_list LDAP_P(( AttributeType *sat, AttributeType ***listp ));
  60 int at_delete_from_list LDAP_P(( int pos, AttributeType ***listp ));
  61 int at_fake_if_needed LDAP_P(( char *name ));
  62 int at_schema_info LDAP_P(( Entry *e ));
  63 int at_add LDAP_P(( LDAP_ATTRIBUTE_TYPE *at, const char **err ));
  64 char * at_canonical_name LDAP_P(( char * a_type ));
  65
  66 void attrs_free LDAP_P(( Attribute *a ));
  67 Attribute *attrs_dup LDAP_P(( Attribute *a ));
  68
  69 /*
  70  * ava.c
  71  */
  72
  73 int get_ava LDAP_P(( BerElement *ber, Ava *ava ));
  74 void ava_free LDAP_P(( Ava *ava, int freeit ));
  75
  76 /*
  77  * backend.c
  78  */
  79
  80 int backend_init LDAP_P((void));
  81 int backend_add LDAP_P((BackendInfo *aBackendInfo));
  82 int backend_num LDAP_P((Backend *be));
  83 int backend_startup LDAP_P((Backend *be));
  84 int backend_shutdown LDAP_P((Backend *be));
  85 int backend_destroy LDAP_P((void));
  86
  87 BackendInfo * backend_info LDAP_P(( char *type ));
  88 BackendDB * backend_db_init LDAP_P(( char *type ));
  89
  90 BackendDB * select_backend LDAP_P(( char * dn ));
  91
  92 int be_issuffix LDAP_P(( Backend *be, char *suffix ));
  93 int be_isroot LDAP_P(( Backend *be, char *ndn ));
  94 int be_isroot_pw LDAP_P(( Backend *be, char *ndn, struct berval *cred ));
  95 char* be_root_dn LDAP_P(( Backend *be ));
  96 int be_entry_release_rw LDAP_P(( Backend *be, Entry *e, int rw ));
  97 #define be_entry_release_r( be, e ) be_entry_release_rw( be, e, 0 )
  98 #define be_entry_release_w( be, e ) be_entry_release_rw( be, e, 1 )
  99
 100
 101 extern int      backend_unbind LDAP_P((Connection *conn, Operation *op));
 102
 103 extern int      backend_connection_init LDAP_P((Connection *conn));
 104 extern int      backend_connection_destroy LDAP_P((Connection *conn));
 105
 106 extern int      backend_group LDAP_P((Backend *be,
 107         Entry *target,
 108         char *gr_ndn, char *op_ndn,
 109         char *objectclassValue, char *groupattrName));
 110
 111 #ifdef SLAPD_SCHEMA_DN
 112 /* temporary extern for temporary routine*/
 113 extern Attribute *backend_subschemasubentry( Backend * );
 114 #endif
 115
 116
 117 /*
 118  * ch_malloc.c
 119  */
 120
 121 void * ch_malloc LDAP_P(( ber_len_t size ));
 122 void * ch_realloc LDAP_P(( void *block, ber_len_t size ));
 123 void * ch_calloc LDAP_P(( ber_len_t nelem, ber_len_t size ));
 124 char * ch_strdup LDAP_P(( const char *string ));
 125 void   ch_free LDAP_P(( void * ));
 126 #define free ch_free
 127
 128 /*
 129  * charray.c
 130  */
 131
 132 void charray_add LDAP_P(( char ***a, char *s ));
 133 void charray_merge LDAP_P(( char ***a, char **s ));
 134 void charray_free LDAP_P(( char **array ));
 135 int charray_inlist LDAP_P(( char **a, char *s ));
 136 char ** charray_dup LDAP_P(( char **a ));
 137 char ** str2charray LDAP_P(( char *str, char *brkstr ));
 138 char * charray2str LDAP_P(( char **a ));
 139
 140 /*
 141  * controls.c
 142  */
 143 int get_ctrls LDAP_P((
 144         Connection *co,
 145         Operation *op,
 146         int senderrors ));
 147
 148 int get_manageDSAit LDAP_P(( Operation *op ));
 149
 150 /*
 151  * config.c
 152  */
 153
 154 int read_config LDAP_P(( char *fname ));
 155
 156 /*
 157  * connection.c
 158  */
 159 int connections_init LDAP_P((void));
 160 int connections_shutdown LDAP_P((void));
 161 int connections_destroy LDAP_P((void));
 162 int connections_timeout_idle LDAP_P((time_t));
 163
 164 long connection_init LDAP_P((
 165         ber_socket_t s,
 166         const char* url,
 167         const char* dnsname,
 168         const char* peername,
 169         const char* sockname,
 170         int use_tls ));
 171
 172 void connection_closing LDAP_P(( Connection *c ));
 173 int connection_state_closing LDAP_P(( Connection *c ));
 174 char *connection_state2str LDAP_P(( int state ));
 175
 176 int connection_write LDAP_P((ber_socket_t s));
 177 int connection_read LDAP_P((ber_socket_t s));
 178
 179 unsigned long connections_nextid(void);
 180
 181 Connection* connection_first LDAP_P((ber_socket_t *));
 182 Connection* connection_next LDAP_P((Connection *, ber_socket_t *));
 183 void connection_done LDAP_P((Connection *));
 184
 185 /*
 186  * dn.c
 187  */
 188
 189 char * dn_normalize LDAP_P(( char *dn ));
 190 char * dn_normalize_case LDAP_P(( char *dn ));
 191 char * dn_parent LDAP_P(( Backend *be, char *dn ));
 192 char ** dn_subtree LDAP_P(( Backend *be, char *dn ));
 193 char * dn_rdn LDAP_P(( Backend *be, char *dn ));
 194 int dn_issuffix LDAP_P(( char *dn, char *suffix ));
 195 #ifdef DNS_DN
 196 int dn_type LDAP_P(( char *dn ));
 197 #endif
 198 char * str2upper LDAP_P(( char *str ));
 199 char * str2lower LDAP_P(( char *str ));
 200 int rdn_validate LDAP_P(( const char* str ));
 201 char * rdn_attr_value LDAP_P(( char * rdn ));
 202 char * rdn_attr_type LDAP_P(( char * rdn ));
 203 void build_new_dn LDAP_P(( char ** new_dn, char *e_dn, char * p_dn,
 204                            char * newrdn ));
 205 /*
 206  * entry.c
 207  */
 208
 209 Entry * str2entry LDAP_P(( char *s ));
 210 char * entry2str LDAP_P(( Entry *e, int *len ));
 211 void entry_free LDAP_P(( Entry *e ));
 212
 213 int entry_cmp LDAP_P(( Entry *a, Entry *b ));
 214 int entry_dn_cmp LDAP_P(( Entry *a, Entry *b ));
 215 int entry_id_cmp LDAP_P(( Entry *a, Entry *b ));
 216
 217 /*
 218  * filter.c
 219  */
 220
 221 int get_filter LDAP_P(( Connection *conn, BerElement *ber, Filter **filt, char **fstr ));
 222 void filter_free LDAP_P(( Filter *f ));
 223 void filter_print LDAP_P(( Filter *f ));
 224
 225 /*
 226  * filterentry.c
 227  */
 228
 229 int test_filter LDAP_P(( Backend *be, Connection *conn, Operation *op, Entry *e,
 230         Filter  *f ));
 231
 232 /*
 233  * lock.c
 234  */
 235
 236 FILE * lock_fopen LDAP_P(( char *fname, char *type, FILE **lfp ));
 237 int lock_fclose LDAP_P(( FILE *fp, FILE *lfp ));
 238
 239 /*
 240  * module.c
 241  */
 242
 243 #ifdef SLAPD_MODULES
 244 int load_module LDAP_P(( const char* file_name, int argc, char *argv[] ));
 245 #endif /* SLAPD_MODULES */
 246
 247 /*
 248  * monitor.c
 249  */
 250 extern char *supportedExtensions[];
 251 extern char *supportedControls[];
 252
 253 void monitor_info LDAP_P((
 254         Connection *conn,
 255         Operation *op,
 256         char ** attrs,
 257         int attrsonly ));
 258
 259 /*
 260  * operation.c
 261  */
 262
 263 void slap_op_free LDAP_P(( Operation *op ));
 264 Operation * slap_op_alloc LDAP_P((
 265         BerElement *ber, ber_int_t msgid,
 266         ber_tag_t tag, ber_int_t id ));
 267
 268 int slap_op_add LDAP_P(( Operation **olist, Operation *op ));
 269 int slap_op_remove LDAP_P(( Operation **olist, Operation *op ));
 270 Operation * slap_op_pop LDAP_P(( Operation **olist ));
 271
 272 /*
 273  * phonetic.c
 274  */
 275
 276 char * first_word LDAP_P(( char *s ));
 277 char * next_word LDAP_P(( char *s ));
 278 char * word_dup LDAP_P(( char *w ));
 279 char * phonetic LDAP_P(( char *s ));
 280
 281 /*
 282  * repl.c
 283  */
 284
 285 void replog LDAP_P(( Backend *be, Operation *op, char *dn, void *change ));
 286
 287 /*
 288  * result.c
 289  */
 290
 291 struct berval **get_entry_referrals LDAP_P((
 292         Backend *be, Connection *conn, Operation *op,
 293         Entry *e ));
 294
 295 void send_ldap_result LDAP_P((
 296         Connection *conn, Operation *op,
 297         int err, char *matched, char *text,
 298         struct berval **refs,
 299         LDAPControl **ctrls ));
 300
 301 void send_ldap_disconnect LDAP_P((
 302         Connection *conn, Operation *op,
 303         int err, char *text ));
 304
 305 void send_search_result LDAP_P((
 306         Connection *conn, Operation *op,
 307         int err, char *matched, char *text,
 308         struct berval **refs,
 309         LDAPControl **ctrls,
 310         int nentries ));
 311
 312 int send_search_reference LDAP_P((
 313         Backend *be, Connection *conn, Operation *op,
 314         Entry *e, struct berval **refs, int scope,
 315         LDAPControl **ctrls,
 316         struct berval ***v2refs ));
 317
 318 int send_search_entry LDAP_P((
 319         Backend *be, Connection *conn, Operation *op,
 320         Entry *e, char **attrs, int attrsonly,
 321         LDAPControl **ctrls ));
 322
 323 int str2result LDAP_P(( char *s,
 324         int *code, char **matched, char **info ));
 325
 326 /*
 327  * sasl.c
 328  */
 329 extern char **supportedSASLMechanisms;
 330
 331 int sasl_init(void);
 332 int sasl_destroy(void);
 333
 334 /*
 335  * schema.c
 336  */
 337
 338 int oc_schema_check LDAP_P(( Entry *e ));
 339 int oc_check_operational_attr LDAP_P(( char *type ));
 340 int oc_check_usermod_attr LDAP_P(( char *type ));
 341 int oc_check_no_usermod_attr LDAP_P(( char *type ));
 342 ObjectClass *oc_find LDAP_P((const char *ocname));
 343 int oc_add LDAP_P((LDAP_OBJECT_CLASS *oc, const char **err));
 344 Syntax *syn_find LDAP_P((const char *synname));
 345 int syn_add LDAP_P((LDAP_SYNTAX *syn, slap_syntax_check_func *check, const char **err));
 346 MatchingRule *mr_find LDAP_P((const char *mrname));
 347 int mr_add LDAP_P((LDAP_MATCHING_RULE *mr, slap_mr_normalize_func *normalize, slap_mr_compare_func *compare, const char **err));
 348 void schema_info LDAP_P((Connection *conn, Operation *op, char **attrs, int attrsonly));
 349 int schema_init LDAP_P((void));
 350
 351 int is_entry_objectclass LDAP_P(( Entry *, char* objectclass ));
 352 #define is_entry_alias(e)               is_entry_objectclass((e), "ALIAS")
 353 #define is_entry_referral(e)    is_entry_objectclass((e), "REFERRAL")
 354
 355
 356 /*
 357  * schemaparse.c
 358  */
 359
 360 void parse_oc_old LDAP_P(( Backend *be, char *fname, int lineno, int argc, char **argv ));
 361 void parse_oc LDAP_P(( char *fname, int lineno, char *line ));
 362 void parse_at LDAP_P(( char *fname, int lineno, char *line ));
 363 char *scherr2str LDAP_P((int code));
 364 /*
 365  * str2filter.c
 366  */
 367
 368 Filter * str2filter LDAP_P(( char *str ));
 369
 370 /*
 371  * suffixalias.c
 372  */
 373 char *suffix_alias LDAP_P(( Backend *be, char *ndn ));
 374
 375 /*
 376  * value.c
 377  */
 378
 379 int value_add_fast LDAP_P(( struct berval ***vals, struct berval **addvals, int nvals,
 380         int naddvals, int *maxvals ));
 381 int value_add LDAP_P(( struct berval ***vals, struct berval **addvals ));
 382 void value_normalize LDAP_P(( char *s, int syntax ));
 383 int value_cmp LDAP_P(( struct berval *v1, struct berval *v2, int syntax,
 384         int normalize ));
 385 int value_find LDAP_P(( struct berval **vals, struct berval *v, int syntax,
 386         int normalize ));
 387
 388 /*
 389  * user.c
 390  */
 391 #if defined(HAVE_PWD_H) && defined(HAVE_GRP_H)
 392 void slap_init_user LDAP_P(( char *username, char *groupname ));
 393 #endif
 394
 395 /*
 396  * Other...
 397  */
 398
 399 extern struct berval **default_referral;
 400 extern char             *replogfile;
 401 extern const char Versionstr[];
 402 extern int              active_threads;
 403 extern int              defsize;
 404 extern int              deftime;
 405 extern int              g_argc;
 406 extern int              global_default_access;
 407 extern int              global_lastmod;
 408 extern int              global_idletimeout;
 409 extern int              global_schemacheck;
 410 extern char             *global_realm;
 411 extern int              lber_debug;
 412 extern int              ldap_syslog;
 413
 414 extern ldap_pvt_thread_mutex_t  num_sent_mutex;
 415 extern long             num_bytes_sent;
 416 extern long             num_pdu_sent;
 417 extern long             num_entries_sent;
 418 extern long             num_refs_sent;
 419
 420 extern ldap_pvt_thread_mutex_t  num_ops_mutex;
 421 extern long             num_ops_completed;
 422 extern long             num_ops_initiated;
 423
 424 extern char   *slapd_pid_file;
 425 extern char   *slapd_args_file;
 426 extern char             **g_argv;
 427 extern time_t   starttime;
 428
 429 time_t slap_get_time LDAP_P((void));
 430
 431 extern ldap_pvt_thread_mutex_t  active_threads_mutex;
 432 extern ldap_pvt_thread_cond_t   active_threads_cond;
 433
 434 extern ldap_pvt_thread_mutex_t  entry2str_mutex;
 435 extern ldap_pvt_thread_mutex_t  replog_mutex;
 436
 437 #ifdef SLAPD_CRYPT
 438 extern ldap_pvt_thread_mutex_t  crypt_mutex;
 439 #endif
 440 extern ldap_pvt_thread_mutex_t  gmtime_mutex;
 441
 442 extern AccessControl *global_acl;
 443
 444 int     slap_init LDAP_P((int mode, char* name));
 445 int     slap_startup LDAP_P(( Backend *be ));
 446 int     slap_shutdown LDAP_P(( Backend *be ));
 447 int     slap_destroy LDAP_P((void));
 448
 449 struct sockaddr_in;
 450
 451 extern int      slapd_daemon_init( char *urls, int port, int tls_port );
 452 extern int      slapd_daemon_destroy(void);
 453 extern int      slapd_daemon(void);
 454
 455 extern void slapd_set_write LDAP_P((ber_socket_t s, int wake));
 456 extern void slapd_clr_write LDAP_P((ber_socket_t s, int wake));
 457 extern void slapd_set_read LDAP_P((ber_socket_t s, int wake));
 458 extern void slapd_clr_read LDAP_P((ber_socket_t s, int wake));
 459
 460 extern void slapd_remove LDAP_P((ber_socket_t s, int wake));
 461
 462 extern void     slap_set_shutdown LDAP_P((int sig));
 463 extern void     slap_do_nothing   LDAP_P((int sig));
 464
 465 extern void     config_info LDAP_P((
 466         Connection *conn,
 467         Operation *op,
 468         char ** attrs,
 469         int attrsonly ));
 470
 471 extern void     root_dse_info LDAP_P((
 472         Connection *conn,
 473         Operation *op,
 474         char ** attrs,
 475         int attrsonly ));
 476
 477 extern int      do_abandon LDAP_P((Connection *conn, Operation *op));
 478 extern int      do_add LDAP_P((Connection *conn, Operation *op));
 479 extern int      do_bind LDAP_P((Connection *conn, Operation *op));
 480 extern int      do_compare LDAP_P((Connection *conn, Operation *op));
 481 extern int      do_delete LDAP_P((Connection *conn, Operation *op));
 482 extern int      do_modify LDAP_P((Connection *conn, Operation *op));
 483 extern int      do_modrdn LDAP_P((Connection *conn, Operation *op));
 484 extern int      do_search LDAP_P((Connection *conn, Operation *op));
 485 extern int      do_unbind LDAP_P((Connection *conn, Operation *op));
 486 extern int      do_extended LDAP_P((Connection *conn, Operation *op));
 487
 488
 489 extern ber_socket_t dtblsize;
 490
 491 LDAP_END_DECL
 492
 493 #endif /* _proto_slap */
 494