]> git.sur5r.net Git - openldap/blob - include/slapi-plugin.h
Sync with slapd
[openldap] / include / slapi-plugin.h
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  *
4  * Copyright 1998-2005 The OpenLDAP Foundation.
5  * Portions Copyright 1997,2002,2003 IBM Corporation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted only as authorized by the OpenLDAP
10  * Public License.
11  *
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>.
15  */
16
17 /*
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.
21  */
22
23 #ifndef _SLAPI_PLUGIN_H
24 #define _SLAPI_PLUGIN_H
25
26 #include <ldap.h>
27
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;
42
43 #define SLAPI_ATTR_UNIQUEID     "entryUUID"
44 #define SLAPI_ATTR_OBJECTCLASS  "objectClass"
45
46 /* pblock routines */
47 int slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value );
48 int slapi_pblock_set( Slapi_PBlock *pb, int arg, void *value );
49 Slapi_PBlock *slapi_pblock_new( void );
50 void slapi_pblock_destroy( Slapi_PBlock *pb );
51
52 /* entry/attr/dn routines */
53 Slapi_Entry *slapi_str2entry( char *s, int flags );
54 #define SLAPI_STR2ENTRY_REMOVEDUPVALS   1
55 #define SLAPI_STR2ENTRY_ADDRDNVALS      2
56 #define SLAPI_STR2ENTRY_BIGENTRY        4
57 #define SLAPI_STR2ENTRY_TOMBSTONE_CHECK 8
58 #define SLAPI_STR2ENTRY_IGNORE_STATE    16
59 #define SLAPI_STR2ENTRY_INCLUDE_VERSION_STR     32
60 #define SLAPI_STR2ENTRY_EXPAND_OBJECTCLASSES    64
61 #define SLAPI_STR2ENTRY_NOT_WELL_FORMED_LDIF    128
62 char *slapi_entry2str( Slapi_Entry *e, int *len );
63 char *slapi_entry_get_dn( Slapi_Entry *e );
64 int slapi_x_entry_get_id( Slapi_Entry *e );
65 void slapi_entry_set_dn( Slapi_Entry *e, char *dn );
66 Slapi_Entry *slapi_entry_dup( Slapi_Entry *e );
67 int slapi_entry_attr_delete( Slapi_Entry *e, char *type );
68 Slapi_Entry *slapi_entry_alloc();
69 void slapi_entry_free( Slapi_Entry *e );
70 int slapi_entry_attr_merge( Slapi_Entry *e, char *type, struct berval **vals );
71 int slapi_entry_attr_find( Slapi_Entry *e, char *type, Slapi_Attr **attr );
72 char *slapi_entry_attr_get_charptr( const Slapi_Entry *e, const char *type );
73 int slapi_entry_attr_get_int( const Slapi_Entry *e, const char *type );
74 long slapi_entry_attr_get_long( const Slapi_Entry *e, const char *type );
75 unsigned int slapi_entry_attr_get_uint( const Slapi_Entry *e, const char *type );
76 unsigned long slapi_entry_attr_get_ulong( const Slapi_Entry *e, const char *type );
77 int slapi_attr_get_values( Slapi_Attr *attr, struct berval ***vals );
78 char *slapi_dn_normalize( char *dn );
79 char *slapi_dn_normalize_case( char *dn );
80 int slapi_dn_issuffix( char *dn, char *suffix );
81 char *slapi_dn_beparent( Slapi_PBlock *pb, const char *dn );
82 char *slapi_dn_parent( const char *dn );
83 int slapi_dn_isparent( const char *parentdn, const char *childdn );
84 char *slapi_dn_ignore_case( char *dn );
85 int slapi_rdn2typeval( char *rdn, char **type, struct berval *bv );
86 char *slapi_dn_plus_rdn(const char *dn, const char *rdn);
87
88 /* DS 5.x SLAPI */
89 int slapi_access_allowed( Slapi_PBlock *pb, Slapi_Entry *e, char *attr, struct berval *val, int access );
90 int slapi_acl_check_mods( Slapi_PBlock *pb, Slapi_Entry *e, LDAPMod **mods, char **errbuf );
91 Slapi_Attr *slapi_attr_new( void );
92 Slapi_Attr *slapi_attr_init( Slapi_Attr *a, const char *type );
93 void slapi_attr_free( Slapi_Attr **a );
94 Slapi_Attr *slapi_attr_dup( const Slapi_Attr *attr );
95 int slapi_attr_add_value( Slapi_Attr *a, const Slapi_Value *v );
96 int slapi_attr_type2plugin( const char *type, void **pi );
97 int slapi_attr_get_type( const Slapi_Attr *attr, char **type );
98 int slapi_attr_get_oid_copy( const Slapi_Attr *attr, char **oidp );
99 int slapi_attr_get_flags( const Slapi_Attr *attr, unsigned long *flags );
100 int slapi_attr_flag_is_set( const Slapi_Attr *attr, unsigned long flag );
101 int slapi_attr_value_cmp( const Slapi_Attr *attr, const struct berval *v1, const struct berval *v2 );
102 int slapi_attr_value_find( const Slapi_Attr *a, struct berval *v );
103 #define SLAPI_TYPE_CMP_EXACT    0
104 #define SLAPI_TYPE_CMP_BASE     1
105 #define SLAPI_TYPE_CMP_SUBTYPE  2
106 int slapi_attr_type_cmp( const char *t1, const char *t2, int opt );
107 int slapi_attr_types_equivalent( const char *t1, const char *t2 );
108 int slapi_attr_first_value( Slapi_Attr *a, Slapi_Value **v );
109 int slapi_attr_next_value( Slapi_Attr *a, int hint, Slapi_Value **v );
110 int slapi_attr_get_numvalues( const Slapi_Attr *a, int *numValues );
111 int slapi_attr_get_valueset( const Slapi_Attr *a, Slapi_ValueSet **vs );
112 int slapi_attr_get_bervals_copy( Slapi_Attr *a, struct berval ***vals );
113 int slapi_entry_attr_hasvalue( Slapi_Entry *e, const char *type, const char *value );
114 int slapi_entry_attr_merge_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
115 void slapi_entry_attr_set_charptr(Slapi_Entry* e, const char *type, const char *value);
116 void slapi_entry_attr_set_int( Slapi_Entry* e, const char *type, int l);
117 void slapi_entry_attr_set_uint( Slapi_Entry* e, const char *type, unsigned int l);
118 void slapi_entry_attr_set_long(Slapi_Entry* e, const char *type, long l);
119 void slapi_entry_attr_set_ulong(Slapi_Entry* e, const char *type, unsigned long l);
120 int slapi_entry_has_children(const Slapi_Entry *e);
121 size_t slapi_entry_size(Slapi_Entry *e);
122 int slapi_is_rootdse( const char *dn );
123 int slapi_entry_attr_merge_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
124 int slapi_entry_add_values_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
125 int slapi_entry_add_valueset(Slapi_Entry *e, const char *type, Slapi_ValueSet *vs);
126 int slapi_entry_delete_values_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
127 int slapi_entry_merge_values_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
128 int slapi_entry_attr_replace_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
129 int slapi_entry_add_value(Slapi_Entry *e, const char *type, const Slapi_Value *value);
130 int slapi_entry_add_string(Slapi_Entry *e, const char *type, const char *value);
131 int slapi_entry_delete_string(Slapi_Entry *e, const char *type, const char *value);
132 int slapi_entry_first_attr( const Slapi_Entry *e, Slapi_Attr **attr );
133 int slapi_entry_next_attr( const Slapi_Entry *e, Slapi_Attr *prevattr, Slapi_Attr **attr );
134 const char *slapi_entry_get_uniqueid( const Slapi_Entry *e );
135 void slapi_entry_set_uniqueid( Slapi_Entry *e, char *uniqueid );
136 int slapi_entry_schema_check( Slapi_PBlock *pb, Slapi_Entry *e );
137 int slapi_entry_rdn_values_present( const Slapi_Entry *e );
138 int slapi_entry_add_rdn_values( Slapi_Entry *e );
139 char *slapi_attr_syntax_normalize( const char *s );
140
141 Slapi_Value *slapi_value_new( void );
142 Slapi_Value *slapi_value_new_berval(const struct berval *bval);
143 Slapi_Value *slapi_value_new_value(const Slapi_Value *v);
144 Slapi_Value *slapi_value_new_string(const char *s);
145 Slapi_Value *slapi_value_init(Slapi_Value *v);
146 Slapi_Value *slapi_value_init_berval(Slapi_Value *v, struct berval *bval);
147 Slapi_Value *slapi_value_init_string(Slapi_Value *v,const char *s);
148 Slapi_Value *slapi_value_dup(const Slapi_Value *v);
149 void slapi_value_free(Slapi_Value **value);
150 const struct berval *slapi_value_get_berval( const Slapi_Value *value );
151 Slapi_Value *slapi_value_set_berval( Slapi_Value *value, const struct berval *bval );
152 Slapi_Value *slapi_value_set_value( Slapi_Value *value, const Slapi_Value *vfrom);
153 Slapi_Value *slapi_value_set( Slapi_Value *value, void *val, unsigned long len);
154 int slapi_value_set_string(Slapi_Value *value, const char *strVal);
155 int slapi_value_set_int(Slapi_Value *value, int intVal);
156 const char*slapi_value_get_string(const Slapi_Value *value);
157 int slapi_value_get_int(const Slapi_Value *value); 
158 unsigned int slapi_value_get_uint(const Slapi_Value *value); 
159 long slapi_value_get_long(const Slapi_Value *value); 
160 unsigned long slapi_value_get_ulong(const Slapi_Value *value); 
161 size_t slapi_value_get_length(const Slapi_Value *value);
162 int slapi_value_compare(const Slapi_Attr *a,const Slapi_Value *v1,const Slapi_Value *v2);
163
164 Slapi_ValueSet *slapi_valueset_new( void );
165 void slapi_valueset_free(Slapi_ValueSet *vs);
166 void slapi_valueset_init(Slapi_ValueSet *vs);
167 void slapi_valueset_done(Slapi_ValueSet *vs);
168 void slapi_valueset_add_value(Slapi_ValueSet *vs, const Slapi_Value *addval);
169 int slapi_valueset_first_value( Slapi_ValueSet *vs, Slapi_Value **v );
170 int slapi_valueset_next_value( Slapi_ValueSet *vs, int index, Slapi_Value **v);
171 int slapi_valueset_count( const Slapi_ValueSet *vs);
172 void slapi_valueset_set_valueset(Slapi_ValueSet *vs1, const Slapi_ValueSet *vs2);
173
174 /* locks and synchronization */
175 typedef struct slapi_mutex      Slapi_Mutex;
176 typedef struct slapi_condvar    Slapi_CondVar;
177 Slapi_Mutex *slapi_new_mutex( void );
178 void slapi_destroy_mutex( Slapi_Mutex *mutex );
179 void slapi_lock_mutex( Slapi_Mutex *mutex );
180 int slapi_unlock_mutex( Slapi_Mutex *mutex );
181 Slapi_CondVar *slapi_new_condvar( Slapi_Mutex *mutex );
182 void slapi_destroy_condvar( Slapi_CondVar *cvar );
183 int slapi_wait_condvar( Slapi_CondVar *cvar, struct timeval *timeout );
184 int slapi_notify_condvar( Slapi_CondVar *cvar, int notify_all );
185
186 /* thread-safe LDAP connections */
187 LDAP *slapi_ldap_init( char *ldaphost, int ldapport, int secure, int shared );
188 void slapi_ldap_unbind( LDAP *ld );
189
190 char *slapi_ch_malloc( unsigned long size );
191 void slapi_ch_free( void **ptr );
192 void slapi_ch_free_string( char **ptr );
193 char *slapi_ch_calloc( unsigned long nelem, unsigned long size );
194 char *slapi_ch_realloc( char *block, unsigned long size );
195 char *slapi_ch_strdup( char *s );
196 void slapi_ch_array_free( char **arrayp );
197 struct berval *slapi_ch_bvdup(const struct berval *v);
198 struct berval **slapi_ch_bvecdup(const struct berval **v);
199
200 /* LDAP V3 routines */
201 int slapi_control_present( LDAPControl **controls, char *oid,
202         struct berval **val, int *iscritical);
203 void slapi_register_supported_control(char *controloid,
204         unsigned long controlops);
205 #define SLAPI_OPERATION_BIND            0x00000001L
206 #define SLAPI_OPERATION_UNBIND          0x00000002L
207 #define SLAPI_OPERATION_SEARCH          0x00000004L
208 #define SLAPI_OPERATION_MODIFY          0x00000008L
209 #define SLAPI_OPERATION_ADD             0x00000010L
210 #define SLAPI_OPERATION_DELETE          0x00000020L
211 #define SLAPI_OPERATION_MODDN           0x00000040L
212 #define SLAPI_OPERATION_MODRDN          SLAPI_OPERATION_MODDN
213 #define SLAPI_OPERATION_COMPARE         0x00000080L
214 #define SLAPI_OPERATION_ABANDON         0x00000100L
215 #define SLAPI_OPERATION_EXTENDED        0x00000200L
216 #define SLAPI_OPERATION_ANY             0xFFFFFFFFL
217 #define SLAPI_OPERATION_NONE            0x00000000L
218 int slapi_get_supported_controls(char ***ctrloidsp, unsigned long **ctrlopsp);
219 LDAPControl *slapi_dup_control(LDAPControl *ctrl);
220 void slapi_register_supported_saslmechanism(char *mechanism);
221 char **slapi_get_supported_saslmechanisms();
222 char **slapi_get_supported_extended_ops(void);
223
224
225 /* send ldap result back */
226 void slapi_send_ldap_result( Slapi_PBlock *pb, int err, char *matched,
227         char *text, int nentries, struct berval **urls );
228 int slapi_send_ldap_search_entry( Slapi_PBlock *pb, Slapi_Entry *e,
229         LDAPControl **ectrls, char **attrs, int attrsonly );
230 int slapi_send_ldap_search_reference( Slapi_PBlock *pb, Slapi_Entry *e,
231         struct berval **urls, LDAPControl **ectrls, struct berval **v2refs );
232
233 /* filter routines */
234 Slapi_Filter *slapi_str2filter( char *str );
235 Slapi_Filter *slapi_filter_dup( Slapi_Filter *f );
236 void slapi_filter_free( Slapi_Filter *f, int recurse );
237 int slapi_filter_get_choice( Slapi_Filter *f);
238 int slapi_filter_get_ava( Slapi_Filter *f, char **type, struct berval **bval );
239 Slapi_Filter *slapi_filter_list_first( Slapi_Filter *f );
240 Slapi_Filter *slapi_filter_list_next( Slapi_Filter *f, Slapi_Filter *fprev );
241 int slapi_filter_get_attribute_type( Slapi_Filter *f, char **type ); 
242 int slapi_x_filter_set_attribute_type( Slapi_Filter *f, const char *type );
243 int slapi_filter_get_subfilt( Slapi_Filter *f, char **type, char **initial,
244         char ***any, char **final );
245 Slapi_Filter *slapi_filter_join( int ftype, Slapi_Filter *f1, Slapi_Filter *f2);
246 int slapi_x_filter_append( int choice, Slapi_Filter **pContainingFilter,
247         Slapi_Filter **pNextFilter, Slapi_Filter *filterToAppend );
248 int slapi_filter_test( Slapi_PBlock *pb, Slapi_Entry *e, Slapi_Filter *f,
249         int verify_access );
250 int slapi_filter_test_simple( Slapi_Entry *e, Slapi_Filter *f );
251 typedef int (*FILTER_APPLY_FN)( Slapi_Filter *f, void *arg );
252 int slapi_filter_apply( Slapi_Filter *f, FILTER_APPLY_FN fn, void *arg, int *error_code );
253 #define SLAPI_FILTER_SCAN_STOP                  -1 /* set by callback */
254 #define SLAPI_FILTER_SCAN_ERROR                 -2 /* set by callback */
255 #define SLAPI_FILTER_SCAN_NOMORE                0 /* set by callback */
256 #define SLAPI_FILTER_SCAN_CONTINUE              1 /* set by callback */
257 #define SLAPI_FILTER_UNKNOWN_FILTER_TYPE        2 /* set by slapi_filter_apply() */
258
259 /* internal add/delete/search/modify routines */
260 Slapi_PBlock *slapi_search_internal( char *base, int scope, char *filter, 
261         LDAPControl **controls, char **attrs, int attrsonly );
262 Slapi_PBlock *slapi_modify_internal( char *dn, LDAPMod **mods,
263         LDAPControl **controls, int log_change );
264 Slapi_PBlock *slapi_add_internal( char * dn, LDAPMod **attrs,
265         LDAPControl **controls, int log_changes );
266 Slapi_PBlock *slapi_add_entry_internal( Slapi_Entry * e,
267         LDAPControl **controls, int log_change );
268 Slapi_PBlock *slapi_delete_internal( char * dn,  LDAPControl **controls,
269         int log_change );
270 Slapi_PBlock *slapi_modrdn_internal( char * olddn, char * newrdn,
271         int deloldrdn, LDAPControl **controls,
272         int log_change );
273 Slapi_PBlock *slapi_rename_internal( const char * olddn, const char *newrdn,
274         const char *newsuperior, int delolrdn,
275         LDAPControl **controls, int log_change );
276 void slapi_free_search_results_internal(Slapi_PBlock *pb);
277
278 /* new internal add/delete/search/modify routines */
279 typedef void (*plugin_result_callback)( int rc, void *callback_data );
280 typedef int (*plugin_referral_entry_callback)( char * referral,
281         void *callback_data );
282 typedef int (*plugin_search_entry_callback)( Slapi_Entry *e,
283         void *callback_data );
284 void slapi_free_search_results_internal( Slapi_PBlock *pb );
285
286 #define SLAPI_OP_FLAG_NEVER_CHAIN       0x0800
287
288 int slapi_search_internal_pb( Slapi_PBlock *pb );
289 int slapi_search_internal_callback_pb( Slapi_PBlock *pb, void *callback_data,
290         plugin_result_callback prc, plugin_search_entry_callback psec,
291         plugin_referral_entry_callback prec );
292 int slapi_add_internal_pb( Slapi_PBlock *pb );
293 int slapi_modify_internal_pb( Slapi_PBlock *pb );
294 int slapi_modrdn_internal_pb( Slapi_PBlock *pb );
295 int slapi_delete_internal_pb( Slapi_PBlock *pb );
296
297 int slapi_seq_internal_callback_pb(Slapi_PBlock *pb, void *callback_data,
298         plugin_result_callback res_callback,
299         plugin_search_entry_callback srch_callback,
300         plugin_referral_entry_callback ref_callback);
301
302 void slapi_search_internal_set_pb( Slapi_PBlock *pb, const char *base,
303         int scope, const char *filter, char **attrs, int attrsonly,
304         LDAPControl **controls, const char *uniqueid,
305         Slapi_ComponentId *plugin_identity, int operation_flags );
306 void slapi_add_entry_internal_set_pb( Slapi_PBlock *pb, Slapi_Entry *e,
307         LDAPControl **controls, Slapi_ComponentId *plugin_identity,
308         int operation_flags );
309 int slapi_add_internal_set_pb( Slapi_PBlock *pb, const char *dn,
310         LDAPMod **attrs, LDAPControl **controls,
311         Slapi_ComponentId *plugin_identity, int operation_flags );
312 void slapi_modify_internal_set_pb( Slapi_PBlock *pb, const char *dn,
313         LDAPMod **mods, LDAPControl **controls, const char *uniqueid,
314         Slapi_ComponentId *plugin_identity, int operation_flags );
315 void slapi_rename_internal_set_pb( Slapi_PBlock *pb, const char *olddn,
316         const char *newrdn, const char *newsuperior, int deloldrdn,
317         LDAPControl **controls, const char *uniqueid,
318         Slapi_ComponentId *plugin_identity, int operation_flags );
319 void slapi_delete_internal_set_pb( Slapi_PBlock *pb, const char *dn,
320         LDAPControl **controls, const char *uniqueid,
321         Slapi_ComponentId *plugin_identity, int operation_flags );
322 void slapi_seq_internal_set_pb( Slapi_PBlock *pb, char *ibase, int type,
323         char *attrname, char *val, char **attrs, int attrsonly,
324         LDAPControl **controls, Slapi_ComponentId *plugin_identity,
325         int operation_flags );
326
327 /* connection related routines */
328 int slapi_is_connection_ssl(Slapi_PBlock *pPB, int *isSSL);
329 int slapi_get_client_port(Slapi_PBlock *pPB, int *fromPort);
330
331 /* computed attributes */
332 typedef struct _computed_attr_context computed_attr_context;
333 typedef int (*slapi_compute_output_t)(computed_attr_context *c, Slapi_Attr *a, Slapi_Entry *e);
334 typedef int (*slapi_compute_callback_t)(computed_attr_context *c, char *type, Slapi_Entry *e, slapi_compute_output_t outputfn);
335 typedef int (*slapi_search_rewrite_callback_t)(Slapi_PBlock *pb);
336 int slapi_compute_add_evaluator(slapi_compute_callback_t function);
337 int slapi_compute_add_search_rewriter(slapi_search_rewrite_callback_t function);
338 int compute_rewrite_search_filter(Slapi_PBlock *pb);
339 int compute_evaluator(computed_attr_context *c, char *type, Slapi_Entry *e, slapi_compute_output_t outputfn);
340 int slapi_x_compute_get_pblock(computed_attr_context *c, Slapi_PBlock **pb);
341
342 /* ACL plugins; only SLAPI_PLUGIN_ACL_ALLOW_ACCESS supported now */
343 typedef int (*slapi_acl_callback_t)(Slapi_PBlock *pb,
344         Slapi_Entry *e,
345         const char *attr,
346         struct berval *berval,
347         int access,
348         void *state);
349
350 /* object extensions */
351 typedef void *(*slapi_extension_constructor_fnptr)(void *object, void *parent);
352
353 typedef void (*slapi_extension_destructor_fnptr)(void *extension,
354         void *object, void *parent);
355
356 int slapi_register_object_extension( const char *pluginname,
357         const char *objectname, slapi_extension_constructor_fnptr constructor,
358         slapi_extension_destructor_fnptr destructor, int *objecttype,
359         int *extensionhandle);
360
361 #define SLAPI_EXT_CONNECTION    "Connection"
362 #define SLAPI_EXT_OPERATION     "Operation"
363 #define SLAPI_EXT_ENTRY         "Entry"
364 #define SLAPI_EXT_MTNODE        "Mapping Tree Node"
365
366 void *slapi_get_object_extension(int objecttype, void *object,
367         int extensionhandle);
368 void slapi_set_object_extension(int objecttype, void *object,
369         int extensionhandle, void *extension);
370
371 int slapi_x_backend_get_flags( const Slapi_Backend *be, unsigned long *flags );
372
373 /* parameters currently supported */
374
375 /*
376  * Attribute flags returned by slapi_attr_get_flags()
377  */
378 #define SLAPI_ATTR_FLAG_SINGLE          0x0001
379 #define SLAPI_ATTR_FLAG_OPATTR          0x0002
380 #define SLAPI_ATTR_FLAG_READONLY        0x0004
381 #define SLAPI_ATTR_FLAG_STD_ATTR        SLAPI_ATTR_FLAG_READONLY
382 #define SLAPI_ATTR_FLAG_OBSOLETE        0x0040
383 #define SLAPI_ATTR_FLAG_COLLECTIVE      0x0080
384 #define SLAPI_ATTR_FLAG_NOUSERMOD       0x0100
385
386 /*
387  * Backend flags returned by slapi_x_backend_get_flags()
388  */
389 #define SLAPI_BACKEND_FLAG_NOLASTMOD            0x0001U
390 #define SLAPI_BACKEND_FLAG_NO_SCHEMA_CHECK      0x0002U
391 #define SLAPI_BACKEND_FLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
392 #define SLAPI_BACKEND_FLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
393 #define SLAPI_BACKEND_FLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
394 #define SLAPI_BACKEND_FLAG_OVERLAY              0x0080U /* this db struct is an overlay */
395 #define SLAPI_BACKEND_FLAG_GLOBAL_OVERLAY       0x0100U /* this db struct is a global overlay */
396 #define SLAPI_BACKEND_FLAG_SHADOW               0x8000U /* a shadow */
397 #define SLAPI_BACKEND_FLAG_SYNC_SHADOW          0x1000U /* a sync shadow */
398 #define SLAPI_BACKEND_FLAG_SLURP_SHADOW         0x2000U /* a slurp shadow */
399
400 /*
401  * ACL levels
402  */
403 #define SLAPI_ACL_COMPARE       0x01
404 #define SLAPI_ACL_SEARCH        0x02
405 #define SLAPI_ACL_READ          0x04
406 #define SLAPI_ACL_WRITE         0x08
407 #define SLAPI_ACL_DELETE        0x10    
408 #define SLAPI_ACL_ADD           0x20
409 #define SLAPI_ACL_SELF          0x40
410 #define SLAPI_ACL_PROXY         0x80
411 #define SLAPI_ACL_ALL           0x7f
412
413 /* plugin types supported */
414
415 #define SLAPI_PLUGIN_DATABASE           1
416 #define SLAPI_PLUGIN_EXTENDEDOP         2
417 #define SLAPI_PLUGIN_PREOPERATION       3
418 #define SLAPI_PLUGIN_POSTOPERATION      4
419 #define SLAPI_PLUGIN_MATCHINGRULE       5
420 #define SLAPI_PLUGIN_SYNTAX             6
421 #define SLAPI_PLUGIN_AUDIT              7   
422
423 /* misc params */
424
425 #define SLAPI_BACKEND                           130
426 #define SLAPI_CONNECTION                        131
427 #define SLAPI_OPERATION                         132
428 #define SLAPI_REQUESTOR_ISROOT                  133
429 #define SLAPI_BE_MONITORDN                      134
430 #define SLAPI_BE_TYPE                           135
431 #define SLAPI_BE_READONLY                       136
432 #define SLAPI_BE_LASTMOD                        137
433 #define SLAPI_CONN_ID                           139
434
435 /* operation params */
436 #define SLAPI_OPINITIATED_TIME                  140
437 #define SLAPI_REQUESTOR_DN                      141
438 #define SLAPI_IS_REPLICATED_OPERATION           142
439 #define SLAPI_REQUESTOR_ISUPDATEDN              SLAPI_IS_REPLICATED_OPERATION
440
441 /* connection  structure params*/
442 #define SLAPI_CONN_DN                           143
443 #define SLAPI_CONN_AUTHTYPE                     144
444 #define SLAPI_CONN_CLIENTIP                     145
445 #define SLAPI_CONN_SERVERIP                     146
446 /* OpenLDAP extensions */
447 #define SLAPI_X_CONN_CLIENTPATH                 1300
448 #define SLAPI_X_CONN_SERVERPATH                 1301
449 #define SLAPI_X_CONN_IS_UDP                     1302
450 #define SLAPI_X_CONN_SSF                        1303
451 #define SLAPI_X_CONN_SASL_CONTEXT               1304
452
453 /*  Authentication types */
454 #define SLAPD_AUTH_NONE   "none"
455 #define SLAPD_AUTH_SIMPLE "simple"
456 #define SLAPD_AUTH_SSL    "SSL"
457 #define SLAPD_AUTH_SASL   "SASL " 
458
459 /* plugin configuration parmams */
460 #define SLAPI_PLUGIN                            3
461 #define SLAPI_PLUGIN_PRIVATE                    4
462 #define SLAPI_PLUGIN_TYPE                       5
463 #define SLAPI_PLUGIN_ARGV                       6
464 #define SLAPI_PLUGIN_ARGC                       7
465 #define SLAPI_PLUGIN_VERSION                    8
466 #define SLAPI_PLUGIN_OPRETURN                   9
467 #define SLAPI_PLUGIN_OBJECT                     10
468 #define SLAPI_PLUGIN_DESTROY_FN                 11
469 #define SLAPI_PLUGIN_DESCRIPTION                12
470 #define SLAPI_PLUGIN_IDENTITY                   13
471
472 /* internal opreations params */
473 #define SLAPI_PLUGIN_INTOP_RESULT               15
474 #define SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES       16
475 #define SLAPI_PLUGIN_INTOP_SEARCH_REFERRALS     17
476
477 /* transaction arguments */
478 #define SLAPI_PARENT_TXN                        190
479 #define SLAPI_TXN                               191
480
481 /* function pointer params for backends */
482 #define SLAPI_PLUGIN_DB_BIND_FN                 200
483 #define SLAPI_PLUGIN_DB_UNBIND_FN               201
484 #define SLAPI_PLUGIN_DB_SEARCH_FN               202
485 #define SLAPI_PLUGIN_DB_COMPARE_FN              203
486 #define SLAPI_PLUGIN_DB_MODIFY_FN               204
487 #define SLAPI_PLUGIN_DB_MODRDN_FN               205
488 #define SLAPI_PLUGIN_DB_ADD_FN                  206
489 #define SLAPI_PLUGIN_DB_DELETE_FN               207
490 #define SLAPI_PLUGIN_DB_ABANDON_FN              208
491 #define SLAPI_PLUGIN_DB_CONFIG_FN               209
492 #define SLAPI_PLUGIN_CLOSE_FN                   210
493 #define SLAPI_PLUGIN_DB_FLUSH_FN                211
494 #define SLAPI_PLUGIN_START_FN                   212
495 #define SLAPI_PLUGIN_DB_SEQ_FN                  213
496 #define SLAPI_PLUGIN_DB_ENTRY_FN                214
497 #define SLAPI_PLUGIN_DB_REFERRAL_FN             215
498 #define SLAPI_PLUGIN_DB_RESULT_FN               216
499 #define SLAPI_PLUGIN_DB_LDIF2DB_FN              217
500 #define SLAPI_PLUGIN_DB_DB2LDIF_FN              218
501 #define SLAPI_PLUGIN_DB_BEGIN_FN                219
502 #define SLAPI_PLUGIN_DB_COMMIT_FN               220
503 #define SLAPI_PLUGIN_DB_ABORT_FN                221
504 #define SLAPI_PLUGIN_DB_ARCHIVE2DB_FN           222
505 #define SLAPI_PLUGIN_DB_DB2ARCHIVE_FN           223
506 #define SLAPI_PLUGIN_DB_NEXT_SEARCH_ENTRY_FN    224
507 #define SLAPI_PLUGIN_DB_FREE_RESULT_SET_FN      225
508 #define SLAPI_PLUGIN_DB_SIZE_FN                 226
509 #define SLAPI_PLUGIN_DB_TEST_FN                 227
510
511
512 /*  functions pointers for LDAP V3 extended ops */
513 #define SLAPI_PLUGIN_EXT_OP_FN                  300
514 #define SLAPI_PLUGIN_EXT_OP_OIDLIST             301
515
516 /* preoperation */
517 #define SLAPI_PLUGIN_PRE_BIND_FN                401
518 #define SLAPI_PLUGIN_PRE_UNBIND_FN              402
519 #define SLAPI_PLUGIN_PRE_SEARCH_FN              403
520 #define SLAPI_PLUGIN_PRE_COMPARE_FN             404
521 #define SLAPI_PLUGIN_PRE_MODIFY_FN              405
522 #define SLAPI_PLUGIN_PRE_MODRDN_FN              406
523 #define SLAPI_PLUGIN_PRE_ADD_FN                 407
524 #define SLAPI_PLUGIN_PRE_DELETE_FN              408
525 #define SLAPI_PLUGIN_PRE_ABANDON_FN             409
526 #define SLAPI_PLUGIN_PRE_ENTRY_FN               410
527 #define SLAPI_PLUGIN_PRE_REFERRAL_FN            411
528 #define SLAPI_PLUGIN_PRE_RESULT_FN              412
529
530 /* internal preoperation */
531 #define SLAPI_PLUGIN_INTERNAL_PRE_ADD_FN        420
532 #define SLAPI_PLUGIN_INTERNAL_PRE_MODIFY_FN     421
533 #define SLAPI_PLUGIN_INTERNAL_PRE_MODRDN_FN     422
534 #define SLAPI_PLUGIN_INTERNAL_PRE_DELETE_FN     423
535
536 /* backend preoperation */
537 #define SLAPI_PLUGIN_BE_PRE_ADD_FN              450
538 #define SLAPI_PLUGIN_BE_PRE_MODIFY_FN           451
539 #define SLAPI_PLUGIN_BE_PRE_MODRDN_FN           452
540 #define SLAPI_PLUGIN_BE_PRE_DELETE_FN           453
541
542 /* postoperation */
543 #define SLAPI_PLUGIN_POST_BIND_FN               501
544 #define SLAPI_PLUGIN_POST_UNBIND_FN             502
545 #define SLAPI_PLUGIN_POST_SEARCH_FN             503
546 #define SLAPI_PLUGIN_POST_COMPARE_FN            504
547 #define SLAPI_PLUGIN_POST_MODIFY_FN             505
548 #define SLAPI_PLUGIN_POST_MODRDN_FN             506
549 #define SLAPI_PLUGIN_POST_ADD_FN                507
550 #define SLAPI_PLUGIN_POST_DELETE_FN             508
551 #define SLAPI_PLUGIN_POST_ABANDON_FN            509
552 #define SLAPI_PLUGIN_POST_ENTRY_FN              510
553 #define SLAPI_PLUGIN_POST_REFERRAL_FN           511
554 #define SLAPI_PLUGIN_POST_RESULT_FN             512
555
556 /* internal postoperation */
557 #define SLAPI_PLUGIN_INTERNAL_POST_ADD_FN       520
558 #define SLAPI_PLUGIN_INTERNAL_POST_MODIFY_FN    521
559 #define SLAPI_PLUGIN_INTERNAL_POST_MODRDN_FN    522
560 #define SLAPI_PLUGIN_INTERNAL_POST_DELETE_FN    523
561
562 /* backend postoperation */
563 #define SLAPI_PLUGIN_BE_POST_ADD_FN             550
564 #define SLAPI_PLUGIN_BE_POST_MODIFY_FN          551
565 #define SLAPI_PLUGIN_BE_POST_MODRDN_FN          552
566 #define SLAPI_PLUGIN_BE_POST_DELETE_FN          553
567
568 #define SLAPI_OPERATION_TYPE                    590
569
570 #define SLAPI_PLUGIN_MR_FILTER_CREATE_FN        600
571 #define SLAPI_PLUGIN_MR_INDEXER_CREATE_FN       601
572 #define SLAPI_PLUGIN_MR_FILTER_MATCH_FN         602
573 #define SLAPI_PLUGIN_MR_FILTER_INDEX_FN         603
574 #define SLAPI_PLUGIN_MR_FILTER_RESET_FN         604
575 #define SLAPI_PLUGIN_MR_INDEX_FN                605
576 #define SLAPI_PLUGIN_MR_OID                     610
577 #define SLAPI_PLUGIN_MR_TYPE                    611
578 #define SLAPI_PLUGIN_MR_VALUE                   612
579 #define SLAPI_PLUGIN_MR_VALUES                  613
580 #define SLAPI_PLUGIN_MR_KEYS                    614
581 #define SLAPI_PLUGIN_MR_FILTER_REUSABLE         615
582 #define SLAPI_PLUGIN_MR_QUERY_OPERATOR          616
583 #define SLAPI_PLUGIN_MR_USAGE                   617
584
585 #define SLAPI_MATCHINGRULE_NAME                 1
586 #define SLAPI_MATCHINGRULE_OID                  2
587 #define SLAPI_MATCHINGRULE_DESC                 3
588 #define SLAPI_MATCHINGRULE_SYNTAX               4
589 #define SLAPI_MATCHINGRULE_OBSOLETE             5
590
591 #define SLAPI_OP_LESS                                   1
592 #define SLAPI_OP_LESS_OR_EQUAL                          2
593 #define SLAPI_OP_EQUAL                                  3
594 #define SLAPI_OP_GREATER_OR_EQUAL                       4
595 #define SLAPI_OP_GREATER                                5
596 #define SLAPI_OP_SUBSTRING                              6
597
598 #define SLAPI_PLUGIN_MR_USAGE_INDEX             0
599 #define SLAPI_PLUGIN_MR_USAGE_SORT              1
600
601 #define SLAPI_PLUGIN_SYNTAX_FILTER_AVA          700
602 #define SLAPI_PLUGIN_SYNTAX_FILTER_SUB          701
603 #define SLAPI_PLUGIN_SYNTAX_VALUES2KEYS         702
604 #define SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_AVA  703
605 #define SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_SUB  704
606 #define SLAPI_PLUGIN_SYNTAX_NAMES               705
607 #define SLAPI_PLUGIN_SYNTAX_OID                 706
608 #define SLAPI_PLUGIN_SYNTAX_FLAGS               707
609 #define SLAPI_PLUGIN_SYNTAX_COMPARE             708
610
611 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORKEYS                 1
612 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORDERING               2
613
614 #define SLAPI_PLUGIN_ACL_INIT                   730
615 #define SLAPI_PLUGIN_ACL_SYNTAX_CHECK           731
616 #define SLAPI_PLUGIN_ACL_ALLOW_ACCESS           732
617 #define SLAPI_PLUGIN_ACL_MODS_ALLOWED           733
618 #define SLAPI_PLUGIN_ACL_MODS_UPDATE            734
619
620 #define SLAPI_OPERATION_AUTHTYPE                741
621 #define SLAPI_OPERATION_ID                      742
622 #define SLAPI_CONN_CERT                         743
623 #define SLAPI_CONN_AUTHMETHOD                   746
624
625 #define SLAPI_RESULT_CODE                       881
626 #define SLAPI_RESULT_TEXT                       882
627 #define SLAPI_RESULT_MATCHED                    883
628
629 /* managedsait control */
630 #define SLAPI_MANAGEDSAIT                       1000
631
632 /* audit plugin defines */
633 #define SLAPI_PLUGIN_AUDIT_DATA                1100
634 #define SLAPI_PLUGIN_AUDIT_FN                  1101
635
636 /* backend_group extension */
637 #define SLAPI_X_PLUGIN_PRE_GROUP_FN             1202 
638 #define SLAPI_X_PLUGIN_POST_GROUP_FN            1203
639
640 #define SLAPI_X_GROUP_ENTRY                     1250 /* group entry */
641 #define SLAPI_X_GROUP_ATTRIBUTE                 1251 /* member attribute */
642 #define SLAPI_X_GROUP_OPERATION_DN              1252 /* asserted value */
643 #define SLAPI_X_GROUP_TARGET_ENTRY              1253 /* target entry */
644
645 /* config stuff */
646 #define SLAPI_CONFIG_FILENAME                   40
647 #define SLAPI_CONFIG_LINENO                     41
648 #define SLAPI_CONFIG_ARGC                       42
649 #define SLAPI_CONFIG_ARGV                       43
650
651 /*  operational params */
652 #define SLAPI_TARGET_ADDRESS                    48
653 #define SLAPI_TARGET_UNIQUEID                   49
654 #define SLAPI_TARGET_DN                         50
655
656 /* server LDAPv3 controls  */
657 #define SLAPI_REQCONTROLS                       51
658 #define SLAPI_RESCONTROLS                       55
659 #define SLAPI_ADD_RESCONTROL                    56      
660 #define SLAPI_CONTROLS_ARG                      58
661
662 /* add params */
663 #define SLAPI_ADD_TARGET                        SLAPI_TARGET_DN
664 #define SLAPI_ADD_ENTRY                         60
665 #define SLAPI_ADD_EXISTING_DN_ENTRY             61
666 #define SLAPI_ADD_PARENT_ENTRY                  62
667 #define SLAPI_ADD_PARENT_UNIQUEID               63
668 #define SLAPI_ADD_EXISTING_UNIQUEID_ENTRY       64
669
670 /* bind params */
671 #define SLAPI_BIND_TARGET                       SLAPI_TARGET_DN
672 #define SLAPI_BIND_METHOD                       70
673 #define SLAPI_BIND_CREDENTIALS                  71      
674 #define SLAPI_BIND_SASLMECHANISM                72      
675 #define SLAPI_BIND_RET_SASLCREDS                73      
676
677 /* compare params */
678 #define SLAPI_COMPARE_TARGET                    SLAPI_TARGET_DN
679 #define SLAPI_COMPARE_TYPE                      80
680 #define SLAPI_COMPARE_VALUE                     81
681
682 /* delete params */
683 #define SLAPI_DELETE_TARGET                     SLAPI_TARGET_DN
684 #define SLAPI_DELETE_EXISTING_ENTRY             SLAPI_ADD_EXISTING_DN_ENTRY
685
686 /* modify params */
687 #define SLAPI_MODIFY_TARGET                     SLAPI_TARGET_DN
688 #define SLAPI_MODIFY_MODS                       90
689 #define SLAPI_MODIFY_EXISTING_ENTRY             SLAPI_ADD_EXISTING_DN_ENTRY
690
691 /* modrdn params */
692 #define SLAPI_MODRDN_TARGET                     SLAPI_TARGET_DN
693 #define SLAPI_MODRDN_NEWRDN                     100
694 #define SLAPI_MODRDN_DELOLDRDN                  101
695 #define SLAPI_MODRDN_NEWSUPERIOR                102     /* v3 only */
696 #define SLAPI_MODRDN_EXISTING_ENTRY             SLAPI_ADD_EXISTING_DN_ENTRY
697 #define SLAPI_MODRDN_PARENT_ENTRY               104
698 #define SLAPI_MODRDN_NEWPARENT_ENTRY            105
699 #define SLAPI_MODRDN_TARGET_ENTRY               106
700 #define SLAPI_MODRDN_NEWSUPERIOR_ADDRESS        107
701
702 /* search params */
703 #define SLAPI_SEARCH_TARGET                     SLAPI_TARGET_DN
704 #define SLAPI_SEARCH_SCOPE                      110
705 #define SLAPI_SEARCH_DEREF                      111
706 #define SLAPI_SEARCH_SIZELIMIT                  112
707 #define SLAPI_SEARCH_TIMELIMIT                  113
708 #define SLAPI_SEARCH_FILTER                     114
709 #define SLAPI_SEARCH_STRFILTER                  115
710 #define SLAPI_SEARCH_ATTRS                      116
711 #define SLAPI_SEARCH_ATTRSONLY                  117
712
713 /* abandon params */
714 #define SLAPI_ABANDON_MSGID                     120
715
716 /* extended operation params */
717 #define SLAPI_EXT_OP_REQ_OID                    160
718 #define SLAPI_EXT_OP_REQ_VALUE          161     
719
720 /* extended operation return codes */
721 #define SLAPI_EXT_OP_RET_OID                    162     
722 #define SLAPI_EXT_OP_RET_VALUE          163     
723
724 #define SLAPI_PLUGIN_EXTENDED_SENT_RESULT       -1
725
726 #define SLAPI_FAIL_DISKFULL             -2
727 #define SLAPI_FAIL_GENERAL              -1
728 #define SLAPI_PLUGIN_EXTENDED_NOT_HANDLED -2
729 #define SLAPI_BIND_SUCCESS              0
730 #define SLAPI_BIND_FAIL                 2
731 #define SLAPI_BIND_ANONYMOUS            3
732
733 /* Search result params */
734 #define SLAPI_SEARCH_RESULT_SET                 193
735 #define SLAPI_SEARCH_RESULT_ENTRY               194
736 #define SLAPI_NENTRIES                          195
737 #define SLAPI_SEARCH_REFERRALS                  196
738
739 /* filter types */
740 #ifndef LDAP_FILTER_AND
741 #define LDAP_FILTER_AND         0xa0L
742 #endif
743 #ifndef LDAP_FILTER_OR
744 #define LDAP_FILTER_OR          0xa1L
745 #endif
746 #ifndef LDAP_FILTER_NOT
747 #define LDAP_FILTER_NOT         0xa2L
748 #endif
749 #ifndef LDAP_FILTER_EQUALITY
750 #define LDAP_FILTER_EQUALITY    0xa3L
751 #endif
752 #ifndef LDAP_FILTER_SUBSTRINGS
753 #define LDAP_FILTER_SUBSTRINGS  0xa4L
754 #endif
755 #ifndef LDAP_FILTER_GE
756 #define LDAP_FILTER_GE          0xa5L
757 #endif
758 #ifndef LDAP_FILTER_LE
759 #define LDAP_FILTER_LE          0xa6L
760 #endif
761 #ifndef LDAP_FILTER_PRESENT
762 #define LDAP_FILTER_PRESENT     0x87L
763 #endif
764 #ifndef LDAP_FILTER_APPROX
765 #define LDAP_FILTER_APPROX      0xa8L
766 #endif
767 #ifndef LDAP_FILTER_EXT_MATCH
768 #define LDAP_FILTER_EXT_MATCH   0xa9L
769 #endif
770
771 int slapi_log_error( int severity, char *subsystem, char *fmt, ... );
772 #define SLAPI_LOG_FATAL                 0
773 #define SLAPI_LOG_TRACE                 1
774 #define SLAPI_LOG_PACKETS               2
775 #define SLAPI_LOG_ARGS                  3
776 #define SLAPI_LOG_CONNS                 4
777 #define SLAPI_LOG_BER                   5
778 #define SLAPI_LOG_FILTER                6
779 #define SLAPI_LOG_CONFIG                7
780 #define SLAPI_LOG_ACL                   8
781 #define SLAPI_LOG_SHELL                 9
782 #define SLAPI_LOG_PARSE                 10
783 #define SLAPI_LOG_HOUSE                 11
784 #define SLAPI_LOG_REPL                  12
785 #define SLAPI_LOG_CACHE                 13
786 #define SLAPI_LOG_PLUGIN                14
787 #define SLAPI_LOG_TIMING                15
788
789 #define SLAPI_PLUGIN_DESCRIPTION        12
790 typedef struct slapi_plugindesc {
791         char    *spd_id;
792         char    *spd_vendor;
793         char    *spd_version;
794         char    *spd_description;
795 } Slapi_PluginDesc;
796
797 #define SLAPI_PLUGIN_VERSION_01         "01"
798 #define SLAPI_PLUGIN_VERSION_02         "02"
799 #define SLAPI_PLUGIN_VERSION_03         "03"
800 #define SLAPI_PLUGIN_CURRENT_VERSION    SLAPI_PLUGIN_VERSION_03
801
802 #endif /* _SLAPI_PLUGIN_H */
803