2 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
3 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 * Copyright IBM Corp. 1997,2002,2003
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
12 #ifndef _SLAPI_PLUGIN_H
13 #define _SLAPI_PLUGIN_H
17 typedef struct slapi_pblock Slapi_PBlock;
18 typedef struct slapi_entry Slapi_Entry;
19 typedef struct slapi_attr Slapi_Attr;
20 typedef struct slapi_value Slapi_Value;
21 typedef struct slapi_valueset Slapi_ValueSet;
22 typedef struct slapi_filter Slapi_Filter;
25 int slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value );
26 int slapi_pblock_set( Slapi_PBlock *pb, int arg, void *value );
27 Slapi_PBlock *slapi_pblock_new();
28 void slapi_pblock_destroy( Slapi_PBlock* );
30 /* entry/attr/dn routines */
31 Slapi_Entry *slapi_str2entry( char *s, int flags );
32 char *slapi_entry2str( Slapi_Entry *e, int *len );
33 char *slapi_entry_get_dn( Slapi_Entry *e );
34 int slapi_x_entry_get_id( Slapi_Entry *e );
35 void slapi_entry_set_dn( Slapi_Entry *e, char *dn );
36 Slapi_Entry *slapi_entry_dup( Slapi_Entry *e );
37 int slapi_entry_attr_delete( Slapi_Entry *e, char *type );
38 Slapi_Entry *slapi_entry_alloc();
39 void slapi_entry_free( Slapi_Entry *e );
40 int slapi_entry_attr_merge( Slapi_Entry *e, char *type, struct berval **vals );
41 int slapi_entry_attr_find( Slapi_Entry *e, char *type, Slapi_Attr **attr );
42 char *slapi_entry_attr_get_charptr( const Slapi_Entry *e, const char *type );
43 int slapi_entry_attr_get_int( const Slapi_Entry *e, const char *type );
44 int slapi_entry_attr_get_long( const Slapi_Entry *e, const char *type );
45 int slapi_entry_attr_get_uint( const Slapi_Entry *e, const char *type );
46 int slapi_entry_attr_get_ulong( const Slapi_Entry *e, const char *type );
47 int slapi_attr_get_values( Slapi_Attr *attr, struct berval ***vals );
48 char *slapi_dn_normalize( char *dn );
49 char *slapi_dn_normalize_case( char *dn );
50 int slapi_dn_issuffix( char *dn, char *suffix );
51 char *slapi_dn_beparent( Slapi_PBlock *pb, const char *dn );
52 char *slapi_dn_parent( const char *dn );
53 int slapi_dn_isparent( const char *parentdn, const char *childdn );
54 char *slapi_dn_ignore_case( char *dn );
57 int slapi_access_allowed( Slapi_PBlock *pb, Slapi_Entry *e, char *attr, struct berval *val, int access );
58 int slapi_acl_check_mods( Slapi_PBlock *pb, Slapi_Entry *e, LDAPMod **mods, char **errbuf );
59 Slapi_Attr *slapi_attr_new( void );
60 Slapi_Attr *slapi_attr_init( Slapi_Attr *a, const char *type );
61 void slapi_attr_free( Slapi_Attr **a );
62 Slapi_Attr *slapi_attr_dup( const Slapi_Attr *attr );
63 int slapi_attr_add_value( Slapi_Attr *a, const Slapi_Value *v );
64 int slapi_attr_type2plugin( const char *type, void **pi );
65 int slapi_attr_get_type( const Slapi_Attr *attr, char **type );
66 int slapi_attr_get_oid_copy( const Slapi_Attr *attr, char **oidp );
67 int slapi_attr_get_flags( const Slapi_Attr *attr, unsigned long *flags );
68 int slapi_attr_flag_is_set( const Slapi_Attr *attr, unsigned long flag );
69 int slapi_attr_value_cmp( const Slapi_Attr *attr, const struct berval *v1, const struct berval *v2 );
70 int slapi_attr_value_find( const Slapi_Attr *a, struct berval *v );
71 #define SLAPI_TYPE_CMP_EXACT 0
72 #define SLAPI_TYPE_CMP_BASE 1
73 #define SLAPI_TYPE_CMP_SUBTYPE 2
74 int slapi_attr_type_cmp( const char *t1, const char *t2, int opt );
75 int slapi_attr_types_equivalent( const char *t1, const char *t2 );
76 int slapi_attr_first_value( Slapi_Attr *a, Slapi_Value **v );
77 int slapi_attr_next_value( Slapi_Attr *a, int hint, Slapi_Value **v );
78 int slapi_attr_get_numvalues( const Slapi_Attr *a, int *numValues );
79 int slapi_attr_get_valueset( const Slapi_Attr *a, Slapi_ValueSet **vs );
80 int slapi_attr_get_bervals_copy( Slapi_Attr *a, struct berval ***vals );
81 int slapi_entry_attr_hasvalue( Slapi_Entry *e, const char *type, const char *value );
82 int slapi_entry_attr_merge_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
83 void slapi_entry_attr_set_charptr(Slapi_Entry* e, const char *type, const char *value);
84 void slapi_entry_attr_set_int( Slapi_Entry* e, const char *type, int l);
85 void slapi_entry_attr_set_uint( Slapi_Entry* e, const char *type, unsigned int l);
86 void slapi_entry_attr_set_long(Slapi_Entry* e, const char *type, long l);
87 void slapi_entry_attr_set_ulong(Slapi_Entry* e, const char *type, unsigned long l);
88 int slapi_is_rootdse( const char *dn );
89 int slapi_entry_attr_merge_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
90 int slapi_entry_add_values_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
91 int slapi_entry_add_valueset(Slapi_Entry *e, const char *type, Slapi_ValueSet *vs);
92 int slapi_entry_delete_values_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
93 int slapi_entry_merge_values_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
94 int slapi_entry_attr_replace_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
95 int slapi_entry_add_value(Slapi_Entry *e, const char *type, const Slapi_Value *value);
96 int slapi_entry_add_string(Slapi_Entry *e, const char *type, const char *value);
97 int slapi_entry_delete_string(Slapi_Entry *e, const char *type, const char *value);
98 int slapi_entry_first_attr( const Slapi_Entry *e, Slapi_Attr **attr );
99 int slapi_entry_next_attr( const Slapi_Entry *e, Slapi_Attr *prevattr, Slapi_Attr **attr );
100 char *slapi_attr_syntax_normalize( const char *s );
102 Slapi_Value *slapi_value_new( void );
103 Slapi_Value *slapi_value_new_berval(const struct berval *bval);
104 Slapi_Value *slapi_value_new_value(const Slapi_Value *v);
105 Slapi_Value *slapi_value_new_string(const char *s);
106 Slapi_Value *slapi_value_init(Slapi_Value *v);
107 Slapi_Value *slapi_value_init_berval(Slapi_Value *v, struct berval *bval);
108 Slapi_Value *slapi_value_init_string(Slapi_Value *v,const char *s);
109 Slapi_Value *slapi_value_dup(const Slapi_Value *v);
110 void slapi_value_free(Slapi_Value **value);
111 const struct berval *slapi_value_get_berval( const Slapi_Value *value );
112 Slapi_Value *slapi_value_set_berval( Slapi_Value *value, const struct berval *bval );
113 Slapi_Value *slapi_value_set_value( Slapi_Value *value, const Slapi_Value *vfrom);
114 Slapi_Value *slapi_value_set( Slapi_Value *value, void *val, unsigned long len);
115 int slapi_value_set_string(Slapi_Value *value, const char *strVal);
116 int slapi_value_set_int(Slapi_Value *value, int intVal);
117 const char*slapi_value_get_string(const Slapi_Value *value);
118 int slapi_value_get_int(const Slapi_Value *value);
119 unsigned int slapi_value_get_uint(const Slapi_Value *value);
120 long slapi_value_get_long(const Slapi_Value *value);
121 unsigned long slapi_value_get_ulong(const Slapi_Value *value);
122 size_t slapi_value_get_length(const Slapi_Value *value);
123 int slapi_value_compare(const Slapi_Attr *a,const Slapi_Value *v1,const Slapi_Value *v2);
125 Slapi_ValueSet *slapi_valueset_new( void );
126 void slapi_valueset_free(Slapi_ValueSet *vs);
127 void slapi_valueset_init(Slapi_ValueSet *vs);
128 void slapi_valueset_done(Slapi_ValueSet *vs);
129 void slapi_valueset_add_value(Slapi_ValueSet *vs, const Slapi_Value *addval);
130 int slapi_valueset_first_value( Slapi_ValueSet *vs, Slapi_Value **v );
131 int slapi_valueset_next_value( Slapi_ValueSet *vs, int index, Slapi_Value **v);
132 int slapi_valueset_count( const Slapi_ValueSet *vs);
133 void slapi_valueset_set_valueset(Slapi_ValueSet *vs1, const Slapi_ValueSet *vs2);
135 typedef struct slapi_mutex Slapi_Mutex;
136 typedef struct slapi_condvar Slapi_CondVar;
137 Slapi_Mutex *slapi_new_mutex( void );
138 void slapi_destroy_mutex( Slapi_Mutex *mutex );
139 void slapi_lock_mutex( Slapi_Mutex *mutex );
140 int slapi_unlock_mutex( Slapi_Mutex *mutex );
141 Slapi_CondVar *slapi_new_condvar( Slapi_Mutex *mutex );
142 void slapi_destroy_condvar( Slapi_CondVar *cvar );
143 int slapi_wait_condvar( Slapi_CondVar *cvar, struct timeval *timeout );
144 int slapi_notify_condvar( Slapi_CondVar *cvar, int notify_all );
146 char *slapi_ch_malloc( unsigned long size );
147 void slapi_ch_free( void **ptr );
148 void slapi_ch_free_string( char **ptr );
149 char *slapi_ch_calloc( unsigned long nelem, unsigned long size );
150 char *slapi_ch_realloc( char *block, unsigned long size );
151 char *slapi_ch_strdup( char *s );
152 void slapi_ch_array_free( char **arrayp );
153 struct berval *slapi_ch_bvdup(const struct berval *v);
154 struct berval **slapi_ch_bvecdup(const struct berval **v);
156 /* LDAP V3 routines */
157 int slapi_control_present( LDAPControl **controls, char *oid,
158 struct berval **val, int *iscritical);
159 void slapi_register_supported_control(char *controloid,
160 unsigned long controlops);
161 #define SLAPI_OPERATION_BIND 0x00000001L
162 #define SLAPI_OPERATION_UNBIND 0x00000002L
163 #define SLAPI_OPERATION_SEARCH 0x00000004L
164 #define SLAPI_OPERATION_MODIFY 0x00000008L
165 #define SLAPI_OPERATION_ADD 0x00000010L
166 #define SLAPI_OPERATION_DELETE 0x00000020L
167 #define SLAPI_OPERATION_MODDN 0x00000040L
168 #define SLAPI_OPERATION_MODRDN SLAPI_OPERATION_MODDN
169 #define SLAPI_OPERATION_COMPARE 0x00000080L
170 #define SLAPI_OPERATION_ABANDON 0x00000100L
171 #define SLAPI_OPERATION_EXTENDED 0x00000200L
172 #define SLAPI_OPERATION_ANY 0xFFFFFFFFL
173 #define SLAPI_OPERATION_NONE 0x00000000L
174 int slapi_get_supported_controls(char ***ctrloidsp, unsigned long **ctrlopsp);
175 LDAPControl *slapi_dup_control(LDAPControl *ctrl);
176 void slapi_register_supported_saslmechanism(char *mechanism);
177 char **slapi_get_supported_saslmechanisms();
178 char **slapi_get_supported_extended_ops(void);
181 /* send ldap result back */
182 void slapi_send_ldap_result( Slapi_PBlock *pb, int err, char *matched,
183 char *text, int nentries, struct berval **urls );
184 int slapi_send_ldap_search_entry( Slapi_PBlock *pb, Slapi_Entry *e,
185 LDAPControl **ectrls, char **attrs, int attrsonly );
186 int slapi_send_ldap_search_reference( Slapi_PBlock *pb, Slapi_Entry *e,
187 struct berval **urls, LDAPControl **ectrls, struct berval **v2refs );
189 /* filter routines */
190 Slapi_Filter *slapi_str2filter( char *str );
191 Slapi_Filter *slapi_filter_dup( Slapi_Filter *f );
192 void slapi_filter_free( Slapi_Filter *f, int recurse );
193 int slapi_filter_get_choice( Slapi_Filter *f);
194 int slapi_filter_get_ava( Slapi_Filter *f, char **type, struct berval **bval );
195 Slapi_Filter *slapi_filter_list_first( Slapi_Filter *f );
196 Slapi_Filter *slapi_filter_list_next( Slapi_Filter *f, Slapi_Filter *fprev );
197 int slapi_filter_get_attribute_type( Slapi_Filter *f, char **type );
198 int slapi_filter_get_subfilt( Slapi_Filter *f, char **type, char **initial,
199 char ***any, char **final );
200 Slapi_Filter *slapi_filter_join( int ftype, Slapi_Filter *f1, Slapi_Filter *f2);
201 int slapi_x_filter_append( int choice, Slapi_Filter **pContainingFilter,
202 Slapi_Filter **pNextFilter, Slapi_Filter *filterToAppend );
203 int slapi_filter_test( Slapi_PBlock *pb, Slapi_Entry *e, Slapi_Filter *f,
205 int slapi_filter_test_simple( Slapi_Entry *e, Slapi_Filter *f );
206 typedef int (*FILTER_APPLY_FN)( Slapi_Filter *f, void *arg );
207 int slapi_filter_apply( Slapi_Filter *f, FILTER_APPLY_FN fn, void *arg, int *error_code );
208 #define SLAPI_FILTER_SCAN_STOP -1 /* set by callback */
209 #define SLAPI_FILTER_SCAN_ERROR -2 /* set by callback */
210 #define SLAPI_FILTER_SCAN_NOMORE 0 /* set by callback */
211 #define SLAPI_FILTER_SCAN_CONTINUE 1 /* set by callback */
212 #define SLAPI_FILTER_UNKNOWN_FILTER_TYPE 2 /* set by slapi_filter_apply() */
214 /* internal add/delete/search/modify routines */
215 Slapi_PBlock *slapi_search_internal( char *base, int scope, char *filter,
216 LDAPControl **controls, char **attrs, int attrsonly );
217 Slapi_PBlock *slapi_modify_internal( char *dn, LDAPMod **mods,
218 LDAPControl **controls, int log_change );
219 Slapi_PBlock *slapi_add_internal( char * dn, LDAPMod **attrs,
220 LDAPControl **controls, int log_changes );
221 Slapi_PBlock *slapi_add_entry_internal( Slapi_Entry * e,
222 LDAPControl **controls, int log_change );
223 Slapi_PBlock *slapi_delete_internal( char * dn, LDAPControl **controls,
225 Slapi_PBlock *slapi_modrdn_internal( char * olddn, char * newrdn,
226 int deloldrdn, LDAPControl **controls,
229 Slapi_PBlock *slapi_modrdn_internal( char * olddn, char * newrdn,
230 char *newParent, int deloldrdn, LDAPControl **controls,
233 void slapi_free_search_results_internal(Slapi_PBlock *pb);
235 /* connection related routines */
236 int slapi_is_connection_ssl(Slapi_PBlock *pPB, int *isSSL);
237 int slapi_get_client_port(Slapi_PBlock *pPB, int *fromPort);
239 /* computed attributes */
240 typedef struct _computed_attr_context computed_attr_context;
241 typedef int (*slapi_compute_output_t)(computed_attr_context *c, Slapi_Attr *a, Slapi_Entry *e);
242 typedef int (*slapi_compute_callback_t)(computed_attr_context *c, char *type, Slapi_Entry *e, slapi_compute_output_t outputfn);
243 typedef int (*slapi_search_rewrite_callback_t)(Slapi_PBlock *pb);
244 int slapi_compute_add_evaluator(slapi_compute_callback_t function);
245 int slapi_compute_add_search_rewriter(slapi_search_rewrite_callback_t function);
246 int compute_rewrite_search_filter(Slapi_PBlock *pb);
247 int compute_evaluator(computed_attr_context *c, char *type, Slapi_Entry *e, slapi_compute_output_t outputfn);
248 int slapi_x_compute_get_pblock(computed_attr_context *c, Slapi_PBlock **pb);
250 /* ACL plugins; only SLAPI_PLUGIN_ACL_ALLOW_ACCESS supported now */
251 typedef int (*slapi_acl_callback_t)(Slapi_PBlock *pb,
254 struct berval *berval,
258 /* object extensions */
259 typedef void *(*slapi_extension_constructor_fnptr)(void *object, void *parent);
261 typedef void (*slapi_extension_destructor_fnptr)(void *extension,
262 void *object, void *parent);
264 int slapi_register_object_extension( const char *pluginname,
265 const char *objectname, slapi_extension_constructor_fnptr constructor,
266 slapi_extension_destructor_fnptr destructor, int *objecttype,
267 int *extensionhandle);
269 #define SLAPI_EXT_CONNECTION "Connection"
270 #define SLAPI_EXT_OPERATION "Operation"
271 #define SLAPI_EXT_ENTRY "Entry"
272 #define SLAPI_EXT_MTNODE "Mapping Tree Node"
274 void *slapi_get_object_extension(int objecttype, void *object,
275 int extensionhandle);
276 void slapi_set_object_extension(int objecttype, void *object,
277 int extensionhandle, void *extension);
279 /* parameters currently supported */
282 * Attribute flags returned by slapi_attr_get_flags()
284 #define SLAPI_ATTR_FLAG_SINGLE 0x0001
285 #define SLAPI_ATTR_FLAG_OPATTR 0x0002
286 #define SLAPI_ATTR_FLAG_READONLY 0x0004
287 #define SLAPI_ATTR_FLAG_STD_ATTR SLAPI_ATTR_FLAG_READONLY
288 #define SLAPI_ATTR_FLAG_OBSOLETE 0x0040
289 #define SLAPI_ATTR_FLAG_COLLECTIVE 0x0080
290 #define SLAPI_ATTR_FLAG_NOUSERMOD 0x0100
295 #define SLAPI_ACL_COMPARE 0x01
296 #define SLAPI_ACL_SEARCH 0x02
297 #define SLAPI_ACL_READ 0x04
298 #define SLAPI_ACL_WRITE 0x08
299 #define SLAPI_ACL_DELETE 0x10
300 #define SLAPI_ACL_ADD 0x20
301 #define SLAPI_ACL_SELF 0x40
302 #define SLAPI_ACL_PROXY 0x80
303 #define SLAPI_ACL_ALL 0x7f
305 /* plugin types supported */
307 #define SLAPI_PLUGIN_DATABASE 1
308 #define SLAPI_PLUGIN_EXTENDEDOP 2
309 #define SLAPI_PLUGIN_PREOPERATION 3
310 #define SLAPI_PLUGIN_POSTOPERATION 4
311 #define SLAPI_PLUGIN_MATCHINGRULE 5
312 #define SLAPI_PLUGIN_SYNTAX 6
313 #define SLAPI_PLUGIN_AUDIT 7
317 #define SLAPI_BACKEND 130
318 #define SLAPI_CONNECTION 131
319 #define SLAPI_OPERATION 132
320 #define SLAPI_REQUESTOR_ISROOT 133
321 #define SLAPI_BE_MONITORDN 134
322 #define SLAPI_BE_TYPE 135
323 #define SLAPI_BE_READONLY 136
324 #define SLAPI_BE_LASTMOD 137
325 #define SLAPI_CONN_ID 139
327 /* operation params */
328 #define SLAPI_OPINITIATED_TIME 140
329 #define SLAPI_REQUESTOR_DN 141
330 #define SLAPI_REQUESTOR_ISUPDATEDN 142
332 /* connection structure params*/
333 #define SLAPI_CONN_DN 143
334 #define SLAPI_CONN_AUTHTYPE 144
335 #define SLAPI_CONN_CLIENTIP 145
336 #define SLAPI_CONN_SERVERIP 146
337 /* OpenLDAP extensions */
338 #define SLAPI_X_CONN_CLIENTPATH 1300
339 #define SLAPI_X_CONN_SERVERPATH 1301
340 #define SLAPI_X_CONN_IS_UDP 1302
341 #define SLAPI_X_CONN_SSF 1303
342 #define SLAPI_X_CONN_SASL_CONTEXT 1304
344 /* Authentication types */
345 #define SLAPD_AUTH_NONE "none"
346 #define SLAPD_AUTH_SIMPLE "simple"
347 #define SLAPD_AUTH_SSL "SSL"
348 #define SLAPD_AUTH_SASL "SASL "
350 /* plugin configuration parmams */
351 #define SLAPI_PLUGIN 3
352 #define SLAPI_PLUGIN_PRIVATE 4
353 #define SLAPI_PLUGIN_TYPE 5
354 #define SLAPI_PLUGIN_ARGV 6
355 #define SLAPI_PLUGIN_ARGC 7
356 #define SLAPI_PLUGIN_VERSION 8
357 #define SLAPI_PLUGIN_OPRETURN 9
358 #define SLAPI_PLUGIN_OBJECT 10
359 #define SLAPI_PLUGIN_DESTROY_FN 11
360 #define SLAPI_PLUGIN_DESCRIPTION 12
362 /* internal opreations params */
363 #define SLAPI_PLUGIN_INTOP_RESULT 15
364 #define SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES 16
365 #define SLAPI_PLUGIN_INTOP_SEARCH_REFERRALS 17
367 /* function pointer params for backends */
368 #define SLAPI_PLUGIN_DB_BIND_FN 200
369 #define SLAPI_PLUGIN_DB_UNBIND_FN 201
370 #define SLAPI_PLUGIN_DB_SEARCH_FN 202
371 #define SLAPI_PLUGIN_DB_COMPARE_FN 203
372 #define SLAPI_PLUGIN_DB_MODIFY_FN 204
373 #define SLAPI_PLUGIN_DB_MODRDN_FN 205
374 #define SLAPI_PLUGIN_DB_ADD_FN 206
375 #define SLAPI_PLUGIN_DB_DELETE_FN 207
376 #define SLAPI_PLUGIN_DB_ABANDON_FN 208
377 #define SLAPI_PLUGIN_DB_CONFIG_FN 209
378 #define SLAPI_PLUGIN_CLOSE_FN 210
379 #define SLAPI_PLUGIN_DB_FLUSH_FN 211
380 #define SLAPI_PLUGIN_START_FN 212
381 #define SLAPI_PLUGIN_DB_SEQ_FN 213
382 #define SLAPI_PLUGIN_DB_ENTRY_FN 214
383 #define SLAPI_PLUGIN_DB_REFERRAL_FN 215
384 #define SLAPI_PLUGIN_DB_RESULT_FN 216
385 #define SLAPI_PLUGIN_DB_LDIF2DB_FN 217
386 #define SLAPI_PLUGIN_DB_DB2LDIF_FN 218
387 #define SLAPI_PLUGIN_DB_BEGIN_FN 219
388 #define SLAPI_PLUGIN_DB_COMMIT_FN 220
389 #define SLAPI_PLUGIN_DB_ABORT_FN 221
390 #define SLAPI_PLUGIN_DB_ARCHIVE2DB_FN 222
391 #define SLAPI_PLUGIN_DB_DB2ARCHIVE_FN 223
392 #define SLAPI_PLUGIN_DB_NEXT_SEARCH_ENTRY_FN 224
393 #define SLAPI_PLUGIN_DB_FREE_RESULT_SET_FN 225
394 #define SLAPI_PLUGIN_DB_SIZE_FN 226
395 #define SLAPI_PLUGIN_DB_TEST_FN 227
398 /* functions pointers for LDAP V3 extended ops */
399 #define SLAPI_PLUGIN_EXT_OP_FN 300
400 #define SLAPI_PLUGIN_EXT_OP_OIDLIST 301
402 /* functions for preoperation functions */
403 #define SLAPI_PLUGIN_PRE_BIND_FN 401
404 #define SLAPI_PLUGIN_PRE_UNBIND_FN 402
405 #define SLAPI_PLUGIN_PRE_SEARCH_FN 403
406 #define SLAPI_PLUGIN_PRE_COMPARE_FN 404
407 #define SLAPI_PLUGIN_PRE_MODIFY_FN 405
408 #define SLAPI_PLUGIN_PRE_MODRDN_FN 406
409 #define SLAPI_PLUGIN_PRE_ADD_FN 407
410 #define SLAPI_PLUGIN_PRE_DELETE_FN 408
411 #define SLAPI_PLUGIN_PRE_ABANDON_FN 409
412 #define SLAPI_PLUGIN_PRE_ENTRY_FN 410
413 #define SLAPI_PLUGIN_PRE_REFERRAL_FN 411
414 #define SLAPI_PLUGIN_PRE_RESULT_FN 412
416 /* functions for postoperation functions*/
417 #define SLAPI_PLUGIN_POST_BIND_FN 501
418 #define SLAPI_PLUGIN_POST_UNBIND_FN 502
419 #define SLAPI_PLUGIN_POST_SEARCH_FN 503
420 #define SLAPI_PLUGIN_POST_COMPARE_FN 504
421 #define SLAPI_PLUGIN_POST_MODIFY_FN 505
422 #define SLAPI_PLUGIN_POST_MODRDN_FN 506
423 #define SLAPI_PLUGIN_POST_ADD_FN 507
424 #define SLAPI_PLUGIN_POST_DELETE_FN 508
425 #define SLAPI_PLUGIN_POST_ABANDON_FN 509
426 #define SLAPI_PLUGIN_POST_ENTRY_FN 510
427 #define SLAPI_PLUGIN_POST_REFERRAL_FN 511
428 #define SLAPI_PLUGIN_POST_RESULT_FN 512
430 #define SLAPI_OPERATION_TYPE 590
432 #define SLAPI_PLUGIN_MR_FILTER_CREATE_FN 600
433 #define SLAPI_PLUGIN_MR_INDEXER_CREATE_FN 601
434 #define SLAPI_PLUGIN_MR_FILTER_MATCH_FN 602
435 #define SLAPI_PLUGIN_MR_FILTER_INDEX_FN 603
436 #define SLAPI_PLUGIN_MR_FILTER_RESET_FN 604
437 #define SLAPI_PLUGIN_MR_INDEX_FN 605
438 #define SLAPI_PLUGIN_MR_OID 610
439 #define SLAPI_PLUGIN_MR_TYPE 611
440 #define SLAPI_PLUGIN_MR_VALUE 612
441 #define SLAPI_PLUGIN_MR_VALUES 613
442 #define SLAPI_PLUGIN_MR_KEYS 614
443 #define SLAPI_PLUGIN_MR_FILTER_REUSABLE 615
444 #define SLAPI_PLUGIN_MR_QUERY_OPERATOR 616
445 #define SLAPI_PLUGIN_MR_USAGE 617
447 #define SLAPI_MATCHINGRULE_NAME 1
448 #define SLAPI_MATCHINGRULE_OID 2
449 #define SLAPI_MATCHINGRULE_DESC 3
450 #define SLAPI_MATCHINGRULE_SYNTAX 4
451 #define SLAPI_MATCHINGRULE_OBSOLETE 5
453 #define SLAPI_OP_LESS 1
454 #define SLAPI_OP_LESS_OR_EQUAL 2
455 #define SLAPI_OP_EQUAL 3
456 #define SLAPI_OP_GREATER_OR_EQUAL 4
457 #define SLAPI_OP_GREATER 5
458 #define SLAPI_OP_SUBSTRING 6
460 #define SLAPI_PLUGIN_MR_USAGE_INDEX 0
461 #define SLAPI_PLUGIN_MR_USAGE_SORT 1
463 #define SLAPI_PLUGIN_SYNTAX_FILTER_AVA 700
464 #define SLAPI_PLUGIN_SYNTAX_FILTER_SUB 701
465 #define SLAPI_PLUGIN_SYNTAX_VALUES2KEYS 702
466 #define SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_AVA 703
467 #define SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_SUB 704
468 #define SLAPI_PLUGIN_SYNTAX_NAMES 705
469 #define SLAPI_PLUGIN_SYNTAX_OID 706
470 #define SLAPI_PLUGIN_SYNTAX_FLAGS 707
471 #define SLAPI_PLUGIN_SYNTAX_COMPARE 708
473 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORKEYS 1
474 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORDERING 2
476 #define SLAPI_PLUGIN_ACL_INIT 730
477 #define SLAPI_PLUGIN_ACL_SYNTAX_CHECK 731
478 #define SLAPI_PLUGIN_ACL_ALLOW_ACCESS 732
479 #define SLAPI_PLUGIN_ACL_MODS_ALLOWED 733
480 #define SLAPI_PLUGIN_ACL_MODS_UPDATE 734
482 #define SLAPI_OPERATION_AUTHTYPE 741
483 #define SLAPI_OPERATION_ID 742
484 #define SLAPI_CONN_CERT 743
485 #define SLAPI_CONN_AUTHMETHOD 746
487 #define SLAPI_RESULT_CODE 881
488 #define SLAPI_RESULT_TEXT 882
489 #define SLAPI_RESULT_MATCHED 883
491 /* audit plugin defines */
492 #define SLAPI_PLUGIN_AUDIT_DATA 1100
493 #define SLAPI_PLUGIN_AUDIT_FN 1101
495 /* managedsait control */
496 #define SLAPI_MANAGEDSAIT 1000
499 #define SLAPI_CONFIG_FILENAME 40
500 #define SLAPI_CONFIG_LINENO 41
501 #define SLAPI_CONFIG_ARGC 42
502 #define SLAPI_CONFIG_ARGV 43
504 /* operational params */
505 #define SLAPI_TARGET_DN 50
506 #define SLAPI_REQCONTROLS 51
508 /* server LDAPv3 controls */
509 #define SLAPI_RESCONTROLS 55
510 #define SLAPI_ADD_RESCONTROL 56
513 #define SLAPI_ADD_TARGET SLAPI_TARGET_DN
514 #define SLAPI_ADD_ENTRY 60
517 #define SLAPI_BIND_TARGET SLAPI_TARGET_DN
518 #define SLAPI_BIND_METHOD 70
519 #define SLAPI_BIND_CREDENTIALS 71
520 #define SLAPI_BIND_SASLMECHANISM 72
521 #define SLAPI_BIND_RET_SASLCREDS 73
524 #define SLAPI_COMPARE_TARGET SLAPI_TARGET_DN
525 #define SLAPI_COMPARE_TYPE 80
526 #define SLAPI_COMPARE_VALUE 81
529 #define SLAPI_DELETE_TARGET SLAPI_TARGET_DN
532 #define SLAPI_MODIFY_TARGET SLAPI_TARGET_DN
533 #define SLAPI_MODIFY_MODS 90
536 #define SLAPI_MODRDN_TARGET SLAPI_TARGET_DN
537 #define SLAPI_MODRDN_NEWRDN 100
538 #define SLAPI_MODRDN_DELOLDRDN 101
539 #define SLAPI_MODRDN_NEWSUPERIOR 102 /* v3 only */
542 #define SLAPI_SEARCH_TARGET SLAPI_TARGET_DN
543 #define SLAPI_SEARCH_SCOPE 110
544 #define SLAPI_SEARCH_DEREF 111
545 #define SLAPI_SEARCH_SIZELIMIT 112
546 #define SLAPI_SEARCH_TIMELIMIT 113
547 #define SLAPI_SEARCH_FILTER 114
548 #define SLAPI_SEARCH_STRFILTER 115
549 #define SLAPI_SEARCH_ATTRS 116
550 #define SLAPI_SEARCH_ATTRSONLY 117
553 #define SLAPI_ABANDON_MSGID 120
555 /* extended operation params */
556 #define SLAPI_EXT_OP_REQ_OID 160
557 #define SLAPI_EXT_OP_REQ_VALUE 161
559 /* extended operation return codes */
560 #define SLAPI_EXT_OP_RET_OID 162
561 #define SLAPI_EXT_OP_RET_VALUE 163
563 #define SLAPI_PLUGIN_EXTENDED_SENT_RESULT -1
565 #define SLAPI_BIND_SUCCESS 0
566 #define SLAPI_BIND_FAIL 2
567 #define SLAPI_BIND_ANONYMOUS 3
569 /* Search result params */
570 #define SLAPI_SEARCH_RESULT_SET 193
571 #define SLAPI_SEARCH_RESULT_ENTRY 194
572 #define SLAPI_NENTRIES 195
573 #define SLAPI_SEARCH_REFERRALS 196
576 #ifndef LDAP_FILTER_AND
577 #define LDAP_FILTER_AND 0xa0L
579 #ifndef LDAP_FILTER_OR
580 #define LDAP_FILTER_OR 0xa1L
582 #ifndef LDAP_FILTER_NOT
583 #define LDAP_FILTER_NOT 0xa2L
585 #ifndef LDAP_FILTER_EQUALITY
586 #define LDAP_FILTER_EQUALITY 0xa3L
588 #ifndef LDAP_FILTER_SUBSTRINGS
589 #define LDAP_FILTER_SUBSTRINGS 0xa4L
591 #ifndef LDAP_FILTER_GE
592 #define LDAP_FILTER_GE 0xa5L
594 #ifndef LDAP_FILTER_LE
595 #define LDAP_FILTER_LE 0xa6L
597 #ifndef LDAP_FILTER_PRESENT
598 #define LDAP_FILTER_PRESENT 0x87L
600 #ifndef LDAP_FILTER_APPROX
601 #define LDAP_FILTER_APPROX 0xa8L
603 #ifndef LDAP_FILTER_EXT_MATCH
604 #define LDAP_FILTER_EXT_MATCH 0xa9L
607 int slapi_log_error( int severity, char *subsystem, char *fmt, ... );
608 #define SLAPI_LOG_FATAL 0
609 #define SLAPI_LOG_TRACE 1
610 #define SLAPI_LOG_PACKETS 2
611 #define SLAPI_LOG_ARGS 3
612 #define SLAPI_LOG_CONNS 4
613 #define SLAPI_LOG_BER 5
614 #define SLAPI_LOG_FILTER 6
615 #define SLAPI_LOG_CONFIG 7
616 #define SLAPI_LOG_ACL 8
617 #define SLAPI_LOG_SHELL 9
618 #define SLAPI_LOG_PARSE 10
619 #define SLAPI_LOG_HOUSE 11
620 #define SLAPI_LOG_REPL 12
621 #define SLAPI_LOG_CACHE 13
622 #define SLAPI_LOG_PLUGIN 14
623 #define SLAPI_LOG_TIMING 15
625 #define SLAPI_PLUGIN_DESCRIPTION 12
626 typedef struct slapi_plugindesc {
630 char *spd_description;
633 #define SLAPI_PLUGIN_VERSION_01 "01"
634 #define SLAPI_PLUGIN_VERSION_02 "02"
635 #define SLAPI_PLUGIN_VERSION_03 "03"
636 #define SLAPI_PLUGIN_CURRENT_VERSION SLAPI_PLUGIN_VERSION_03
638 #endif /* _SLAPI_PLUGIN_H */