2 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
3 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 * Portions Copyright IBM Corp. 1997,2002-2003
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
9 * Public License, version 2.7 or later.
12 #ifdef LDAP_SLAPI /* SLAPI is OPTIONAL */
17 #include <ibm_pblock_params.h>
22 * Quick 'n' dirty to make struct slapi_* in slapi-plugin.h opaque
24 #define slapi_entry slap_entry
25 #define slapi_attr slap_attr
26 #define slapi_value berval
27 #define slapi_valueset berval*
28 #define slapi_filter slap_filter
32 #include <slapi-plugin.h>
40 /* a little naif ... */
49 #if 0 /* unused (yet?) */
50 #define dn_normalize_case dn_normalize
51 #define SLAPD_NO_MEMORY 7
52 #define ANYBODY_STRING "CN=ANYBODY"
54 extern int slap_debug;
56 extern int dn_check(char *, int *);
58 typedef struct strlist {
64 extern struct berval *ns_get_supported_extop( int );
69 typedef struct _Audit_record Audit_record;
71 #define SLAPI_CONTROL_MANAGEDSAIT_OID LDAP_CONTROL_MANAGEDSAIT
72 #define SLAPI_CONTROL_SORTEDSEARCH_OID LDAP_CONTROL_SORTREQUEST
73 #define SLAPI_CONTROL_PAGED_RESULTS_OID LDAP_CONTROL_PAGEDRESULTS
75 typedef int (*SLAPI_FUNC)( Slapi_PBlock *pb );
77 #if 0 /* unused (yet?) */
78 #define DOMAIN "Domain"
79 #define TCPIPPATH "SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters"
82 typedef struct _slapi_control {
85 unsigned long *s_ctrl_ops;
88 typedef struct _ExtendedOp {
89 struct berval ext_oid;
92 struct _ExtendedOp *ext_next;
95 /* Computed attribute support */
96 struct _computed_attr_context {
97 /* slap_send_search_entry() argblock */
99 AttributeName *cac_attrs;
100 int cac_attrsonly : 1;
101 int cac_userattrs : 1;
103 AccessControlState cac_acl_state;
108 /* for slapi_attr_type_cmp() */
109 #define SLAPI_TYPE_CMP_EXACT 0
110 #define SLAPI_TYPE_CMP_BASE 1
111 #define SLAPI_TYPE_CMP_SUBTYPE 2
113 typedef enum slapi_extension_e {
114 SLAPI_X_EXT_CONNECTION = 0,
115 SLAPI_X_EXT_OPERATION = 1,
120 * Was: slapi_pblock.h
123 #ifndef NO_PBLOCK_CLASS /* where's this test from? */
125 #if 0 /* unused (yet?) */
127 #define CMP_GREATER 1
128 #define CMP_LOWER (-1)
130 #define PBLOCK_ERROR (-1)
131 #define INVALID_PARAM PBLOCK_ERROR
132 #define PBLOCK_MAX_PARAMS 100
134 struct slapi_pblock {
135 ldap_pvt_thread_mutex_t pblockMutex;
138 int curParams[PBLOCK_MAX_PARAMS];
139 void *curVals[PBLOCK_MAX_PARAMS];
142 #endif /* !NO_PBLOCK_CLASS */
148 #define SLAPI_PLUGIN_IS_POST_FN(x) ((x) >= SLAPI_PLUGIN_POST_BIND_FN && (x) <= SLAPI_PLUGIN_POST_RESULT_FN)
156 #define OBJECTCLASS "objectclass"
158 #define CHANGE_TIME "changetime"
159 #define CHANGE_TYPE "changetype"
160 #define CHANGE_TARGETDN "targetdn"
161 #define CHANGES "changes"
162 #define CHANGE_NUMBER "changenumber"
164 * FIXME: I get complaints like "ADD" being redefined - first definition
165 * being in "/usr/include/arpa/nameser.h:552"
170 #define DEL "delete: "
172 #define REPLACE "replace: "
175 #define MODRDN "modrdn"
176 #define CHANGE_LOGENTRY "changelogentry"
177 #define IBM_CHANGE_LOGENTRY "ibm-changelog"
178 #define CL_NEWRDN "newrdn"
179 #define CL_DELRDN "deleteoldrdn"
180 #define CHANGE_INITIATOR "ibm-changeInitiatorsName"
182 extern void slapi_register_changelog_suffix(char *suffix);
183 extern char **slapi_get_changelog_suffixes();
184 extern void slapi_update_changelog_counters(long curNum, long numEntries);
185 extern char *slapi_get_cl_firstNum();
186 extern char *slapi_get_cl_lastNum();
187 extern int slapi_add_to_changelog(Slapi_Entry *ent, char *suffix, char *chNum, Operation* op);
188 extern int slapi_delete_changelog(char *dn, char *suffix, char *chNum, Operation* op);
189 extern int slapi_modify_changelog(char *dn,LDAPMod *mods,char *suffix, char *chNum, Operation* op);
190 extern int slapi_modifyrdn_changelog(char *olddn, char *newRdn, int delRdn, char *suffix, char *chNum, Operation* op);
191 extern Backend * slapi_cl_get_be(char *dn);
196 * Attribute flags returned by slapi_attr_get_flags()
198 #define SLAPI_ATTR_FLAG_SINGLE 0x0001
199 #define SLAPI_ATTR_FLAG_OPATTR 0x0002
200 #define SLAPI_ATTR_FLAG_READONLY 0x0004
201 #define SLAPI_ATTR_FLAG_STD_ATTR SLAPI_ATTR_FLAG_READONLY
202 #define SLAPI_ATTR_FLAG_OBSOLETE 0x0040
203 #define SLAPI_ATTR_FLAG_COLLECTIVE 0x0080
204 #define SLAPI_ATTR_FLAG_NOUSERMOD 0x0100
209 #define SLAPI_ACL_COMPARE 0x01
210 #define SLAPI_ACL_SEARCH 0x02
211 #define SLAPI_ACL_READ 0x04
212 #define SLAPI_ACL_WRITE 0x08
213 #define SLAPI_ACL_DELETE 0x10
214 #define SLAPI_ACL_ADD 0x20
215 #define SLAPI_ACL_SELF 0x40
216 #define SLAPI_ACL_PROXY 0x80
217 #define SLAPI_ACL_ALL 0x7f
220 * Plugin types universally supported by SLAPI
223 #define SLAPI_PLUGIN_DATABASE 1
224 #define SLAPI_PLUGIN_EXTENDEDOP 2
225 #define SLAPI_PLUGIN_PREOPERATION 3
226 #define SLAPI_PLUGIN_POSTOPERATION 4
227 #define SLAPI_PLUGIN_MATCHINGRULE 5
228 #define SLAPI_PLUGIN_SYNTAX 6
229 /* XXX this is SLAPI_PLUGIN_ACL in SunDS */
230 #define SLAPI_PLUGIN_AUDIT 7
232 * The following plugin types are reserved for future
233 * Sun ONE DS compatability.
235 #define SLAPI_PLUGIN_BEPREOPERATION 8
236 #define SLAPI_PLUGIN_BEPOSTOPERATION 9
237 #define SLAPI_PLUGIN_ENTRY 10
238 #define SLAPI_PLUGIN_TYPE_OBJECT 11
239 #define SLAPI_PLUGIN_INTERNAL_PREOPERATION 12
240 #define SLAPI_PLUGIN_INTERNAL_POSTOPERATION 13
241 #define SLAPI_PLUGIN_PWD_STORAGE_SCHEME 14
242 #define SLAPI_PLUGIN_VATTR_SP 15
243 #define SLAPI_PLUGIN_REVER_PWD_STORAGE_SCHEME 16
245 #define SLAPI_PLUGIN_EXTENDED_SENT_RESULT -1
246 #define SLAPI_PLUGIN_EXTENDED_NOT_HANDLED -2
248 #define SLAPI_BIND_SUCCESS 0
249 #define SLAPI_BIND_FAIL 2
250 #define SLAPI_BIND_ANONYMOUS 3
252 #define SLAPI_BACKEND 130
253 #define SLAPI_CONNECTION 131
254 #define SLAPI_OPERATION 132
255 #define SLAPI_REQUESTOR_ISROOT 133
256 #define SLAPI_BE_MONITORDN 134
257 #define SLAPI_BE_TYPE 135
258 #define SLAPI_BE_READONLY 136
259 #define SLAPI_BE_LASTMOD 137
260 #define SLAPI_OPERATION_PARAMETERS 138
261 #define SLAPI_CONN_ID 139
263 #define SLAPI_OPINITIATED_TIME 140
264 #define SLAPI_REQUESTOR_DN 141
265 #define SLAPI_REQUESTOR_ISUPDATEDN 142
266 #define SLAPI_IS_REPLICATED_OPERATION SLAPI_REQUESTOR_ISUPDATEDN
267 #define SLAPI_CONN_DN 143
268 #define SLAPI_CONN_AUTHTYPE 144
269 #define SLAPI_CONN_CLIENTIP 145
270 #define SLAPI_CONN_SERVERIP 146
271 #define SLAPI_X_CONN_CLIENTPATH 1300
272 #define SLAPI_X_CONN_SERVERPATH 1301
273 #define SLAPI_X_CONN_IS_UDP 1302
274 #define SLAPI_X_CONN_SSF 1303
275 #define SLAPI_X_CONN_SASL_CONTEXT 1304
277 #define SLAPD_AUTH_NONE "none"
278 #define SLAPD_AUTH_SIMPLE "simple"
279 #define SLAPD_AUTH_SSL "SSL"
280 #define SLAPD_AUTH_SASL "SASL "
282 #define SLAPI_PLUGIN 3
283 #define SLAPI_PLUGIN_PRIVATE 4
284 #define SLAPI_PLUGIN_TYPE 5
285 #define SLAPI_PLUGIN_ARGV 6
286 #define SLAPI_PLUGIN_ARGC 7
287 #define SLAPI_PLUGIN_VERSION 8
289 #define SLAPI_PLUGIN_OPRETURN 9
290 #define SLAPI_PLUGIN_OBJECT 10
291 #define SLAPI_PLUGIN_DESTROY_FN 11
293 #define SLAPI_PLUGIN_DESCRIPTION 12
295 #define SLAPI_PLUGIN_INTOP_RESULT 15
296 #define SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES 16
297 #define SLAPI_PLUGIN_INTOP_SEARCH_REFERRALS 17
299 #define SLAPI_PLUGIN_DB_BIND_FN 200
300 #define SLAPI_PLUGIN_DB_UNBIND_FN 201
301 #define SLAPI_PLUGIN_DB_SEARCH_FN 202
302 #define SLAPI_PLUGIN_DB_COMPARE_FN 203
303 #define SLAPI_PLUGIN_DB_MODIFY_FN 204
304 #define SLAPI_PLUGIN_DB_MODRDN_FN 205
305 #define SLAPI_PLUGIN_DB_ADD_FN 206
306 #define SLAPI_PLUGIN_DB_DELETE_FN 207
307 #define SLAPI_PLUGIN_DB_ABANDON_FN 208
308 #define SLAPI_PLUGIN_DB_CONFIG_FN 209
309 #define SLAPI_PLUGIN_CLOSE_FN 210
310 #define SLAPI_PLUGIN_DB_FLUSH_FN 211
311 #define SLAPI_PLUGIN_START_FN 212
312 #define SLAPI_PLUGIN_DB_SEQ_FN 213
313 #define SLAPI_PLUGIN_DB_ENTRY_FN 214
314 #define SLAPI_PLUGIN_DB_REFERRAL_FN 215
315 #define SLAPI_PLUGIN_DB_RESULT_FN 216
316 #define SLAPI_PLUGIN_DB_LDIF2DB_FN 217
317 #define SLAPI_PLUGIN_DB_DB2LDIF_FN 218
318 #define SLAPI_PLUGIN_DB_BEGIN_FN 219
319 #define SLAPI_PLUGIN_DB_COMMIT_FN 220
320 #define SLAPI_PLUGIN_DB_ABORT_FN 221
321 #define SLAPI_PLUGIN_DB_ARCHIVE2DB_FN 222
322 #define SLAPI_PLUGIN_DB_DB2ARCHIVE_FN 223
323 #define SLAPI_PLUGIN_DB_NEXT_SEARCH_ENTRY_FN 224
324 #define SLAPI_PLUGIN_DB_FREE_RESULT_SET_FN 225
325 #define SLAPI_PLUGIN_DB_SIZE_FN 226
326 #define SLAPI_PLUGIN_DB_TEST_FN 227
327 #define SLAPI_PLUGIN_DB_NO_ACL 250
329 #define SLAPI_PLUGIN_EXT_OP_FN 300
330 #define SLAPI_PLUGIN_EXT_OP_OIDLIST 301
331 #define SLAPI_PLUGIN_PRE_BIND_FN 401
332 #define SLAPI_PLUGIN_PRE_UNBIND_FN 402
333 #define SLAPI_PLUGIN_PRE_SEARCH_FN 403
334 #define SLAPI_PLUGIN_PRE_COMPARE_FN 404
335 #define SLAPI_PLUGIN_PRE_MODIFY_FN 405
336 #define SLAPI_PLUGIN_PRE_MODRDN_FN 406
337 #define SLAPI_PLUGIN_PRE_ADD_FN 407
338 #define SLAPI_PLUGIN_PRE_DELETE_FN 408
339 #define SLAPI_PLUGIN_PRE_ABANDON_FN 409
340 #define SLAPI_PLUGIN_PRE_ENTRY_FN 410
341 #define SLAPI_PLUGIN_PRE_REFERRAL_FN 411
342 #define SLAPI_PLUGIN_PRE_RESULT_FN 412
343 #define SLAPI_PLUGIN_POST_BIND_FN 501
344 #define SLAPI_PLUGIN_POST_UNBIND_FN 502
345 #define SLAPI_PLUGIN_POST_SEARCH_FN 503
346 #define SLAPI_PLUGIN_POST_COMPARE_FN 504
347 #define SLAPI_PLUGIN_POST_MODIFY_FN 505
348 #define SLAPI_PLUGIN_POST_MODRDN_FN 506
349 #define SLAPI_PLUGIN_POST_ADD_FN 507
350 #define SLAPI_PLUGIN_POST_DELETE_FN 508
351 #define SLAPI_PLUGIN_POST_ABANDON_FN 509
352 #define SLAPI_PLUGIN_POST_ENTRY_FN 510
353 #define SLAPI_PLUGIN_POST_REFERRAL_FN 511
354 #define SLAPI_PLUGIN_POST_RESULT_FN 512
356 #define SLAPI_OPERATION_TYPE 590
358 #define SLAPI_PLUGIN_MR_FILTER_CREATE_FN 600
359 #define SLAPI_PLUGIN_MR_INDEXER_CREATE_FN 601
360 #define SLAPI_PLUGIN_MR_FILTER_MATCH_FN 602
361 #define SLAPI_PLUGIN_MR_FILTER_INDEX_FN 603
362 #define SLAPI_PLUGIN_MR_FILTER_RESET_FN 604
363 #define SLAPI_PLUGIN_MR_INDEX_FN 605
364 #define SLAPI_PLUGIN_MR_OID 610
365 #define SLAPI_PLUGIN_MR_TYPE 611
366 #define SLAPI_PLUGIN_MR_VALUE 612
367 #define SLAPI_PLUGIN_MR_VALUES 613
368 #define SLAPI_PLUGIN_MR_KEYS 614
369 #define SLAPI_PLUGIN_MR_FILTER_REUSABLE 615
370 #define SLAPI_PLUGIN_MR_QUERY_OPERATOR 616
371 #define SLAPI_PLUGIN_MR_USAGE 617
373 #define SLAPI_OP_LESS 1
374 #define SLAPI_OP_LESS_OR_EQUAL 2
375 #define SLAPI_OP_EQUAL 3
376 #define SLAPI_OP_GREATER_OR_EQUAL 4
377 #define SLAPI_OP_GREATER 5
378 #define SLAPI_OP_SUBSTRING 6
380 #define SLAPI_PLUGIN_MR_USAGE_INDEX 0
381 #define SLAPI_PLUGIN_MR_USAGE_SORT 1
383 #define SLAPI_MATCHINGRULE_NAME 1
384 #define SLAPI_MATCHINGRULE_OID 2
385 #define SLAPI_MATCHINGRULE_DESC 3
386 #define SLAPI_MATCHINGRULE_SYNTAX 4
387 #define SLAPI_MATCHINGRULE_OBSOLETE 5
389 #define SLAPI_PLUGIN_SYNTAX_FILTER_AVA 700
390 #define SLAPI_PLUGIN_SYNTAX_FILTER_SUB 701
391 #define SLAPI_PLUGIN_SYNTAX_VALUES2KEYS 702
392 #define SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_AVA 703
393 #define SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_SUB 704
394 #define SLAPI_PLUGIN_SYNTAX_NAMES 705
395 #define SLAPI_PLUGIN_SYNTAX_OID 706
396 #define SLAPI_PLUGIN_SYNTAX_FLAGS 707
397 #define SLAPI_PLUGIN_SYNTAX_COMPARE 708
399 #define SLAPI_PLUGIN_ACL_INIT 730
400 #define SLAPI_PLUGIN_ACL_SYNTAX_CHECK 731
401 #define SLAPI_PLUGIN_ACL_ALLOW_ACCESS 732
402 #define SLAPI_PLUGIN_ACL_MODS_ALLOWED 733
403 #define SLAPI_PLUGIN_ACL_MODS_UPDATE 734
405 #define SLAPI_OPERATION_AUTHTYPE 741
406 #define SLAPI_OPERATION_ID 742
407 #define SLAPI_CONN_CERT 743
408 #define SLAPI_CONN_AUTHMETHOD 746
410 #define SLAPI_RESULT_CODE 881
411 #define SLAPI_RESULT_TEXT 882
412 #define SLAPI_RESULT_MATCHED 883
414 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORKEYS 1
415 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORDERING 2
417 #define SLAPI_PLUGIN_AUDIT_DATA 1100
418 #define SLAPI_PLUGIN_AUDIT_FN 1101
420 /* DS 5.x Computed Attribute Callbacks (not exposed) */
421 #define SLAPI_PLUGIN_COMPUTE_EVALUATOR_FN 1200
422 #define SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN 1201
424 #define SLAPI_MANAGEDSAIT 1000
426 #define SLAPI_CONFIG_FILENAME 40
427 #define SLAPI_CONFIG_LINENO 41
428 #define SLAPI_CONFIG_ARGC 42
429 #define SLAPI_CONFIG_ARGV 43
431 #define SLAPI_TARGET_DN 50
432 #define SLAPI_REQCONTROLS 51
434 #define SLAPI_ENTRY_PRE_OP 52
435 #define SLAPI_ENTRY_POST_OP 53
437 #define SLAPI_RESCONTROLS 55
438 #define SLAPI_ADD_RESCONTROL 56
440 #define SLAPI_ADD_TARGET SLAPI_TARGET_DN
441 #define SLAPI_ADD_ENTRY 60
443 #define SLAPI_BIND_TARGET SLAPI_TARGET_DN
444 #define SLAPI_BIND_METHOD 70
445 #define SLAPI_BIND_CREDENTIALS 71
446 #define SLAPI_BIND_SASLMECHANISM 72
447 #define SLAPI_BIND_RET_SASLCREDS 73
449 #define SLAPI_COMPARE_TARGET SLAPI_TARGET_DN
450 #define SLAPI_COMPARE_TYPE 80
451 #define SLAPI_COMPARE_VALUE 81
453 #define SLAPI_DELETE_TARGET SLAPI_TARGET_DN
455 #define SLAPI_MODIFY_TARGET SLAPI_TARGET_DN
456 #define SLAPI_MODIFY_MODS 90
458 #define SLAPI_MODRDN_TARGET SLAPI_TARGET_DN
459 #define SLAPI_MODRDN_NEWRDN 100
460 #define SLAPI_MODRDN_DELOLDRDN 101
461 #define SLAPI_MODRDN_NEWSUPERIOR 102
463 #define SLAPI_SEARCH_TARGET SLAPI_TARGET_DN
464 #define SLAPI_SEARCH_SCOPE 110
465 #define SLAPI_SEARCH_DEREF 111
466 #define SLAPI_SEARCH_SIZELIMIT 112
467 #define SLAPI_SEARCH_TIMELIMIT 113
468 #define SLAPI_SEARCH_FILTER 114
469 #define SLAPI_SEARCH_STRFILTER 115
470 #define SLAPI_SEARCH_ATTRS 116
471 #define SLAPI_SEARCH_ATTRSONLY 117
473 #define SLAPI_ABANDON_MSGID 120
475 #define SLAPI_SEQ_TYPE 150
476 #define SLAPI_SEQ_ATTRNAME 151
477 #define SLAPI_SEQ_VAL 152
479 #define SLAPI_EXT_OP_REQ_OID 160
480 #define SLAPI_EXT_OP_REQ_VALUE 161
481 #define SLAPI_EXT_OP_RET_OID 162
482 #define SLAPI_EXT_OP_RET_VALUE 163
484 #define SLAPI_MR_FILTER_ENTRY 170
485 #define SLAPI_MR_FILTER_TYPE 171
486 #define SLAPI_MR_FILTER_VALUE 172
487 #define SLAPI_MR_FILTER_OID 173
488 #define SLAPI_MR_FILTER_DNATTRS 174
490 #define SLAPI_LDIF2DB_FILE 180
491 #define SLAPI_LDIF2DB_REMOVEDUPVALS 185
493 #define SLAPI_DB2LDIF_PRINTKEY 183
495 #define SLAPI_PARENT_TXN 190
496 #define SLAPI_TXN 191
498 #define SLAPI_SEARCH_RESULT_SET 193
499 #define SLAPI_SEARCH_RESULT_ENTRY 194
500 #define SLAPI_NENTRIES 195
501 #define SLAPI_SEARCH_REFERRALS 196
503 #define SLAPI_CHANGENUMBER 197
504 #define SLAPI_LOG_OPERATION 198
506 #define SLAPI_DBSIZE 199
508 #define SLAPI_LOG_FATAL 0
509 #define SLAPI_LOG_TRACE 1
510 #define SLAPI_LOG_PACKETS 2
511 #define SLAPI_LOG_ARGS 3
512 #define SLAPI_LOG_CONNS 4
513 #define SLAPI_LOG_BER 5
514 #define SLAPI_LOG_FILTER 6
515 #define SLAPI_LOG_CONFIG 7
516 #define SLAPI_LOG_ACL 8
517 #define SLAPI_LOG_SHELL 9
518 #define SLAPI_LOG_PARSE 10
519 #define SLAPI_LOG_HOUSE 11
520 #define SLAPI_LOG_REPL 12
521 #define SLAPI_LOG_CACHE 13
522 #define SLAPI_LOG_PLUGIN 14
524 #define SLAPI_OPERATION_BIND 0x00000001L
525 #define SLAPI_OPERATION_UNBIND 0x00000002L
526 #define SLAPI_OPERATION_SEARCH 0x00000004L
527 #define SLAPI_OPERATION_MODIFY 0x00000008L
528 #define SLAPI_OPERATION_ADD 0x00000010L
529 #define SLAPI_OPERATION_DELETE 0x00000020L
530 #define SLAPI_OPERATION_MODDN 0x00000040L
531 #define SLAPI_OPERATION_MODRDN SLAPI_OPERATION_MODDN
532 #define SLAPI_OPERATION_COMPARE 0x00000080L
533 #define SLAPI_OPERATION_ABANDON 0x00000100L
534 #define SLAPI_OPERATION_EXTENDED 0x00000200L
535 #define SLAPI_OPERATION_ANY 0xFFFFFFFFL
536 #define SLAPI_OPERATION_NONE 0x00000000L
540 #include "proto-slapi.h"
542 #endif /* _SLAPI_H */
543 #endif /* LDAP_SLAPI */