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