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

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