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