git.sur5r.net Git - openldap/blob - 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_LOG_CHANGE        0x0001
 287 #define SLAPI_OP_FLAG_NEVER_CHAIN       0x0800
 288
 289 int slapi_search_internal_pb( Slapi_PBlock *pb );
 290 int slapi_search_internal_callback_pb( Slapi_PBlock *pb, void *callback_data,
 291         plugin_result_callback prc, plugin_search_entry_callback psec,
 292         plugin_referral_entry_callback prec );
 293 int slapi_add_internal_pb( Slapi_PBlock *pb );
 294 int slapi_modify_internal_pb( Slapi_PBlock *pb );
 295 int slapi_modrdn_internal_pb( Slapi_PBlock *pb );
 296 int slapi_delete_internal_pb( Slapi_PBlock *pb );
 297
 298 int slapi_seq_internal_callback_pb(Slapi_PBlock *pb, void *callback_data,
 299         plugin_result_callback res_callback,
 300         plugin_search_entry_callback srch_callback,
 301         plugin_referral_entry_callback ref_callback);
 302
 303 void slapi_search_internal_set_pb( Slapi_PBlock *pb, const char *base,
 304         int scope, const char *filter, char **attrs, int attrsonly,
 305         LDAPControl **controls, const char *uniqueid,
 306         Slapi_ComponentId *plugin_identity, int operation_flags );
 307 void slapi_add_entry_internal_set_pb( Slapi_PBlock *pb, Slapi_Entry *e,
 308         LDAPControl **controls, Slapi_ComponentId *plugin_identity,
 309         int operation_flags );
 310 int slapi_add_internal_set_pb( Slapi_PBlock *pb, const char *dn,
 311         LDAPMod **attrs, LDAPControl **controls,
 312         Slapi_ComponentId *plugin_identity, int operation_flags );
 313 void slapi_modify_internal_set_pb( Slapi_PBlock *pb, const char *dn,
 314         LDAPMod **mods, LDAPControl **controls, const char *uniqueid,
 315         Slapi_ComponentId *plugin_identity, int operation_flags );
 316 void slapi_rename_internal_set_pb( Slapi_PBlock *pb, const char *olddn,
 317         const char *newrdn, const char *newsuperior, int deloldrdn,
 318         LDAPControl **controls, const char *uniqueid,
 319         Slapi_ComponentId *plugin_identity, int operation_flags );
 320 void slapi_delete_internal_set_pb( Slapi_PBlock *pb, const char *dn,
 321         LDAPControl **controls, const char *uniqueid,
 322         Slapi_ComponentId *plugin_identity, int operation_flags );
 323 void slapi_seq_internal_set_pb( Slapi_PBlock *pb, char *ibase, int type,
 324         char *attrname, char *val, char **attrs, int attrsonly,
 325         LDAPControl **controls, Slapi_ComponentId *plugin_identity,
 326         int operation_flags );
 327
 328 /* connection related routines */
 329 int slapi_is_connection_ssl(Slapi_PBlock *pPB, int *isSSL);
 330 int slapi_get_client_port(Slapi_PBlock *pPB, int *fromPort);
 331
 332 /* computed attributes */
 333 typedef struct _computed_attr_context computed_attr_context;
 334 typedef int (*slapi_compute_output_t)(computed_attr_context *c, Slapi_Attr *a, Slapi_Entry *e);
 335 typedef int (*slapi_compute_callback_t)(computed_attr_context *c, char *type, Slapi_Entry *e, slapi_compute_output_t outputfn);
 336 typedef int (*slapi_search_rewrite_callback_t)(Slapi_PBlock *pb);
 337 int slapi_compute_add_evaluator(slapi_compute_callback_t function);
 338 int slapi_compute_add_search_rewriter(slapi_search_rewrite_callback_t function);
 339 int compute_rewrite_search_filter(Slapi_PBlock *pb);
 340 int compute_evaluator(computed_attr_context *c, char *type, Slapi_Entry *e, slapi_compute_output_t outputfn);
 341 int slapi_x_compute_get_pblock(computed_attr_context *c, Slapi_PBlock **pb);
 342
 343 /* ACL plugins; only SLAPI_PLUGIN_ACL_ALLOW_ACCESS supported now */
 344 typedef int (*slapi_acl_callback_t)(Slapi_PBlock *pb,
 345         Slapi_Entry *e,
 346         const char *attr,
 347         struct berval *berval,
 348         int access,
 349         void *state);
 350
 351 /* object extensions */
 352 typedef void *(*slapi_extension_constructor_fnptr)(void *object, void *parent);
 353
 354 typedef void (*slapi_extension_destructor_fnptr)(void *extension,
 355         void *object, void *parent);
 356
 357 int slapi_register_object_extension( const char *pluginname,
 358         const char *objectname, slapi_extension_constructor_fnptr constructor,
 359         slapi_extension_destructor_fnptr destructor, int *objecttype,
 360         int *extensionhandle);
 361
 362 #define SLAPI_EXT_CONNECTION    "Connection"
 363 #define SLAPI_EXT_OPERATION     "Operation"
 364 #define SLAPI_EXT_ENTRY         "Entry"
 365 #define SLAPI_EXT_MTNODE        "Mapping Tree Node"
 366
 367 void *slapi_get_object_extension(int objecttype, void *object,
 368         int extensionhandle);
 369 void slapi_set_object_extension(int objecttype, void *object,
 370         int extensionhandle, void *extension);
 371
 372 int slapi_x_backend_get_flags( const Slapi_Backend *be, unsigned long *flags );
 373
 374 /* parameters currently supported */
 375
 376 /*
 377  * Attribute flags returned by slapi_attr_get_flags()
 378  */
 379 #define SLAPI_ATTR_FLAG_SINGLE          0x0001
 380 #define SLAPI_ATTR_FLAG_OPATTR          0x0002
 381 #define SLAPI_ATTR_FLAG_READONLY        0x0004
 382 #define SLAPI_ATTR_FLAG_STD_ATTR        SLAPI_ATTR_FLAG_READONLY
 383 #define SLAPI_ATTR_FLAG_OBSOLETE        0x0040
 384 #define SLAPI_ATTR_FLAG_COLLECTIVE      0x0080
 385 #define SLAPI_ATTR_FLAG_NOUSERMOD       0x0100
 386
 387 /*
 388  * Backend flags returned by slapi_x_backend_get_flags()
 389  */
 390 #define SLAPI_BACKEND_FLAG_NOLASTMOD            0x0001U
 391 #define SLAPI_BACKEND_FLAG_NO_SCHEMA_CHECK      0x0002U
 392 #define SLAPI_BACKEND_FLAG_GLUE_INSTANCE        0x0010U /* a glue backend */
 393 #define SLAPI_BACKEND_FLAG_GLUE_SUBORDINATE     0x0020U /* child of a glue hierarchy */
 394 #define SLAPI_BACKEND_FLAG_GLUE_LINKED          0x0040U /* child is connected to parent */
 395 #define SLAPI_BACKEND_FLAG_OVERLAY              0x0080U /* this db struct is an overlay */
 396 #define SLAPI_BACKEND_FLAG_GLOBAL_OVERLAY       0x0100U /* this db struct is a global overlay */
 397 #define SLAPI_BACKEND_FLAG_SHADOW               0x8000U /* a shadow */
 398 #define SLAPI_BACKEND_FLAG_SYNC_SHADOW          0x1000U /* a sync shadow */
 399 #define SLAPI_BACKEND_FLAG_SLURP_SHADOW         0x2000U /* a slurp shadow */
 400
 401 /*
 402  * ACL levels
 403  */
 404 #define SLAPI_ACL_COMPARE       0x01
 405 #define SLAPI_ACL_SEARCH        0x02
 406 #define SLAPI_ACL_READ          0x04
 407 #define SLAPI_ACL_WRITE         0x08
 408 #define SLAPI_ACL_DELETE        0x10
 409 #define SLAPI_ACL_ADD           0x20
 410 #define SLAPI_ACL_SELF          0x40
 411 #define SLAPI_ACL_PROXY         0x80
 412 #define SLAPI_ACL_ALL           0x7f
 413
 414 /* plugin types supported */
 415
 416 #define SLAPI_PLUGIN_DATABASE           1
 417 #define SLAPI_PLUGIN_EXTENDEDOP         2
 418 #define SLAPI_PLUGIN_PREOPERATION       3
 419 #define SLAPI_PLUGIN_POSTOPERATION      4
 420 #define SLAPI_PLUGIN_MATCHINGRULE       5
 421 #define SLAPI_PLUGIN_SYNTAX             6
 422 #define SLAPI_PLUGIN_AUDIT              7
 423
 424 /* misc params */
 425
 426 #define SLAPI_BACKEND                           130
 427 #define SLAPI_CONNECTION                        131
 428 #define SLAPI_OPERATION                         132
 429 #define SLAPI_REQUESTOR_ISROOT                  133
 430 #define SLAPI_BE_MONITORDN                      134
 431 #define SLAPI_BE_TYPE                           135
 432 #define SLAPI_BE_READONLY                       136
 433 #define SLAPI_BE_LASTMOD                        137
 434 #define SLAPI_CONN_ID                           139
 435
 436 /* operation params */
 437 #define SLAPI_OPINITIATED_TIME                  140
 438 #define SLAPI_REQUESTOR_DN                      141
 439 #define SLAPI_REQUESTOR_ISUPDATEDN              142
 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 /* function pointer params for backends */
 478 #define SLAPI_PLUGIN_DB_BIND_FN                 200
 479 #define SLAPI_PLUGIN_DB_UNBIND_FN               201
 480 #define SLAPI_PLUGIN_DB_SEARCH_FN               202
 481 #define SLAPI_PLUGIN_DB_COMPARE_FN              203
 482 #define SLAPI_PLUGIN_DB_MODIFY_FN               204
 483 #define SLAPI_PLUGIN_DB_MODRDN_FN               205
 484 #define SLAPI_PLUGIN_DB_ADD_FN                  206
 485 #define SLAPI_PLUGIN_DB_DELETE_FN               207
 486 #define SLAPI_PLUGIN_DB_ABANDON_FN              208
 487 #define SLAPI_PLUGIN_DB_CONFIG_FN               209
 488 #define SLAPI_PLUGIN_CLOSE_FN                   210
 489 #define SLAPI_PLUGIN_DB_FLUSH_FN                211
 490 #define SLAPI_PLUGIN_START_FN                   212
 491 #define SLAPI_PLUGIN_DB_SEQ_FN                  213
 492 #define SLAPI_PLUGIN_DB_ENTRY_FN                214
 493 #define SLAPI_PLUGIN_DB_REFERRAL_FN             215
 494 #define SLAPI_PLUGIN_DB_RESULT_FN               216
 495 #define SLAPI_PLUGIN_DB_LDIF2DB_FN              217
 496 #define SLAPI_PLUGIN_DB_DB2LDIF_FN              218
 497 #define SLAPI_PLUGIN_DB_BEGIN_FN                219
 498 #define SLAPI_PLUGIN_DB_COMMIT_FN               220
 499 #define SLAPI_PLUGIN_DB_ABORT_FN                221
 500 #define SLAPI_PLUGIN_DB_ARCHIVE2DB_FN           222
 501 #define SLAPI_PLUGIN_DB_DB2ARCHIVE_FN           223
 502 #define SLAPI_PLUGIN_DB_NEXT_SEARCH_ENTRY_FN    224
 503 #define SLAPI_PLUGIN_DB_FREE_RESULT_SET_FN      225
 504 #define SLAPI_PLUGIN_DB_SIZE_FN                 226
 505 #define SLAPI_PLUGIN_DB_TEST_FN                 227
 506
 507
 508 /*  functions pointers for LDAP V3 extended ops */
 509 #define SLAPI_PLUGIN_EXT_OP_FN                  300
 510 #define SLAPI_PLUGIN_EXT_OP_OIDLIST             301
 511
 512 /* functions for preoperation functions */
 513 #define SLAPI_PLUGIN_PRE_BIND_FN                401
 514 #define SLAPI_PLUGIN_PRE_UNBIND_FN              402
 515 #define SLAPI_PLUGIN_PRE_SEARCH_FN              403
 516 #define SLAPI_PLUGIN_PRE_COMPARE_FN             404
 517 #define SLAPI_PLUGIN_PRE_MODIFY_FN              405
 518 #define SLAPI_PLUGIN_PRE_MODRDN_FN              406
 519 #define SLAPI_PLUGIN_PRE_ADD_FN                 407
 520 #define SLAPI_PLUGIN_PRE_DELETE_FN              408
 521 #define SLAPI_PLUGIN_PRE_ABANDON_FN             409
 522 #define SLAPI_PLUGIN_PRE_ENTRY_FN               410
 523 #define SLAPI_PLUGIN_PRE_REFERRAL_FN            411
 524 #define SLAPI_PLUGIN_PRE_RESULT_FN              412
 525
 526 /*  functions for postoperation functions*/
 527 #define SLAPI_PLUGIN_POST_BIND_FN               501
 528 #define SLAPI_PLUGIN_POST_UNBIND_FN             502
 529 #define SLAPI_PLUGIN_POST_SEARCH_FN             503
 530 #define SLAPI_PLUGIN_POST_COMPARE_FN            504
 531 #define SLAPI_PLUGIN_POST_MODIFY_FN             505
 532 #define SLAPI_PLUGIN_POST_MODRDN_FN             506
 533 #define SLAPI_PLUGIN_POST_ADD_FN                507
 534 #define SLAPI_PLUGIN_POST_DELETE_FN             508
 535 #define SLAPI_PLUGIN_POST_ABANDON_FN            509
 536 #define SLAPI_PLUGIN_POST_ENTRY_FN              510
 537 #define SLAPI_PLUGIN_POST_REFERRAL_FN           511
 538 #define SLAPI_PLUGIN_POST_RESULT_FN             512
 539
 540 #define SLAPI_OPERATION_TYPE                    590
 541
 542 #define SLAPI_PLUGIN_MR_FILTER_CREATE_FN        600
 543 #define SLAPI_PLUGIN_MR_INDEXER_CREATE_FN       601
 544 #define SLAPI_PLUGIN_MR_FILTER_MATCH_FN         602
 545 #define SLAPI_PLUGIN_MR_FILTER_INDEX_FN         603
 546 #define SLAPI_PLUGIN_MR_FILTER_RESET_FN         604
 547 #define SLAPI_PLUGIN_MR_INDEX_FN                605
 548 #define SLAPI_PLUGIN_MR_OID                     610
 549 #define SLAPI_PLUGIN_MR_TYPE                    611
 550 #define SLAPI_PLUGIN_MR_VALUE                   612
 551 #define SLAPI_PLUGIN_MR_VALUES                  613
 552 #define SLAPI_PLUGIN_MR_KEYS                    614
 553 #define SLAPI_PLUGIN_MR_FILTER_REUSABLE         615
 554 #define SLAPI_PLUGIN_MR_QUERY_OPERATOR          616
 555 #define SLAPI_PLUGIN_MR_USAGE                   617
 556
 557 #define SLAPI_MATCHINGRULE_NAME                 1
 558 #define SLAPI_MATCHINGRULE_OID                  2
 559 #define SLAPI_MATCHINGRULE_DESC                 3
 560 #define SLAPI_MATCHINGRULE_SYNTAX               4
 561 #define SLAPI_MATCHINGRULE_OBSOLETE             5
 562
 563 #define SLAPI_OP_LESS                                   1
 564 #define SLAPI_OP_LESS_OR_EQUAL                          2
 565 #define SLAPI_OP_EQUAL                                  3
 566 #define SLAPI_OP_GREATER_OR_EQUAL                       4
 567 #define SLAPI_OP_GREATER                                5
 568 #define SLAPI_OP_SUBSTRING                              6
 569
 570 #define SLAPI_PLUGIN_MR_USAGE_INDEX             0
 571 #define SLAPI_PLUGIN_MR_USAGE_SORT              1
 572
 573 #define SLAPI_PLUGIN_SYNTAX_FILTER_AVA          700
 574 #define SLAPI_PLUGIN_SYNTAX_FILTER_SUB          701
 575 #define SLAPI_PLUGIN_SYNTAX_VALUES2KEYS         702
 576 #define SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_AVA  703
 577 #define SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_SUB  704
 578 #define SLAPI_PLUGIN_SYNTAX_NAMES               705
 579 #define SLAPI_PLUGIN_SYNTAX_OID                 706
 580 #define SLAPI_PLUGIN_SYNTAX_FLAGS               707
 581 #define SLAPI_PLUGIN_SYNTAX_COMPARE             708
 582
 583 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORKEYS                 1
 584 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORDERING               2
 585
 586 #define SLAPI_PLUGIN_ACL_INIT                   730
 587 #define SLAPI_PLUGIN_ACL_SYNTAX_CHECK           731
 588 #define SLAPI_PLUGIN_ACL_ALLOW_ACCESS           732
 589 #define SLAPI_PLUGIN_ACL_MODS_ALLOWED           733
 590 #define SLAPI_PLUGIN_ACL_MODS_UPDATE            734
 591
 592 #define SLAPI_OPERATION_AUTHTYPE                741
 593 #define SLAPI_OPERATION_ID                      742
 594 #define SLAPI_CONN_CERT                         743
 595 #define SLAPI_CONN_AUTHMETHOD                   746
 596
 597 #define SLAPI_RESULT_CODE                       881
 598 #define SLAPI_RESULT_TEXT                       882
 599 #define SLAPI_RESULT_MATCHED                    883
 600
 601 /* managedsait control */
 602 #define SLAPI_MANAGEDSAIT                       1000
 603
 604 /* audit plugin defines */
 605 #define SLAPI_PLUGIN_AUDIT_DATA                1100
 606 #define SLAPI_PLUGIN_AUDIT_FN                  1101
 607
 608 /* backend_group extension */
 609 #define SLAPI_X_PLUGIN_PRE_GROUP_FN             1202
 610 #define SLAPI_X_PLUGIN_POST_GROUP_FN            1203
 611
 612 #define SLAPI_X_GROUP_ENTRY                     1250 /* group entry */
 613 #define SLAPI_X_GROUP_ATTRIBUTE                 1251 /* member attribute */
 614 #define SLAPI_X_GROUP_OPERATION_DN              1252 /* asserted value */
 615 #define SLAPI_X_GROUP_TARGET_ENTRY              1253 /* target entry */
 616
 617 /* config stuff */
 618 #define SLAPI_CONFIG_FILENAME                   40
 619 #define SLAPI_CONFIG_LINENO                     41
 620 #define SLAPI_CONFIG_ARGC                       42
 621 #define SLAPI_CONFIG_ARGV                       43
 622
 623 /*  operational params */
 624 #define SLAPI_TARGET_ADDRESS                    48
 625 #define SLAPI_TARGET_UNIQUEID                   49
 626 #define SLAPI_TARGET_DN                         50
 627 #define SLAPI_REQCONTROLS                       51
 628
 629 /* server LDAPv3 controls  */
 630 #define SLAPI_RESCONTROLS                       55
 631 #define SLAPI_ADD_RESCONTROL                    56
 632
 633 /* add params */
 634 #define SLAPI_ADD_TARGET                        SLAPI_TARGET_DN
 635 #define SLAPI_ADD_ENTRY                         60
 636 #define SLAPI_ADD_EXISTING_DN_ENTRY             61
 637 #define SLAPI_ADD_PARENT_ENTRY                  62
 638 #define SLAPI_ADD_PARENT_UNIQUEID               63
 639 #define SLAPI_ADD_EXISTING_UNIQUEID_ENTRY       64
 640
 641 /* bind params */
 642 #define SLAPI_BIND_TARGET                       SLAPI_TARGET_DN
 643 #define SLAPI_BIND_METHOD                       70
 644 #define SLAPI_BIND_CREDENTIALS                  71
 645 #define SLAPI_BIND_SASLMECHANISM                72
 646 #define SLAPI_BIND_RET_SASLCREDS                73
 647
 648 /* compare params */
 649 #define SLAPI_COMPARE_TARGET                    SLAPI_TARGET_DN
 650 #define SLAPI_COMPARE_TYPE                      80
 651 #define SLAPI_COMPARE_VALUE                     81
 652
 653 /* delete params */
 654 #define SLAPI_DELETE_TARGET                     SLAPI_TARGET_DN
 655 #define SLAPI_DELETE_EXISTING_ENTRY             SLAPI_ADD_EXISTING_DN_ENTRY
 656
 657 /* modify params */
 658 #define SLAPI_MODIFY_TARGET                     SLAPI_TARGET_DN
 659 #define SLAPI_MODIFY_MODS                       90
 660 #define SLAPI_MODIFY_EXISTING_ENTRY             SLAPI_ADD_EXISTING_DN_ENTRY
 661
 662 /* modrdn params */
 663 #define SLAPI_MODRDN_TARGET                     SLAPI_TARGET_DN
 664 #define SLAPI_MODRDN_NEWRDN                     100
 665 #define SLAPI_MODRDN_DELOLDRDN                  101
 666 #define SLAPI_MODRDN_NEWSUPERIOR                102     /* v3 only */
 667 #define SLAPI_MODRDN_EXISTING_ENTRY             SLAPI_ADD_EXISTING_DN_ENTRY
 668 #define SLAPI_MODRDN_PARENT_ENTRY               104
 669 #define SLAPI_MODRDN_NEWPARENT_ENTRY            105
 670 #define SLAPI_MODRDN_TARGET_ENTRY               106
 671 #define SLAPI_MODRDN_NEWSUPERIOR_ADDRESS        107
 672
 673 /* search params */
 674 #define SLAPI_SEARCH_TARGET                     SLAPI_TARGET_DN
 675 #define SLAPI_SEARCH_SCOPE                      110
 676 #define SLAPI_SEARCH_DEREF                      111
 677 #define SLAPI_SEARCH_SIZELIMIT                  112
 678 #define SLAPI_SEARCH_TIMELIMIT                  113
 679 #define SLAPI_SEARCH_FILTER                     114
 680 #define SLAPI_SEARCH_STRFILTER                  115
 681 #define SLAPI_SEARCH_ATTRS                      116
 682 #define SLAPI_SEARCH_ATTRSONLY                  117
 683
 684 /* abandon params */
 685 #define SLAPI_ABANDON_MSGID                     120
 686
 687 /* extended operation params */
 688 #define SLAPI_EXT_OP_REQ_OID                    160
 689 #define SLAPI_EXT_OP_REQ_VALUE          161
 690
 691 /* extended operation return codes */
 692 #define SLAPI_EXT_OP_RET_OID                    162
 693 #define SLAPI_EXT_OP_RET_VALUE          163
 694
 695 #define SLAPI_PLUGIN_EXTENDED_SENT_RESULT       -1
 696
 697 #define SLAPI_FAIL_DISKFULL             -2
 698 #define SLAPI_FAIL_GENERAL              -1
 699 #define SLAPI_BIND_SUCCESS              0
 700 #define SLAPI_BIND_FAIL                 2
 701 #define SLAPI_BIND_ANONYMOUS            3
 702
 703 /* Search result params */
 704 #define SLAPI_SEARCH_RESULT_SET                 193
 705 #define SLAPI_SEARCH_RESULT_ENTRY               194
 706 #define SLAPI_NENTRIES                          195
 707 #define SLAPI_SEARCH_REFERRALS                  196
 708
 709 /* filter types */
 710 #ifndef LDAP_FILTER_AND
 711 #define LDAP_FILTER_AND         0xa0L
 712 #endif
 713 #ifndef LDAP_FILTER_OR
 714 #define LDAP_FILTER_OR          0xa1L
 715 #endif
 716 #ifndef LDAP_FILTER_NOT
 717 #define LDAP_FILTER_NOT         0xa2L
 718 #endif
 719 #ifndef LDAP_FILTER_EQUALITY
 720 #define LDAP_FILTER_EQUALITY    0xa3L
 721 #endif
 722 #ifndef LDAP_FILTER_SUBSTRINGS
 723 #define LDAP_FILTER_SUBSTRINGS  0xa4L
 724 #endif
 725 #ifndef LDAP_FILTER_GE
 726 #define LDAP_FILTER_GE          0xa5L
 727 #endif
 728 #ifndef LDAP_FILTER_LE
 729 #define LDAP_FILTER_LE          0xa6L
 730 #endif
 731 #ifndef LDAP_FILTER_PRESENT
 732 #define LDAP_FILTER_PRESENT     0x87L
 733 #endif
 734 #ifndef LDAP_FILTER_APPROX
 735 #define LDAP_FILTER_APPROX      0xa8L
 736 #endif
 737 #ifndef LDAP_FILTER_EXT_MATCH
 738 #define LDAP_FILTER_EXT_MATCH   0xa9L
 739 #endif
 740
 741 int slapi_log_error( int severity, char *subsystem, char *fmt, ... );
 742 #define SLAPI_LOG_FATAL                 0
 743 #define SLAPI_LOG_TRACE                 1
 744 #define SLAPI_LOG_PACKETS               2
 745 #define SLAPI_LOG_ARGS                  3
 746 #define SLAPI_LOG_CONNS                 4
 747 #define SLAPI_LOG_BER                   5
 748 #define SLAPI_LOG_FILTER                6
 749 #define SLAPI_LOG_CONFIG                7
 750 #define SLAPI_LOG_ACL                   8
 751 #define SLAPI_LOG_SHELL                 9
 752 #define SLAPI_LOG_PARSE                 10
 753 #define SLAPI_LOG_HOUSE                 11
 754 #define SLAPI_LOG_REPL                  12
 755 #define SLAPI_LOG_CACHE                 13
 756 #define SLAPI_LOG_PLUGIN                14
 757 #define SLAPI_LOG_TIMING                15
 758
 759 #define SLAPI_PLUGIN_DESCRIPTION        12
 760 typedef struct slapi_plugindesc {
 761         char    *spd_id;
 762         char    *spd_vendor;
 763         char    *spd_version;
 764         char    *spd_description;
 765 } Slapi_PluginDesc;
 766
 767 #define SLAPI_PLUGIN_VERSION_01         "01"
 768 #define SLAPI_PLUGIN_VERSION_02         "02"
 769 #define SLAPI_PLUGIN_VERSION_03         "03"
 770 #define SLAPI_PLUGIN_CURRENT_VERSION    SLAPI_PLUGIN_VERSION_03
 771
 772 #endif /* _SLAPI_PLUGIN_H */
 773