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