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