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