git.sur5r.net Git - openldap/blob - include/slapi-plugin.h

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