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