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