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

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