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