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