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