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