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