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