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